🟢Orders

Creating a new order

POST/client/api/Orders

Body

application/jsontext/jsonapplication/*+json

orderNumber*string

orderDate*string

price*number (double)

currency*string

customernullable all of

addressnullable all of

linesnullable array of OrderLineCreationRequest (object)

Response

200400401403404429500

Success.

Body

text/plainapplication/jsontext/json

orderIdstring (uuid)

returnUrlnullable string

Request

JavaScriptCurlPython

const response = await fetch('/client/api/Orders', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "currency": "text",
      "orderDate": "text",
      "orderNumber": "text",
      "price": 0
    }),
});
const data = await response.json();

Response

200

{
  "orderId": "123e4567-e89b-12d3-a456-426614174000",
  "returnUrl": "text"
}

SMARTReturns URL: Upon successful submission, the API will return your SMARTReturns Short URL which can be used to provide access to your customers should you wish to email them a link directly.

Updating an order

PUT/client/api/Orders

Body

application/jsontext/jsonapplication/*+json

orderNumber*string

orderDate*string

price*number (double)

currency*string

customernullable all of

addressnullable all of

linesnullable array of OrderLineCreationRequest (object)

Response

200400401403404429500

Success.

Body

text/plainapplication/jsontext/json

orderIdstring (uuid)

returnUrlnullable string

Request

JavaScriptCurlPython

const response = await fetch('/client/api/Orders', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "currency": "text",
      "orderDate": "text",
      "orderNumber": "text",
      "price": 0
    }),
});
const data = await response.json();

Response

200

{
  "orderId": "123e4567-e89b-12d3-a456-426614174000",
  "returnUrl": "text"
}

No duplicates: If a return has already been created against an order it will no longer be editable.