API Reference

P4 Warehouse API

Summary

The P4 Warehouse API provides a comprehensive interface for managing warehouse operations. It allows for efficient inventory tracking, order processing, and data management. By leveraging this API, developers can integrate warehouse functionalities into their applications seamlessly, enhancing operational workflows and improving overall efficiency.

Explanation

The P4 Warehouse API is engineered to offer a suite of functionalities essential for warehouse management. It facilitates real-time inventory tracking, enabling businesses to maintain accurate stock levels and reduce the risk of shortages or overstocking. The API's order processing capabilities streamline the workflow by automating order entries, updates, and shipment tracking, thereby minimizing manual errors. Additionally, the API supports robust data management features, ensuring secure and efficient data handling. This integration empowers businesses to optimize their warehouse operations, leading to improved productivity and customer satisfaction.

Returns adjustments on given query.

post

Authorizations

ApiKey

ApiKeystringRequired

Api key taken from 'Gateway API key' setting.

Body

application/jsontext/jsonapplication/*+json

conditionstring · nullableOptional

Responses

200

OK

text/plainapplication/jsontext/json

idstring · uuid · nullableOptional

timestampstring · date-time · nullableOptional

clientstring · nullableOptional

subTypestring · nullableOptional

typestring · nullableOptional

fromWarehousestring · nullableOptional

toWarehousestring · nullableOptional

productIdstring · uuidOptional

packsizeIdstring · uuid · nullableOptional

skustring · nullableOptional

eachCountinteger · int32 · nullableOptional

numberOfPacksinteger · int32 · nullableOptional

lotNumberstring · nullableOptional

expiryDatestring · date-time · nullableOptional

serialNumberstring · nullableOptional

quantitynumber · double · nullableOptional

reasonstring · nullableOptional

post

/adjustments

HTTPcURLJavaScriptPython

POST /adjustments HTTP/1.1
ApiKey: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 211

{
  "condition": "text",
  "rules": [
    {
      "field": "text",
      "value": "text",
      "operator": "text",
      "condition": "text",
      "rules": [
        {
          "field": "text",
          "value": "text",
          "operator": "text",
          "condition": "text",
          "rules": [
            "[Circular Reference]"
          ]
        }
      ]
    }
  ]
}

application/jsontext/jsonapplication/*+json

200

OK

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "timestamp": "2026-03-02T21:26:29.728Z",
  "client": "text",
  "subType": "text",
  "type": "text",
  "fromWarehouse": "text",
  "toWarehouse": "text",
  "productId": "123e4567-e89b-12d3-a456-426614174000",
  "packsizeId": "123e4567-e89b-12d3-a456-426614174000",
  "sku": "text",
  "eachCount": 1,
  "numberOfPacks": 1,
  "lotNumber": "text",
  "expiryDate": "2026-03-02T21:26:29.728Z",
  "serialNumber": "text",
  "quantity": 1,
  "reason": "text"
}

Marks a set of adjustments as uploaded

post

Authorizations

ApiKey

ApiKeystringRequired

Api key taken from 'Gateway API key' setting.

Body

application/jsontext/jsonapplication/*+json

idsstring · uuid[] · nullableOptional

integrationReferencestring · nullableOptional

integrationMessagestring · nullableOptional

Responses

200

OK

text/plainapplication/jsontext/json

idstring · uuidOptional

406

Not Acceptable

text/plainapplication/jsontext/json

post

/adjustments/upload

HTTPcURLJavaScriptPython

POST /adjustments/upload HTTP/1.1
ApiKey: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 106

{
  "ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "integrationReference": "text",
  "integrationMessage": "text"
}

application/jsontext/jsonapplication/*+json

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

Returns client invoices

get

Authorizations

ApiKey

ApiKeystringRequired

Api key taken from 'Gateway API key' setting.

Query parameters

Pageinteger · int32Optional

PageSizeinteger · int32Optional

Responses

200

OK

text/plainapplication/jsontext/json

idstring · uuidOptional

invoiceNumberstring · nullableOptional

clientIdstring · uuidOptional

startPeriodstring · date-timeOptional

endPeriodstring · date-timeOptional

postingDatestring · date-timeOptional

subTotalnumber · doubleOptional

totalnumber · doubleOptional

dateCreatedstring · date-timeOptional

get

/client-invoices

HTTPcURLJavaScriptPython

GET /client-invoices HTTP/1.1
ApiKey: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "invoiceNumber": "text",
    "clientId": "123e4567-e89b-12d3-a456-426614174000",
    "startPeriod": "2026-03-02T21:26:29.728Z",
    "endPeriod": "2026-03-02T21:26:29.728Z",
    "postingDate": "2026-03-02T21:26:29.728Z",
    "subTotal": 1,
    "total": 1,
    "dateCreated": "2026-03-02T21:26:29.728Z"
  }
]

Returns a single client invoice 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

idstring · uuidOptional

invoiceNumberstring · nullableOptional

clientIdstring · uuidOptional

startPeriodstring · date-timeOptional

endPeriodstring · date-timeOptional

postingDatestring · date-timeOptional

subTotalnumber · doubleOptional

totalnumber · doubleOptional

dateCreatedstring · date-timeOptional

fromNamestring · nullableOptional

fromAddress1string · nullableOptional

fromAddress2string · nullableOptional

fromCitystring · nullableOptional

fromStateProvincestring · nullableOptional

fromZipPostalCodestring · nullableOptional

fromCountrystring · nullableOptional

billToNamestring · nullableOptional

billToAddress1string · nullableOptional

billToAddress2string · nullableOptional

billToCitystring · nullableOptional

billToStateProvincestring · nullableOptional

billToZipPostalCodestring · nullableOptional

billToCountrystring · nullableOptional

404

Not Found

text/plainapplication/jsontext/json

get

/client-invoices/{id}

HTTPcURLJavaScriptPython

GET /client-invoices/{id} HTTP/1.1
ApiKey: YOUR_API_KEY
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "invoiceNumber": "text",
  "clientId": "123e4567-e89b-12d3-a456-426614174000",
  "startPeriod": "2026-03-02T21:26:29.728Z",
  "endPeriod": "2026-03-02T21:26:29.728Z",
  "postingDate": "2026-03-02T21:26:29.728Z",
  "subTotal": 1,
  "total": 1,
  "dateCreated": "2026-03-02T21:26:29.728Z",
  "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"
  },
  "fromName": "text",
  "fromAddress1": "text",
  "fromAddress2": "text",
  "fromCity": "text",
  "fromStateProvince": "text",
  "fromZipPostalCode": "text",
  "fromCountry": "text",
  "billToName": "text",
  "billToAddress1": "text",
  "billToAddress2": "text",
  "billToCity": "text",
  "billToStateProvince": "text",
  "billToZipPostalCode": "text",
  "billToCountry": "text",
  "lines": [
    {
      "lineNumber": 1,
      "item": "text",
      "description": "text",
      "additionalCharges": "text",
      "rate": 1,
      "quantity": 1
    }
  ]
}

Returns all clients

get

Authorizations

ApiKey

ApiKeystringRequired

Api key taken from 'Gateway API key' setting.

Query parameters

clientNamestringOptional

Responses

200

OK

text/plainapplication/jsontext/json

descriptionstring · nullableOptional

ssccCompanyIdstring · nullableOptional

companyNamestring · nullableOptional

emailstring · nullableOptional

phonestring · nullableOptional

contactPersonstring · nullableOptional

taxIdstring · nullableOptional

address1string · nullableOptional

address2string · nullableOptional

citystring · nullableOptional

stateProvincestring · nullableOptional

zipPostalCodestring · nullableOptional

countrystring · nullableOptional

idstring · uuidOptional

namestring · nullableOptional

get

/clients

HTTPcURLJavaScriptPython

GET /clients HTTP/1.1
ApiKey: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "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"
  }
]

Create new client

post

Authorizations

ApiKey

ApiKeystringRequired

Api key taken from 'Gateway API key' setting.

Body

application/jsontext/jsonapplication/*+json

descriptionstring · nullableOptional

ssccCompanyIdstring · nullableOptional

companyNamestring · nullableOptional

emailstring · nullableOptional

phonestring · nullableOptional

contactPersonstring · nullableOptional

taxIdstring · nullableOptional

address1string · nullableOptional

address2string · nullableOptional

citystring · nullableOptional

stateProvincestring · nullableOptional

zipPostalCodestring · nullableOptional

countrystring · nullableOptional

namestring · nullableOptional

Unique client code/name (required, immutable after creation)

Responses

200

OK

text/plainapplication/jsontext/json

idstring · uuidOptional

406

Not Acceptable

text/plainapplication/jsontext/json

post

/clients

HTTPcURLJavaScriptPython

POST /clients HTTP/1.1
ApiKey: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 261

{
  "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",
  "name": "text"
}

application/jsontext/jsonapplication/*+json

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

Update an existing client

put

Authorizations

ApiKey

ApiKeystringRequired

Api key taken from 'Gateway API key' setting.

Body

application/jsontext/jsonapplication/*+json

descriptionstring · nullableOptional

ssccCompanyIdstring · nullableOptional

companyNamestring · nullableOptional

emailstring · nullableOptional

phonestring · nullableOptional

contactPersonstring · nullableOptional

taxIdstring · nullableOptional

address1string · nullableOptional

address2string · nullableOptional

citystring · nullableOptional

stateProvincestring · nullableOptional

zipPostalCodestring · nullableOptional

countrystring · nullableOptional

idstring · uuidOptional

Client ID (required for update)

Responses

200

OK

text/plainapplication/jsontext/json

idstring · uuidOptional

406

Not Acceptable

text/plainapplication/jsontext/json

put

/clients

HTTPcURLJavaScriptPython

PUT /clients HTTP/1.1
ApiKey: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 291

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

application/jsontext/jsonapplication/*+json

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

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-02T21:26:29.728Z",
          "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-02T21:26:29.728Z",
          "packsizeEachCount": 1
        }
      ]
    }
  ]
}

Returns all customers

get

Authorizations

ApiKey

ApiKeystringRequired

Api key taken from 'Gateway API key' setting.

Query parameters

CustomerCodestringOptional

ClientIdstring · uuidOptional

Pageinteger · int32Optional

PageSizeinteger · int32Optional

Responses

200

OK

text/plainapplication/jsontext/json

companyNamestring · nullableOptional

descriptionstring · nullableOptional

phonestring · nullableOptional

emailstring · nullableOptional

contactPersonstring · nullableOptional

taxIdstring · nullableOptional

idstring · uuidOptional

customerCodestring · nullableOptional

406

Not Acceptable

text/plainapplication/jsontext/json

get

/customers

HTTPcURLJavaScriptPython

GET /customers HTTP/1.1
ApiKey: YOUR_API_KEY
Accept: */*

