Update Product Inventory

curl --request PATCH \
  --url https://omnicommerce.sg/api/v1/products/{productId}/inventory \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "quantity": 125
}
'

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({quantity: 125})
};

fetch('https://omnicommerce.sg/api/v1/products/{productId}/inventory', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://omnicommerce.sg/api/v1/products/{productId}/inventory"

payload = { "quantity": 125 }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "apiVersion": "developer_v1",
  "ok": true,
  "operationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "completed",
  "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "warnings": [
    "<string>"
  ],
  "recommendations": [
    "<string>"
  ],
  "links": {},
  "data": {
    "changed": true,
    "quantity": 1,
    "inventoryVersion": 1,
    "syncToMarketplaces": true,
    "jobIds": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "targets": [
      {
        "platform": "shopee",
        "accountId": "<string>",
        "status": "queued",
        "jobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "targetId": "<string>"
      }
    ],
    "emittedEvents": [
      "product.inventory.changed"
    ]
  },
  "jobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "apiVersion": "developer_v1",
  "ok": true,
  "operationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "completed",
  "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "warnings": [
    "<string>"
  ],
  "recommendations": [
    "<string>"
  ],
  "links": {},
  "data": {
    "changed": true,
    "quantity": 1,
    "inventoryVersion": 1,
    "syncToMarketplaces": true,
    "jobIds": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "targets": [
      {
        "platform": "shopee",
        "accountId": "<string>",
        "status": "queued",
        "jobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "targetId": "<string>"
      }
    ],
    "emittedEvents": [
      "product.inventory.changed"
    ]
  },
  "jobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Products

Update Product Inventory

Update canonical on-hand inventory for a simple product or variant UUID. Multi-variant parent products must be updated through their variant IDs. A successful quantity change emits product.inventory.changed to matching developer webhook subscriptions.

Authorization

Requires an API credential with catalog:write. OmniCommerce derives organizationId from that credential; the request body cannot select or override an organization. ERP-managed and multi-source inventory keeps its existing ownership protections.

Marketplace sync

The update is Omni-only by default. Set syncToMarketplaces to true to create one durable inventory outbox job per marketplace account. Omit targets to sync every enabled, published account for the product, or provide exact { platform, accountId } targets. Every explicit target is validated before inventory changes. The response contains each job ID and immediate target status; use GET /api/v1/jobs/{jobId} for progress.

PATCH

api

products

{productId}

inventory

Update Product Inventory

curl --request PATCH \
  --url https://omnicommerce.sg/api/v1/products/{productId}/inventory \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "quantity": 125
}
'

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({quantity: 125})
};

fetch('https://omnicommerce.sg/api/v1/products/{productId}/inventory', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://omnicommerce.sg/api/v1/products/{productId}/inventory"

payload = { "quantity": 125 }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "apiVersion": "developer_v1",
  "ok": true,
  "operationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "completed",
  "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "warnings": [
    "<string>"
  ],
  "recommendations": [
    "<string>"
  ],
  "links": {},
  "data": {
    "changed": true,
    "quantity": 1,
    "inventoryVersion": 1,
    "syncToMarketplaces": true,
    "jobIds": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "targets": [
      {
        "platform": "shopee",
        "accountId": "<string>",
        "status": "queued",
        "jobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "targetId": "<string>"
      }
    ],
    "emittedEvents": [
      "product.inventory.changed"
    ]
  },
  "jobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "apiVersion": "developer_v1",
  "ok": true,
  "operationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "completed",
  "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "warnings": [
    "<string>"
  ],
  "recommendations": [
    "<string>"
  ],
  "links": {},
  "data": {
    "changed": true,
    "quantity": 1,
    "inventoryVersion": 1,
    "syncToMarketplaces": true,
    "jobIds": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "targets": [
      {
        "platform": "shopee",
        "accountId": "<string>",
        "status": "queued",
        "jobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "targetId": "<string>"
      }
    ],
    "emittedEvents": [
      "product.inventory.changed"
    ]
  },
  "jobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

Authorization

string

header

required

Bearer API key for server-to-server access. Session auth is also supported in first-party UI flows.

Path Parameters

productId

string<uuid>

required

OmniCommerce simple-product or variant UUID.

Body

application/json

quantity

integer

required

New canonical on-hand quantity.

Required range: x >= 0

syncToMarketplaces

boolean

default:false

Queue durable sync jobs after the Omni inventory update.

targets

object[]

Exact enabled and published marketplace accounts. Requires syncToMarketplaces=true.

Required array length: 1 - 25 elements

Show child attributes

Response

Inventory updated; no marketplace job was queued.

apiVersion

enum<string>

required

Available options:

developer_v1

enum<boolean>

required

Available options:

true

operationId

string<uuid>

required

status

enum<string>

required

Available options:

completed,

accepted

productId

string<uuid>

required

warnings

string[]

required

recommendations

string[]

required

links

object

required

Show child attributes

data

object

required

Show child attributes

jobId

string<uuid>

Overview

Endpoints

Webhooks

Update Product Inventory

Authorization

Marketplace sync

Authorizations

Path Parameters

Body

Response