Sales & Returns
Any Partner application responsible for accessing sales & returns data and status must be authorized to interact with the Sales & Returns endpoint, which requires a valid bearer token in the request headers. This token is obtained by authenticating through the Authentication service.
Scope
Exposes a streamlined alternative to the Orders API focused exclusively on sales and return transactions. It enables Partners to retrieve store-level stock (or increment it in the case of returns) and to correctly account for sales and refunds. Unlike the Orders API, the service logic is driven by the analysis of payment entities (captures and refunds), allowing Partners to operate on meaningful states based on payment transactions rather than order lifecycle events.
customerPreferenceStandard, customerPreferenceMarketing and customerPreferenceProfiling report the customer's privacy consents as they are at the time of the call, not as they were when the order was created.
Rate limiting
| Environment | Requests / min | Entities / min |
|---|---|---|
| Dev/Quality | ∞ | ∞ |