Product

Product

Summary

Path Operation Description
/Products GET

Get a list of products.

POST

Create a product.

/Products/Brands GET

Get a list of brands.

POST

Create a brand.

/Products/Brands/count GET

Get the count of the matching brands.

/Products/Brands/{id} DELETE

Delete a brand.

GET

Get a brand.

PATCH

Update a brand.

/Products/bulk GET

Get a limitness of products.

/Products/count GET

Get the count of the matching products.

/Products/CustomFieldsMeta GET

Get meta of custom fields.

/Products/Manufacturers GET

Get a list of manufacturers.

POST

Create a manufacturer.

/Products/Manufacturers/count GET

Get the count of the matching manufacturers.

/Products/Manufacturers/{id} DELETE

Delete a manufacturer.

GET

Get a manufacturer.

PATCH

Update a manufacturer.

/Products/ProductTaxClasses GET

Get a list of product tax classes.

POST

Create a product tax class.

/Products/ProductTaxClasses/count GET

Get the count of the product tax classes.

/Products/ProductTaxClasses/{id} GET

Get a product tax class.

/Products/Variants GET

Get a list of variants.

POST

Create a variant.

/Products/Variants/count GET

Get the count of the matching variants.

/Products/Variants/{id} DELETE

Delete a variant.

GET

Get a variant.

PATCH

Update a variant.

/Products/VariantValues GET

Get a list of variant values.

POST

Create a variant value.

/Products/VariantValues/count GET

Get the count of the matching variant values.

/Products/VariantValues/{id} DELETE

Delete a variant value.

GET

Get a variant value.

PATCH

Update a variant value.

/Products/{id} DELETE

Delete a product.

GET

Get a product.

PATCH

Update a product.

/Products/{id}/Attachments GET

Get a list of attachment ids.

POST

Create an attachment.

/Products/{id}/Attachments/{attachmentId} DELETE

Delete an attachment.

GET

Get a attachment.

/Products/{id}/disableInventory POST

Disable the inventory function in Product

/Products/{id}/disableVariant POST

Disable the variant function in Product

/Products/{id}/enableInventory POST

Enable the inventory function in Product

/Products/{id}/enableVariant POST

Enable the variant function in Product

/Products/{id}/Images DELETE

Delete all product images.

GET

Get a list of product image ids.

POST

Append image to product's gallery and set this image as main image of the product.

/Products/{id}/Images/Settings GET

Get the setting of gallery.

POST

Update the setting of gallery.

/Products/{id}/Images/{imageId} PATCH

Reassign a product image.

/Products/{id}/Images/{productImageId} DELETE

Delet a product image.

GET

Get a product image.

Open api
/v1/Products

Paths

GET /Products

Get a list of products with paging (optional).

filter string

Filtering conditions.

expand string

Expanding related objects.

select string

Selecting a set of fields.

search string

Search keywords.

orderby string

Sequence of selected records.

limit integer (int32)

Maximum number of items allowed to be fetched.

offset integer (int32)

Number of skipped items in the result set.

200

Get list of products or emtpy list.

POST /Products

Create a product using the given data.

product required

JSON data of the product to be created.

201
integer

The id of the newly created product.

GET /Products/Brands

Get a list of brands with paging (optional).

filter string

Filtering conditions.

expand string

Expanding related objects.

select string

Selecting a set of fields.

search string

Search keywords.

orderby string

Sequence of selected records.

limit integer (int32)

Maximum number of items allowed to be fetched.

offset integer (int32)

Number of skipped items in the result set.

200
Brand[]

List of brands or emtpy list.

POST /Products/Brands

Create a brand using the given data.

brand required

JSON data of the brand to be created.

201
integer

The id of the newly created brand.

GET /Products/Brands/count

Get the count of the matching brands.

filter string

Filtering conditions.

search string

Search keywords.

200
integer

Count number of the matching brands.

DELETE /Products/Brands/{id}

Delete a brand by id.

id required integer (int64)

Brand id.

200 void

Delete successfully.

GET /Products/Brands/{id}

Get a brand by id.

id required integer (int64)

Brand id.

expand string

Expanding related objects.

