Skip to main content
API docs by Redocly

Sales Order Support API (1.0.0)

Download OpenAPI specification:Download

team-headquarters: team-headquarters@newstore.com URL: https://newstoreinc.slack.com/archives/C07ECPJ7601

Sales Order Support HTTP API

updateOrder

Update order

Update order information

Updates specific fields of an order.

Supported updates:

  • Order Status
Authorizations:
oauth
path Parameters
id
required
string

ID of the order.

header Parameters
Request-Id
required
string
Tenant
required
string
X-Newstore-Tenant
required
string
Request Body schema: application/json
status
string

The new status of the order. Only on_hold is currently supported.

Responses

Request samples

Content type
application/json
{
  • "status": "string"
}

Response samples

Content type
application/problem+json
{
  • "error_code": "string",
  • "message": "string",
  • "request_id": "string"
}

Manage orders

Cancel multiple orders in bulk

Use this resource to cancel multiple orders in bulk. This endpoint is designed for internal use by NewStore support team / agents.

Important Notes:

  • This endpoint temporarily enables DC (Distribution Center) cancellations if not already enabled
  • The original cancellation configuration is automatically restored after processing
  • Orders are assumed to be with ID type 'internal'
  • The response includes both succeeded and failed cancellations with detailed error information
  • Order can only be cancelled if it is in a state that allows cancellation (e.g. not closed, not in fulfillment)

Use Cases:

  • Bulk cancellation of orders for customer service scenarios in response to an incident that caused multiple orders to be created with wrong information
Request Body schema: application/json
order_ids
required
Array of strings non-empty [ items non-empty ]

List of order IDs to cancel

reason
required
string non-empty

Reason for cancellation

note
string

Optional note for cancellation

Responses

Request samples

Content type
application/json
{
  • "order_ids": [
    ],
  • "reason": "Techincal issue",
  • "note": "Orders canceled in bulk due to technical issue causing multiple orders to be created with wrong information"
}

Response samples

Content type
application/json
{
  • "succeeded": [
    ],
  • "failed": [
    ]
}