[
  {
    "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"
  }
]

Create new customer

post

Authorizations

ApiKey

ApiKeystringRequired

Api key taken from 'Gateway API key' setting.

Body

application/jsontext/jsonapplication/*+json

companyNamestring · nullableOptional

descriptionstring · nullableOptional

phonestring · nullableOptional

emailstring · nullableOptional

contactPersonstring · nullableOptional

taxIdstring · nullableOptional

clientIdstring · uuid · nullableOptional

customerCodestring · nullableOptional

Responses

200

OK

text/plainapplication/jsontext/json

idstring · uuidOptional

406

Not Acceptable

text/plainapplication/jsontext/json

post

/customers

HTTPcURLJavaScriptPython

POST /customers HTTP/1.1
ApiKey: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 422

{
  "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
    }
  ],
  "clientId": "123e4567-e89b-12d3-a456-426614174000",
  "customerCode": "text"
}

application/jsontext/jsonapplication/*+json

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

Update an existing customer

put

Authorizations

ApiKey

ApiKeystringRequired

Api key taken from 'Gateway API key' setting.

Body

application/jsontext/jsonapplication/*+json

companyNamestring · nullableOptional

descriptionstring · nullableOptional

phonestring · nullableOptional

emailstring · nullableOptional

contactPersonstring · nullableOptional

taxIdstring · nullableOptional

idstring · uuidOptional

Responses

200

OK

text/plainapplication/jsontext/json

idstring · uuidOptional

406

Not Acceptable

text/plainapplication/jsontext/json

put

/customers

HTTPcURLJavaScriptPython

PUT /customers HTTP/1.1
ApiKey: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 394

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

application/jsontext/jsonapplication/*+json

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

Returns a single customer 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

companyNamestring · nullableOptional

descriptionstring · nullableOptional

phonestring · nullableOptional

emailstring · nullableOptional

contactPersonstring · nullableOptional

taxIdstring · nullableOptional

idstring · uuidOptional

customerCodestring · nullableOptional

406

Not Acceptable

text/plainapplication/jsontext/json

get

/customers/{id}

HTTPcURLJavaScriptPython

GET /customers/{id} HTTP/1.1
ApiKey: YOUR_API_KEY
Accept: */*

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

Delete customer 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

/customers/{id}

HTTPcURLJavaScriptPython