select string

Selecting a set of fields.

200

Get the brand.

PATCH /Products/Brands/{id}

Update a brand using the given data.

id required integer (int64)

Brand id.

brand

Update data in the JSON format.

200 void

Update successfully.

GET /Products/bulk

Get a limitness of products with paging (optional).

filter string

Filtering conditions.

search string

Search keywords.

orderby string

Sequence of selected records.

limit integer (int32)

Maximum number of items allowed to be fetched.

offset integer (int32)

Number of skipped items in the result set.

200

Get limitness list of products or emtpy list.

GET /Products/count

Get the count of the matching products.

filter string

Filtering conditions.

search string

Search keywords.

200
integer

Count number of the matching products.

GET /Products/CustomFieldsMeta

Get meta of custom fields.

200 void

Get custom fields meta successfully.

GET /Products/Manufacturers

Get a list of manufacturers with paging (optional).

filter string

Filtering conditions.

expand string

Expanding related objects.

select string

Selecting a set of fields.

search string

Search keywords.

orderby string

Sequence of selected records.

limit integer (int32)

Maximum number of items allowed to be fetched.

offset integer (int32)

Number of skipped items in the result set.

200

List of manufacturers or emtpy list.

POST /Products/Manufacturers

Create a manufacturer using the given data.

manufacturer required

JSON data of the manufacturer to be created.

201
integer

The id of the newly created manufacturer.

GET /Products/Manufacturers/count

Get the count of the matching manufacturers.

filter string

Filtering conditions.

search string

Search keywords.

200
integer

Count number of the matching manufacturers.

DELETE /Products/Manufacturers/{id}

Delete a manufacturer by id.

id required integer (int64)

Manufacturer id.

200 void

Delete successfully.

GET /Products/Manufacturers/{id}

Get a manufacturer by id.

id required integer (int64)

Manufacturer id.

expand string

Expanding related objects.

select string

Selecting a set of fields.

200

Get the manufacturer.

PATCH /Products/Manufacturers/{id}

Update a manufacturer using the given data.

id required integer (int64)

Manufacturer id.

manufacturer

Update data in the JSON format.

200 void

Update successfully.

GET /Products/ProductTaxClasses

Get a list of product tax classes with paging (optional).

filter string

Filtering conditions.

expand string

Expanding related objects.

select string

Selecting a set of fields.

orderby string

Sequence of selected records.

limit integer (int32)

Maximum number of items allowed to be fetched.

offset integer (int32)

Number of skipped items in the result set.

200

List of product tax classes or emtpy list.

POST /Products/ProductTaxClasses

Create a product tax class using the given data.

productTaxClass required

JSON data of the manufacturer to be created.

201
integer

The id of the newly created product tax class.

GET /Products/ProductTaxClasses/count

Get the count of the matching product tax classes.

filter string

Filtering conditions.

200
integer

Count number of the matching product tax classes.

GET /Products/ProductTaxClasses/{id}

Get a product tax class by id.

id required integer (int64)

ProductTaxClass id.

expand string

Expanding related objects.

select string

Selecting a set of fields.

200

Get the product tax class.

GET /Products/Variants

Get a list of variants with paging (optional).

filter string

Filtering conditions.

expand string

Expanding related objects.

select string

Selecting a set of fields.

orderby string

Sequence of selected records.

limit integer (int32)

Maximum number of items allowed to be fetched.

offset integer (int32)

Number of skipped items in the result set.

200

List of variants or emtpy list.

POST /Products/Variants

Create a variant using the given data.

variant required

JSON data of the variant to be created.

201
integer

The id of the newly created variant.

GET /Products/Variants/count

Get the count of the matching variants.

filter string

Filtering conditions.

200
integer

Count number of the matching variants.

DELETE /Products/Variants/{id}

Delete a variant by id.

id required integer (int64)

Variant id.

200 void

Delete successfully.

GET /Products/Variants/{id}

Get a variant by id.

id required integer (int64)

Variant id.

expand string

Expanding related objects.

select string

Selecting a set of fields.

200

Find the variant.

PATCH /Products/Variants/{id}

