CustomerReturns

Returns all open customer returns

get

Authorizations

ApiKey

ApiKeystringRequired

Api key taken from 'Gateway API key' setting.

Query parameters

ClientIdstring · uuidOptional

Pageinteger · int32Optional

PageSizeinteger · int32Optional

Responses

200

OK

text/plainapplication/jsontext/json

trackingNumberstring · nullableOptional

commentsstring · nullableOptional

carrierstring · nullableOptional

referenceNumberstring · nullableOptional

reference1string · nullableOptional

reference2string · nullableOptional

reference3string · nullableOptional

idstring · uuidOptional

customerReturnNumberstring · nullableOptional

get

/customer-returns

HTTPcURLJavaScriptPython

GET /customer-returns HTTP/1.1
ApiKey: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "trackingNumber": "text",
    "comments": "text",
    "carrier": "text",
    "referenceNumber": "text",
    "reference1": "text",
    "reference2": "text",
    "reference3": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "customerReturnNumber": "text",
    "customer": {
      "companyName": "text",
      "description": "text",
      "phone": "text",
      "email": "text",
      "contactPerson": "text",
      "taxId": "text",
      "addresses": [
        {
          "id": "text",
          "name": "text",
          "attnTo": "text",
          "address1": "text",
          "address2": "text",
          "routeNumber": "text",
          "city": "text",
          "stateProvince": "text",
          "zipPostalCode": "text",
          "country": "text",
          "phone": "text",
          "email": "text",
          "isDefault": true
        }
      ],
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "client": {
        "description": "text",
        "ssccCompanyId": "text",
        "companyName": "text",
        "email": "text",
        "phone": "text",
        "contactPerson": "text",
        "taxId": "text",
        "address1": "text",
        "address2": "text",
        "city": "text",
        "stateProvince": "text",
        "zipPostalCode": "text",
        "country": "text",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text"
      },
      "customerCode": "text"
    },
    "warehouse": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "warehouseCode": "text",
      "name": "text",
      "description": "text",
      "phone": "text",
      "email": "text",
      "referenceNumber": "text",
      "address1": "text",
      "address2": "text",
      "city": "text",
      "stateProvince": "text",
      "zipPostalCode": "text",
      "country": "text"
    }
  }
]

Create new customer return

post

Authorizations

ApiKey

ApiKeystringRequired

Api key taken from 'Gateway API key' setting.

Body

