How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Newstore sales-orders API

Operations related to sales order management.

Newstore sales-orders API is one of 41 APIs that Newstore publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Sales Orders. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and API documentation.

This API exposes 8 operations across 7 paths, and defines 40 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://dodici-demo.p.newstore.net/.

8 operations 7 paths 40 schemas 3 GET1 PATCH4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://dodici-demo.p.newstore.net
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Newstore sales-orders API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth) using the clientCredentials 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.

sales-orders 8

Operations related to sales order management.

GET
/v0/orders
showOrderHistoryForCustomer
showOrderHistoryForCustomer 3 params → default200400404409412429500
GET
/v0/orders/{id}
showSalesOrderByIdAndIdType
showSalesOrderByIdAndIdType 3 params → default200400404409412429500
POST
/v0/orders/{id}/_extend_grace_period
createGracePeriod
createGracePeriod 2 params → default200404409412429500502
GET
/v0/orders/{id}/cancel
showCancellationStatus
showCancellationStatus 2 params → default200400404429500502503
POST
/v0/orders/{id}/cancel
createCancellation
createCancellation 3 params body → default200400404429500502503
POST
/v0/orders/{id}/items/{item_uuid}/cancel
createLineItemCancellation
createLineItemCancellation 3 params → default200400404429500502503
POST
/v0/orders/{id}/prices
createPriceInformationForItems
createPriceInformationForItems 2 params body → default200400404429500502503
PATCH
/v0/orders/{id}/serial_numbers
updateSalesOrderSerialNumbers
updateSalesOrderSerialNumbers 2 params body → default204400404429500502503

Schemas 40

The contract defines 40 schemas that model the data the API accepts and returns. The most detailed are SalesOrderDetailResponse (27 properties), SalesOrderAddress (15 properties), SalesOrderDetail (15 properties), SalesOrder (10 properties). Each schema is shown below with its type and property counts.

SalesOrderAddress
object
Address
15 properties
SalesOrderDetail
object
15 properties 5 required
SalesOrderCustomer
object
4 properties
SalesOrderSerialNumbersRequestItemEpc
object
The epc which should be assigned to the specified order line item.
3 properties 3 required
SalesOrderDetailResponse
object
Schema for fetching sales order using external ID
27 properties 10 required
SalesOrderItemShipment
object
4 properties 2 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 properties 4 required
Type1
string
The type of the discount, either 'fixed' or 'percentage'.
SalesOrderExternalIdentifier
object
External identifier for the order item
2 properties
SalesOrderFulfillmentType
string
The fulfillment type of the order. In case of mixed cart orders, fulfillment type is always 'multiple'
Category
string
Describes if it is a Payment (authorization or capture) or Refund.
Fulfillment
string
Fulfillment type
SalesOrder
object
10 properties 9 required
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 properties 1 required
SalesOrderTaxLine
object
4 properties 2 required
Origin
object
The ship-from origin for this fulfillment group. Omitted when neither zip code nor country code is known.
2 properties
SalesOrderPricesResponse
object
The response for retrieving price information.
2 properties 2 required
Level
string
On which level the discount was applied, either on the entire order or only on this item.
SalesOrderSerialNumbersRequest
object
The response for adding serial number information.
1 property 1 required
Price1
object
4 properties 3 required
SalesOrderChannelType
string
The channel through which the order was placed.
Problem
object
9 properties
SalesOrderTotals
object
7 properties
SalesOrderDiscount
object
7 properties 4 required
SalesOrderTaxMethod
string
Method of calculation of the taxes, can be vatincluded or vatexcluded.
SalesOrderCancellationRequest
object
Request schema for order cancellation.
2 properties 1 required
SalesOrderSerialNumbersRequestItem
object
3 properties 2 required
SalesOrderPricesRequest
object
The request for retrieving price information.
1 property 1 required
SalesOrderItem
object
6 properties 6 required
SalesOrderOrigin
string
Describes in which Order Management System the order originated from.
SalesOrderListResponse
object
Order history for a customer retrieved from external OMS
1 property 1 required
SalesOrderProductAttributes
object
Additional product-related information.
6 properties 1 required
CountryCode
string
Country code for this address. Must be ISO-3166 reference
SalesOrderExtendedAttribute
object
2 properties 2 required
SalesOrderFulfillment
object
2 properties 1 required
SalesOrderPrice1
object
The response for retrieving price information.
5 properties 5 required
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.
SalesOrderPaymentMethod
string
The method customer paid for the order.
SalesOrderCancellationResponse
object
Request schema for order cancellation status.
3 properties 3 required
SalesOrderStatus
string
Current status of the sales order

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

newstore-sales-orders-api-openapi.yml Raw ↑

Other APIs Newstore publishes across the network.

Newstore address API
Newstore audit-events API
Newstore cart API
Newstore cashboxes API
Newstore customer-configuration API
Newstore customer-profile API
Newstore customerProfile API
Newstore data API
Newstore EasypostAdapterConfig API
Newstore fulfillment-requests API
Newstore identity-providers API
Newstore Import Schemas API
Where this information came from

This is an independent, third-party profile of Newstore sales-orders API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.