DELETE /customers/{id} HTTP/1.1
ApiKey: YOUR_API_KEY
Accept: */*

No content

Returns inventory

get

Authorizations

ApiKey

ApiKeystringRequired

Api key taken from 'Gateway API key' setting.

Query parameters

warehouseIdstring · uuidOptional

clientIdstring · uuidOptional

Responses

200

OK

text/plainapplication/jsontext/json

productIdstring · uuid · nullableOptional

skustring · nullableOptional

clientIdstring · uuid · nullableOptional

warehouseIdstring · uuid · nullableOptional

quantitynumber · doubleOptional

isSerialControlledbooleanOptional

isExpiryControlledbooleanOptional

isDecimalControlledbooleanOptional

get

/inventory

HTTPcURLJavaScriptPython

GET /inventory HTTP/1.1
ApiKey: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "productId": "123e4567-e89b-12d3-a456-426614174000",
    "sku": "text",
    "clientId": "123e4567-e89b-12d3-a456-426614174000",
    "warehouseId": "123e4567-e89b-12d3-a456-426614174000",
    "quantity": 1,
    "isSerialControlled": true,
    "isExpiryControlled": true,
    "isDecimalControlled": true,
    "details": [
      {
        "serialNumber": "text",
        "lotNumber": "text",
        "expiry": "2026-03-02T21:26:29.728Z",
        "eachCount": 1,
        "quantity": 1
      }
    ]
  }
]

Returns pick ticket list

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

referenceNumberstring · nullableOptional

poNumberstring · nullableOptional

commentsstring · nullableOptional

pickingInstructionsstring · nullableOptional

requiredDatestring · date-time · nullableOptional

cancelDatestring · date-time · nullableOptional

freightTypestring · enumOptionalPossible values:

routeNumberstring · nullableOptional

freightTermsstring · nullableOptional

carrierstring · nullableOptional

shippingServicestring · nullableOptional

dateCreatedstring · date-timeOptional

closeDatestring · date-time · nullableOptional

idstring · uuidOptional

pickTicketNumberstring · nullableOptional

get

/pick-tickets

HTTPcURLJavaScriptPython

GET /pick-tickets HTTP/1.1
ApiKey: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "referenceNumber": "text",
    "poNumber": "text",
    "comments": "text",
    "pickingInstructions": "text",
    "requiredDate": "2026-03-02T21:26:29.728Z",
    "cancelDate": "2026-03-02T21:26:29.728Z",
    "freightType": "TruckLoad",
    "routeNumber": "text",
    "freightTerms": "text",
    "carrier": "text",
    "shippingService": "text",
    "dateCreated": "2026-03-02T21:26:29.728Z",
    "closeDate": "2026-03-02T21:26:29.728Z",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "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"
    },
    "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"
    },
    "pickTicketNumber": "text"
  }
]

Create new pick ticket

post

Authorizations

ApiKey

ApiKeystringRequired

Api key taken from 'Gateway API key' setting.

Body

application/jsontext/jsonapplication/*+json

referenceNumberstring · nullableOptional

poNumberstring · nullableOptional

commentsstring · nullableOptional

pickingInstructionsstring · nullableOptional

requiredDatestring · date-time · nullableOptional

cancelDatestring · date-time · nullableOptional

freightTypestring · enumOptionalPossible values:

routeNumberstring · nullableOptional

freightTermsstring · nullableOptional

carrierstring · nullableOptional

shippingServicestring · nullableOptional

dateCreatedstring · date-timeOptional

closeDatestring · date-time · nullableOptional

warehouseIdstring · uuidOptional

customerIdstring · uuidOptional

pickTicketNumberstring · nullableOptional

Responses

200

OK

text/plainapplication/jsontext/json

idstring · uuidOptional

406

Not Acceptable

text/plainapplication/jsontext/json

post

/pick-tickets

HTTPcURLJavaScriptPython

POST /pick-tickets HTTP/1.1
ApiKey: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1203

{
  "referenceNumber": "text",
  "poNumber": "text",
  "comments": "text",
  "pickingInstructions": "text",
  "requiredDate": "2026-03-02T21:26:29.728Z",
  "cancelDate": "2026-03-02T21:26:29.728Z",
  "freightType": "TruckLoad",
  "routeNumber": "text",
  "freightTerms": "text",
  "carrier": "text",
  "shippingService": "text",
  "dateCreated": "2026-03-02T21:26:29.728Z",
  "closeDate": "2026-03-02T21:26:29.728Z",
  "warehouseId": "123e4567-e89b-12d3-a456-426614174000",
  "customerId": "123e4567-e89b-12d3-a456-426614174000",
  "pickTicketNumber": "text",
  "shipFrom": {
    "name": "text",
    "phone": "text",
    "email": "text",
    "address1": "text",
    "address2": "text",
    "city": "text",
    "stateProvince": "text",
    "zipPostal": "text",
    "country": "text"
  },
  "shipTo": {
    "name": "text",
    "phone": "text",
    "email": "text",
    "address1": "text",
    "address2": "text",
    "city": "text",
    "stateProvince": "text",
    "zipPostal": "text",
    "country": "text"
  },
  "billTo": {
    "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",
      "orderedQuantity": 1,
      "referenceNumber": "text",
      "reference1": "text",
      "reference2": "text",
      "reference3": "text"
    }
  ]
}

application/jsontext/jsonapplication/*+json

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

Update an existing pick ticket

put

Authorizations

ApiKey

ApiKeystringRequired

Api key taken from 'Gateway API key' setting.

Body

application/jsontext/jsonapplication/*+json

referenceNumberstring · nullableOptional

poNumberstring · nullableOptional

commentsstring · nullableOptional

pickingInstructionsstring · nullableOptional

requiredDatestring · date-time · nullableOptional

cancelDatestring · date-time · nullableOptional

freightTypestring · enumOptionalPossible values:

routeNumberstring · nullableOptional

freightTermsstring · nullableOptional

carrierstring · nullableOptional

shippingServicestring · nullableOptional

dateCreatedstring · date-timeOptional

closeDatestring · date-time · nullableOptional

idstring · uuidOptional

Responses

200

OK

text/plainapplication/jsontext/json

idstring · uuidOptional

406

Not Acceptable

text/plainapplication/jsontext/json

put

/pick-tickets

HTTPcURLJavaScriptPython

PUT /pick-tickets HTTP/1.1
ApiKey: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1116

{
  "referenceNumber": "text",
  "poNumber": "text",
  "comments": "text",
  "pickingInstructions": "text",
  "requiredDate": "2026-03-02T21:26:29.728Z",
  "cancelDate": "2026-03-02T21:26:29.728Z",
  "freightType": "TruckLoad",
  "routeNumber": "text",
  "freightTerms": "text",
  "carrier": "text",
  "shippingService": "text",
  "dateCreated": "2026-03-02T21:26:29.728Z",
  "closeDate": "2026-03-02T21:26:29.728Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "shipFrom": {
    "name": "text",
    "phone": "text",
    "email": "text",
    "address1": "text",
    "address2": "text",
    "city": "text",
    "stateProvince": "text",
    "zipPostal": "text",
    "country": "text"
  },
  "shipTo": {
    "name": "text",
    "phone": "text",
    "email": "text",
    "address1": "text",
    "address2": "text",
    "city": "text",
    "stateProvince": "text",
    "zipPostal": "text",
    "country": "text"
  },
  "billTo": {
    "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",
      "orderedQuantity": 1,
      "referenceNumber": "text",
      "reference1": "text",
      "reference2": "text",
      "reference3": "text"
    }
  ]
}

application/jsontext/jsonapplication/*+json

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

Returns a single pick ticket 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

referenceNumberstring · nullableOptional

poNumberstring · nullableOptional

commentsstring · nullableOptional

pickingInstructionsstring · nullableOptional

requiredDatestring · date-time · nullableOptional

cancelDatestring · date-time · nullableOptional

freightTypestring · enumOptionalPossible values:

routeNumberstring · nullableOptional

freightTermsstring · nullableOptional

carrierstring · nullableOptional

shippingServicestring · nullableOptional

dateCreatedstring · date-timeOptional

closeDatestring · date-time · nullableOptional

idstring · uuidOptional

pickTicketNumberstring · nullableOptional

404

Not Found

text/plainapplication/jsontext/json

get

/pick-tickets/{id}

HTTPcURLJavaScriptPython

GET /pick-tickets/{id} HTTP/1.1
ApiKey: YOUR_API_KEY
Accept: */*