Update a variant using the given data.

id required integer (int64)

Variant id.

variant

Update data in the JSON format.

200 void

successful operation

GET /Products/VariantValues

Get a list of variant values with paging (optional).

filter string

Filtering conditions.

expand string

Expanding related objects.

select string

Selecting a set of fields.

orderby string

Sequence of selected records.

limit integer (int32)

Maximum number of items allowed to be fetched.

offset integer (int32)

Number of skipped items in the result set.

200

List of variant values or emtpy list.

POST /Products/VariantValues

Create a variant value using the given data.

VariantValue required

JSON data of the variant value to be created.

201
integer

The id of the newly created variant value.

GET /Products/VariantValues/count

Get the count of the matching variant values.

filter string

Filtering conditions.

200
integer

Count number of the matching variant values.

DELETE /Products/VariantValues/{id}

Delete a variant value by id.

id required integer (int64)

Variant value id.

200 void

Delete successfully.

GET /Products/VariantValues/{id}

Get a variant value by id.

id required integer (int64)

Variant value id.

expand string

Expanding related objects.

select string

Selecting a set of fields.

200

Find the variant value.

PATCH /Products/VariantValues/{id}

Update a variant value using the given data.

id required integer (int64)

Variant value id.

variantValue

Update data in the JSON format.

200 void

successful operation

DELETE /Products/{id}

Delete a product by id asynchronously. It is recommended that you register webhook on Product.DELETE event to obtain asynchronous job confirmation.

id required integer (int64)

Product id.

202 void

Delete request accepted.

GET /Products/{id}

Get a product by id.

id required integer (int64)

Product id

expand string

Expanding related objects.

select string

Selecting a set of fields.

200

Find the product.

PATCH /Products/{id}

Update a product using the given data.

id required integer (int64)

Product id

product

Update data in the JSON format.

200 void

Update successfully.

GET /Products/{id}/Attachments

Get a list of attachment ids with product id.

id required integer (int64)

Product id.

limit integer (int32)

Maximum number of items allowed to be fetched.

offset integer (int32)

Number of skipped items in the result set.

meta boolean

Indicate whether to include meta information for the atachment, default to false

200
object[]

List of attachment ids or empty list.

POST /Products/{id}/Attachments

Create an attachment using the given data.

id required integer (int64)

Product id.

attachment required

JSON data of the attachment to be created.

201
integer

The id of the newly created attachment.

DELETE /Products/{id}/Attachments/{attachmentId}

Delete an attachment by id.

id required integer (int64)

Product id.

attachmentId required integer (int64)

Attachment id.

200 void

Delete successfully.

GET /Products/{id}/Attachments/{attachmentId}

Get an attachment by id.

id required integer (int64)

Product id.

attachmentId required integer (int64)

Attachment id.

200

Find the attachment.

POST /Products/{id}/disableInventory

After disable this, the product will change the status to SingleService or VariantService

id required integer (int64)

Product id.

200
integer

The id of status changed product.

POST /Products/{id}/disableVariant

After disable this, the product will remove all the related SKUs and create a default one

id required integer (int64)

Product id.

200
integer

The id of status changed product.

POST /Products/{id}/enableInventory

After enable this, the product will change the status to SingleInventory or VariantInventory

id required integer (int64)

Product id.

200
integer

The id of status changed product.

POST /Products/{id}/enableVariant

After enbled this, the product can create the multi SKUs and remove the default one

id required integer (int64)

Product id.

200
integer

The id of status changed product.

DELETE /Products/{id}/Images

Delete all product images.

id required integer (int64)

Product id.

200 void

Delete successfully.

GET /Products/{id}/Images

Get a list of product image ids with product id.

id required integer (int64)

Product id.

limit integer (int32)

Maximum number of items allowed to be fetched.

offset integer (int32)

Number of skipped items in the result set.

200

List of product image ids or empty list.

POST /Products/{id}/Images

Append image to product's gallery and set this image as main image of the product by using the given data.

id required integer (int64)

Product id.

productImage required

JSON data of the product image to be created.

201
integer

The id of the newly created product image.

GET /Products/{id}/Images/Settings

