This API describes how to create the products in OMS.

Common Parameter

Test Endpoint: https://api-dev.gcparcelservice.com/openapi/product/create

Production Endpoint: https://api.gcparcelservice.com/openapi/product/create

Method: POST


Request Body

{ 
  "sku": "sku-1",
  "barcode": "EAN/UPC code",  
  "product_name": "product name", 
  "product_description": "product desc",  
  "image_url": "https://img.goforgps.com/image.jpg", 
  "length": 6.23,
  "width": 6.23,
  "height": 6.23,
  "weight": 1.23,
  "custom_declare_price": 8.6,
  "custom_hs_code": "",
  "country_origin": "CN", 
  "item_type": 1
}

Request Body Explanation

Attribute NameTypeDescription
skuStringsku number
barcodeStringbarcode, must be unique
product_nameStringname of the product
product_descriptionStringdescription of the product
image_urlStringthe url of product image
lengthFloatlength of the product, inch
widthFloatwidth of the product, inch
heightFloatheight of the product, inch
weightFloatweight of the product, pound
custom_declare_priceFloatprice when declare to custom
custom_hs_codeString(optional) hs_code when declare to custom
country_originStringoriginal country of the product
item_typeInteger1. normal; 2. material with undetachable battery; 3. material with detachable battery; 4. battery; 5. liquid material; 6. paste material; 7. powder material; 8. magnetic material

Response Body

{ 
  "code": 200,
  "message": "success"
} 

Response Body Explanation

Attribute NameTypeDescription
codeIntegerResponse code: 200 successful, 400/500 failed
messageStringmessage of the result of product creation


Code Example

Create Product In OMS API Code Example