API / Product
Use case / Master data sync

Create Product

Changed on

Create a new product in a product type.

post/v1/products/product

Request

  • Base URL: https://api.qargo.com
  • URL: https://api.qargo.com/v1/products/product
  • Auth: OAuth 2 (client credentials, token URL /v1/auth/token)

Request body

codestring

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

descriptionstring

Free-text description of the product.

namestring required

Name of the product.

Example request

{
  "code": "UN1090",
  "description": "Acetone, flammable liquid",
  "name": "Acetone"
}

Response

Successful Response

codestring

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

descriptionstring

Free-text description of the product.

idstring uuid required

Unique identifier of the product.

namestring required

Name of the product.

is_archivedboolean required

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

Example response

{
  "code": "UN1090",
  "description": "Acetone, flammable liquid",
  "name": "Acetone",
  "product_type": {
    "name": "Chemicals",
    "code": "CHEM"
  },
  "parent_product": {
    "name": "Acetone",
    "code": "UN1090"
  }
}

Changes