Warehouse Operations

Atomically create up to 100 Warehouse Operations with caller-controlled external IDs. If any operation fails, none are stored. Each operation is created as CONFIRMED, assigned to every active company location available to the API key, and stored together with its product lines and storage values as historical snapshots. Products must reference active catalogue products visible at those locations. operationType accepts RECEIVING or TRANSFER, while operation.code, operation.type, and operation.name carry the external operation identity. Monetary, discount, package, weight, volume, and product-line values follow the same validation rules as Orders. An externalId already used by a non-deleted Warehouse Operation returns WAREHOUSE_OPERATION_ALREADY_EXISTS; the repeated request does not update the existing Warehouse Operation. Every Warehouse Operation requires at least one product line.

POSThttp://localhost:3000/api/v1/warehouse/operations
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_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

To 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.

FieldTypeRequirementDescription
externalIdstringRequiredCaller-controlled source-system identifier; it does not need to be a UUID. A value already used by a non-deleted Warehouse Operation returns WAREHOUSE_OPERATION_ALREADY_EXISTS. Maximum 200 characters.
operationobject | nullOptionalOptional external operation identity.
operation.codestringOn createRequired when operation is provided on create.
operation.typestringOptionalOptional external operation type.
operation.namestringOptionalOptional external operation name.
operationType"RECEIVING" | "TRANSFER"On createSystem operation type required on create.
datesobject | nullOptionalOptional document dates.
dates.invoicedateOn createRequired when dates is provided on create.
packagesobject | nullOptionalOptional package count and type.
packages.type"box" | "pallet"On createPackage type. Required when packages is provided on create.
packages.valueintegerOn createNon-negative package count. Required when packages is provided on create.
discountobject | nullOptionalOptional percentage or fixed-amount discount.
discount.type"percent" | "amount"On createDiscount type. Required when discount is provided on create.
discount.valuedecimal stringOn createNon-negative discount value with up to three decimal places. Required when discount is provided on create.
descriptionstring | nullOptionalOptional operation note.
amountobject | nullOptionalOptional subtotal, total and currency amounts.
amount.subtotaldecimal stringOptionalSubtotal amount.
amount.totaldecimal stringOn createRequired when amount is provided on create.
amount.currency"UAH" | "EUR" | "USD" | "PLN"OptionalOptional amount currency. Allowed values: UAH, EUR, USD, PLN.
weightobject | nullOptionalOptional weight in kilograms.
weight.type"kg"On createWeight unit. Required when weight is provided on create.
weight.valuedecimal stringOn createWeight value. Required when weight is provided on create.
volumeobject | nullOptionalOptional volume in cubic metres.
volume.type"m3"On createVolume unit. Required when volume is provided on create.
volume.valuedecimal stringOn createVolume value. Required when volume is provided on create.
productsarrayOn createAt least one product line item is required on create.
products[].externalIdstringOn createProduct external identifier required on create.
products[].positionintegerOptionalOptional line position.
products[].quantityobject | nullOptionalOptional product quantity.
products[].quantity.valuedecimal stringOn createQuantity value required on create when quantity is provided.
products[].quantity.unit"pcs"On createQuantity unit required on create when quantity is provided.
products[].pricedecimal stringOptionalOptional unit price.
products[].amountdecimal stringOptionalOptional line amount.
products[].storagearrayOptionalOptional storage locations.
products[].storage[].type"shelf" | "pallet"On createStorage type required on create when storage is provided.
products[].storage[].valuestringOn createStorage identifier required on create when storage is provided.

Error responses

Possible errors returned by this endpoint and how to resolve them.

StatusCodeMeaningResolution
400INVALID_JSONThe request body is not valid JSON.Send one correctly formatted JSON array.
400INVALID_PAYLOADThe JSON body is not an array.Send a root JSON array containing between 1 and 100 objects.
401UNAUTHORIZEDThe Authorization header is missing, malformed, or contains an invalid API key.Send a valid API key using the Bearer authorization scheme.
401API_KEY_EXPIREDThe API key has reached its expiration date.Create a new API key and retry the request.
403FORBIDDENThe 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.
409PRODUCT_DELETEDA product referenced by externalId is deleted.Restore the product in Y3M, then retry the request.
409WAREHOUSE_TASK_ALREADY_EXISTSA Warehouse task already uses this externalId, including a deleted task.Use another externalId.
409WAREHOUSE_OPERATION_ALREADY_EXISTSA non-deleted Warehouse Operation already uses this externalId.Use another externalId or delete the existing Warehouse Operation before creating a new one.
409WAREHOUSE_UNAVAILABLEWarehouse is inactive.Activate Warehouse, then retry the request.
413PAYLOAD_TOO_LARGEThe request body exceeds the 1 MiB limit.Reduce the JSON payload size to 1 MiB or less.
415UNSUPPORTED_MEDIA_TYPEThe Content-Type header is not application/json.Send Content-Type: application/json.
422VALIDATION_ERRORThe 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.
429RATE_LIMIT_EXCEEDEDMore than 30 requests were sent within 60 seconds.Wait for the number of seconds specified by the Retry-After header.
500INTERNAL_ERRORRequest infrastructure, authentication, or rate-limit processing is temporarily unavailable.Retry later. Contact support if the error continues.
500STORAGE_ERRORThe validated payload could not be stored.Retry later. Contact support if the error continues.

Example request

Send this JSON array in the POST request body.

[
  {
    "externalId": "OPERATION-001",
    "operation": {
      "code": "RCV-001",
      "type": "supplier_delivery",
      "name": "Receive supplier shipment"
    },
    "operationType": "RECEIVING",
    "dates": {
      "invoice": "2026-11-18"
    },
    "packages": {
      "type": "box",
      "value": 3
    },
    "discount": {
      "type": "percent",
      "value": "5.000"
    },
    "description": "Receiving note",
    "amount": {
      "subtotal": "225.830",
      "total": "214.540",
      "currency": "UAH"
    },
    "weight": {
      "type": "kg",
      "value": "17.493"
    },
    "volume": {
      "type": "m3",
      "value": "0.079"
    },
    "products": [
      {
        "externalId": "PRODUCT-001",
        "position": 1,
        "quantity": {
          "value": "2.000",
          "unit": "pcs"
        },
        "price": "150.000",
        "amount": "300.000",
        "storage": [
          {
            "type": "shelf",
            "value": "A-01-02"
          }
        ]
      }
    ]
  }
]