API Reference
  1. Orders

Update Order

patch
https://api.nuport.io/integration/orders

Updates the state of an order and its various fields within the Nuport system. You should be able to map your own flow to Nuport's order flow.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
1280

The state diagram of an order. An order has a status and several sub-statuses related to a status (if any).

Body Params
string

The internal ID used to identify the order. Will be used to reference the order if the reference ID is not provided.

string

The reference ID used to identify the order. Will be used to reference the order if the internal ID is not provided.

string
enum

The status of an order. Follow the diagram to change the status of an order in a sequence that makes logical sense within your own system.

Allowed:
string
enum

The sub-status of an order. This sub-status will only change if the "status" field of the payload is set to PROCESSING, otherwise this field will be discarded.

Allowed:
Headers
string
required
Defaults to API_KEY

The API key retrieved from your company settings on the Nuport platform. This should be in every header in order to facilitate proper integration.

Responses

Updated almost 3 years ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated almost 3 years ago