Merchant API: list of identifiers
About this article
This article provides an overview of identifiers and references used in ChannelEngine's Merchant API.
Introduction
ChannelEngine makes use of several identifiers to facilitate the management and troubleshooting of product selections, stock locations, orders, cancelations, and other parts of the platform.
Therefore, knowing what identifiers refer to and where to find them is crucial to keep your ecommerce operations running smoothly.
For more information on the Merchant API, refer to one of the following links:
Identifiers
| Identifier | Resource | Definition |
merchantProductNumber |
Product | The unique reference assigned to a product by your system (e.g.: ERP, OMS). |
stockLocationId |
Offer |
The unique ID of the stock location. If this is not provided, the default stock location is used. |
merchantOrderNo |
Order | The unique reference assigned to the order by your system (e.g.: ERP, OMS). |
channelOrderNo |
Order | The unique reference assigned to the order by a marketplace. |
orderId |
Order | The unique ID of the order within your tenant on ChannelEngine. |
ChannelOrderLineNo |
Order | The unique reference assigned to the order line by the marketplace. Currently, this reference only applies to METRO Markets. |
OrderLineId |
Order | The unique ID assigned to the order line by the marketplace. Currently, this ID only applies to METRO Markets. |
merchantCancellationNo |
Cancelation | The unique reference assigned to the cancelation by your system (e.g.: ERP, OMS). |
merchantShipmentNo |
Shipment | The unique reference assigned to the shipment by your system (e.g.: ERP, OMS). |
channelShipmentNo |
Shipment | The unique reference assigned to the shipment by a marketplace. |
merchantReturnNo |
Return | The unique reference assigned to the return by your system (e.g.: ERP, OMS). |
channelReturnNo |
Return | The unique reference assigned to the return by a marketplace. In case of a merchant return, it remains empty. |
returnId |
Return | The unique ID of the return within your tenant on ChannelEngine. |
channelId |
Channels | The unique ID of the channel within your tenant on ChannelEngine. E.g.: Zalando's channelId is 1 if it is the first channel added to your tenant. This parameter changes incrementally with every channel you add. |
globalChannelId |
Channels | The unique ID of the channel across ChannelEngine. E.g.: Zalando’s globalChannelId is always 1373. |
ChannelReference |
Channels | The unique reference you can assign to a marketplace on its Setup page. It is also accessible via the /v2/channels endpoint in the Merchant API. |
reportId |
Report | The unique ID of a settlement report generated by ChannelEngine. |
channelSettlementNo |
Report | The unique reference assigned to the settlement by the marketplace. The settlement is a file containing transactions between the marketplace and the merchant. |
SettlementId |
Report | The unique reference assigned to the settlement by ChannelEngine. |
channelSellerNo |
Report | The unique reference assigned to the merchant by the marketplace. |
NB: listed parameters are lower camel case (e.g.:
orderId) if they are part of requests, and upper camel case (e.g.: OrderId) if they are part of responses.
Comments
0 comments
Article is closed for comments.