Support API (v0)

Download OpenAPI specification:Download

This is an internal API for our customer support.

Changes:

01/2019 - Initial release
02/2019 - Add /orders/{order-id}/_force_cancel endpoint

Retry delivery booking

Tries to book deliveries for the given sales order. Use this method when booking operation failed for the given order and cannot be retried from NOM or the Fulfillment App. You can use the Get booking status method to check the status of a booking.

Authorizations:

newStoreAccessToken

path Parameters

order_id

required

string

Unique ID of the sales order.

Responses

Get booking status

Retrieves the shipment booking status.

Authorizations:

newStoreAccessToken

path Parameters

order_id

required

string

Unique ID of the sales order.

Responses

Response samples

200

Content type

application/json

{"booking_status": [{"fulfillment_request_id": "76ba2c90-c413-438e-8040-a3585a2db770",
"status": "pending"
},
{"fulfillment_request_id": "7c9f2605-9fb3-5444-8fee-47fe51608efe",
"status": "booked"
},
{"fulfillment_request_id": "27a39710-4b2d-43fd-b636-5f7aed3073a2",
"status": "failed",
"error_type": "validation_error",
"error_description": "The provided zip code is invalid."
}
]
}

Update order details

Updates the details of an order. Use this method to update order details, such as the store location (store_id) where an order was originally placed, to a different location.

The details of the order are also updated in NewStore Omnichannel Manager.

Authorizations:

newStoreAccessToken

path Parameters

order_id

required

string

Unique ID of the sales order.

Request Body schema: application/json

object

The store where the order was placed.

id

required

string

The ID of the store in the NewStore platform.

Responses

Request samples

Payload

Content type

application/json

{"placement_location": {"id": "0004"
}
}