🟢Orders

Creating a new order

post

Authorizations

basic

AuthorizationstringRequired

Basic Authorization header using the Bearer scheme.

Body

application/jsontext/jsonapplication/*+json

Responses

200

Success.

text/plainapplication/jsontext/json

400

The request cannot be fulfilled due to bad syntax or an invalid parameter.

401

Invalid authentication/authorization credentials. A request to the Retain me Order API with invalid/expired API Key(s).

403

HTTPS Required or Typically could not grant access to the system

404

Request for a resource that was not found.

429

Request limit exceeded, only 50 order permitted per request.

500

Internal systems error.

post

/client/api/Orders

HTTPcURLJavaScriptPython

POST /client/api/Orders HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 592

{
  "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

{
  "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

Authorizations

basic

AuthorizationstringRequired

Basic Authorization header using the Bearer scheme.

Body

application/jsontext/jsonapplication/*+json

Responses

200

Success.

text/plainapplication/jsontext/json

400

The request cannot be fulfilled due to bad syntax or an invalid parameter.

401

Invalid authentication/authorization credentials. A request to the Retain me Order API with invalid/expired API Key(s).

403

HTTPS Required or Typically could not grant access to the system

404

Request for a resource that was not found.

429

Request limit exceeded, only 50 order permitted per request.

500

Internal systems error.

put

/client/api/Orders

HTTPcURLJavaScriptPython

PUT /client/api/Orders HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 592

{
  "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

{
  "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.