Warehouse tasks
Create 1 to 100 Warehouse tasks from one JSON array. Each task receives DRAFT status, is assigned to the API key locations, and starts without an assignee. Duplicate externalId values are rejected; each item is returned in the batch results.
http://localhost:3000/api/v1/warehouse/tasks- Method
- POST
- Content type
- application/json
- Authentication
- Required · active locations · non-expired key
- Maximum payload
- 1 MiB
- Request frequency
- 30 requests per 60 seconds
Request headers
Send these headers with every POST request.
Content-Type: application/json
Authorization: Bearer y3m_ABCD2345_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxTo get the authorization key, open Dashboard, use the three-dot menu on the company card, and select API integrations. Under Secret keys, select Create secret key, enable the Warehouse scope, and assign at least one active location. Copy the full key when it is created because it is shown only once, then send it after Bearer in the Authorization header.
Request fields
Required and optional fields accepted in the JSON request body. Unknown fields are rejected at every level.
| Field | Type | Requirement | Description |
|---|---|---|---|
externalId | string | Required | Caller-controlled source-system task identifier. It must be unique within the company. Maximum 200 characters. |
task | object | Optional | Optional Warehouse task identity. |
task.code | string | On create | Required when task is provided on create. External warehouse task code, stored unchanged. Maximum 100 characters. |
task.type | string | Optional | Optional external warehouse task type, stored unchanged. Maximum 100 characters. |
task.name | string | null | Optional | Optional warehouse task display name. Maximum 200 characters. |
dates | object | On create | Warehouse task schedule required on create. Both dates use the YYYY-MM-DD format. |
dates.scheduled | date | On create | First scheduled Warehouse task date required on create in YYYY-MM-DD format. |
dates.end | date | Optional | Last scheduled Warehouse task date in YYYY-MM-DD format. Must not be earlier than dates.scheduled and defaults to dates.scheduled when omitted. |
operationType | "RECEIVING" | "TRANSFER" | On create | Warehouse operation type required on create. Operations attached to this task must use the same operation type. |
description | string | null | Optional | Optional warehouse task description or note. Maximum 2,000 characters. |
operations | array | On create | Between 1 and 1,000 confirmed Warehouse Operations required on create. |
operations[].externalId | string | On create | External identifier required on create for an existing confirmed Warehouse Operation with the same operationType. |
operations[].position | integer | Optional | Optional positive operation position. Supplied positions must be unique. |
Error responses
Possible errors returned by this endpoint and how to resolve them.
| Status | Code | Meaning | Resolution |
|---|---|---|---|
400 | INVALID_JSON | The request body is not valid JSON. | Send one correctly formatted JSON object. |
400 | INVALID_PAYLOAD | The JSON body is not an object. | Send a JSON object instead of an array, string, number, or null. |
401 | UNAUTHORIZED | The Authorization header is missing, malformed, or contains an invalid API key. | Send a valid API key using the Bearer authorization scheme. |
401 | API_KEY_EXPIRED | The API key has reached its expiration date. | Create a new API key and retry the request. |
403 | FORBIDDEN | The API key cannot access this module or is not assigned to an active company location. | Assign an active location, enable the required module, or use another key. |
409 | PRODUCT_DELETED | A product referenced by externalId is deleted. | Restore the product in Y3M, then retry the request. |
409 | WAREHOUSE_TASK_ALREADY_EXISTS | A Warehouse task already uses this externalId, including a deleted task. | Use another externalId. |
409 | WAREHOUSE_OPERATION_ALREADY_EXISTS | A non-deleted Warehouse Operation already uses this externalId. | Use another externalId or delete the existing Warehouse Operation before creating a new one. |
409 | WAREHOUSE_UNAVAILABLE | Warehouse is inactive. | Activate Warehouse, then retry the request. |
413 | PAYLOAD_TOO_LARGE | The request body exceeds the 1 MiB limit. | Reduce the JSON payload size to 1 MiB or less. |
415 | UNSUPPORTED_MEDIA_TYPE | The Content-Type header is not application/json. | Send Content-Type: application/json. |
422 | VALIDATION_ERROR | The JSON is valid but one or more fields do not satisfy the endpoint contract. | Use each { path, message } entry in error.details to correct the specified field. |
429 | RATE_LIMIT_EXCEEDED | More than 30 requests were sent within 60 seconds. | Wait for the number of seconds specified by the Retry-After header. |
500 | INTERNAL_ERROR | Request infrastructure, authentication, or rate-limit processing is temporarily unavailable. | Retry later. Contact support if the error continues. |
500 | STORAGE_ERROR | The validated payload could not be stored. | Retry later. Contact support if the error continues. |
Example request
Send this JSON object in the POST request body.
[
{
"externalId": "WAREHOUSE-001",
"task": {
"code": "RCV-001",
"type": "supplier_delivery",
"name": "Receive supplier shipment"
},
"dates": {
"scheduled": "2026-10-20",
"end": "2026-10-22"
},
"operationType": "RECEIVING",
"description": "Receiving note",
"operations": [
{
"externalId": "OPERATION-001",
"position": 1
}
]
}
]