Create a return order

Testing Env

POST

https://statimlogistics-test.dsapp.io/integration/api/v1/orders/return

Create a return order in the system. Even though an order is created successfully, the response can return an array
named "validationErrors" containing errors that will need to be addressed. Note that Basic Authentication is required for all requests
as such, make sure to provide the Authorization header with a valid value.

Request

Authorization

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Query Params

sourceOrderId

string

required

Example:

Header Params

Content-Type

string

required

Example:

application/json

string

required

Example:

text/plain

Body Params application/json

serviceLevelId

string

required

ignoreItems

string

required

itemsToAdd

array [object {8}]

required

barcodeTemplate

string

required

parcelTypeId

string

required

description

string

required

weight

string

required

height

string

required

length

string

required

width

string

required

userFields

array [object {2}]

required

Example

{
  "serviceLevelId": "<string>",
  "ignoreItems": "<boolean>",
  "itemsToAdd": [
    {
      "barcodeTemplate": "<string>",
      "parcelTypeId": "<string>",
      "description": "<string>",
      "weight": "<double>",
      "height": "<double>",
      "length": "<double>",
      "width": "<double>",
      "userFields": [
        {
          "userFieldId": "<string>",
          "value": "<string>"
        },
        {
          "userFieldId": "<string>",
          "value": "<string>"
        }
      ]
    },
    {
      "barcodeTemplate": "<string>",
      "parcelTypeId": "<string>",
      "description": "<string>",
      "weight": "<double>",
      "height": "<double>",
      "length": "<double>",
      "width": "<double>",
      "userFields": [
        {
          "userFieldId": "<string>",
          "value": "<string>"
        },
        {
          "userFieldId": "<string>",
          "value": "<string>"
        }
      ]
    }
  ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://statimlogistics-test.dsapp.io/integration/api/v1/orders/return?sourceOrderId=<string>' \
--header 'Accept: text/plain' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
  "serviceLevelId": "<string>",
  "ignoreItems": "<boolean>",
  "itemsToAdd": [
    {
      "barcodeTemplate": "<string>",
      "parcelTypeId": "<string>",
      "description": "<string>",
      "weight": "<double>",
      "height": "<double>",
      "length": "<double>",
      "width": "<double>",
      "userFields": [
        {
          "userFieldId": "<string>",
          "value": "<string>"
        },
        {
          "userFieldId": "<string>",
          "value": "<string>"
        }
      ]
    },
    {
      "barcodeTemplate": "<string>",
      "parcelTypeId": "<string>",
      "description": "<string>",
      "weight": "<double>",
      "height": "<double>",
      "length": "<double>",
      "width": "<double>",
      "userFields": [
        {
          "userFieldId": "<string>",
          "value": "<string>"
        },
        {
          "userFieldId": "<string>",
          "value": "<string>"
        }
      ]
    }
  ]
}'

Responses

🟢200Return order was successfully returned

text/plain

Body

object {0}

Example

{
  "orderId": "string"
}

🟠400Request has missing/invalid values

🔴500An error occurred when trying to create the return order

🟠401Unauthorized

Modified at 2025-02-27 04:57:40

orders

Create a new order from a template