Get Order by ID
GET
v1/managers/store/orders/{order-id}/viewGet a specific order by its ID.
:::info[]
Currency Handling for Orders
When the store currency, order currency, and the currency of the shipping address (for cash on delivery) are different, partners must convert the order total to the appropriate currency. The order details already provide both the currency type and the conversion rate, making it easy to apply the conversion when necessary. This ensures that the correct amount is processed smoothly, even when multiple currencies are involved.
:::
:::note[]
Data Masking for Marketplace Orders
When is_marketplace_order
is true, the order is from an external provider, and certain customer information, such as customer.name
, customer.email
, and customer.phone
, will be masked for privacy. For example, names like "John Doe" become "J*** D***", emails are masked as "t***@.", and phone numbers as "***00". Masked data may not follow proper syntax. Additionally, for marketplace orders, customer.phone
may be null
if not provided.
:::
Request
The Authorization token is a unique key given to the third-party application (Partner) by Zid. It is used to authenticate the API requests made by the Partner application. The token verifies the partner's identity and ensures they have permission to access Zid's API but does not provide any specific user or store information. It should be included in the header of API requests when the partner application needs to access Zid's API.
This token is used to authenticate and access information related to the store. It is obtained through an OAuth mechanism and is required to perform operations on the store's data. The X-Manager-Token
should be included in the header of API requests that require store-related information.
Preferred language for the response. Defaults to en
if not specified.
Request samples
Responses
The status of the response.