OPEN-API-English
  1. Product
OPEN-API-English
  • Default Group
    • Product
      • Create/Edit Products
        POST
      • Create Product Identification Code
        POST
      • Query SKU
        POST
      • SKU Batch Query
        POST
    • Inbound Plan
      • Create Inbound Plan
      • Inbound Plan Shipping Operation
      • Add Inbound Plan Attachment
      • Cancel Inbound Plan
      • Inbound Plan Information Query
    • Inventory
      • Batch Inventory Query
      • Inventory Query
      • Batch Query of Inventory Age
    • Orders
      • Create Sales Order (with attachments)
      • Get Order Details
      • Orders - Query List
      • Order Attachment Upload
      • Cancel Order
  1. Product

Create/Edit Products

POST
/v1/product/save

Request

Header Params
x-api-key
string 
required
Example:
abc123(认证信息)
Content-Type
string 
required
Example:
application/json
Body Params application/json
sku
string 
required
SKU
customItemNo
string 
optional
Custom Product Code
upc
string 
optional
UPC Code
productType
integer 
optional
Product Type 1: Finished Product Product Type 2: Accessories Product Type 3: Consumables (Default is Finished Product if not specified)
name
string 
required
Chinese Name
nameEn
string 
required
English Name
description
string 
optional
Product Description (the default value is English product name (nameEn))
packingType
integer 
required
Product Shipping Packaging 0: Original Packaging Shipment 1: Repackaging
length
number 
required
Product Length(cm)
width
number 
required
Product Width(cm)
height
number 
required
Product Height(cm)
weight
number 
required
Product Weight(g)
itemLength
number 
optional
Item Length(cm)
itemWidth
number 
optional
Item Width(cm)
itemHeight
number 
optional
Item Height(cm)
expirationControl
integer 
optional
Expiration Control 0: No 1: Yes (Default is No if not specified)
expirationDate
integer 
optional
Storage Period (Days)
packedQty
integer 
optional
Packing Quantity
packedLength
number 
optional
Packing Length(cm)
packedWidth
number 
optional
Packing Width(cm)
packedHeight
number 
optional
Packing Height(cm)
packedWeight
number 
optional
Packing Weight(g)
cost
number 
optional
Cost
currency
string 
optional
Currency
isInsuranceFlag
string 
optional
Is the product insured value? N: No; Y: Yes (Not filled defaults to No)
isInsuranceRate
number 
optional
Insurance Rate
remark
string 
optional
Remark
customName
string 
optional
Customs Declaration Name (Chinese)
customNameEn
string 
optional
Customs Declaration Name (English)
isRequireSn
integer 
required
SN Request 0: No 1: Yes ( Default is No if not filled in)
Example
{
    "sku": "string",
    "customItemNo": "string",
    "upc": "string",
    "productType": 0,
    "name": "string",
    "nameEn": "string",
    "description": "string",
    "packingType": 0,
    "length": 0,
    "width": 0,
    "height": 0,
    "weight": 0,
    "itemLength": 0,
    "itemWidth": 0,
    "itemHeight": 0,
    "expirationControl": 0,
    "expirationDate": 0,
    "packedQty": 0,
    "packedLength": 0,
    "packedWidth": 0,
    "packedHeight": 0,
    "packedWeight": 0,
    "cost": 0,
    "currency": "string",
    "isInsuranceFlag": "string",
    "isInsuranceRate": 0,
    "remark": "string",
    "customName": "string",
    "customNameEn": "string",
    "isRequireSn": 0
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://127.0.0.1/v1/product/save' \
--header 'x-api-key: abc123(认证信息)' \
--header 'Content-Type: application/json' \
--data-raw '{
    "sku": "string",
    "customItemNo": "string",
    "upc": "string",
    "productType": 0,
    "name": "string",
    "nameEn": "string",
    "description": "string",
    "packingType": 0,
    "length": 0,
    "width": 0,
    "height": 0,
    "weight": 0,
    "itemLength": 0,
    "itemWidth": 0,
    "itemHeight": 0,
    "expirationControl": 0,
    "expirationDate": 0,
    "packedQty": 0,
    "packedLength": 0,
    "packedWidth": 0,
    "packedHeight": 0,
    "packedWeight": 0,
    "cost": 0,
    "currency": "string",
    "isInsuranceFlag": "string",
    "isInsuranceRate": 0,
    "remark": "string",
    "customName": "string",
    "customNameEn": "string",
    "isRequireSn": 0
}'

Responses

🟢200成功
application/json
Body
object {0}
Example
{
  "statusCode": 200,
  "status": 0,
  "code": 200,
  "message": "产品创建成功"
}
Modified at 2024-03-06 09:48:18
Next
Create Product Identification Code
Built with