Repzo API - Product (1.0.0)

Download OpenAPI specification:Download

OpenAPI specification for Repzo Product endpoints.

Find products

query Parameters

params

object

Query parameters for filtering products

Responses

Response samples

Content type

application/json

{"data": [{"_id": "string",
"name": "string",
"category": "string",
"active": true,
"company_namespace": ["string"
],
"local_name": "string",
"sku": "string",
"sub_category": ["string"
],
"assigned_to": ["string"
],
"auditable": true,
"barcode": "string",
"sv_tax": "string",
"sv_measureUnit": "string",
"description": "string",
"local_description": "string",
"product_img": "string",
"base_price": "string",
"assigned_media": ["string"
],
"html_description": "string",
"modifiers_group": ["string"
],
"featured": true,
"brand": "string",
"rsp": 0,
"measureunit_family": "string",
"integration_meta": { },
"teams": ["string"
],
"position": 0,
"product_groups": ["string"
],
"frozen_pre_sales": true,
"frozen_sales": true,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}
],
"total_result": 0,
"current_count": 0,
"total_pages": 0,
"current_page": 0,
"per_page": 0,
"first_page_url": "string",
"last_page_url": "string",
"next_page_url": "string",
"prev_page_url": "string",
"path": "string"
}

Create a product

Request Body schema: application/json

name required	string Name of the product
category required	string ID of the product category
active	boolean Whether the product is active
company_namespace	Array of strings Company namespaces
local_name	string Localized name of the product
sku	string Stock keeping unit
sub_category	Array of strings IDs of the product sub-categories
assigned_to	Array of strings Representatives assigned to this product
auditable	boolean Whether the product is auditable
barcode	string Barcode of the product
sv_tax	string ID of the tax
sv_measureUnit	string ID of the measure unit
description	string Description of the product
local_description	string Localized description of the product
product_img	string Product image URL
base_price	string Base price of the product
assigned_media	Array of strings Media assigned to this product
html_description	string HTML description of the product
modifiers_group	Array of strings Modifier groups for the product
featured	boolean Whether the product is featured
brand	string ID of the brand
rsp	number Recommended selling price
measureunit_family	string ID of the measure unit family
	object Integration metadata
teams	Array of strings Teams
position	number Position of the product
product_groups	Array of strings Product groups
frozen_pre_sales	boolean Whether pre-sales are frozen
frozen_sales	boolean Whether sales are frozen
	Array of objects (VariantCreateBody) List of variants for this product

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"category": "string",
"active": true,
"company_namespace": ["string"
],
"local_name": "string",
"sku": "string",
"sub_category": ["string"
],
"assigned_to": ["string"
],
"auditable": true,
"barcode": "string",
"sv_tax": "string",
"sv_measureUnit": "string",
"description": "string",
"local_description": "string",
"product_img": "string",
"base_price": "string",
"assigned_media": ["string"
],
"html_description": "string",
"modifiers_group": ["string"
],
"featured": true,
"brand": "string",
"rsp": 0,
"measureunit_family": "string",
"integration_meta": { },
"teams": ["string"
],
"position": 0,
"product_groups": ["string"
],
"frozen_pre_sales": true,
"frozen_sales": true,
"variants": [{"name": "string",
"product": "string",
"price": 0,
"company_namespace": ["string"
],
"disabled": true,
"uuid": "string",
"local_name": "string",
"sku": "string",
"barcode": "string",
"weight": 0,
"length": 0,
"width": 0,
"height": 0,
"position": 0,
"default": true,
"variant_img": "string",
"modifiers_groups": ["string"
],
"integration_meta": { }
}
]
}

Response samples

Content type

application/json

