Outstanding Shipment Sync

Use this API to sync outstanding shipment quantities in bulk. Each row updates one retailer, optional shop, and offer combination.

At A Glance

PUT/v2/shipments/outstanding/sync-data

Area	Detail
Base URL	https://api.mulltiply.org
Content type	application/json
Authentication	x-api-key request header
Request body	Array of outstanding shipment records
Object shape	Flat object, no nested fields

Headers

Content-Type: application/json
x-api-key: YOUR_API_KEY

Request Body

JSON Body

Request body

[
  {
    "retailerSyncId": "RET-2001",
    "shopSyncId": "00003",
    "outstandingQuantity": 3,
    "offerSyncId": "OFFER-1001"
  }
]

cURL

Outstanding shipment sync request

curl --request PUT \
  --url 'https://api.mulltiply.org/v2/shipments/outstanding/sync-data' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: YOUR_API_KEY' \
  --data '[{"retailerSyncId":"RET-2001","shopSyncId":"00003","outstandingQuantity":3,"offerSyncId":"OFFER-1001"}]'

Field Mapping

API field	Source field	Required	Description
retailerSyncId	retailerSyncId	Yes	Retailer identifier.
shopSyncId	shopSyncId	No	Shop identifier. Can be null.
outstandingQuantity	outstandingQuantity	Yes	Outstanding shipment quantity.
offerSyncId	offerSyncId	Yes	Offer identifier.

Processing Rules

1. Send one object per outstanding shipment record.
2. Pass retailerSyncId directly from the source.
3. Pass shopSyncId directly when available, or null when not available.
4. Pass outstandingQuantity directly from the source.
5. Pass offerSyncId directly from the source.
6. Treat each object independently during processing.

Final Payload Example

Final payload

[
  {
    "retailerSyncId": "RET-2001",
    "shopSyncId": "SHOP-2001",
    "outstandingQuantity": 3,
    "offerSyncId": "OFFER-1001"
  },
  {
    "retailerSyncId": "RET-2002",
    "shopSyncId": null,
    "outstandingQuantity": 5,
    "offerSyncId": "OFFER-1002"
  }
]

Source Data Checklist

Source column	Source	Used for
retailerSyncId	Source API	Retailer identification
shopSyncId	Source API	Shop identification
outstandingQuantity	Source API	Outstanding quantity
offerSyncId	Source API	Offer identification

Implementation Checklist

• Confirm every row has retailerSyncId.
• Confirm every row has offerSyncId.
• Confirm outstandingQuantity is numeric.
• Send shopSyncId as null when no shop is available.
• Send a JSON array for both single and bulk updates.