application/jsontext/jsonapplication/*+json

trackingNumberstring · nullableOptional

commentsstring · nullableOptional

carrierstring · nullableOptional

referenceNumberstring · nullableOptional

reference1string · nullableOptional

reference2string · nullableOptional

reference3string · nullableOptional

customerIdstring · uuidOptional

warehouseIdstring · uuidOptional

customerReturnNumberstring · nullableOptional

Responses

200

OK

text/plainapplication/jsontext/json

idstring · uuidOptional

406

Not Acceptable

text/plainapplication/jsontext/json

post

/customer-returns

HTTPcURLJavaScriptPython

POST /customer-returns HTTP/1.1
ApiKey: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 671

{
  "trackingNumber": "text",
  "comments": "text",
  "carrier": "text",
  "referenceNumber": "text",
  "reference1": "text",
  "reference2": "text",
  "reference3": "text",
  "customerId": "123e4567-e89b-12d3-a456-426614174000",
  "warehouseId": "123e4567-e89b-12d3-a456-426614174000",
  "customerReturnNumber": "text",
  "from": {
    "name": "text",
    "phone": "text",
    "email": "text",
    "address1": "text",
    "address2": "text",
    "city": "text",
    "stateProvince": "text",
    "zipPostal": "text",
    "country": "text"
  },
  "lines": [
    {
      "lineNumber": 1,
      "packsize": 1,
      "numberOfPacks": 1,
      "productId": "123e4567-e89b-12d3-a456-426614174000",
      "quantity": 1,
      "referenceNumber": "text",
      "reference1": "text",
      "reference2": "text",
      "reference3": "text",
      "instructions": "text"
    }
  ]
}

application/jsontext/jsonapplication/*+json

{
  "id": "123e4567-e89b-12d3-a456-426614174000"
}

Update an existing customer return

put

Authorizations

ApiKey

ApiKeystringRequired

Api key taken from 'Gateway API key' setting.

Body

application/jsontext/jsonapplication/*+json

trackingNumberstring · nullableOptional

commentsstring · nullableOptional

carrierstring · nullableOptional

referenceNumberstring · nullableOptional

reference1string · nullableOptional

reference2string · nullableOptional

reference3string · nullableOptional

idstring · uuidOptional

Responses

200

OK

text/plainapplication/jsontext/json

idstring · uuidOptional

406

Not Acceptable

text/plainapplication/jsontext/json

put

/customer-returns

HTTPcURLJavaScriptPython

PUT /customer-returns HTTP/1.1
ApiKey: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 580

{
  "trackingNumber": "text",
  "comments": "text",
  "carrier": "text",
  "referenceNumber": "text",
  "reference1": "text",
  "reference2": "text",
  "reference3": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "from": {
    "name": "text",
    "phone": "text",
    "email": "text",
    "address1": "text",
    "address2": "text",
    "city": "text",
    "stateProvince": "text",
    "zipPostal": "text",
    "country": "text"
  },
  "lines": [
    {
      "lineNumber": 1,
      "packsize": 1,
      "numberOfPacks": 1,
      "productId": "123e4567-e89b-12d3-a456-426614174000",
      "quantity": 1,
      "referenceNumber": "text",
      "reference1": "text",
      "reference2": "text",
      "reference3": "text",
      "instructions": "text"
    }
  ]
}

application/jsontext/jsonapplication/*+json

{
  "id": "123e4567-e89b-12d3-a456-426614174000"
}

Upload an existing pending customer return

post

Authorizations

ApiKey

ApiKeystringRequired

Api key taken from 'Gateway API key' setting.

Body

application/jsontext/jsonapplication/*+json

idsstring · uuid[] · nullableOptional

uploadedSuceededboolean · nullableOptional

uploadMessagestring · nullableOptional

resetUploadCountboolean · nullableOptional

Responses

200

OK

No content

post

/customer-returns/upload

HTTPcURLJavaScriptPython

POST /customer-returns/upload HTTP/1.1
ApiKey: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 119

{
  "ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "uploadedSuceeded": true,
  "uploadMessage": "text",
  "resetUploadCount": true
}

application/jsontext/jsonapplication/*+json

200

OK

No content

Returns a single customer return by id

get

Authorizations

ApiKey

ApiKeystringRequired

Api key taken from 'Gateway API key' setting.

Path parameters

idstring · uuidRequired

Responses

200

OK

text/plainapplication/jsontext/json

trackingNumberstring · nullableOptional

commentsstring · nullableOptional

carrierstring · nullableOptional

referenceNumberstring · nullableOptional

reference1string · nullableOptional

reference2string · nullableOptional

reference3string · nullableOptional

idstring · uuidOptional

customerReturnNumberstring · nullableOptional

404

Not Found

text/plainapplication/jsontext/json

get

/customer-returns/{id}

HTTPcURLJavaScriptPython

GET /customer-returns/{id} HTTP/1.1
ApiKey: YOUR_API_KEY
Accept: */*

{
  "trackingNumber": "text",
  "comments": "text",
  "carrier": "text",
  "referenceNumber": "text",
  "reference1": "text",
  "reference2": "text",
  "reference3": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "customerReturnNumber": "text",
  "customer": {
    "companyName": "text",
    "description": "text",
    "phone": "text",
    "email": "text",
    "contactPerson": "text",
    "taxId": "text",
    "addresses": [
      {
        "id": "text",
        "name": "text",
        "attnTo": "text",
        "address1": "text",
        "address2": "text",
        "routeNumber": "text",
        "city": "text",
        "stateProvince": "text",
        "zipPostalCode": "text",
        "country": "text",
        "phone": "text",
        "email": "text",
        "isDefault": true
      }
    ],
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "client": {
      "description": "text",
      "ssccCompanyId": "text",
      "companyName": "text",
      "email": "text",
      "phone": "text",
      "contactPerson": "text",
      "taxId": "text",
      "address1": "text",
      "address2": "text",
      "city": "text",
      "stateProvince": "text",
      "zipPostalCode": "text",
      "country": "text",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    },
    "customerCode": "text"
  },
  "warehouse": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "warehouseCode": "text",
    "name": "text",
    "description": "text",
    "phone": "text",
    "email": "text",
    "referenceNumber": "text",
    "address1": "text",
    "address2": "text",
    "city": "text",
    "stateProvince": "text",
    "zipPostalCode": "text",
    "country": "text"
  },
  "lines": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "lineNumber": 1,
      "product": {
        "description": "text",
        "upc": "text",
        "barcodeType": "Code128",
        "barcodeValue": "text",
        "referenceNumber": "text",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "client": {
          "description": "text",
          "ssccCompanyId": "text",
          "companyName": "text",
          "email": "text",
          "phone": "text",
          "contactPerson": "text",
          "taxId": "text",
          "address1": "text",
          "address2": "text",
          "city": "text",
          "stateProvince": "text",
          "zipPostalCode": "text",
          "country": "text",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text"
        },
        "sku": "text"
      },
      "quantity": 1,
      "referenceNumber": "text",
      "reference1": "text",
      "reference2": "text",
      "reference3": "text",
      "receivedQuantity": 1,
      "damagedQuantity": 1,
      "toteLineId": "123e4567-e89b-12d3-a456-426614174000",
      "details": [
        {
          "toteLineDetailId": "123e4567-e89b-12d3-a456-426614174000",
          "receivedQuantity": 1,
          "lotNumber": "text",
          "serialNumber": "text",
          "expiryDate": "2026-03-02T22:30:40.269Z",
          "packsizeEachCount": 1
        }
      ]
    }
  ]
}