Get the setting of gallery.

id required integer (int64)

Related product id.

200

Get the gallery setting.

POST /Products/{id}/Images/Settings

Update the setting of gallery.

id required integer (int64)

Related product id.

setting required

JSON data of the GallerySetting to be updated.

200 void

Update the gallery setting.

PATCH /Products/{id}/Images/{imageId}

Reassign a product image.

id required integer (int64)

Product id.

productImageId required integer (int64)

Product image id.

assignment required

JSON data of the product image to be created.

200 void

Assignment successfully.

DELETE /Products/{id}/Images/{productImageId}

Delete a product image by id.

id required integer (int64)

Product id.

productImageId required integer (int64)

Product image id.

200 void

Delete successfully.

GET /Products/{id}/Images/{productImageId}

Get a product image by id.

id required integer (int64)

Product id.

productImageId required integer (int64)

Product image id.

200

Find the product image.

Definitions

AttachmentInfo

Attachment Info.

Name Type Description
id readonly integer (int64)

Attachment id.

name required string

Attachment name.

size readonly integer (int64)

Attachment size.

mimeType required string

Attachment mime type.

content required string[]

Attachment binary content.

uploadTime readonly string (date-time)

Attachment upload time.

Brand

Brand Model

Name Type Description
id readonly integer (int64)

A unique idendifier of brand

name required string

Brand name

creationTime readonly string (date-time)

Creation time of brand

updateTime readonly string (date-time)

Update time of brand

BrandInfo

Brand

Name Type Description
id required integer (int64)

Brand id. Mandatory for create product.

name string

Brand name.

CategoryInfo

Category

Name Type Description
id required integer (int64)

Category id. Mandatory for create product.

name string

Category name.

GallerySetting

Gallery Setting

Name Type Description
enableChannel boolean

Switch of channel images

enableVariant boolean

Switch of variant images

assignVariant VariantInfo

Dominate variant

Image assignment param

Product image assignment param

Name Type Description
assignments object[]

Related images assignment

ImageAssignment

Image assignment info

Name Type Description
channel ImageChannelInfo

Channel info.

variantValue ImageVariantValueInfo

Variant value info.

ImageChannelInfo

Image related channel info

Name Type Description
id required integer (int64)

Channel id.

ImageVariantValueInfo

Image related variant-value info

Name Type Description
id required integer (int64)

Variant value id.

Manufacturer

Manufacturer Model

Name Type Description
id readonly integer (int64)

A unique idendifier of manufacturer

name required string

Manufacturer name

creationTime readonly string (date-time)

Creation time of manufacturer

updateTime readonly string (date-time)

Update time of manufacturer

ManufacturerInfo

Manufacturer

Name Type Description
id required integer (int64)

Manufacturer id. Mandatory for create product.

name string

Manufacturer name.

Product

Product Model

Name Type Description
customFields object

Value of custom fields.

object
id readonly integer (int64)

A unique idendifier of product

code required string

product code

name required string

product name

category CategoryInfo

product category

batchSerial string

Product type

Possible values:

  • None
  • BatchProduct
  • SerialProduct
shelfLife integer (int32)

Shelf life

alertDaysBeforeExpiry integer (int32)

Alert days before expiry

productTaxClass ProductTaxClassInfo

Product tax class

status string

Product status

Possible values:

  • Active
  • Inactive
weight number

Product Weight

length number

Product Length

height number

Product height

width number

Product width

weightUnitId integer (int64)

Weight Unit

lengthUnitId integer (int64)

Length Unit

hsTariffCode string

HS Tariff Code

countryofOrigin string

Origin Country

taaSProductTaxClass string

Taas Tax Class(deprecated)

Possible values:

  • Standard
  • P20
  • P50
  • P80
  • G
  • H
  • I
  • K
  • M
backOrderAllowed boolean

Product allow back order

dropShipAllowed boolean

Product allow dropship

manufacturer ManufacturerInfo

Product manufacturer

brand BrandInfo

Product brand

stamp StampInfo

Product stamp

vendor VendorInfo

Product vendor

variantEnabled readonly boolean

enable adding SKUs for product

