Product API
The Product resource stores information about a product and its variants.
Index
- Product API
- Index
- Representations
- Product
- Product Variant
- REST Endpoints
- Product Service
- Create a Product
- Update a Product
- Update a Product By ID
- Update a Product By Prodref
- Look up Product by gtin/productRef
- Find Product by ID
- Delete Product by ID
- Find Product by Ref
- Delete Product by Ref
- Product Variant Service
- Create a Product Variant
- Update a Product Variant
- Update a Product Variant By ID
- Update a Product Variant By Variant Ref
- Find Product Variant by ID
- Find Product Variant by Ref
- Delete Product variant by Ref
- Find Product variants by productId
- Find Product variants by productId
- Delete Product variants by product Id/variantId
- Upload Product Variants
Representations
All requests or responses are JSON objects.
Product
Represents a product.
active - boolean - Used by Shopify to indicate a product is enabled. Depreciated field in TWC
additionalImageLink - string - Additional image link (URL).
additionalImageLink2 - string - Second additional image link (URL) for product.
attributeGroups - AttributeGroup - An optional group of attibute values stored under as a object in the group “attributeGroups”.
availability - string - Product Availablity. Should be one of:
- available
- preorder
- disabled
availabilityDescription - String- Product availability description.
brandId - string - Product brand identifier.
brandName - string - Product brand name.
calculatedPrice - number - Product calculated price.
color - string - Product Color.
condition - String - Product Condition - can be any of the values:
- New
- Used
- Refurbished
cost- number - Product’s Cost
defaultVariant - string - Default variant for the Product.
deleted - boolean
description - string
digitalProduct - Indicates if the product is digital only
disabled -
expirationDate -
featured - boolean
gtin -
gtinType -
- GTIN8
- GTIN12
- GTIN13
- ITF
- MPN
- UPC
- JAN
- EAN
- GTIN14
id - string -
imageLink - string - Main image link (URL) for the product.
inventoryLevel - integer -
inventoryTracking - string -
- none
- product
- variant
isbn - string -
link - string -
maxOrderQuantity -
minOrderQuantity -
backInStockThreshold - Minimum stock level valve where a product or variant is considered to be back in stock.
lowStockThreshold - Minimum stock level valve where a product or variant is considered to be in low stock.
mobileLink -
physicalSpecs - PhysicalSpecifications -
productRef - string - Mandatory field. The customer’s unique identifier for the product (e.g. UPC)
status -
- APPROVED
- UNAPPROVED
- CHECK
- VERIFICATION_PENDING
- ACTIVE
- ARCHIVED
- DRAFT
- QUIT
- DISCONTINUED
title - string -
variance - The array for vaiants.
variantOptions - VariantOptions - Array of variant Options.
variants - productVariants - Array of variant Options.
variantsAvailable - boolean -
createdDate - The date and time (ISO 8601 format) when the product record was created.
lastModifiedDate - The date and time (ISO 8601 format) when the product information was last updated.
additionalImageLink2 - string -
swatchImageLink - string -
backOrderable - boolean -
supplier - string -
category - string -
range - string -
Product Variant
Represents a product Variant.
active - boolean - To enable a product variant.
additionalImageLink - string - Image link.
attributeGroups - AttributeGroup - The group of attibute values stored as an object in group of atributeGroups.
availability - string - Product Availablity and value should be one of the below values.
- available
- preorder
- disabled
availabilityDescription - String- In detailed
of the product availability.
baseProductId - string - Base Product Id.
baseProductRef - string - Base Product Name.
brandId - string - Product brand Id.
brandName - string - Product brand Name.
calculatedPrice - number - Product calculated price.
color - string - Product Color.
condition - String - Product Condition. Should be any of the below values.
- New
- Used
- Refurbished
cost- number - Product’s Cost
defaultVariant - string - Default variant for the Product.
deleted - boolean
description - string
digitalProduct -
disabled -
expirationDate -
featured - boolean
gtin -
gtinType -
- GTIN8
- GTIN12
- GTIN13
- ITF
- MPN
- UPC
- JAN
- EAN
- GTIN14
id - string -
imageLink - string -
inventoryLevel - integer -
inventoryTracking - string -
- none
- product
- variant
isbn - string -
link - string -
maxOrderQuantity -
minOrderQuantity -
mobileLink -
physicalSpecs - PhysicalSpecifications -
productRef - string - A mandatory field
status -
- APPROVED
- UNAPPROVED
- CHECK
- VERIFICATION_PENDING
- ACTIVE
- ARCHIVED
- DRAFT
- QUIT
- DISCONTINUED
stock - Stock
title - string - Title
variance - The array for vaiants.
variantOptions - VariantOptions - Array of variant Options.
createdDate - The date and time (ISO 8601 format) when the customer was created.
lastModifiedDate - The date and time (ISO 8601 format) when the customer information was last updated.
additionalImageLink2 - string -
swatchImageLink - string -
REST Endpoints
Product Service
Create a Product
Creates a new Product data set in the TWC system.
Please note that it is mandatory for you to include a productRef (your own internal product identifier).
Endpoint: /api/v2/products
Method: POST
OAuth 2.0 Scopes: Tenant authentication - authentication
| Key | Value |
|---|---|
| Content-Type | application/json |
| Authorization | {Bearer token} |
| X-TWC-Tenant | {Tenant Name} |
{
"active": true,
"additionalImageLink": "string",
"attributeGroups": {
"additionalProp1": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
},
"additionalProp2": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
},
"additionalProp3": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
}
},
"availability": "available",
"availabilityDescription": "string",
"brandId": "string",
"brandName": "string",
"calculatedPrice": 0,
"color": "string",
"condition": "New",
"cost": 0,
"defaultVariant": "string",
"deleted": true,
"description": "string",
"digitalProduct": true,
"disabled": true,
"expirationDate": "2022-06-20T11:25:28.525Z",
"featured": true,
"gtin": "string",
"gtinType": "GTIN8",
"imageLink": "string",
"inventoryLevel": 0,
"inventoryTracking": "none",
"isbn": "string",
"link": "string",
"maxOrderQuantity": 0,
"minOrderQuantity": 0,
"backInStockThreshold":0,
"lowStockThreshold": 0,
"mobileLink": "string",
"physicalSpecs": {
"dimensionUnitCode": "string",
"dimensionUnitName": "string",
"maxDepth": 0,
"maxHeight": 0,
"maxWeight": 0,
"maxWidth": 0,
"minWeight": 0,
"weightUnitCode": "string",
"weightUnitName": "string"
},
"productRef": "string",
"status": "APPROVED",
"title": "string",
"variance": [
"string"
],
"variantOptions": [
{
"optionId": "string",
"optionName": "string"
}
],
"variantsAvailable": true
}
{
"active": true,
"additionalImageLink": "string",
"attributeGroups": {
"additionalProp1": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
},
"additionalProp2": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
},
"additionalProp3": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
}
},
"availability": "available",
"availabilityDescription": "string",
"brandId": "string",
"brandName": "string",
"calculatedPrice": 0,
"color": "string",
"condition": "New",
"cost": 0,
"defaultVariant": "string",
"deleted": true,
"description": "string",
"digitalProduct": true,
"disabled": true,
"expirationDate": "2022-06-21T05:56:37.582Z",
"featured": true,
"gtin": "string",
"gtinType": "GTIN8",
"id": "string",
"imageLink": "string",
"inventoryLevel": 0,
"inventoryTracking": "none",
"isbn": "string",
"link": "string",
"maxOrderQuantity": 0,
"minOrderQuantity": 0,
"backInStockThreshold":0,
"lowStockThreshold": 0,
"mobileLink": "string",
"physicalSpecs": {
"dimensionUnitCode": "string",
"dimensionUnitName": "string",
"maxDepth": 0,
"maxHeight": 0,
"maxWeight": 0,
"maxWidth": 0,
"minWeight": 0,
"weightUnitCode": "string",
"weightUnitName": "string"
},
"productRef": "string",
"status": "APPROVED",
"title": "string",
"variance": [
"string"
],
"variantOptions": [
{
"optionId": "string",
"optionName": "string"
}
],
"variants": [
{
"active": true,
"additionalImageLink": "string",
"attributeGroups": {
"additionalProp1": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
},
"additionalProp2": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
},
"additionalProp3": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
}
},
"availability": "available",
"availabilityDescription": "string",
"baseProductId": "string",
"baseProductRef": "string",
"brandId": "string",
"brandName": "string",
"calculatedPrice": 0,
"color": "string",
"condition": "New",
"cost": 0,
"defaultVariant": "string",
"deleted": true,
"description": "string",
"digitalProduct": true,
"disabled": true,
"expirationDate": "2022-06-21T05:56:37.582Z",
"featured": true,
"gtin": "string",
"gtinType": "GTIN8",
"id": "string",
"imageLink": "string",
"inventoryLevel": 0,
"inventoryTracking": "none",
"isbn": "string",
"link": "string",
"maxOrderQuantity": 0,
"minOrderQuantity": 0,
"backInStockThreshold":0,
"lowStockThreshold": 0,
"mobileLink": "string",
"physicalSpecs": {
"dimensionUnitCode": "string",
"dimensionUnitName": "string",
"maxDepth": 0,
"maxHeight": 0,
"maxWeight": 0,
"maxWidth": 0,
"minWeight": 0,
"weightUnitCode": "string",
"weightUnitName": "string"
},
"productRef": "string",
"status": "APPROVED",
"stock": {
"stockLevels": [
{
"locationRef": "string",
"locationid": "string",
"stock": "string"
}
],
"totalStock": "string"
},
"title": "string",
"variance": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"variantOptions": [
{
"optionDefaultImage": "string",
"optionId": "string",
"optionLabel": "string",
"optionValue": "string",
"optionsImageId": "string"
}
],
"createdDate": "2022-08-31T04:46:13.275Z",
"lastModifiedDate": "2022-08-31T04:48:33.731Z"
}
],
"variantsAvailable": true,
"createdDate": "2022-08-31T04:46:13.275Z",
"lastModifiedDate": "2022-08-31T04:48:33.731Z"
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request unable to create customer
- 401 Unauthorized,
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Update a Product
Update Product data set in the TWC system.
Endpoint: /api/v2/products
Method: PUT
OAuth 2.0 Scopes: Tenant authentication - authentication
| Key | Value |
|---|---|
| Content-Type | application/json |
| Authorization | {Bearer token} |
| X-TWC-Tenant | {Tenant Name} |
{
"active": true,
"additionalImageLink": "string",
"attributeGroups": {
"additionalProp1": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
},
"additionalProp2": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
},
"additionalProp3": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
}
},
"availability": "available",
"availabilityDescription": "string",
"brandId": "string",
"brandName": "string",
"calculatedPrice": 0,
"color": "string",
"condition": "New",
"cost": 0,
"defaultVariant": "string",
"deleted": true,
"description": "string",
"digitalProduct": true,
"disabled": true,
"expirationDate": "2022-06-20T14:22:00.119Z",
"featured": true,
"gtin": "string",
"gtinType": "GTIN8",
"id": "string",
"imageLink": "string",
"inventoryLevel": 0,
"inventoryTracking": "none",
"isbn": "string",
"link": "string",
"maxOrderQuantity": 0,
"minOrderQuantity": 0,
"backInStockThreshold":0,
"lowStockThreshold": 0,
"mobileLink": "string",
"physicalSpecs": {
"dimensionUnitCode": "string",
"dimensionUnitName": "string",
"maxDepth": 0,
"maxHeight": 0,
"maxWeight": 0,
"maxWidth": 0,
"minWeight": 0,
"weightUnitCode": "string",
"weightUnitName": "string"
},
"productRef": "string",
"status": "APPROVED",
"title": "string",
"variance": [
"string"
],
"variantOptions": [
{
"optionId": "string",
"optionName": "string"
}
],
"variants": [
{
"active": true,
"additionalImageLink": "string",
"attributeGroups": {
"additionalProp1": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
},
"additionalProp2": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
},
"additionalProp3": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
}
},
"availability": "available",
"availabilityDescription": "string",
"baseProductId": "string",
"baseProductRef": "string",
"brandId": "string",
"brandName": "string",
"calculatedPrice": 0,
"color": "string",
"condition": "New",
"cost": 0,
"defaultVariant": "string",
"deleted": true,
"description": "string",
"digitalProduct": true,
"disabled": true,
"expirationDate": "2022-06-20T14:22:00.119Z",
"featured": true,
"gtin": "string",
"gtinType": "GTIN8",
"id": "string",
"imageLink": "string",
"inventoryLevel": 0,
"inventoryTracking": "none",
"isbn": "string",
"link": "string",
"maxOrderQuantity": 0,
"minOrderQuantity": 0,
"backInStockThreshold":0,
"lowStockThreshold": 0,
"mobileLink": "string",
"physicalSpecs": {
"dimensionUnitCode": "string",
"dimensionUnitName": "string",
"maxDepth": 0,
"maxHeight": 0,
"maxWeight": 0,
"maxWidth": 0,
"minWeight": 0,
"weightUnitCode": "string",
"weightUnitName": "string"
},
"productRef": "string",
"status": "APPROVED",
"stock": {
"stockLevels": [
{
"locationRef": "string",
"locationid": "string",
"stock": "string"
}
],
"totalStock": "string"
},
"title": "string",
"variance": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"variantOptions": [
{
"optionDefaultImage": "string",
"optionId": "string",
"optionLabel": "string",
"optionValue": "string",
"optionsImageId": "string"
}
]
}
],
"variantsAvailable": true
}
{
"active": true,
"additionalImageLink": "string",
"attributeGroups": {
"additionalProp1": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
},
"additionalProp2": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
},
"additionalProp3": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
}
},
"availability": "available",
"availabilityDescription": "string",
"brandId": "string",
"brandName": "string",
"calculatedPrice": 0,
"color": "string",
"condition": "New",
"cost": 0,
"defaultVariant": "string",
"deleted": true,
"description": "string",
"digitalProduct": true,
"disabled": true,
"expirationDate": "2022-06-22T07:32:52.279Z",
"featured": true,
"gtin": "string",
"gtinType": "GTIN8",
"id": "string",
"imageLink": "string",
"inventoryLevel": 0,
"inventoryTracking": "none",
"isbn": "string",
"link": "string",
"maxOrderQuantity": 0,
"minOrderQuantity": 0,
"backInStockThreshold":0,
"lowStockThreshold": 0,
"mobileLink": "string",
"physicalSpecs": {
"dimensionUnitCode": "string",
"dimensionUnitName": "string",
"maxDepth": 0,
"maxHeight": 0,
"maxWeight": 0,
"maxWidth": 0,
"minWeight": 0,
"weightUnitCode": "string",
"weightUnitName": "string"
},
"productRef": "string",
"status": "APPROVED",
"title": "string",
"variance": [
"string"
],
"variantOptions": [
{
"optionId": "string",
"optionName": "string"
}
],
"variants": [
{
"active": true,
"additionalImageLink": "string",
"attributeGroups": {
"additionalProp1": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
},
"additionalProp2": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
},
"additionalProp3": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
}
},
"availability": "available",
"availabilityDescription": "string",
"baseProductId": "string",
"baseProductRef": "string",
"brandId": "string",
"brandName": "string",
"calculatedPrice": 0,
"color": "string",
"condition": "New",
"cost": 0,
"defaultVariant": "string",
"deleted": true,
"description": "string",
"digitalProduct": true,
"disabled": true,
"expirationDate": "2022-06-22T07:32:52.279Z",
"featured": true,
"gtin": "string",
"gtinType": "GTIN8",
"id": "string",
"imageLink": "string",
"inventoryLevel": 0,
"inventoryTracking": "none",
"isbn": "string",
"link": "string",
"maxOrderQuantity": 0,
"minOrderQuantity": 0,
"backInStockThreshold":0,
"lowStockThreshold": 0,
"mobileLink": "string",
"physicalSpecs": {
"dimensionUnitCode": "string",
"dimensionUnitName": "string",
"maxDepth": 0,
"maxHeight": 0,
"maxWeight": 0,
"maxWidth": 0,
"minWeight": 0,
"weightUnitCode": "string",
"weightUnitName": "string"
},
"productRef": "string",
"status": "APPROVED",
"stock": {
"stockLevels": [
{
"locationRef": "string",
"locationid": "string",
"stock": "string"
}
],
"totalStock": "string"
},
"title": "string",
"variance": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"variantOptions": [
{
"optionDefaultImage": "string",
"optionId": "string",
"optionLabel": "string",
"optionValue": "string",
"optionsImageId": "string"
}
],
"createdDate": "2022-08-31T04:46:13.275Z",
"lastModifiedDate": "2022-08-31T04:48:33.731Z"
}
],
"variantsAvailable": true,
"createdDate": "2022-08-31T04:46:13.275Z",
"lastModifiedDate": "2022-08-31T04:48:33.731Z"
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request unable to create customer
- 401 Unauthorized,
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Find products by gtin (sku) or productRef
Returns a list of products from a specific Store while passing the gtin (SKU) or productRef as a query parameters in the endpoint. If the products does not exist, this method returns a empty list.
Endpoint: /api/v2/products/lookup
Method: GET
OAuth 2.0 Scopes: Tenant authentication - authentication
| Key | Value |
|---|---|
| Content-Type | application/json |
| Authorization | {Bearer token} |
| X-TWC-Tenant | {Tenant Name} |
- {gtin}
- {productRef}
{
"products": [
{
"active": true,
"additionalImageLink": "string",
"attributeGroups": {
"additionalProp1": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
},
"additionalProp2": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
},
"additionalProp3": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
}
},
"availability": "available",
"availabilityDescription": "string",
"brandId": "string",
"brandName": "string",
"calculatedPrice": 0,
"color": "string",
"condition": "New",
"cost": 0,
"defaultVariant": "string",
"deleted": true,
"description": "string",
"digitalProduct": true,
"disabled": true,
"expirationDate": "2022-06-21T05:58:10.365Z",
"featured": true,
"gtin": "string",
"gtinType": "GTIN8",
"id": "string",
"imageLink": "string",
"inventoryLevel": 0,
"inventoryTracking": "none",
"isbn": "string",
"link": "string",
"maxOrderQuantity": 0,
"minOrderQuantity": 0,
"backInStockThreshold":0,
"lowStockThreshold": 0,
"mobileLink": "string",
"physicalSpecs": {
"dimensionUnitCode": "string",
"dimensionUnitName": "string",
"maxDepth": 0,
"maxHeight": 0,
"maxWeight": 0,
"maxWidth": 0,
"minWeight": 0,
"weightUnitCode": "string",
"weightUnitName": "string"
},
"productRef": "string",
"status": "APPROVED",
"title": "string",
"variance": [
"string"
],
"variantOptions": [
{
"optionId": "string",
"optionName": "string"
}
],
"variants": [
{
"active": true,
"additionalImageLink": "string",
"attributeGroups": {
"additionalProp1": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
},
"additionalProp2": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
},
"additionalProp3": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
}
},
"availability": "available",
"availabilityDescription": "string",
"baseProductId": "string",
"baseProductRef": "string",
"brandId": "string",
"brandName": "string",
"calculatedPrice": 0,
"color": "string",
"condition": "New",
"cost": 0,
"defaultVariant": "string",
"deleted": true,
"description": "string",
"digitalProduct": true,
"disabled": true,
"expirationDate": "2022-06-21T05:58:10.365Z",
"featured": true,
"gtin": "string",
"gtinType": "GTIN8",
"id": "string",
"imageLink": "string",
"inventoryLevel": 0,
"inventoryTracking": "none",
"isbn": "string",
"link": "string",
"maxOrderQuantity": 0,
"minOrderQuantity": 0,
"backInStockThreshold":0,
"lowStockThreshold": 0,
"mobileLink": "string",
"physicalSpecs": {
"dimensionUnitCode": "string",
"dimensionUnitName": "string",
"maxDepth": 0,
"maxHeight": 0,
"maxWeight": 0,
"maxWidth": 0,
"minWeight": 0,
"weightUnitCode": "string",
"weightUnitName": "string"
},
"productRef": "string",
"status": "APPROVED",
"stock": {
"stockLevels": [
{
"locationRef": "string",
"locationid": "string",
"stock": "string"
}
],
"totalStock": "string"
},
"title": "string",
"variance": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"variantOptions": [
{
"optionDefaultImage": "string",
"optionId": "string",
"optionLabel": "string",
"optionValue": "string",
"optionsImageId": "string"
}
],
"createdDate": "2022-08-31T04:46:13.275Z",
"lastModifiedDate": "2022-08-31T04:48:33.731Z"
}
],
"variantsAvailable": true,
"createdDate": "2022-08-31T04:46:13.275Z",
"lastModifiedDate": "2022-08-31T04:48:33.731Z"
}
],
"variants": [
{
"active": true,
"additionalImageLink": "string",
"attributeGroups": {
"additionalProp1": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
},
"additionalProp2": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
},
"additionalProp3": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
}
},
"availability": "available",
"availabilityDescription": "string",
"baseProductId": "string",
"baseProductRef": "string",
"brandId": "string",
"brandName": "string",
"calculatedPrice": 0,
"color": "string",
"condition": "New",
"cost": 0,
"defaultVariant": "string",
"deleted": true,
"description": "string",
"digitalProduct": true,
"disabled": true,
"expirationDate": "2022-06-21T05:58:10.365Z",
"featured": true,
"gtin": "string",
"gtinType": "GTIN8",
"id": "string",
"imageLink": "string",
"inventoryLevel": 0,
"inventoryTracking": "none",
"isbn": "string",
"link": "string",
"maxOrderQuantity": 0,
"minOrderQuantity": 0,
"backInStockThreshold":0,
"lowStockThreshold": 0,
"mobileLink": "string",
"physicalSpecs": {
"dimensionUnitCode": "string",
"dimensionUnitName": "string",
"maxDepth": 0,
"maxHeight": 0,
"maxWeight": 0,
"maxWidth": 0,
"minWeight": 0,
"weightUnitCode": "string",
"weightUnitName": "string"
},
"productRef": "string",
"status": "APPROVED",
"stock": {
"stockLevels": [
{
"locationRef": "string",
"locationid": "string",
"stock": "string"
}
],
"totalStock": "string"
},
"title": "string",
"variance": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"variantOptions": [
{
"optionDefaultImage": "string",
"optionId": "string",
"optionLabel": "string",
"optionValue": "string",
"optionsImageId": "string"
}
],
"createdDate": "2022-08-31T04:46:13.275Z",
"lastModifiedDate": "2022-08-31T04:48:33.731Z"
}
]
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request unable to create customer
- 401 Unauthorized,
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Get Product by ID
Returns a Product by its ID from a specific Store while passing the respective ID as a path variable in the endpoint. If the Product does not exist, this method returns a blank value.
Endpoint: /api/v2/products/{id}
Method: GET
OAuth 2.0 Scopes: Tenant authentication - authentication
| Key | Value |
|---|---|
| Content-Type | application/json |
| Authorization | {Bearer token} |
| X-TWC-Tenant | {Tenant Name} |
- {id}
{
"active": true,
"additionalImageLink": "string",
"attributeGroups": {
"additionalProp1": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
},
"additionalProp2": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
},
"additionalProp3": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
}
},
"availability": "available",
"availabilityDescription": "string",
"brandId": "string",
"brandName": "string",
"calculatedPrice": 0,
"color": "string",
"condition": "New",
"cost": 0,
"defaultVariant": "string",
"deleted": true,
"description": "string",
"digitalProduct": true,
"disabled": true,
"expirationDate": "2022-06-21T06:02:15.257Z",
"featured": true,
"gtin": "string",
"gtinType": "GTIN8",
"id": "string",
"imageLink": "string",
"inventoryLevel": 0,
"inventoryTracking": "none",
"isbn": "string",
"link": "string",
"maxOrderQuantity": 0,
"minOrderQuantity": 0,
"backInStockThreshold":0,
"lowStockThreshold": 0,
"mobileLink": "string",
"physicalSpecs": {
"dimensionUnitCode": "string",
"dimensionUnitName": "string",
"maxDepth": 0,
"maxHeight": 0,
"maxWeight": 0,
"maxWidth": 0,
"minWeight": 0,
"weightUnitCode": "string",
"weightUnitName": "string"
},
"productRef": "string",
"status": "APPROVED",
"title": "string",
"variance": [
"string"
],
"variantOptions": [
{
"optionId": "string",
"optionName": "string"
}
],
"variants": [
{
"active": true,
"additionalImageLink": "string",
"attributeGroups": {
"additionalProp1": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
},
"additionalProp2": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
},
"additionalProp3": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
}
},
"availability": "available",
"availabilityDescription": "string",
"baseProductId": "string",
"baseProductRef": "string",
"brandId": "string",
"brandName": "string",
"calculatedPrice": 0,
"color": "string",
"condition": "New",
"cost": 0,
"defaultVariant": "string",
"deleted": true,
"description": "string",
"digitalProduct": true,
"disabled": true,
"expirationDate": "2022-06-21T06:02:15.257Z",
"featured": true,
"gtin": "string",
"gtinType": "GTIN8",
"id": "string",
"imageLink": "string",
"inventoryLevel": 0,
"inventoryTracking": "none",
"isbn": "string",
"link": "string",
"maxOrderQuantity": 0,
"minOrderQuantity": 0,
"backInStockThreshold":0,
"lowStockThreshold": 0,
"mobileLink": "string",
"physicalSpecs": {
"dimensionUnitCode": "string",
"dimensionUnitName": "string",
"maxDepth": 0,
"maxHeight": 0,
"maxWeight": 0,
"maxWidth": 0,
"minWeight": 0,
"weightUnitCode": "string",
"weightUnitName": "string"
},
"productRef": "string",
"status": "APPROVED",
"stock": {
"stockLevels": [
{
"locationRef": "string",
"locationid": "string",
"stock": "string"
}
],
"totalStock": "string"
},
"title": "string",
"variance": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"variantOptions": [
{
"optionDefaultImage": "string",
"optionId": "string",
"optionLabel": "string",
"optionValue": "string",
"optionsImageId": "string"
}
],
"createdDate": "2022-08-31T04:46:13.275Z",
"lastModifiedDate": "2022-08-31T04:48:33.731Z"
}
],
"variantsAvailable": true,
"createdDate": "2022-08-31T04:46:13.275Z",
"lastModifiedDate": "2022-08-31T04:48:33.731Z"
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request unable to create customer
- 401 Unauthorized,
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Delete Product by ID
Deleting a Product marks the Product as deleted and produces the HTTP response confirming the action. If the Product does not exist, this method returns a empty response.
Endpoint: /api/v2/products/{id}
Method: DELETE
OAuth 2.0 Scopes: Tenant authentication - authentication
| Key | Value |
|---|---|
| Content-Type | application/json |
| Authorization | {Bearer token} |
| X-TWC-Tenant | {Tenant Name} |
- {id}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request unable to create customer
- 401 Unauthorized,
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Delete Product by Ref
Deleting a Product by ref marks the Product as deleted and produces the HTTP response confirming the action. If the product does not exist, this method returns a empty response.
Endpoint: /api/v2/products/{productRef}/byref
Method: DELETE
OAuth 2.0 Scopes: Tenant authentication - authentication
| Key | Value |
|---|---|
| Content-Type | application/json |
| Authorization | {Bearer token} |
| X-TWC-Tenant | {Tenant Name} |
- {productRef}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request unable to create customer
- 401 Unauthorized,
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Add multiple Products
Creates an array of new products.
Endpoint: /api/v2/uploadProducts
Method: POST
OAuth 2.0 Scopes: Tenant authentication - authentication
| Key | Value |
|---|---|
| Content-Type | application/json |
| Authorization | {Bearer token} |
| X-TWC-Tenant | {Tenant Name} |
[
{
"active": true,
"additionalImageLink": "string",
"attributeGroups": {
"additionalProp1": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
},
"additionalProp2": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
},
"additionalProp3": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
}
},
"availability": "available",
"availabilityDescription": "string",
"brandId": "string",
"brandName": "string",
"calculatedPrice": 0,
"color": "string",
"condition": "New",
"cost": 0,
"defaultVariant": "string",
"deleted": true,
"description": "string",
"digitalProduct": true,
"disabled": true,
"expirationDate": "2022-06-21T04:59:19.592Z",
"featured": true,
"gtin": "string",
"gtinType": "GTIN8",
"id": "string",
"imageLink": "string",
"inventoryLevel": 0,
"inventoryTracking": "none",
"isbn": "string",
"link": "string",
"maxOrderQuantity": 0,
"minOrderQuantity": 0,
"backInStockThreshold":0,
"lowStockThreshold": 0,
"mobileLink": "string",
"physicalSpecs": {
"dimensionUnitCode": "string",
"dimensionUnitName": "string",
"maxDepth": 0,
"maxHeight": 0,
"maxWeight": 0,
"maxWidth": 0,
"minWeight": 0,
"weightUnitCode": "string",
"weightUnitName": "string"
},
"productRef": "string",
"status": "APPROVED",
"title": "string",
"variance": [
"string"
],
"variantOptions": [
{
"optionId": "string",
"optionName": "string"
}
],
"variants": [
{
"active": true,
"additionalImageLink": "string",
"attributeGroups": {
"additionalProp1": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
},
"additionalProp2": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
},
"additionalProp3": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
}
},
"availability": "available",
"availabilityDescription": "string",
"baseProductId": "string",
"baseProductRef": "string",
"brandId": "string",
"brandName": "string",
"calculatedPrice": 0,
"color": "string",
"condition": "New",
"cost": 0,
"defaultVariant": "string",
"deleted": true,
"description": "string",
"digitalProduct": true,
"disabled": true,
"expirationDate": "2022-06-21T04:59:19.592Z",
"featured": true,
"gtin": "string",
"gtinType": "GTIN8",
"id": "string",
"imageLink": "string",
"inventoryLevel": 0,
"inventoryTracking": "none",
"isbn": "string",
"link": "string",
"maxOrderQuantity": 0,
"minOrderQuantity": 0,
"backInStockThreshold":0,
"lowStockThreshold": 0,
"mobileLink": "string",
"physicalSpecs": {
"dimensionUnitCode": "string",
"dimensionUnitName": "string",
"maxDepth": 0,
"maxHeight": 0,
"maxWeight": 0,
"maxWidth": 0,
"minWeight": 0,
"weightUnitCode": "string",
"weightUnitName": "string"
},
"productRef": "string",
"status": "APPROVED",
"stock": {
"stockLevels": [
{
"locationRef": "string",
"locationid": "string",
"stock": "string"
}
],
"totalStock": "string"
},
"title": "string",
"variance": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"variantOptions": [
{
"optionDefaultImage": "string",
"optionId": "string",
"optionLabel": "string",
"optionValue": "string",
"optionsImageId": "string"
}
]
}
],
"variantsAvailable": true
}
]
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request unable to create customer
- 401 Unauthorized,
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Product Variant Service
Create a Product Variant
Creates a new Product Variants data set in the TWC system.
Endpoint: /api/v2/products/variants
Method: POST
OAuth 2.0 Scopes: Tenant authentication - authentication
| Key | Value |
|---|---|
| Content-Type | application/json |
| Authorization | {Bearer token} |
| X-TWC-Tenant | {Tenant Name} |
{
"active": true,
"additionalImageLink": "string",
"attributeGroups": {
"additionalProp1": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
},
"additionalProp2": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
},
"additionalProp3": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
}
},
"availability": "available",
"availabilityDescription": "string",
"baseProductId": "string",
"baseProductRef": "string",
"brandId": "string",
"brandName": "string",
"calculatedPrice": 0,
"color": "string",
"condition": "New",
"cost": 0,
"defaultVariant": "string",
"deleted": true,
"description": "string",
"digitalProduct": true,
"disabled": true,
"expirationDate": "2022-06-21T06:11:41.075Z",
"featured": true,
"gtin": "string",
"gtinType": "GTIN8",
"id": "string",
"imageLink": "string",
"inventoryLevel": 0,
"inventoryTracking": "none",
"isbn": "string",
"link": "string",
"maxOrderQuantity": 0,
"minOrderQuantity": 0,
"backInStockThreshold":0,
"lowStockThreshold": 0,
"mobileLink": "string",
"physicalSpecs": {
"dimensionUnitCode": "string",
"dimensionUnitName": "string",
"maxDepth": 0,
"maxHeight": 0,
"maxWeight": 0,
"maxWidth": 0,
"minWeight": 0,
"weightUnitCode": "string",
"weightUnitName": "string"
},
"productRef": "string",
"status": "APPROVED",
"stock": {
"stockLevels": [
{
"locationRef": "string",
"locationid": "string",
"stock": "string"
}
],
"totalStock": "string"
},
"title": "string",
"variance": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"variantOptions": [
{
"optionDefaultImage": "string",
"optionId": "string",
"optionLabel": "string",
"optionValue": "string",
"optionsImageId": "string"
}
]
}
{
"active": true,
"additionalImageLink": "string",
"attributeGroups": {
"additionalProp1": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
},
"additionalProp2": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
},
"additionalProp3": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
}
},
"availability": "available",
"availabilityDescription": "string",
"baseProductId": "string",
"baseProductRef": "string",
"brandId": "string",
"brandName": "string",
"calculatedPrice": 0,
"color": "string",
"condition": "New",
"cost": 0,
"defaultVariant": "string",
"deleted": true,
"description": "string",
"digitalProduct": true,
"disabled": true,
"expirationDate": "2022-06-21T06:11:41.093Z",
"featured": true,
"gtin": "string",
"gtinType": "GTIN8",
"id": "string",
"imageLink": "string",
"inventoryLevel": 0,
"inventoryTracking": "none",
"isbn": "string",
"link": "string",
"maxOrderQuantity": 0,
"minOrderQuantity": 0,
"backInStockThreshold":0,
"lowStockThreshold": 0,
"mobileLink": "string",
"physicalSpecs": {
"dimensionUnitCode": "string",
"dimensionUnitName": "string",
"maxDepth": 0,
"maxHeight": 0,
"maxWeight": 0,
"maxWidth": 0,
"minWeight": 0,
"weightUnitCode": "string",
"weightUnitName": "string"
},
"productRef": "string",
"status": "APPROVED",
"stock": {
"stockLevels": [
{
"locationRef": "string",
"locationid": "string",
"stock": "string"
}
],
"totalStock": "string"
},
"title": "string",
"variance": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"variantOptions": [
{
"optionDefaultImage": "string",
"optionId": "string",
"optionLabel": "string",
"optionValue": "string",
"optionsImageId": "string"
}
],
"createdDate": "2022-08-31T04:46:13.275Z",
"lastModifiedDate": "2022-08-31T04:48:33.731Z"
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request unable to create customer
- 401 Unauthorized,
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Update a Product Variant
Update Product Variant data set in the TWC system.
Endpoint: /api/v2/products/variants
Method: PUT
OAuth 2.0 Scopes: Tenant authentication - authentication
| Key | Value |
|---|---|
| Content-Type | application/json |
| Authorization | {Bearer token} |
| X-TWC-Tenant | {Tenant Name} |
{
"active": true,
"additionalImageLink": "string",
"attributeGroups": {
"additionalProp1": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
},
"additionalProp2": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
},
"additionalProp3": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
}
},
"availability": "available",
"availabilityDescription": "string",
"baseProductId": "string",
"baseProductRef": "string",
"brandId": "string",
"brandName": "string",
"calculatedPrice": 0,
"color": "string",
"condition": "New",
"cost": 0,
"defaultVariant": "string",
"deleted": true,
"description": "string",
"digitalProduct": true,
"disabled": true,
"expirationDate": "2022-06-21T06:12:22.906Z",
"featured": true,
"gtin": "string",
"gtinType": "GTIN8",
"id": "string",
"imageLink": "string",
"inventoryLevel": 0,
"inventoryTracking": "none",
"isbn": "string",
"link": "string",
"maxOrderQuantity": 0,
"minOrderQuantity": 0,
"backInStockThreshold":0,
"lowStockThreshold": 0,
"mobileLink": "string",
"physicalSpecs": {
"dimensionUnitCode": "string",
"dimensionUnitName": "string",
"maxDepth": 0,
"maxHeight": 0,
"maxWeight": 0,
"maxWidth": 0,
"minWeight": 0,
"weightUnitCode": "string",
"weightUnitName": "string"
},
"productRef": "string",
"status": "APPROVED",
"stock": {
"stockLevels": [
{
"locationRef": "string",
"locationid": "string",
"stock": "string"
}
],
"totalStock": "string"
},
"title": "string",
"variance": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"variantOptions": [
{
"optionDefaultImage": "string",
"optionId": "string",
"optionLabel": "string",
"optionValue": "string",
"optionsImageId": "string"
}
]
}
{
"active": true,
"additionalImageLink": "string",
"attributeGroups": {
"additionalProp1": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
},
"additionalProp2": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
},
"additionalProp3": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
}
},
"availability": "available",
"availabilityDescription": "string",
"baseProductId": "string",
"baseProductRef": "string",
"brandId": "string",
"brandName": "string",
"calculatedPrice": 0,
"color": "string",
"condition": "New",
"cost": 0,
"defaultVariant": "string",
"deleted": true,
"description": "string",
"digitalProduct": true,
"disabled": true,
"expirationDate": "2022-06-21T06:12:22.925Z",
"featured": true,
"gtin": "string",
"gtinType": "GTIN8",
"id": "string",
"imageLink": "string",
"inventoryLevel": 0,
"inventoryTracking": "none",
"isbn": "string",
"link": "string",
"maxOrderQuantity": 0,
"minOrderQuantity": 0,
"backInStockThreshold":0,
"lowStockThreshold": 0,
"mobileLink": "string",
"physicalSpecs": {
"dimensionUnitCode": "string",
"dimensionUnitName": "string",
"maxDepth": 0,
"maxHeight": 0,
"maxWeight": 0,
"maxWidth": 0,
"minWeight": 0,
"weightUnitCode": "string",
"weightUnitName": "string"
},
"productRef": "string",
"status": "APPROVED",
"stock": {
"stockLevels": [
{
"locationRef": "string",
"locationid": "string",
"stock": "string"
}
],
"totalStock": "string"
},
"title": "string",
"variance": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"variantOptions": [
{
"optionDefaultImage": "string",
"optionId": "string",
"optionLabel": "string",
"optionValue": "string",
"optionsImageId": "string"
}
],
"createdDate": "2022-08-31T04:46:13.275Z",
"lastModifiedDate": "2022-08-31T04:48:33.731Z"
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request unable to create customer
- 401 Unauthorized,
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Get Variant by Variant ID
Returns a Product Variant by its ID from a specific Store while passing the respective ID as a query param in the endpoint.
If the Product Variant does not exist, this method returns a Blank.
Endpoint: /api/v2/products/variants/{id}
Method: GET
OAuth 2.0 Scopes: Tenant authentication - authentication
| Key | Value |
|---|---|
| Content-Type | application/json |
| Authorization | {Bearer token} |
| X-TWC-Tenant | {Tenant Name} |
- Query Paramters
- {aggregateStock}
- {queryStock}
- Path variables
- {id}
{
"active": true,
"additionalImageLink": "string",
"attributeGroups": {
"additionalProp1": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
},
"additionalProp2": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
},
"additionalProp3": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
}
},
"availability": "available",
"availabilityDescription": "string",
"baseProductId": "string",
"baseProductRef": "string",
"brandId": "string",
"brandName": "string",
"calculatedPrice": 0,
"color": "string",
"condition": "New",
"cost": 0,
"defaultVariant": "string",
"deleted": true,
"description": "string",
"digitalProduct": true,
"disabled": true,
"expirationDate": "2022-06-21T06:14:04.176Z",
"featured": true,
"gtin": "string",
"gtinType": "GTIN8",
"id": "string",
"imageLink": "string",
"inventoryLevel": 0,
"inventoryTracking": "none",
"isbn": "string",
"link": "string",
"maxOrderQuantity": 0,
"minOrderQuantity": 0,
"backInStockThreshold":0,
"lowStockThreshold": 0,
"mobileLink": "string",
"physicalSpecs": {
"dimensionUnitCode": "string",
"dimensionUnitName": "string",
"maxDepth": 0,
"maxHeight": 0,
"maxWeight": 0,
"maxWidth": 0,
"minWeight": 0,
"weightUnitCode": "string",
"weightUnitName": "string"
},
"productRef": "string",
"status": "APPROVED",
"stock": {
"stockLevels": [
{
"locationRef": "string",
"locationid": "string",
"stock": "string"
}
],
"totalStock": "string"
},
"title": "string",
"variance": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"variantOptions": [
{
"optionDefaultImage": "string",
"optionId": "string",
"optionLabel": "string",
"optionValue": "string",
"optionsImageId": "string"
}
],
"createdDate": "2022-08-31T04:46:13.275Z",
"lastModifiedDate": "2022-08-31T04:48:33.731Z"
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request unable to create customer
- 401 Unauthorized,
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Get Variant by Variant Ref
Returns a Product variant by its Ref from a specific Store while passing the respective Ref as a path param in the endpoint. If the Product does not exist, this method returns a blank response.
Endpoint: /api/v2/products/variants/{variantRef}/byref
Method: GET
OAuth 2.0 Scopes: Tenant authentication - authentication
| Key | Value |
|---|---|
| Content-Type | application/json |
| Authorization | {Bearer token} |
| X-TWC-Tenant | {Tenant Name} |
- Query Paramters
- {aggregateStock}
- {queryStock}
- Path variables
```
- {variantRef} ```
{
"active": true,
"additionalImageLink": "string",
"attributeGroups": {
"additionalProp1": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
},
"additionalProp2": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
},
"additionalProp3": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
}
},
"availability": "available",
"availabilityDescription": "string",
"baseProductId": "string",
"baseProductRef": "string",
"brandId": "string",
"brandName": "string",
"calculatedPrice": 0,
"color": "string",
"condition": "New",
"cost": 0,
"defaultVariant": "string",
"deleted": true,
"description": "string",
"digitalProduct": true,
"disabled": true,
"expirationDate": "2022-06-21T06:17:47.571Z",
"featured": true,
"gtin": "string",
"gtinType": "GTIN8",
"id": "string",
"imageLink": "string",
"inventoryLevel": 0,
"inventoryTracking": "none",
"isbn": "string",
"link": "string",
"maxOrderQuantity": 0,
"minOrderQuantity": 0,
"backInStockThreshold":0,
"lowStockThreshold": 0,
"mobileLink": "string",
"physicalSpecs": {
"dimensionUnitCode": "string",
"dimensionUnitName": "string",
"maxDepth": 0,
"maxHeight": 0,
"maxWeight": 0,
"maxWidth": 0,
"minWeight": 0,
"weightUnitCode": "string",
"weightUnitName": "string"
},
"productRef": "string",
"status": "APPROVED",
"stock": {
"stockLevels": [
{
"locationRef": "string",
"locationid": "string",
"stock": "string"
}
],
"totalStock": "string"
},
"title": "string",
"variance": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"variantOptions": [
{
"optionDefaultImage": "string",
"optionId": "string",
"optionLabel": "string",
"optionValue": "string",
"optionsImageId": "string"
}
],
"createdDate": "2022-08-31T04:46:13.275Z",
"lastModifiedDate": "2022-08-31T04:48:33.731Z"
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request unable to create customer
- 401 Unauthorized,
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Delete Variant by Variant Ref
Deleting a Product variant by ref marks the Product variant as deleted and produces the HTTP response confirming the action. If the product variant does not exist, this method returns a empty response.
Endpoint: /api/v2/products/{baseProductRef}/variants/{variantRef}/byref
Method: DELETE
OAuth 2.0 Scopes: Tenant authentication - authentication
| Key | Value |
|---|---|
| Content-Type | application/json |
| Authorization | {Bearer token} |
| X-TWC-Tenant | {Tenant Name} |
- {baseProductRef}
- {variantRef}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request unable to create customer
- 401 Unauthorized,
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Get all product variants by productId
Returns a list of Product variants using the productId as a path variable. If the Product variants does not exist, this method returns a empty list.
Endpoint: /api/v2/products/{productId}/variants
Method: GET
OAuth 2.0 Scopes: Tenant authentication - authentication
| Key | Value |
|---|---|
| Content-Type | application/json |
| Authorization | {Bearer token} |
| X-TWC-Tenant | {Tenant Name} |
- {productId}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request unable to create customer
- 401 Unauthorized,
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Add multiple Variants
Creates an array of new Product variants in the TWC system.
Endpoint: /api/v2/uploadVariants
Method: POST
OAuth 2.0 Scopes: Tenant authentication - authentication
| Key | Value |
|---|---|
| Content-Type | application/json |
| Authorization | {Bearer token} |
| X-TWC-Tenant | {Tenant Name} |
[
{
"active": true,
"additionalImageLink": "string",
"attributeGroups": {
"additionalProp1": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
},
"additionalProp2": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
},
"additionalProp3": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "INTEGER"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "INTEGER"
}
},
"is_obsolete": true
}
},
"availability": "available",
"availabilityDescription": "string",
"baseProductId": "string",
"baseProductRef": "string",
"brandId": "string",
"brandName": "string",
"calculatedPrice": 0,
"color": "string",
"condition": "New",
"cost": 0,
"defaultVariant": "string",
"deleted": true,
"description": "string",
"digitalProduct": true,
"disabled": true,
"expirationDate": "2022-06-21T06:22:48.286Z",
"featured": true,
"gtin": "string",
"gtinType": "GTIN8",
"id": "string",
"imageLink": "string",
"inventoryLevel": 0,
"inventoryTracking": "none",
"isbn": "string",
"link": "string",
"maxOrderQuantity": 0,
"minOrderQuantity": 0,
"backInStockThreshold":0,
"lowStockThreshold": 0,
"mobileLink": "string",
"physicalSpecs": {
"dimensionUnitCode": "string",
"dimensionUnitName": "string",
"maxDepth": 0,
"maxHeight": 0,
"maxWeight": 0,
"maxWidth": 0,
"minWeight": 0,
"weightUnitCode": "string",
"weightUnitName": "string"
},
"productRef": "string",
"status": "APPROVED",
"stock": {
"stockLevels": [
{
"locationRef": "string",
"locationid": "string",
"stock": "string"
}
],
"totalStock": "string"
},
"title": "string",
"variance": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"variantOptions": [
{
"optionDefaultImage": "string",
"optionId": "string",
"optionLabel": "string",
"optionValue": "string",
"optionsImageId": "string"
}
]
}
]
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request unable to create customer
- 401 Unauthorized,
- 403 Forbidden
- 404 Not Found
- 405 Invalid input