Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13125317428.7 KB
pos

Submit a sale event for the given merchant.

post/{merchantId}/pos/{targetMerchantId}/sale

Path parameters

merchantIdstring required

The ID of the POS or inventory data provider.

targetMerchantIdstring required

The ID of the target merchant.

Request body

contentLanguagestring

Required. The two-letter ISO 639-1 language code for the item.

quantitystring int64

Required. The relative change of the available quantity. Negative for items returned.

targetCountrystring

Required. The CLDR territory code for the item.

timestampstring

Required. The inventory timestamp, in ISO 8601 format.

gtinstring

Global Trade Item Number.

saleIdstring

A unique ID to group items from the same sale event.

storeCodestring

Required. The identifier of the merchant's store. Either a storeCode inserted through the API or the code of the store in a Business Profile.

itemIdstring

Required. A unique identifier for the item.

Response

Successful response