🟢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/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

JavaScriptCurl

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

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