inventoryEnabled boolean

enable inventory for product

imageUploaded readonly boolean

indicate a product image is uploaded

salesUom UoMInfo

Default UoM of sales order

purchaseUom UoMInfo

Default UoM of purchase order

inventoryUom UoMInfo

Inventory UoM

mainImage readonly ProductImageBasicInfo

main image id of the product

productUomGroup UomGroupInfo

product uomGroup

skus readonly object[]

SKUs for product

attributes object[]

Product attributes

creationTime readonly string (date-time)

Creation time of product

updateTime readonly string (date-time)

Update time of product

model string

model

deleted readonly boolean

delete status of the product: true, false

ProductAttribute

Product Attribute

Name Type Description
id readonly integer (int64)

A unique idendifier of product attribute

attribute1 string

1st value of 4 attributes

attribute2 string

2nd value of 4 attributes

attribute3 string

3rd value of 4 attributes

attribute4 string

4th value of 4 attributes

creationTime readonly string (date-time)

Creation time of Attribute

updateTime readonly string (date-time)

Update time of Attribute

ProductImage

ProductImage Master Data.

Name Type Description
id readonly integer (int64)

ProductImage id.

fileName required string

ProductImage file name.

fileSize readonly integer (int64)

ProductImage file size.

mimeType required string

ProductImage file mime type.

base64Content required string

ProductImage binary content.

uploadedTime readonly string (date-time)

ProductImage uploaded time.

assignments object[]

Related images assignment

ProductImageBasicInfo

Main image info of product

Name Type Description
id integer (int64)

Attachment id.

fileName string

Attachment file name.

fileSize integer (int64)

Attachment file size.

mimeType string

Attachment file mime type.

uploadedTime string (date-time)

Attachment uploaded time.

assignments object[]

Related images assignment

ProductInfo

Product Info

Name Type Description
id required integer (int64)

Product id.

code string

product code

name string

product name

ProductTaxClass

ProductTaxClass Model

Name Type Description
id readonly integer (int64)

A unique idendifier of ProductTaxClass

description required string

Description.

ProductTaxClassInfo

ProductTaxClass Model

Name Type Description
id integer (int64)

A unique idendifier of ProductTaxClass

description required string

Description.

SKUInfo

SKU Info

Name Type Description
id required integer (int64)

SKU id.

name string

SKU name.

code string

SKU code.

StampInfo

Stamp

Name Type Description
id required integer (int64)

Stamp id. Mandatory for create product.

name string

Stamp name.

color integer (int32)

Stamp name.

UoMInfo

UoM

Name Type Description
id integer (int64)

UoM id.

name string

UoM name.

UomGroupInfo

Purchase UoMGroup

Name Type Description
id integer (int64)

UoMGroup id.

name string

UoMGroup name.

Variant

Variant Model

Name Type Description
id readonly integer (int64)

A unique idendifier of variant

name required string

Variant name

description string

Description

displayOrder integer (int32)

displayOrder

creationTime readonly string (date-time)

Creation time of variant

updateTime readonly string (date-time)

Update time of variant

variantValues readonly object[]

Variant values for current variant

VariantInfo

Variant

Name Type Description
id required integer (int64)

Variant id

name string

Variant name.

description string

Variant description.

displayOrder integer (int32)

Variant display order

VariantValue

Variant Value Model

Name Type Description
id readonly integer (int64)

A unique idendifier of variant

value required string

Variant value

code required string

Variant code

displayOrder integer (int32)

Variant display order

variant required unchangeable VariantInfo

Variant which this variant value belonged

creationTime readonly string (date-time)

Creation time of variant value

updateTime readonly string (date-time)

Update time of variant value

VariantValueInfo

VariantValue

Name Type Description
id required integer (int64)

Variant value id

code string

Variant value code.

value string

Variant value name.

displayOrder integer (int32)

Variant value display order

variantId integer (int64)

Variant id

variantName string

Variant name

VendorInfo

Purchase Vendor

Name Type Description
id integer (int64)

Vendor id.

name string

Vendor name.

code string

Vendor code.

status string

Possible values:

  • INACTIVE
  • ACTIVE