Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Products

Returns products list

get
Authorizations
ApiKeystringRequired

Api key taken from 'Gateway API key' setting.

Query parameters
SkustringOptional
ClientIdstring · uuidOptional
Pageinteger · int32Optional
PageSizeinteger · int32Optional
Responses
200

OK

descriptionstring · nullableOptional
upcstring · nullableOptional
barcodeTypestring · enumOptionalPossible values:
barcodeValuestring · nullableOptional
referenceNumberstring · nullableOptional
idstring · uuidOptional
skustring · nullableOptional
get/products
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
ApiKeystringRequired

Api key taken from 'Gateway API key' setting.

Body
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

descriptionstring · nullableOptional
upcstring · nullableOptional
barcodeTypestring · enumOptionalPossible values:
barcodeValuestring · nullableOptional
referenceNumberstring · nullableOptional
idstring · uuidOptional
skustring · nullableOptional
post/products
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
    }
  ]
}
{
  "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
ApiKeystringRequired

Api key taken from 'Gateway API key' setting.

Body
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

descriptionstring · nullableOptional
upcstring · nullableOptional
barcodeTypestring · enumOptionalPossible values:
barcodeValuestring · nullableOptional
referenceNumberstring · nullableOptional
idstring · uuidOptional
skustring · nullableOptional
put/products
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
    }
  ]
}
{
  "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
ApiKeystringRequired

Api key taken from 'Gateway API key' setting.

Path parameters
idstring · uuidRequired
Responses
200

OK

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
get/products/{id}
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
ApiKeystringRequired

Api key taken from 'Gateway API key' setting.

Path parameters
idstring · uuidRequired
Responses
200

OK

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

No content

Last updated

Was this helpful?