Delete customer return by Id

delete

Authorizations

ApiKey

ApiKeystringRequired

Api key taken from 'Gateway API key' setting.

Path parameters

idstring · uuidRequired

Responses

200

OK

No content

406

Not Acceptable

text/plainapplication/jsontext/json

delete

/customer-returns/{id}

HTTPcURLJavaScriptPython

DELETE /customer-returns/{id} HTTP/1.1
ApiKey: YOUR_API_KEY
Accept: */*

No content

Returns a list of pick tickets by specified field/value

get

Authorizations

ApiKey

ApiKeystringRequired

Api key taken from 'Gateway API key' setting.

Path parameters

fieldstringRequired

valuestringRequired

Responses

200

OK

text/plainapplication/jsontext/json

trackingNumberstring · nullableOptional

commentsstring · nullableOptional

carrierstring · nullableOptional

referenceNumberstring · nullableOptional

reference1string · nullableOptional

reference2string · nullableOptional

reference3string · nullableOptional

idstring · uuidOptional

customerReturnNumberstring · nullableOptional

404

Not Found

text/plainapplication/jsontext/json

get

/customer-returns/{field}/{value}

HTTPcURLJavaScriptPython

GET /customer-returns/{field}/{value} HTTP/1.1
ApiKey: YOUR_API_KEY
Accept: */*

{
  "trackingNumber": "text",
  "comments": "text",
  "carrier": "text",
  "referenceNumber": "text",
  "reference1": "text",
  "reference2": "text",
  "reference3": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "customerReturnNumber": "text",
  "customer": {
    "companyName": "text",
    "description": "text",
    "phone": "text",
    "email": "text",
    "contactPerson": "text",
    "taxId": "text",
    "addresses": [
      {
        "id": "text",
        "name": "text",
        "attnTo": "text",
        "address1": "text",
        "address2": "text",
        "routeNumber": "text",
        "city": "text",
        "stateProvince": "text",
        "zipPostalCode": "text",
        "country": "text",
        "phone": "text",
        "email": "text",
        "isDefault": true
      }
    ],
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "client": {
      "description": "text",
      "ssccCompanyId": "text",
      "companyName": "text",
      "email": "text",
      "phone": "text",
      "contactPerson": "text",
      "taxId": "text",
      "address1": "text",
      "address2": "text",
      "city": "text",
      "stateProvince": "text",
      "zipPostalCode": "text",
      "country": "text",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    },
    "customerCode": "text"
  },
  "warehouse": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "warehouseCode": "text",
    "name": "text",
    "description": "text",
    "phone": "text",
    "email": "text",
    "referenceNumber": "text",
    "address1": "text",
    "address2": "text",
    "city": "text",
    "stateProvince": "text",
    "zipPostalCode": "text",
    "country": "text"
  },
  "lines": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "lineNumber": 1,
      "product": {
        "description": "text",
        "upc": "text",
        "barcodeType": "Code128",
        "barcodeValue": "text",
        "referenceNumber": "text",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "client": {
          "description": "text",
          "ssccCompanyId": "text",
          "companyName": "text",
          "email": "text",
          "phone": "text",
          "contactPerson": "text",
          "taxId": "text",
          "address1": "text",
          "address2": "text",
          "city": "text",
          "stateProvince": "text",
          "zipPostalCode": "text",
          "country": "text",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text"
        },
        "sku": "text"
      },
      "quantity": 1,
      "referenceNumber": "text",
      "reference1": "text",
      "reference2": "text",
      "reference3": "text",
      "receivedQuantity": 1,
      "damagedQuantity": 1,
      "toteLineId": "123e4567-e89b-12d3-a456-426614174000",
      "details": [
        {
          "toteLineDetailId": "123e4567-e89b-12d3-a456-426614174000",
          "receivedQuantity": 1,
          "lotNumber": "text",
          "serialNumber": "text",
          "expiryDate": "2026-03-02T22:30:40.269Z",
          "packsizeEachCount": 1
        }
      ]
    }
  ]
}