YOM Docs

Bulk stock upload

PUT {{URL_BASE_V3}}/admin/catalog/stock/bulk

Creates or updates stock records. The update key is the combination of product and distribution center: if a record already exists for that pair, it is updated; if not, it is created.

What to send

Field Type Requirement Description Examples
data 🔡 List of Objects → Stock 🟢 Required Between 1 and 500 stock records. See details below.
syncId 📝 Text ⚪ Optional Upload identifier. It is stored on every record. "20260810-carga-manana"

No other fields are allowed at the top level of the request body.

Stock

Each data record.

Field Type Requirement Description Examples
sku 📝 Text 🟢 Required Product code in the customer's system. "ABC-1"
quantity 🔢 Number 🟢 Required Stock quantity. 120
distributionCenterExternalId 📝 Text 🟡 Conditional Distribution center code in the customer's system.
*\*Required in the absence of *distributionCenterId. "CD-SANTIAGO"
distributionCenterId 🆔 ObjectId 🟡 Conditional Distribution center identifier in YOM.
*\*Required in the absence of *distributionCenterExternalId. "650a1b2c3d4e5f6a7b8c9d99"
productId 🆔 ObjectId ⚪ Optional Product identifier in YOM.
*\*If omitted, YOM resolves it from the *sku. "650a1b2c3d4e5f6a7b8c9d01"
formatKey 📝 Text ⚪ Optional Product format. "caja"

Example

PUT {{URL_BASE_V3}}/admin/catalog/stock/bulk

{
  "syncId": "20260810-carga-manana",
  "data": [
    {
      "sku": "ABC-1",
      "distributionCenterExternalId": "CD-SANTIAGO",
      "quantity": 120
    },
    {
      "sku": "ABC-2",
      "distributionCenterExternalId": "CD-SANTIAGO",
      "quantity": 0
    },
    {
      "sku": "ABC-3",
      "distributionCenterId": "650a1b2c3d4e5f6a7b8c9d99",
      "quantity": 45,
      "formatKey": "caja"
    }
  ]
}

What it returns

207 — an array with one result per record sent, in the same order.

[
  { "status": 201, "recordId": "650a1b2c3d4e5f6a7b8c9d11", "result": "created" },
  { "status": 204, "recordId": null, "result": "updated" },
  { "status": 422, "recordId": null, "result": "invalid", "error": "ValidationError" }
]
Field Type Requirement Description Examples
result 📝 Text 🟢 Required Record result.
"created" → a new record was created
"updated" → an existing one was updated
"invalid" → could not be processed "created"
status 🔢 Number 🟢 Required Code associated with the result.
201 created · 204 updated · 422 invalid 201
recordId 🆔 ObjectId ⚪ Optional Identifier of the created record. Only present with "created"; null otherwise. "650a1b2c3d4e5f6a7b8c9d11"
error 📝 Text ⚪ Optional Reason for rejection. Only present with "invalid". "ValidationError"

Errors for the whole call:

| --- | --- |