{
  "referenceNumber": "text",
  "poNumber": "text",
  "comments": "text",
  "pickingInstructions": "text",
  "requiredDate": "2026-03-02T21:26:29.728Z",
  "cancelDate": "2026-03-02T21:26:29.728Z",
  "freightType": "TruckLoad",
  "routeNumber": "text",
  "freightTerms": "text",
  "carrier": "text",
  "shippingService": "text",
  "dateCreated": "2026-03-02T21:26:29.728Z",
  "closeDate": "2026-03-02T21:26:29.728Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "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"
  },
  "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"
  },
  "pickTicketNumber": "text",
  "totes": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "sscc18Code": "text",
      "bolNumber": "text",
      "cartonNumber": 1,
      "carrier": "text",
      "shippingService": "text",
      "shippingCost": 1,
      "shippingCostCurrency": "text",
      "trackTraceNumber": "text",
      "lines": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "pickedQuantity": 1,
          "shippedQuantity": 1,
          "deliveredQuantity": 1,
          "pickTicketLineId": "123e4567-e89b-12d3-a456-426614174000",
          "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"
          },
          "details": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "pickedQuantity": 1,
              "shippedQuantity": 1,
              "deliveredQuantity": 1,
              "lotNumber": "text",
              "serialNumber": "text",
              "expiryDate": "2026-03-02T21:26:29.728Z",
              "packsizeEachCount": 1
            }
          ]
        }
      ]
    }
  ],
  "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"
      },
      "orderedQuantity": 1,
      "pickedQuantity": 1,
      "shippedQuantity": 1,
      "referenceNumber": "text",
      "reference1": "text",
      "reference2": "text",
      "reference3": "text"
    }
  ]
}

Delete pick-ticket by Id

delete

Authorizations

ApiKey

ApiKeystringRequired

Api key taken from 'Gateway API key' setting.

Path parameters

idstring · uuidRequired

Responses

200

OK

text/plainapplication/jsontext/json

integer · int32Optional

delete

/pick-tickets/{id}

HTTPcURLJavaScriptPython

DELETE /pick-tickets/{id} HTTP/1.1
ApiKey: YOUR_API_KEY
Accept: */*

200

OK

1

Upload an existing pending pick tickets

post

Authorizations

ApiKey

ApiKeystringRequired

Api key taken from 'Gateway API key' setting.

Path parameters

idstring · uuidRequired

Responses

200

OK

No content

post

/pick-tickets/suspend/{id}

HTTPcURLJavaScriptPython

POST /pick-tickets/suspend/{id} HTTP/1.1
ApiKey: YOUR_API_KEY
Accept: */*

200

OK

No content

Upload an existing pending pick tickets

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

/pick-tickets/upload

HTTPcURLJavaScriptPython

POST /pick-tickets/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 pick ticket by id

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

string · uuidOptional

get

/pick-tickets/id-lookup

HTTPcURLJavaScriptPython

GET /pick-tickets/id-lookup HTTP/1.1
ApiKey: YOUR_API_KEY
Accept: */*

200

OK

123e4567-e89b-12d3-a456-426614174000

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

referenceNumberstring · nullableOptional

poNumberstring · nullableOptional

commentsstring · nullableOptional

pickingInstructionsstring · nullableOptional

requiredDatestring · date-time · nullableOptional

cancelDatestring · date-time · nullableOptional

freightTypestring · enumOptionalPossible values:

routeNumberstring · nullableOptional

freightTermsstring · nullableOptional

carrierstring · nullableOptional

shippingServicestring · nullableOptional

dateCreatedstring · date-timeOptional

closeDatestring · date-time · nullableOptional

idstring · uuidOptional

pickTicketNumberstring · nullableOptional

404

Not Found

text/plainapplication/jsontext/json

get

/pick-tickets/{field}/{value}

HTTPcURLJavaScriptPython

GET /pick-tickets/{field}/{value} HTTP/1.1
ApiKey: YOUR_API_KEY
Accept: */*

{
  "referenceNumber": "text",
  "poNumber": "text",
  "comments": "text",
  "pickingInstructions": "text",
  "requiredDate": "2026-03-02T21:26:29.728Z",
  "cancelDate": "2026-03-02T21:26:29.728Z",
  "freightType": "TruckLoad",
  "routeNumber": "text",
  "freightTerms": "text",
  "carrier": "text",
  "shippingService": "text",
  "dateCreated": "2026-03-02T21:26:29.728Z",
  "closeDate": "2026-03-02T21:26:29.728Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "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"
  },
  "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"
  },
  "pickTicketNumber": "text",
  "totes": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "sscc18Code": "text",
      "bolNumber": "text",
      "cartonNumber": 1,
      "carrier": "text",
      "shippingService": "text",
      "shippingCost": 1,
      "shippingCostCurrency": "text",
      "trackTraceNumber": "text",
      "lines": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "pickedQuantity": 1,
          "shippedQuantity": 1,
          "deliveredQuantity": 1,
          "pickTicketLineId": "123e4567-e89b-12d3-a456-426614174000",
          "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"
          },
          "details": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "pickedQuantity": 1,
              "shippedQuantity": 1,
              "deliveredQuantity": 1,
              "lotNumber": "text",
              "serialNumber": "text",
              "expiryDate": "2026-03-02T21:26:29.728Z",
              "packsizeEachCount": 1
            }
          ]
        }
      ]
    }
  ],
  "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"
      },
      "orderedQuantity": 1,
      "pickedQuantity": 1,
      "shippedQuantity": 1,
      "referenceNumber": "text",
      "reference1": "text",
      "reference2": "text",
      "reference3": "text"
    }
  ]
}

Returns production order list

get

Authorizations

ApiKey

ApiKeystringRequired

Api key taken from 'Gateway API key' setting.

Query parameters

warehouseIdstring · uuidOptional

Pageinteger · int32Optional

PageSizeinteger · int32Optional

Responses

200

OK

text/plainapplication/jsontext/json

referenceNumberstring · nullableOptional

commentsstring · nullableOptional

idstring · uuidOptional

productionOrderNumberstring · nullableOptional

404

Not Found

text/plainapplication/jsontext/json

get

/production-orders

HTTPcURLJavaScriptPython