{"_id": "string",
"name": "string",
"category": "string",
"active": true,
"company_namespace": ["string"
],
"local_name": "string",
"sku": "string",
"sub_category": ["string"
],
"assigned_to": ["string"
],
"auditable": true,
"barcode": "string",
"sv_tax": "string",
"sv_measureUnit": "string",
"description": "string",
"local_description": "string",
"product_img": "string",
"base_price": "string",
"assigned_media": ["string"
],
"html_description": "string",
"modifiers_group": ["string"
],
"featured": true,
"brand": "string",
"rsp": 0,
"measureunit_family": "string",
"integration_meta": { },
"teams": ["string"
],
"position": 0,
"product_groups": ["string"
],
"frozen_pre_sales": true,
"frozen_sales": true,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Get a product by ID

path Parameters

required

string

Responses

Response samples

Content type

application/json

{"_id": "string",
"name": "string",
"category": "string",
"active": true,
"company_namespace": ["string"
],
"local_name": "string",
"sku": "string",
"sub_category": ["string"
],
"assigned_to": ["string"
],
"auditable": true,
"barcode": "string",
"sv_tax": "string",
"sv_measureUnit": "string",
"description": "string",
"local_description": "string",
"product_img": "string",
"base_price": "string",
"assigned_media": ["string"
],
"html_description": "string",
"modifiers_group": ["string"
],
"featured": true,
"brand": "string",
"rsp": 0,
"measureunit_family": "string",
"integration_meta": { },
"teams": ["string"
],
"position": 0,
"product_groups": ["string"
],
"frozen_pre_sales": true,
"frozen_sales": true,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Update a product

path Parameters

required

string

Request Body schema: application/json

name	string Name of the product
category	string ID of the product category
active	boolean Whether the product is active
company_namespace	Array of strings Company namespaces
local_name	string Localized name of the product
sku	string Stock keeping unit
sub_category	Array of strings IDs of the product sub-categories
assigned_to	Array of strings Representatives assigned to this product
auditable	boolean Whether the product is auditable
barcode	string Barcode of the product
sv_tax	string ID of the tax
sv_measureUnit	string ID of the measure unit
description	string Description of the product
local_description	string Localized description of the product
product_img	string Product image URL
base_price	string Base price of the product
assigned_media	Array of strings Media assigned to this product
html_description	string HTML description of the product
modifiers_group	Array of strings Modifier groups for the product
featured	boolean Whether the product is featured
brand	string ID of the brand
rsp	number Recommended selling price
measureunit_family	string ID of the measure unit family
	object Integration metadata
teams	Array of strings Teams
position	number Position of the product
product_groups	Array of strings Product groups
frozen_pre_sales	boolean Whether pre-sales are frozen
frozen_sales	boolean Whether sales are frozen
_id	string Unique identifier for the product
createdAt	string <date-time> Creation timestamp
updatedAt	string <date-time> Last update timestamp
__v	number Version number
	Array of objects List of variants for this product

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"category": "string",
"active": true,
"company_namespace": ["string"
],
"local_name": "string",
"sku": "string",
"sub_category": ["string"
],
"assigned_to": ["string"
],
"auditable": true,
"barcode": "string",
"sv_tax": "string",
"sv_measureUnit": "string",
"description": "string",
"local_description": "string",
"product_img": "string",
"base_price": "string",
"assigned_media": ["string"
],
"html_description": "string",
"modifiers_group": ["string"
],
"featured": true,
"brand": "string",
"rsp": 0,
"measureunit_family": "string",
"integration_meta": { },
"teams": ["string"
],
"position": 0,
"product_groups": ["string"
],
"frozen_pre_sales": true,
"frozen_sales": true,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0,
"variants": [{"name": "string",
"product": "string",
"price": 0,
"company_namespace": ["string"
],
"disabled": true,
"uuid": "string",
"local_name": "string",
"sku": "string",
"barcode": "string",
"weight": 0,
"length": 0,
"width": 0,
"height": 0,
"position": 0,
"default": true,
"variant_img": "string",
"modifiers_groups": ["string"
],
"integration_meta": { },
"_id": "string"
}
]
}

Response samples

Content type

application/json

{"_id": "string",
"name": "string",
"category": "string",
"active": true,
"company_namespace": ["string"
],
"local_name": "string",
"sku": "string",
"sub_category": ["string"
],
"assigned_to": ["string"
],
"auditable": true,
"barcode": "string",
"sv_tax": "string",
"sv_measureUnit": "string",
"description": "string",
"local_description": "string",
"product_img": "string",
"base_price": "string",
"assigned_media": ["string"
],
"html_description": "string",
"modifiers_group": ["string"
],
"featured": true,
"brand": "string",
"rsp": 0,
"measureunit_family": "string",
"integration_meta": { },
"teams": ["string"
],
"position": 0,
"product_groups": ["string"
],
"frozen_pre_sales": true,
"frozen_sales": true,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Remove a product

path Parameters

required

string

Responses

Response samples

Content type

application/json

{"_id": "string",
"name": "string",
"category": "string",
"active": true,
"company_namespace": ["string"
],
"local_name": "string",
"sku": "string",
"sub_category": ["string"
],
"assigned_to": ["string"
],
"auditable": true,
"barcode": "string",
"sv_tax": "string",
"sv_measureUnit": "string",
"description": "string",
"local_description": "string",
"product_img": "string",
"base_price": "string",
"assigned_media": ["string"
],
"html_description": "string",
"modifiers_group": ["string"
],
"featured": true,
"brand": "string",
"rsp": 0,
"measureunit_family": "string",
"integration_meta": { },
"teams": ["string"
],
"position": 0,
"product_groups": ["string"
],
"frozen_pre_sales": true,
"frozen_sales": true,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}