🟢Orders

Creating a new order

post

Authorizations

Body

application/jsontext/jsonapplication/*+json

all ofoptional

Responses

text/plainapplication/jsontext/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/client/api/Orders' \
  --header 'Authorization: Basic username:password' \
  --header 'Content-Type: application/json' \
  --data '{
    "orderNumber": "text",
    "orderDate": "text",
    "price": 1,
    "currency": "text",
    "customer": {
      "clientCustomerId": "text",
      "title": "text",
      "forename": "text",
      "surname": "text",
      "phone": "text",
      "email": "text",
      "isNew": true
    },
    "address": {
      "addressLine1": "text",
      "addressLine2": "text",
      "addressLine3": "text",
      "addressLine4": "text",
      "city": "text",
      "country": "text",
      "postCode": "text"
    },
    "lines": [
      {
        "sku": "text",
        "name": "text",
        "description": "text",
        "imageURL": "text",
        "price": 1,
        "category": "text",
        "returnDays": 1,
        "height": 1,
        "width": 1,
        "depth": 1,
        "quantity": 1,
        "variants": "text",
        "tags": "text",
        "size": "text",
        "colour": "text",
        "brand": "text"
      }
    ]
  }'

application/jsontext/jsonapplication/*+json

200

400

401

403

404

429

500

200

text/plain

application/json

text/json

text/plain

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

Success.

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

Authorizations

Body

application/jsontext/jsonapplication/*+json

all ofoptional

Responses

text/plainapplication/jsontext/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/client/api/Orders' \
  --header 'Authorization: Basic username:password' \
  --header 'Content-Type: application/json' \
  --data '{
    "orderNumber": "text",
    "orderDate": "text",
    "price": 1,
    "currency": "text",
    "customer": {
      "clientCustomerId": "text",
      "title": "text",
      "forename": "text",
      "surname": "text",
      "phone": "text",
      "email": "text",
      "isNew": true
    },
    "address": {
      "addressLine1": "text",
      "addressLine2": "text",
      "addressLine3": "text",
      "addressLine4": "text",
      "city": "text",
      "country": "text",
      "postCode": "text"
    },
    "lines": [
      {
        "sku": "text",
        "name": "text",
        "description": "text",
        "imageURL": "text",
        "price": 1,
        "category": "text",
        "returnDays": 1,
        "height": 1,
        "width": 1,
        "depth": 1,
        "quantity": 1,
        "variants": "text",
        "tags": "text",
        "size": "text",
        "colour": "text",
        "brand": "text"
      }
    ]
  }'

application/jsontext/jsonapplication/*+json

200

400

401

403

404

429

500

200

text/plain

application/json

text/json

text/plain

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

Success.

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