GET /production-orders HTTP/1.1
ApiKey: YOUR_API_KEY
Accept: */*

[
  {
    "referenceNumber": "text",
    "comments": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "productionOrderNumber": "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 production-order

post

Authorizations

ApiKey

ApiKeystringRequired

Api key taken from 'Gateway API key' setting.

Body

application/jsontext/jsonapplication/*+json

referenceNumberstring · nullableOptional

commentsstring · nullableOptional

clientIdstring · uuid · nullableOptional

warehouseIdstring · uuidOptional

productionOrderNumberstring · nullableOptional

Responses

200

OK

text/plainapplication/jsontext/json

idstring · uuidOptional

406

Not Acceptable

text/plainapplication/jsontext/json

post

/production-orders

HTTPcURLJavaScriptPython

POST /production-orders HTTP/1.1
ApiKey: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 554

{
  "referenceNumber": "text",
  "comments": "text",
  "clientId": "123e4567-e89b-12d3-a456-426614174000",
  "warehouseId": "123e4567-e89b-12d3-a456-426614174000",
  "productionOrderNumber": "text",
  "inLines": [
    {
      "lineNumber": 1,
      "productId": "123e4567-e89b-12d3-a456-426614174000",
      "quantity": 1,
      "referenceNumber": "text",
      "reference1": "text",
      "reference2": "text",
      "reference3": "text"
    }
  ],
  "outLines": [
    {
      "lineNumber": 1,
      "productId": "123e4567-e89b-12d3-a456-426614174000",
      "quantity": 1,
      "referenceNumber": "text",
      "reference1": "text",
      "reference2": "text",
      "reference3": "text",
      "lotNumber": "text"
    }
  ]
}

application/jsontext/jsonapplication/*+json

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

Update an existing production-order

put

Authorizations

ApiKey

ApiKeystringRequired

Api key taken from 'Gateway API key' setting.

Body

application/jsontext/jsonapplication/*+json

referenceNumberstring · nullableOptional

commentsstring · nullableOptional

idstring · uuidOptional

Responses

200

OK

text/plainapplication/jsontext/json

idstring · uuidOptional

406

Not Acceptable

text/plainapplication/jsontext/json

put

/production-orders

HTTPcURLJavaScriptPython

PUT /production-orders HTTP/1.1
ApiKey: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 464

{
  "referenceNumber": "text",
  "comments": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "inLines": [
    {
      "lineNumber": 1,
      "productId": "123e4567-e89b-12d3-a456-426614174000",
      "quantity": 1,
      "referenceNumber": "text",
      "reference1": "text",
      "reference2": "text",
      "reference3": "text"
    }
  ],
  "outLines": [
    {
      "lineNumber": 1,
      "productId": "123e4567-e89b-12d3-a456-426614174000",
      "quantity": 1,
      "referenceNumber": "text",
      "reference1": "text",
      "reference2": "text",
      "reference3": "text",
      "lotNumber": "text"
    }
  ]
}

application/jsontext/jsonapplication/*+json

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

Returns a single production order 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

referenceNumberstring · nullableOptional

commentsstring · nullableOptional

idstring · uuidOptional

productionOrderNumberstring · nullableOptional

404

Not Found

text/plainapplication/jsontext/json

get

/production-orders/{id}

HTTPcURLJavaScriptPython

GET /production-orders/{id} HTTP/1.1
ApiKey: YOUR_API_KEY
Accept: */*

{
  "referenceNumber": "text",
  "comments": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "productionOrderNumber": "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"
  },
  "inLines": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "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,
      "producedQuantity": 1,
      "referenceNumber": "text",
      "reference1": "text",
      "reference2": "text",
      "reference3": "text"
    }
  ],
  "outLines": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "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,
      "consumedQuantity": 1,
      "referenceNumber": "text",
      "reference1": "text",
      "reference2": "text",
      "reference3": "text"
    }
  ]
}

Delete production-order 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

/production-orders/{id}

HTTPcURLJavaScriptPython

