Products

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