Skip to main content
API docs by Redocly

Integration API Gateway (v1)

Download OpenAPI specification:Download

PRODUCT

Master/CREATE

This endpoint allows you to create a new master product in the system. Supply all required fields, including barcode type id, barcode number, vendor product code etc. When all fields are populated it creates the Single Unit Product, Inner Pack Product, Outer Pack / Master Product & Pallet Product. A successful operation returns the created product id with a list of ids for each hierarchy level as well.

Authorizations:
Bearer
Request Body schema: application/json
required

Product object that needs to be added to the system

Array
object (MainDetails)
object (Unit)
object (Inner)
object (Master)
object (Pallet)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
"NBj90"

Variant/CREATE

This endpoint allows you to create a new variant product in the system.Supply the masterProductId of the master product you would like to link to this product as well as all required fields, including barcode type id, barcode number, vendor product code etc. When all fields are populated it creates the Single Unit Product, Inner Pack Product, Outer Pack / Master Product & Pallet Product. A successful operation returns the created product id with a list of ids for each hierarchy level as well.

Authorizations:
Bearer
Request Body schema: application/json
required

Product object that needs to be added to the system

Array
masterProductId
string

This is the ID of the Master Product record will be linked to this Product creating a Variant of that Master Product. A Master Product is the first instance of a specific product and you can think of it as a parent record of that product line

object (MainDetails)
object (Unit)
object (Inner)
object (Master)
object (Pallet)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
"NBj90"

PROCESS

This endpoint allows you to check the progress of the Master or Variant Products that have been created by the system. You get an ID back from either the Master/CREATE endpoint or Variant/CREATE endpoint then use that ID to check what products have been created.

Authorizations:
Bearer
path Parameters
integrationId
required
string
Example: KlM89

This is the ID you got from either Master/CREATE or Variant/CREATE

Responses

Response samples

Content type
application/json
[
  • {
    }
]