DELETE /production-orders/{id} HTTP/1.1
ApiKey: YOUR_API_KEY
Accept: */*

No content

Upload an existing pending production order

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

406

Not Acceptable

text/plainapplication/jsontext/json

post

/production-orders/upload

HTTPcURLJavaScriptPython

POST /production-orders/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

No content

Returns products list

get

Authorizations

ApiKey

ApiKeystringRequired

Api key taken from 'Gateway API key' setting.

Query parameters

SkustringOptional

ClientIdstring · uuidOptional

Pageinteger · int32Optional

PageSizeinteger · int32Optional

Responses

200

OK

text/plainapplication/jsontext/json

descriptionstring · nullableOptional

upcstring · nullableOptional

barcodeTypestring · enumOptionalPossible values:

barcodeValuestring · nullableOptional

referenceNumberstring · nullableOptional

idstring · uuidOptional

skustring · nullableOptional

get

/products

HTTPcURLJavaScriptPython

GET /products HTTP/1.1
ApiKey: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "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"
  }
]

Create new product

post

Authorizations

ApiKey

ApiKeystringRequired

Api key taken from 'Gateway API key' setting.

Body

application/jsontext/jsonapplication/*+json

descriptionstring · nullableOptional

upcstring · nullableOptional

barcodeTypestring · enumOptionalPossible values:

barcodeValuestring · nullableOptional

referenceNumberstring · nullableOptional

clientIdstring · uuid · nullableOptional

skustring · nullableOptional

isLotControlledbooleanOptional

lotPatternstring · nullableOptional

isSerialControlledbooleanOptional

isBillOfMaterialbooleanOptional

serialPatternstring · nullableOptional

isExpiryControlledbooleanOptional

isDecimalControlledbooleanOptional

isPacksizeControlledbooleanOptional

palletTieinteger · int32 · nullableOptional

palletHeightinteger · int32 · nullableOptional

heightnumber · double · nullableOptional

lengthnumber · double · nullableOptional

widthnumber · double · nullableOptional

weightnumber · double · nullableOptional

dimsLengthUnitOfMeasurestring · enumOptionalPossible values:

dimsWeightUnitOfMeasurestring · enumOptionalPossible values:

unitOfMeasurestring · enumOptionalPossible values:

categorystring · nullableOptional

freightClassstring · enumOptionalPossible values:

imagestring · nullableOptional

nmfcstring · nullableOptional

commodityDescriptionstring · nullableOptional

htsCodestring · nullableOptional

countryOfOriginstring · nullableOptional

Responses

200

OK

text/plainapplication/jsontext/json

descriptionstring · nullableOptional

upcstring · nullableOptional

barcodeTypestring · enumOptionalPossible values:

barcodeValuestring · nullableOptional

referenceNumberstring · nullableOptional

idstring · uuidOptional

skustring · nullableOptional

406

Not Acceptable

text/plainapplication/jsontext/json

post

/products

HTTPcURLJavaScriptPython

POST /products HTTP/1.1
ApiKey: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 928

{
  "description": "text",
  "upc": "text",
  "barcodeType": "Code128",
  "barcodeValue": "text",
  "referenceNumber": "text",
  "clientId": "123e4567-e89b-12d3-a456-426614174000",
  "sku": "text",
  "isLotControlled": true,
  "lotPattern": "text",
  "isSerialControlled": true,
  "isBillOfMaterial": true,
  "serialPattern": "text",
  "isExpiryControlled": true,
  "isDecimalControlled": true,
  "isPacksizeControlled": true,
  "palletTie": 1,
  "palletHeight": 1,
  "height": 1,
  "length": 1,
  "width": 1,
  "weight": 1,
  "dimsLengthUnitOfMeasure": "Gr",
  "dimsWeightUnitOfMeasure": "Gr",
  "unitOfMeasure": "Gr",
  "category": "text",
  "freightClass": "Class50",
  "image": "text",
  "nmfc": "text",
  "commodityDescription": "text",
  "htsCode": "text",
  "countryOfOrigin": "text",
  "packsizes": [
    {
      "name": "text",
      "eachCount": 1,
      "barcodeValue": "text",
      "barcodeType": "Code128",
      "height": 1,
      "width": 1,
      "length": 1,
      "weight": 1,
      "palletTie": 1,
      "palletHeight": 1
    }
  ],
  "productComponents": [
    {
      "componentProductId": "123e4567-e89b-12d3-a456-426614174000",
      "quantity": 1
    }
  ]
}

application/jsontext/jsonapplication/*+json

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

Update an existing product

put

Authorizations

ApiKey

ApiKeystringRequired

Api key taken from 'Gateway API key' setting.

Body

application/jsontext/jsonapplication/*+json

descriptionstring · nullableOptional

upcstring · nullableOptional

barcodeTypestring · enumOptionalPossible values:

barcodeValuestring · nullableOptional

referenceNumberstring · nullableOptional

idstring · uuidOptional

skustring · nullableOptional

isLotControlledbooleanOptional

lotPatternstring · nullableOptional

isSerialControlledbooleanOptional

isBillOfMaterialbooleanOptional

serialPatternstring · nullableOptional

isExpiryControlledbooleanOptional

isDecimalControlledbooleanOptional

isPacksizeControlledbooleanOptional

palletTieinteger · int32 · nullableOptional

palletHeightinteger · int32 · nullableOptional

heightnumber · double · nullableOptional

lengthnumber · double · nullableOptional

widthnumber · double · nullableOptional

weightnumber · double · nullableOptional

dimsLengthUnitOfMeasurestring · enumOptionalPossible values:

dimsWeightUnitOfMeasurestring · enumOptionalPossible values:

unitOfMeasurestring · enumOptionalPossible values:

categorystring · nullableOptional

freightClassstring · enumOptionalPossible values:

imagestring · nullableOptional

nmfcstring · nullableOptional

commodityDescriptionstring · nullableOptional

htsCodestring · nullableOptional

countryOfOriginstring · nullableOptional

Responses

200

OK

text/plainapplication/jsontext/json

descriptionstring · nullableOptional

upcstring · nullableOptional

barcodeTypestring · enumOptionalPossible values:

barcodeValuestring · nullableOptional

referenceNumberstring · nullableOptional

idstring · uuidOptional

skustring · nullableOptional

406

Not Acceptable

text/plainapplication/jsontext/json

put

/products

HTTPcURLJavaScriptPython

PUT /products HTTP/1.1
ApiKey: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 922

{
  "description": "text",
  "upc": "text",
  "barcodeType": "Code128",
  "barcodeValue": "text",
  "referenceNumber": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "sku": "text",
  "isLotControlled": true,
  "lotPattern": "text",
  "isSerialControlled": true,
  "isBillOfMaterial": true,
  "serialPattern": "text",
  "isExpiryControlled": true,
  "isDecimalControlled": true,
  "isPacksizeControlled": true,
  "palletTie": 1,
  "palletHeight": 1,
  "height": 1,
  "length": 1,
  "width": 1,
  "weight": 1,
  "dimsLengthUnitOfMeasure": "Gr",
  "dimsWeightUnitOfMeasure": "Gr",
  "unitOfMeasure": "Gr",
  "category": "text",
  "freightClass": "Class50",
  "image": "text",
  "nmfc": "text",
  "commodityDescription": "text",
  "htsCode": "text",
  "countryOfOrigin": "text",
  "packsizes": [
    {
      "name": "text",
      "eachCount": 1,
      "barcodeValue": "text",
      "barcodeType": "Code128",
      "height": 1,
      "width": 1,
      "length": 1,
      "weight": 1,
      "palletTie": 1,
      "palletHeight": 1
    }
  ],
  "productComponents": [
    {
      "componentProductId": "123e4567-e89b-12d3-a456-426614174000",
      "quantity": 1
    }
  ]
}

application/jsontext/jsonapplication/*+json

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

Returns a single product 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

descriptionstring · nullableOptional

upcstring · nullableOptional

barcodeTypestring · enumOptionalPossible values:

barcodeValuestring · nullableOptional

referenceNumberstring · nullableOptional

idstring · uuidOptional

skustring · nullableOptional

isLotControlledbooleanOptional

lotPatternstring · nullableOptional

isSerialControlledbooleanOptional

isBillOfMaterialbooleanOptional

serialPatternstring · nullableOptional

isExpiryControlledbooleanOptional

isDecimalControlledbooleanOptional

isPacksizeControlledbooleanOptional

palletTieinteger · int32 · nullableOptional

palletHeightinteger · int32 · nullableOptional

heightnumber · double · nullableOptional

lengthnumber · double · nullableOptional

widthnumber · double · nullableOptional

weightnumber · double · nullableOptional

dimsLengthUnitOfMeasurestring · enumOptionalPossible values:

dimsWeightUnitOfMeasurestring · enumOptionalPossible values:

unitOfMeasurestring · enumOptionalPossible values:

categorystring · nullableOptional

freightClassstring · enumOptionalPossible values:

imagestring · nullableOptional

nmfcstring · nullableOptional

commodityDescriptionstring · nullableOptional

htsCodestring · nullableOptional

countryOfOriginstring · nullableOptional

404

Not Found

text/plainapplication/jsontext/json

get

/products/{id}

HTTPcURLJavaScriptPython

GET /products/{id} HTTP/1.1
ApiKey: YOUR_API_KEY
Accept: */*

{
  "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",
  "isLotControlled": true,
  "lotPattern": "text",
  "isSerialControlled": true,
  "isBillOfMaterial": true,
  "serialPattern": "text",
  "isExpiryControlled": true,
  "isDecimalControlled": true,
  "isPacksizeControlled": true,
  "palletTie": 1,
  "palletHeight": 1,
  "height": 1,
  "length": 1,
  "width": 1,
  "weight": 1,
  "dimsLengthUnitOfMeasure": "Gr",
  "dimsWeightUnitOfMeasure": "Gr",
  "unitOfMeasure": "Gr",
  "category": "text",
  "freightClass": "Class50",
  "image": "text",
  "nmfc": "text",
  "commodityDescription": "text",
  "htsCode": "text",
  "countryOfOrigin": "text",
  "packsizes": [
    {
      "name": "text",
      "eachCount": 1,
      "barcodeValue": "text",
      "barcodeType": "Code128",
      "height": 1,
      "width": 1,
      "length": 1,
      "weight": 1,
      "palletTie": 1,
      "palletHeight": 1
    }
  ],
  "productComponents": [
    {
      "componentProductId": "123e4567-e89b-12d3-a456-426614174000",
      "quantity": 1
    }
  ]
}

Delete product 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

/products/{id}

HTTPcURLJavaScriptPython

