v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

List all products of a center

This API helps you to retrieve all the products that are active in the center on the specified date.

You must specify the unique identifier of the center as center_id in the API request. API helps you to retrieve all the employees that are active in the center on the specified date.

You must specify the unique identifier of the center as center_id in the API request. You can also leverage the pagination feature by passing page and size query parameters if you have a large number of records to be displayed. By default, page is set as 1 and size is set as 10. size cannot be more than 100: which means that the maximum records per page cannot be more than 100.

get/v1/centers/{center_id}/products

Path parameters

center_idstring required

Mandatory Unique 32-character identifier of the center.

Query parameters

pageinteger

Optional Number of the display page. Default value is 1.

sizeinteger

Optional Number of records per page. Default value is 10.

show_in_catalogboolean

Optional Indicates whether the product is displayed on the Catalog tab.

Response

200

Example response

{
  "products": [
    {
      "id": "fb604f5d-bc3a-45c9-816b-0f214b69bd69",
      "code": "002003",
      "name": "Body Icing Inclusive",
      "category_id": "7779e4f2-dfa6-4b8c-b296-126c6ce15b6d",
      "sub_category_id": "93748cc4-b3a2-4234-a407-7cecf38314b3",
      "bussiness_unit_id": "2bea39e4-e57a-4fb9-87af-f9e9721488e5",
      "quantity": {
        "value": 1000,
        "unit": "ml"
      },
      "commission": {
        "eligible": true,
        "value": 100
      },
      "preferences": {
        "consumable": true,
        "retail": true
      },
      "barcodes": [
        {
          "value": "00P003"
        }
      ],
      "tags": [
        "036fae06-6455-46ae-9c4a-028b7d1d8844"
      ],
      "catalog_info": {
        "show_in_catalog": true,
        "display_name": "@#%&()_+-}{[]',./"
      },
      "centers": [
        {
          "center_id": "7aac6915-9252-4dbf-bbff-028e41836ea8",
          "center_code": "CHN",
          "sale_info": {
            "currency_id": 148,
            "include_tax": true,
            "tax_id": "a3ace661-6102-44aa-9888-204dc7b59bfa",
            "sale_price": 1500
          },
          "inventory_info": {
            "transfer_tax_id": "f82482dc-bf92-460d-acb6-1cdc1861d113"
          }
        }
      ]
    }
  ],
  "page_info": {
    "total": 27,
    "page": 1,
    "size": 10
  }
}