🟢Quick Start

Get your API keys

Your API requests are authenticated using API keys.

Any request that doesn't include an API key will return an error.

You can access your API key from the SMARTReturns Dashboard at any time.

Make your first request

To make your first request, send an authenticated request to the orders endpoint. This will create an order, which is the first step to allowing your customers to create their returns.

post

Authorizations

basic

AuthorizationstringRequired

Basic Authorization header using the Bearer scheme.

Body

application/jsontext/jsonapplication/*+json

Responses

200

Success.

text/plainapplication/jsontext/json

orderIdstring · uuidOptional

returnUrlstring · nullableOptional

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