DELETE /products/{id} HTTP/1.1
ApiKey: YOUR_API_KEY
Accept: */*

No content

Returns purchase orders list

get

Authorizations

ApiKey

ApiKeystringRequired

Api key taken from 'Gateway API key' setting.

Query parameters

Pageinteger · int32Optional

PageSizeinteger · int32Optional

clientIdstring · uuidOptional

Responses

200

OK

text/plainapplication/jsontext/json

commentsstring · nullableOptional

referenceNumberstring · nullableOptional

reference1string · nullableOptional

reference2string · nullableOptional

reference3string · nullableOptional

appointmentNumberstring · nullableOptional

appointmentDatestring · date-time · nullableOptional

requiredDatestring · date-time · nullableOptional

dateCreatedstring · date-timeOptional

closeDatestring · date-time · nullableOptional

idstring · uuidOptional

purchaseOrderNumberstring · nullableOptional

get

/purchase-orders

HTTPcURLJavaScriptPython

GET /purchase-orders HTTP/1.1
ApiKey: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "comments": "text",
    "referenceNumber": "text",
    "reference1": "text",
    "reference2": "text",
    "reference3": "text",
    "appointmentNumber": "text",
    "appointmentDate": "2026-03-02T21:26:29.728Z",
    "requiredDate": "2026-03-02T21:26:29.728Z",
    "dateCreated": "2026-03-02T21:26:29.728Z",
    "closeDate": "2026-03-02T21:26:29.728Z",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "purchaseOrderNumber": "text",
    "vendor": {
      "companyName": "text",
      "email": "text",
      "phone": "text",
      "contactPerson": "text",
      "description": "text",
      "address": {
        "address1": "text",
        "address2": "text",
        "city": "text",
        "stateProvince": "text",
        "zipPostalCode": "text",
        "country": "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"
      },
      "vendorCode": "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 purchase order

post

Authorizations

ApiKey

ApiKeystringRequired

Api key taken from 'Gateway API key' setting.

Body

application/jsontext/jsonapplication/*+json

commentsstring · nullableOptional

referenceNumberstring · nullableOptional

reference1string · nullableOptional

reference2string · nullableOptional

reference3string · nullableOptional

appointmentNumberstring · nullableOptional

appointmentDatestring · date-time · nullableOptional

requiredDatestring · date-time · nullableOptional

dateCreatedstring · date-timeOptional

closeDatestring · date-time · nullableOptional

vendorIdstring · uuidOptional

warehouseIdstring · uuidOptional

purchaseOrderNumberstring · nullableOptional

Responses

200

OK

text/plainapplication/jsontext/json

idstring · uuidOptional

406

Not Acceptable

text/plainapplication/jsontext/json

post

/purchase-orders

HTTPcURLJavaScriptPython

POST /purchase-orders HTTP/1.1
ApiKey: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 644

{
  "comments": "text",
  "referenceNumber": "text",
  "reference1": "text",
  "reference2": "text",
  "reference3": "text",
  "appointmentNumber": "text",
  "appointmentDate": "2026-03-02T21:26:29.728Z",
  "requiredDate": "2026-03-02T21:26:29.728Z",
  "dateCreated": "2026-03-02T21:26:29.728Z",
  "closeDate": "2026-03-02T21:26:29.728Z",
  "vendorId": "123e4567-e89b-12d3-a456-426614174000",
  "warehouseId": "123e4567-e89b-12d3-a456-426614174000",
  "purchaseOrderNumber": "text",
  "lines": [
    {
      "lineNumber": 1,
      "packsize": 1,
      "numberOfPacks": 1,
      "productId": "123e4567-e89b-12d3-a456-426614174000",
      "orderedQuantity": 1,
      "referenceNumber": "text",
      "reference1": "text",
      "reference2": "text",
      "reference3": "text"
    }
  ]
}

application/jsontext/jsonapplication/*+json

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

Update an existing purchase order

put

Authorizations

ApiKey

ApiKeystringRequired

Api key taken from 'Gateway API key' setting.

Body

application/jsontext/jsonapplication/*+json

commentsstring · nullableOptional

referenceNumberstring · nullableOptional

reference1string · nullableOptional

reference2string · nullableOptional

reference3string · nullableOptional

appointmentNumberstring · nullableOptional

appointmentDatestring · date-time · nullableOptional

requiredDatestring · date-time · nullableOptional

dateCreatedstring · date-timeOptional

closeDatestring · date-time · nullableOptional

idstring · uuidOptional

Responses

200

OK

text/plainapplication/jsontext/json

idstring · uuidOptional

406

Not Acceptable

text/plainapplication/jsontext/json

put

/purchase-orders

HTTPcURLJavaScriptPython

PUT /purchase-orders HTTP/1.1
ApiKey: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 556

{
  "comments": "text",
  "referenceNumber": "text",
  "reference1": "text",
  "reference2": "text",
  "reference3": "text",
  "appointmentNumber": "text",
  "appointmentDate": "2026-03-02T21:26:29.728Z",
  "requiredDate": "2026-03-02T21:26:29.728Z",
  "dateCreated": "2026-03-02T21:26:29.728Z",
  "closeDate": "2026-03-02T21:26:29.728Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "lines": [
    {
      "lineNumber": 1,
      "packsize": 1,
      "numberOfPacks": 1,
      "productId": "123e4567-e89b-12d3-a456-426614174000",
      "orderedQuantity": 1,
      "referenceNumber": "text",
      "reference1": "text",
      "reference2": "text",
      "reference3": "text"
    }
  ]
}

application/jsontext/jsonapplication/*+json

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

Delete purchase order by code and clientId

delete

Authorizations

ApiKey

ApiKeystringRequired

Api key taken from 'Gateway API key' setting.

Query parameters

codestringOptional

clientIdstring · uuidOptional

Responses

200

OK

text/plainapplication/jsontext/json

integer · int32Optional

406

Not Acceptable

text/plainapplication/jsontext/json

delete

/purchase-orders

HTTPcURLJavaScriptPython

DELETE /purchase-orders HTTP/1.1
ApiKey: YOUR_API_KEY
Accept: */*

1

Upload an existing pending purchase orders

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

406

Not Acceptable

text/plainapplication/jsontext/json

post

/purchase-orders/upload

HTTPcURLJavaScriptPython

POST /purchase-orders/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

No content

Returns a single purchase order 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

commentsstring · nullableOptional

referenceNumberstring · nullableOptional

reference1string · nullableOptional

reference2string · nullableOptional

reference3string · nullableOptional

appointmentNumberstring · nullableOptional

appointmentDatestring · date-time · nullableOptional

requiredDatestring · date-time · nullableOptional

dateCreatedstring · date-timeOptional

closeDatestring · date-time · nullableOptional

idstring · uuidOptional

purchaseOrderNumberstring · nullableOptional

404

Not Found

text/plainapplication/jsontext/json

get

/purchase-orders/{id}

HTTPcURLJavaScriptPython

GET /purchase-orders/{id} HTTP/1.1
ApiKey: YOUR_API_KEY
Accept: */*

{
  "comments": "text",
  "referenceNumber": "text",
  "reference1": "text",
  "reference2": "text",
  "reference3": "text",
  "appointmentNumber": "text",
  "appointmentDate": "2026-03-02T21:26:29.728Z",
  "requiredDate": "2026-03-02T21:26:29.728Z",
  "dateCreated": "2026-03-02T21:26:29.728Z",
  "closeDate": "2026-03-02T21:26:29.728Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "vendor": {
    "companyName": "text",
    "email": "text",
    "phone": "text",
    "contactPerson": "text",
    "description": "text",
    "address": {
      "address1": "text",
      "address2": "text",
      "city": "text",
      "stateProvince": "text",
      "zipPostalCode": "text",
      "country": "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"
    },
    "vendorCode": "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"
  },
  "purchaseOrderNumber": "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"
      },
      "orderedQuantity": 1,
      "referenceNumber": "text",
      "reference1": "text",
      "reference2": "text",
      "reference3": "text",
      "receivedQuantity": 1,
      "details": [
        {
          "receivedQuantity": 1,
          "lotNumber": "text",
          "serialNumber": "text",
          "expiryDate": "2026-03-02T21:26:29.728Z",
          "packsizeEachCount": 1
        }
      ]
    }
  ]
}

Delete purchase-order 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

/purchase-orders/{id}

HTTPcURLJavaScriptPython

DELETE /purchase-orders/{id} HTTP/1.1
ApiKey: YOUR_API_KEY
Accept: */*

