v2.product.add_ssp_item
POST /api/v2/product/add_ssp_item
Create product based on SSP.
Đường dẫn Endpoint
URL: https://partner.shopeemobile.com/api/v2/product/add_ssp_item
Tham số chung
| Tên | Kiểu | Mẫu | Mô tả |
|---|---|---|---|
| partner_id | int | 1 | Partner ID được gán khi đăng ký thành công. Bắt buộc cho tất cả các yêu cầu. |
| timestamp | timestamp | 1610000000 | Dùng để chỉ định thời gian của yêu cầu. Bắt buộc cho tất cả các yêu cầu. Hết hạn sau 5 phút. |
| access_token | string | c09222e3fc40ffb25fc947f738b1abf1 | Token truy cập API, dùng để xác định quyền của bạn đối với API. Có thể sử dụng nhiều lần và hết hạn sau 4 giờ. |
| shop_id | int | 600000 | Mã định danh duy nhất của Shopee cho một cửa hàng. Tham số bắt buộc cho hầu hết các API. |
| sign | string | e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2 | Signature generated by partner_id, api path, timestamp, access_token, shop_id and partner_key via HMAC-SHA256 hashing algorithm. More details: https://open.shopee.com/documents?module=87&type=2&id=58&version=2 |
Tham số Request
| Tên | Kiểu | Bắt buộc | Mẫu | Mô tả |
|---|---|---|---|---|
| ssp_id | int64 | True | Shopee's mã định danh duy nhất for Shopee Standard Product. | |
| original_price | float | False | 99.99 | The price of this item. |
| item_status | string | False | "UNLIST" | Trạng thái sản phẩm, could be UNLIST or NORMAL. |
| dimension | object | False | The dimension of this item. | |
| package_length | int32 | True | 11 | The length of package for this item, the unit is CM. |
| package_width | int32 | True | 11 | The width of package for this item, the unit is CM. |
| package_height | int32 | True | 11 | The height of package for this item, the unit is CM. |
| logistic_info | object[] | True | Kênh vận chuyển setting of this item. | |
| logistic_id | int64 | True | 90003 | ID of the channel. |
| enabled | boolean | True | true | Whether channel is enabled for this item. |
| shipping_fee | float | False | 23.12 | Phí vận chuyển, only needed when logistics fee_type = CUSTOM_PRICE. |
| size_id | int64 | False | 0 | Size ID, only needed when logistic fee_type = SIZE_SELECTION. |
| is_free | boolean | False | false | Whether cover phí vận chuyển for buyer. |
| attribute_list | object[] | False | ||
| attribute_id | int64 | True | 4990 | ID of attribute. |
| attribute_value_list | object[] | True | ||
| value_id | int64 | True | 32142 | Value ID. In the following cases, the value id needs to be uploaded as 0, and original_value_name is mandatory, needs to be filled in customized value. (1) AttributeInputType is TEXT_FILED; (2) AttributeInputType is COMBO_BOX or MULTIPLE_SELECT_COMBO_BOX, and the seller want to fill in a customized value. |
| original_value_name | string | False | Brand | Value name. original_value_name from product.get_attributes api. If value id=0, this field is required. If AttributeType is DATE_TYPE or TIMESTAMP_TYPE, you can thời gian tải lênstamp(string type) as the original_value_name. |
| value_unit | string | False | kg | Unit of giá trị thuộc tính (quantitative attribute only). |
| pre_order | object | False | Pre order setting of this item. | |
| is_pre_order | boolean | True | true | Whether this item is pre order. |
| days_to_ship | int32 | False | 10 | The guaranteed số ngày giao hàng orders. Please get the days_to_ship range from get_item_limit api. |
| item_sku | string | False | SKU tag of this item. | |
| condition | string | False | "NEW" | Tình trạng of item, could be USED or NEW. |
| wholesale | object[] | False | Wholesale setting of this item. | |
| min_count | int32 | True | 1 | Tối thiểu count of this tier. |
| max_count | int32 | True | 100 | Tối đa count of this tier. |
| unit_price | float | True | 28.3 | Unit price of this tier. |
| video_upload_id | string[] | False | ["sg_f4bde9bc-ff3c-485e-a6dd-3161dab4b942_000000"] | Video upload ID returned from video uploading API. Only accept one video_upload_id. |
| item_dangerous | int32 | False | 0 | This field is only applicable for local sellers in Indonesia and Malaysia. Use this field to identify whether a product is a dangerous product. 0 for non-dangerous product and 1 for dangerous product. For more information, please visit the market's respective Seller Education Hub. |
| tax_info | object | False | Tax information for this item. | |
| ncm | string | False | Mercosur Common Nomenclature, it is a convention between Mercosur member countries to easily recognize goods, services and productive factors negotiated among themselves. (BR region) NCM must have 8 digits, OR, if your item doesn't have a NCM enter the value "00" | |
| same_state_cfop | string | False | Tax Code of Operations and Installments for orders that seller and buyer are in the same state. It identifies a specific operation by category at thời gian của issuing the invoice.(BR region) | |
| diff_state_cfop | string | False | Tax Code of Operations and Installments for orders that seller and buyer are in different states. It identifies a specific operation by category at thời gian của issuing the invoice.(BR region) | |
| csosn | string | False | Code of Operation Status – Simples Nacional, code for company operations to identify the origin of the goods and the taxation regime of the operations.(BR region) | |
| origin | string | False | Product source, domestic or foreig (BR region). | |
| cest | string | False | Tax Replacement Specifying Code (CEST), to separate within the same NCM products that do or do not have ICMS tax substitution. (BR region) CEST must have 7 digits, OR, if your item doesn't have a CEST enter the value "00". | |
| measure_unit | string | False | (BR region) | |
| invoice_option | string | False | Value shuold be one of NO_INVOICES VAT_MARGIN_SCHEME_INVOICES VAT_INVOICES NON_VAT_INVOICES and if value is NON_VAT_INVOICE vat_rate should be null (PL region) | |
| vat_rate | string | False | Value should be one of 0% 5% 8% 23% NO_VAT_RATE (PL region) | |
| hs_code | string | True | HS Code (Only for IN region) | |
| tax_code | string | True | Tax Code (Only for IN region) | |
| tax_type | int32 | False | tax_type only for TW whitelist shop. Shopee will referred Tax type when substitute sellers for issuing e-receipts to buyers. All variations share the same tax type. The meaning of value: 0: no tax type 1: tax-able 2: tax-free | |
| pis | string | False | Only for BR shop. PIS - Programa de Integração Social (Social Integration Program). It is a government tax to collect resources for the payment of unemployment insurance and other employee related rights. PIS % - the tax applied to this product | |
| cofins | string | False | Only for BR shop. COFINS – Contribuição para Financiamento da Seguridade Social (Contribution for Social Security Funding). It is a government tax to collect resources for public health system and social security. COFINS % - the tax applied to this product | |
| icms_cst | string | False | Only for BR shop. ICMS - Imposto sobre Circulação de Mercadorias e Serviços (Circulation of Goods and Services Tax). CST - Código da Situação Tributária (Tax Situation Code) is represented by a combination of 3 numbers with the purpose of demonstrating the origin of a product and determining the form of taxation that will apply to it. Therefore, each digit in the CST Table has a specific meaning: the first digit indicates the origin of the operation, the second digit represents the ICMS taxation on the operation and the third digit provides additional information about the form of taxation. | |
| pis_cofins_cst | string | False | Only for BR shop. The CST PIS/Cofins is a code on the Electronic Invoice (NF-e) that identifies the tax situation of PIS (Programa de Integração Social) and Cofins (Contribuição para o Financiamento da Seguridade Social) in sales of goods. | |
| federal_state_taxes | string | False | Only for BR shop. Enter the total percentage of the combination of federal, state, and municipal taxes, using up to two decimals. | |
| operation_type | string | False | Only for BR shop. 1: Retailer 2: Manufacturer | |
| ex_tipi | string | False | Only for BR shop. The EXTIPI field in the NF-e (Nota Fiscal Eletrônica) is used to indicate if there's an exception to the IPI (Imposto sobre Produtos Industrializados) tax rate for a specific product. | |
| fci_num | string | False | Only for BR shop. The FCI Control Number is a mã định danh duy nhất assigned to each import FCI (Import Content Form). It's mandatory on the corresponding NF-e (electronic invoice) to ensure compliance with Brazilian import tax regulations. | |
| recopi_num | string | False | Only for BR shop. RECOPI NACIONAL is a Brazilian government system that facilitates the registration and management of tax-exempt operations involving paper destined for printing books, newspapers, and periodicals (known as "papel imune" in Portuguese). | |
| additional_info | string | False | Only for BR shop. Include relevant information to display on Invoice. | |
| group_item_info | object | False | Only for BR shop. Required if the item is a group item. | |
| group_qtd | string | False | Example: The package contains 6 soda cans. Whether you are selling a pack of 6 cans (fardo) or a single can (unit), enter 6. | |
| group_unit | string | False | Example: The package contains 6 soda cans. Whether you are selling a pack of 6 cans (fardo) or a single can (unit), enter UNI for the individual can. | |
| group_unit_value | string | False | Example: The package contains 6 soda cans. Whether you are selling a pack of 6 cans (fardo) or a single can (unity), enter the value of the individual can. | |
| original_group_price | string | False | Example: The item is a package that contains 6 soda cans. Enter the price of the whole package. | |
| group_gtin_sscc | string | False | Example: The item is a package that contains 6 soda cans. Please inform the GTIN SSCC code for the package. | |
| group_grai_gtin_sscc | string | False | Example: The item is box, that contain 6 packages. Each package contains 6 soda cans. Please inform the GRAI GTIN SSCC code for the Box. | |
| seller_stock | object[] | False | seller stock(Please notice that stock(including Seller Stock and Shopee Stock) should be larger than or equal to real-time reserved stock) | |
| location_id | string | False | location id | |
| stock | int32 | True | stock | |
| size_chart_info | object | False | ||
| size_chart | string | False | ID of bảng kích thước image. If you want to remove the image bảng kích thước of the item, please pass the "size_chart" empty. Notes: Both CB shops and local shops are supported to set "size_chart". | |
| size_chart_id | int64 | False | ID of template bảng kích thước. If you want to remove the template bảng kích thước of the item, please pass the "size_chart_id" as 0. Notes: Only local shops are supported to set "size_chart_id", for CB shops please use "size_chart". | |
| authorised_brand_id | int64 | False | ID of authorised reseller brand. | |
| model_list | object[] | False | Model info list. | |
| tier_index | int32[] | True | [0] | Tier index of this model. |
| model_sku | string | False | SKU | Seller SKU of this model, model_sku length information needs to be no more than 100 characters. |
| original_price | float | True | 38.3 | Giá gốc of this model. |
| seller_stock | object[] | False | seller stock(Please notice that stock(including Seller Stock and Shopee Stock) should be larger than or equal to real-time reserved stock) | |
| location_id | string | False | location id | |
| stock | int32 | True | stock | |
| dimension | object | False | The dimension of this model. If don't set the dimension of this model, will use the dimension of item by default. | |
| package_length | int32 | True | 11 | The length of package for this model, the unit is CM. |
| package_width | int32 | True | 11 | The width of package for this model, the unit is CM. |
| package_height | int32 | True | 11 | The height of package for this model, the unit is CM. |
| pre_order | object | False | Đặt hàng trước information of this model. Notes: If don't set the DTS of this model, will use the DTS of the item by default. | |
| is_pre_order | boolean | True | true | Whether the model is pre order. |
| days_to_ship | int32 | False | 10 | Số ngày giao hàng. Please get the days_to_ship range from the get_item_limit API. |
Tham số Response
| Tên | Kiểu | Mẫu | Mô tả |
|---|---|---|---|
| error | string | Loại lỗi nếu có lỗi xảy ra. Trống nếu không có lỗi. | |
| message | string | Chi tiết lỗi nếu có lỗi xảy ra. Trống nếu không có lỗi. | |
| warning | string | Indicate waring details if hit waring. Empty if no waring happened. | |
| request_id | string | cc807adb6f8abaeb597c7b6e53e14241 | The identifier for an API request for error tracking |
| response | object | ||
| item_id | int64 | 892571850 | Shopee's mã định danh duy nhất for an item. |
Dữ liệu gửi
{ "ssp_id": 556054528, "model_list": [ { "tier_index": [ 0 ], "original_price": 99.99, "seller_stock": [ { "stock": 100 } ] }, { "tier_index": [ 1 ], "original_price": 119.99, "seller_stock": [ { "stock": 200 } ] } ], "logistic_info": [ { "logistic_id": 90003, "enabled": true } ] }
, "warning": "" }