Skip to content

Create Product Type

Request

Create a new product type.

Security
oAuth2ClientCredentials
Bodyapplication/jsonrequired
codestring, <= 255 characters(Code)

Code of the product type. Use it as the reference to the product type in your system.

Default:""
Example:"CHEM"
descriptionstring, <= 255 characters(Description)

Free-text description of the product type.

Default:""
Example:"Chemical waste products"
namestring, <= 255 characters(Name)required

Name of the product type.

Example:"Chemicals"
transport_servicesArray of objects or null(Transport Services)
Any of:

Transport services to link the product type to. Its products are only matched on orders for these transport services. When sent, this list replaces the current links: links not in the list are removed. Omit it to keep the current links.

{
  "code": "CHEM",
  "description": "Chemical waste products",
  "name": "Chemicals",
  "transport_services": [
    { … }
  ]
}

Responses

Successful Response

Bodyapplication/json
codestring, <= 255 characters(Code)

Code of the product type. Use it as the reference to the product type in your system.

Default:""
Example:"CHEM"
descriptionstring, <= 255 characters(Description)

Free-text description of the product type.

Default:""
Example:"Chemical waste products"
idstring, (uuid)(Id)required

Unique identifier of the product type.

namestring(Name)required

Name of the product type.

Example:"Chemicals"
is_archivedboolean(Is Archived)required

Whether the product type is archived. Archived product types and their products can't be used on new orders.

transport_servicesArray of objects(Transport Services)

Transport services the product type is linked to. Its products are only matched on orders for these transport services.

Response
{
  "code": "CHEM",
  "description": "Chemical waste products",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "Chemicals",
  "is_archived": true,
  "transport_services": [
    { … }
  ]
}