Skip to main content

Glossary

Use this glossary when the same identifier appears across multiple APIs. Most integrations depend on consistent syncId usage.

Identity Fields

TermMeaning
syncIdStable external identifier used to match a record between Mulltiply and another system.
retailerSyncIdRetailer/customer identifier. Often maps to the retailer syncId.
shopSyncIdShop/outlet identifier. Can be null in outstanding shipment sync.
offerSyncIdOffer or product variant identifier used for order and shipment matching.
itemSyncIdParent item/product identifier.
customerSyncIdCustomer identifier stored on a shop object to link shop back to retailer.

Payload Terms

TermMeaning
lineItemsProducts included in an order or shipment.
sellingUnitsUnits in which a SKU is sold, such as PAIR or CTN.
shopTagsTags used to match employees to shops.
documentBufferBase64 PDF document bytes for WhatsApp send JSON mode.
recievingPhoneNumberImplemented WhatsApp recipient phone field. Keep this exact spelling.

Error Terms

TermMeaning
nonProcessableRowsRows rejected during validation.
nonProcessableOrdersOrders rejected during order sync validation.
nonProcessablesStocksStock rows rejected during inventory sync validation.
processableRows that passed validation and were queued for processing.
validRowsCountNumber of rows accepted as valid.

Auth Terms

TermMeaning
x-api-keyAPI key header used by most sync endpoints.
Authorization: BearerBearer token auth used by GraphQL, Tally order status, and WhatsApp APIs.