Skip to main content
GET
/
commerce
/
returns
/
{returnId}
/
shipping
/
label
Error
A valid request URL is required to generate request examples
{
  "shippingTotal": {
    "currencyCode": "<string>",
    "value": 123
  },
  "trackingNumber": "<string>",
  "packageResponses": [
    {
      "id": "<string>",
      "trackingNumber": "<string>",
      "label": {
        "imageFormat": "<string>",
        "imageData": "aSDinaTvuI8gbWludGxpZnk=",
        "labelUrl": "<string>"
      },
      "customAttributes": [
        {
          "childAttributes": "<array>",
          "key": "<string>",
          "value": "<string>"
        }
      ],
      "integratorId": "<string>"
    }
  ],
  "customAttributes": [
    {
      "childAttributes": "<array>",
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "messages": [
    {
      "source": "<string>",
      "message": "<string>",
      "code": "<string>"
    }
  ],
  "isSuccessful": true
}

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

returnId
string
required

Query Parameters

responseFields
string

limits which fields are returned in the response body

Response

Success

shippingTotal
object
trackingNumber
string | null
packageResponses
object[] | null
customAttributes
object[] | null
messages
object[] | null
isSuccessful
boolean