Newstore sales-orders API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (oauth) using the application flow, exposing 29 scopes.
Paths & Operations 8
Across 7 paths, the API surfaces 8 operations — 3 GET, 1 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.
The contract defines 40 schemas that model the data the API accepts and returns. The most detailed are SalesOrderDetailResponse (27 properties), SalesOrderDetail (15 properties), SalesOrderAddress (15 properties), SalesOrder (10 properties). Each schema is shown below with its type and property counts.
CountryCode
string
Country code for this address. Must be ISO-3166 reference
SalesOrderSerialNumbersRequestItemEpc
object
The epc which should be assigned to the specified order line item.
3 properties3 required
SalesOrderItemPaymentHistory
object
Contains the payments/refunds history for the order. Can also include multiple payments against multiple credit sources (i.e. gift card + credit card)
5 properties4 required
SalesOrderExternalIdentifier
object
External identifier for the order item
2 properties
SalesOrderPricesResponse
object
The response for retrieving price information.
2 properties2 required
SalesOrderFulfillment
object
2 properties1 required
SalesOrderDiscount
object
7 properties4 required
SalesOrderTotals
object
7 properties
SalesOrderTaxLine
object
4 properties2 required
SalesOrderSerialNumbersRequest
object
The response for adding serial number information.
1 property1 required
SalesOrderPrice1
object
The response for retrieving price information.
5 properties5 required
SalesOrderOrigin
string
Describes in which Order Management System the order originated from.
SalesOrderChannelType
string
The channel through which the order was placed.
SalesOrder
object
10 properties9 required
SalesOrderDetail
object
15 properties5 required
Level
string
On which level the discount was applied, either on the entire order or only on this item.
SalesOrderCustomer
object
4 properties
SalesOrderPricesRequest
object
The request for retrieving price information.
1 property1 required
SalesOrderPaymentMethod
string
The method customer paid for the order.
SalesOrderTaxMethod
string
Method of calculation of the taxes, can be vatincluded or vatexcluded.
Type1
string
The type of the discount, either 'fixed' or 'percentage'.
SalesOrderItemStatus
string
Current status of the order item. 'pending' means the item is in the grace period, 'onhold' means the item couldn't be fulfilled and is in a conflict status.
Price1
object
4 properties3 required
SalesOrderCancellationRequest
object
Request schema for order cancellation.
2 properties1 required
SalesOrderListResponse
object
Order history for a customer retrieved from external OMS
1 property1 required
Category
string
Describes if it is a Payment (authorization or capture) or Refund.
SalesOrderGiftWrapping
object
Gift wrapping information. This field is not required and will not be present if gift wrapping is not applicable for the order
3 properties1 required
SalesOrderItemShipment
object
4 properties2 required
SalesOrderFulfillmentType
string
The fulfillment type of the order. In case of mixed cart orders, fulfillment type is always 'multiple'
Problem
object
9 properties
SalesOrderStatus
string
Current status of the sales order
SalesOrderDetailResponse
object
Schema for fetching sales order using external ID
27 properties10 required
SalesOrderProductAttributes
object
Additional product-related information.
6 properties1 required
SalesOrderAddress
object
Address
15 properties
SalesOrderSerialNumbersRequestItem
object
3 properties2 required
Origin
object
The ship-from origin for this fulfillment group. Omitted when neither zip code nor country code is known.
2 properties
Fulfillment
string
Fulfillment type
SalesOrderItem
object
6 properties6 required
SalesOrderExtendedAttribute
object
2 properties2 required
SalesOrderCancellationResponse
object
Request schema for order cancellation status.
3 properties3 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