No content

Returns a list of purchase orders 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

commentsstring · nullableOptional

referenceNumberstring · nullableOptional

reference1string · nullableOptional

reference2string · nullableOptional

reference3string · nullableOptional

appointmentNumberstring · nullableOptional

appointmentDatestring · date-time · nullableOptional

requiredDatestring · date-time · nullableOptional

dateCreatedstring · date-timeOptional

closeDatestring · date-time · nullableOptional

idstring · uuidOptional

purchaseOrderNumberstring · nullableOptional

404

Not Found

text/plainapplication/jsontext/json

get

/purchase-orders/{field}/{value}

HTTPcURLJavaScriptPython

GET /purchase-orders/{field}/{value} HTTP/1.1
ApiKey: YOUR_API_KEY
Accept: */*

{
  "comments": "text",
  "referenceNumber": "text",
  "reference1": "text",
  "reference2": "text",
  "reference3": "text",
  "appointmentNumber": "text",
  "appointmentDate": "2026-03-02T21:26:29.728Z",
  "requiredDate": "2026-03-02T21:26:29.728Z",
  "dateCreated": "2026-03-02T21:26:29.728Z",
  "closeDate": "2026-03-02T21:26:29.728Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "vendor": {
    "companyName": "text",
    "email": "text",
    "phone": "text",
    "contactPerson": "text",
    "description": "text",
    "address": {
      "address1": "text",
      "address2": "text",
      "city": "text",
      "stateProvince": "text",
      "zipPostalCode": "text",
      "country": "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"
    },
    "vendorCode": "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"
  },
  "purchaseOrderNumber": "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"
      },
      "orderedQuantity": 1,
      "referenceNumber": "text",
      "reference1": "text",
      "reference2": "text",
      "reference3": "text",
      "receivedQuantity": 1,
      "details": [
        {
          "receivedQuantity": 1,
          "lotNumber": "text",
          "serialNumber": "text",
          "expiryDate": "2026-03-02T21:26:29.728Z",
          "packsizeEachCount": 1
        }
      ]
    }
  ]
}

Returns vendors

get

Authorizations

ApiKey

ApiKeystringRequired

Api key taken from 'Gateway API key' setting.

Query parameters

codestringOptional

clientIdstring · uuidOptional

Responses

200

OK

text/plainapplication/jsontext/json

companyNamestring · nullableOptional

emailstring · nullableOptional

phonestring · nullableOptional

contactPersonstring · nullableOptional

descriptionstring · nullableOptional

idstring · uuidOptional

vendorCodestring · nullableOptional

get

/vendors

HTTPcURLJavaScriptPython

GET /vendors HTTP/1.1
ApiKey: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "companyName": "text",
    "email": "text",
    "phone": "text",
    "contactPerson": "text",
    "description": "text",
    "address": {
      "address1": "text",
      "address2": "text",
      "city": "text",
      "stateProvince": "text",
      "zipPostalCode": "text",
      "country": "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"
    },
    "vendorCode": "text"
  }
]

Create new vendor

post

Authorizations

ApiKey

ApiKeystringRequired

Api key taken from 'Gateway API key' setting.

Body

application/jsontext/jsonapplication/*+json

companyNamestring · nullableOptional

emailstring · nullableOptional

phonestring · nullableOptional

contactPersonstring · nullableOptional

descriptionstring · nullableOptional

clientIdstring · uuid · nullableOptional

vendorCodestring · nullableOptional

Responses

200

OK

text/plainapplication/jsontext/json

idstring · uuidOptional

406

Not Acceptable

text/plainapplication/jsontext/json

post

/vendors

HTTPcURLJavaScriptPython

POST /vendors HTTP/1.1
ApiKey: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 291

{
  "companyName": "text",
  "email": "text",
  "phone": "text",
  "contactPerson": "text",
  "description": "text",
  "address": {
    "address1": "text",
    "address2": "text",
    "city": "text",
    "stateProvince": "text",
    "zipPostalCode": "text",
    "country": "text"
  },
  "clientId": "123e4567-e89b-12d3-a456-426614174000",
  "vendorCode": "text"
}

application/jsontext/jsonapplication/*+json

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

Update an existing vendor

put

Authorizations

ApiKey

ApiKeystringRequired

Api key taken from 'Gateway API key' setting.

Body

application/jsontext/jsonapplication/*+json

companyNamestring · nullableOptional

emailstring · nullableOptional

phonestring · nullableOptional

contactPersonstring · nullableOptional

descriptionstring · nullableOptional

idstring · uuidOptional

Responses

200

OK

text/plainapplication/jsontext/json

idstring · uuidOptional

406

Not Acceptable

text/plainapplication/jsontext/json

put

/vendors

HTTPcURLJavaScriptPython

PUT /vendors HTTP/1.1
ApiKey: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 265

{
  "companyName": "text",
  "email": "text",
  "phone": "text",
  "contactPerson": "text",
  "description": "text",
  "address": {
    "address1": "text",
    "address2": "text",
    "city": "text",
    "stateProvince": "text",
    "zipPostalCode": "text",
    "country": "text"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000"
}

application/jsontext/jsonapplication/*+json

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

Returns a single vendor 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

companyNamestring · nullableOptional

emailstring · nullableOptional

phonestring · nullableOptional

contactPersonstring · nullableOptional

descriptionstring · nullableOptional

idstring · uuidOptional

vendorCodestring · nullableOptional

404

Not Found

text/plainapplication/jsontext/json

406

Not Acceptable

text/plainapplication/jsontext/json

get

/vendors/{id}

HTTPcURLJavaScriptPython

GET /vendors/{id} HTTP/1.1
ApiKey: YOUR_API_KEY
Accept: */*

{
  "companyName": "text",
  "email": "text",
  "phone": "text",
  "contactPerson": "text",
  "description": "text",
  "address": {
    "address1": "text",
    "address2": "text",
    "city": "text",
    "stateProvince": "text",
    "zipPostalCode": "text",
    "country": "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"
  },
  "vendorCode": "text"
}

Delete vendor 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

/vendors/{id}

HTTPcURLJavaScriptPython

DELETE /vendors/{id} HTTP/1.1
ApiKey: YOUR_API_KEY
Accept: */*

No content

Returns list of warehouses

get

Authorizations

ApiKey

ApiKeystringRequired

Api key taken from 'Gateway API key' setting.

Query parameters

warehouseCodestringOptional

Responses

200

OK

text/plainapplication/jsontext/json

idstring · uuidOptional

warehouseCodestring · nullableOptional

namestring · nullableOptional

descriptionstring · nullableOptional

phonestring · nullableOptional

emailstring · nullableOptional

referenceNumberstring · nullableOptional

address1string · nullableOptional

address2string · nullableOptional

citystring · nullableOptional

stateProvincestring · nullableOptional

zipPostalCodestring · nullableOptional

countrystring · nullableOptional

406

Not Acceptable

text/plainapplication/jsontext/json

get

/warehouses

HTTPcURLJavaScriptPython

GET /warehouses HTTP/1.1
ApiKey: YOUR_API_KEY
Accept: */*

[
  {
    "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"
  }
]