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.

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

Body Params

internalId

string

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

referenceId

string

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

status

string

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.

subStatus

string

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.

Headers

Authorization

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

Language


xxxxxxxxxx
1
curl --request PATCH \
2
     --url https://api.nuport.io/integration/orders \
3
     --header 'Authorization: API_KEY' \
4
     --header 'accept: application/json' \
5
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400