1. Descriptions of constants and enumerations in interfaces
1.1. State
| Enums | Description |
|---|---|
| success | The request was successful |
| failure | The request was failed |
1.2. Platform
| Enum | Description |
|---|---|
| EBAY | |
| AMAZON | |
| ALIEXPRESS | |
| WISH | |
| SHOPIFY | |
| OTHER | |
| WALMART | |
| CDISCOUNT | |
| REALDE | |
| MANOMANO | |
| OVERSTOCK | |
| SHOPEE | |
| SHOPEE_CNSC | |
| LAZADA | |
| MAGENTO | |
| PAYPAL | |
| NEWEGG | |
| TOPHATTER | |
| JD_ID | |
| JD_TH | |
| WAYFAIR | |
| SPS_COMMERCE | |
| TOKOPEDIA | |
| SHOP_TOKOPEDIA | |
| RAKUTEN | |
| YAHOO | |
| MERCADO | |
| TIKTOK | |
| TIKTOK_GLOBAL | |
| AKULAKU | |
| QOO10 | |
| INDEPENDENT | |
| DISTRIBUTION | |
| TEMU | |
| SHOPLINE | |
| WOO_COMMERCE | |
| LINE_SHOPPING | |
| BLIBLI | |
| SHOPLAZZA | |
| SHEIN | |
| PGMALL | |
| TEAPPLIX | |
| OZON | |
| DLZ_B2B | |
| MOMO | |
| MOMO_3P | |
| TEMU_CERTIFIED | |
| SHOPEE_SCS |
1.3. Lock status
ref by shop,warehouse
| Enum | Description |
|---|---|
| LOCK | lock |
| UNLOCK | Not locked |
1.4. Warehouse type
| Enum | Description |
|---|---|
| SHIP | Shipping warehouse |
| TRANSFER | Transit warehouse |
| COMPLEX | Integrated Warehouse |
1.5. Sku Type
| Enum | Description |
|---|---|
| SINGLE | Singles |
| COMBINE | Compositions |
1.6. Units of weight
| Enum | Description |
|---|---|
| KG | Kilograms |
| LBS | Pounds |
| GRAM | Grams |
1.7. Units of length
| Enum | Description |
|---|---|
| cm | Centimeters |
| In | Inches |
| m | Metres |
1.8. Sales order status
| Enum | Description |
|---|---|
| WAIT_PAYMENT | WAIT_PAYMENT |
| WAIT_AUDIT | WAIT_AUDIT |
| WAIT_SHIP | WAIT_SHIP |
| SHIPPING | SHIPPING |
| SHIP_FAILURE | SHIP_FAILURE |
| PARTIALLY_SHIPPED | PARTIALLY_SHIPPED |
| SHIPPED | SHIPPED |
| CLOSED | CLOSED |
1.9. Sales Orders Payment Methods
| Enum | Description |
|---|---|
| COD | Cash on delivery |
| PAY_ONLINE | Pay online |
1.10. Refund order status
| Enum | Description |
|---|---|
| NEW | To be submitted |
| WAIT_AUDIT | To be reviewed |
| WAIT_BUYER_RETURN | Waiting for the buyer to return it |
| WAIT_BUYER_ACCEPT | Pending confirmation by the buyer |
| WAIT_STORAGE | To be put into storage |
| RECEIVING | Receiving goods |
| FINISH | Refund order is finished |
| CLOSE | Refund order is closed |
1.11. Monetary unit
| Enum | Description |
|---|---|
| PHP | Philippine peso |
| THB | THB |
| VND | VND |
| IDR | Indonesian rupiah |
| MYR | Malaysian Ringgit |
| TWD | New Taiwan Dollar |
| SGD | S$ |
| AUD | Australian dollar |
| JPY | JPY |
| EUR | EUR |
| GBP | British pound |
| CAD | Canadian |
| USD | U S DOLLARS |
| CNY | Chinese yuan |
1.12. Countries
| Enum | Description |
|---|---|
| AD | Andorra |
| AE | United Arab Emirates |
| AF | Afghanistan |
| AG | Antigua and Barbuda |
| AI | Anguilla |
| AL | Albanian |
| AM | Armenian |
| AO | Angora |
| AQ | Antarctica |
| AR | Argentine |
| AS | american samoa |
| AT | Austria |
| AU | Australia |
| AW | Aruba |
| AX | ÅLAND ISLANDS |
| AZ | Azerbaijan |
| BA | Republic of Bosnia and Montenegro |
| BB | Barbados |
| BD | Bangladeshi |
| BE | Belgian |
| BF | Burkina Faso |
| BG | Bulgarian |
| BH | Bahrain |
| BI | Burundi |
| BJ | Benin |
| BL | Saint Barthélemy |
| BM | Bermuda |
| BN | Brunei |
| BO | Bolivia |
| BQ | Bonaire、圣尤斯达蒂斯和萨巴 |
| BR | Brazilian |
| BS | Bahamas |
| BT | Bhutan |
| BV | Bouvet Island |
| BW | Botswana |
| BY | Byelorussia |
| BZ | Belize |
| CA | Canada |
| CC | Cocos Islands |
| CD | Zaire |
| CF | Central African Republic |
| CG | Congolese |
| CH | Switzerland |
| CI | Côte d’Ivoire |
| CK | Cook Islands |
| CL | Chilean |
| CM | Cameroon |
| CN | China |
| CO | Columbia |
| CR | Costa Rica |
| CU | Cubans |
| CV | Cape Verde |
| CW | Curaçao |
| CX | Christmas Island |
| CY | Cyprus |
| CZ | Czech Republic |
| DE | Germany |
| DJ | Djibouti |
| DK | Danes |
| DM | Dominica |
| DO | Dominican Republic |
| DZ | Algeria |
| EC | Petroecuador |
| EE | Estonia |
| EG | Egyptian |
| EH | Western Sahara |
| ER | Eritrean |
| ES | Spaniard |
| ET | Ethiopian |
| FI | Finland |
| FJ | Fiji |
| FK | Falkland Islands |
| FM | Micronesia |
| FO | Faroe Islands |
| FR | France |
| GA | Gabon |
| UK | United Kingdom |
| GD | Grenada |
| GE | Georgia |
| GF | French Guiana |
| GG | Guernsey |
| GH | Ghana |
| GI | Gibraltar |
| GL | Greenland |
| GM | Gambia |
| GN | Guinea |
| GP | Guadeloupe |
| GQ | Equatorial Guinea |
| GR | Greece |
| GS | South Georgia and the South Sandwich Islands |
| GT | Guatemala |
| GU | Guam |
| GW | Guinea-Bissau |
| GY | Guyana |
| HK | Hong Kong, China |
| HM | Heard Island and McDonald Islands |
| HN | Honduras |
| HR | Croatia |
| HT | Haiti |
| HU | Hungary |
| ID | Indonesia |
| IE | Ireland |
| IL | Israel |
| IM | Isle of Man |
| IN | India |
| IO | British Indian Ocean Territory |
| IQ | Iraq |
| IR | Islamic Republic of Iran |
| IS | Iceland |
| IT | Italy |
| JE | Jersey |
| JM | Jamaica |
| JO | Jordan |
| JP | Japan |
| KE | Kenya |
| KG | Kyrgyzstan |
| KH | Cambodia |
| KI | Kiribati |
| KM | Comoros |
| KN | Saint Kitts and Nevis |
| KP | Democratic People's Republic of Korea |
| KR | Republic of Korea |
| KW | Kuwait |
| KY | Cayman Islands |
| KZ | Kazakhstan |
| LA | Lao People's Democratic Republic |
| LB | Lebanon |
| LC | Saint Lucia |
| LI | Liechtenstein |
| LK | Sri Lanka |
| LR | Liberia |
| LS | Lesotho |
| LT | Lithuania |
| LU | Luxembourg |
| LV | Latvia |
| LY | Libyan Arab Jamahiriya |
| MA | Morocco |
| MC | Monaco |
| MD | Republic of Moldova |
| ME | Montenegro |
| MF | Saint Martin |
| MG | Madagascar |
| MH | Marshall Islands |
| MK | The Former Yugoslav Republic of Macedonia |
| ML | Mali |
| MM | Myanmar |
| MN | Mongolia |
| MO | Macao, China |
| MP | Northern Mariana Islands |
| MQ | Martinique |
| MR | Mauritania |
| MS | Montserrat |
| MT | Malta |
| MU | Mauritius |
| MV | Maldives |
| MW | Malawi |
| MX | Mexico |
| MY | Malaysia |
| MZ | Mozambique |
| NA | Namibia |
| NC | New Caledonia |
| NE | Niger |
| NF | Norfolk Island |
| NG | Nigeria |
| NI | Nicaragua |
| NL | Netherlands |
| NO | Norway |
| NP | Nepal |
| NR | Nauru |
| NU | Niue |
| NZ | New Zealand |
| OM | Oman |
| PA | Panama |
| PE | Peru |
| PF | French Polynesia |
| PG | Papua New Guinea |
| PH | Philippines |
| PK | Pakistan |
| PL | Poland |
| PM | Saint Pierre and Miquelon |
| PN | Pitcairn |
| PR | Puerto Rico |
| PS | Palestinian Territory |
| PT | Portugal |
| PW | Palau |
| PY | Paraguay |
| QA | Qatar |
| RE | Reunion |
| RO | Romania |
| RS | Serbia |
| RU | Russia |
| RW | Rwanda |
| SA | Saudi Arabia |
| SB | Solomon Islands |
| SC | Seychelles |
| SD | Sudan |
| SE | Sweden |
| SG | Singapore |
| SH | Saint Helena |
| SI | Slovenia |
| SJ | Svalbard and Jan Mayen |
| SK | Slovak Republic |
| SL | Sierra Leone |
| SM | San Marino |
| SN | Senegal |
| SO | Somalia |
| SR | Suriname |
| SS | South Sudan |
| ST | Sao Tome and Principe |
| SV | El Salvador |
| SX | Sint Maarten |
| SY | Syria |
| SZ | Swaziland |
| TC | Turks and Caicos Islands |
| TD | Chad |
| TF | French Southern Territories |
| TG | Togo |
| TH | Thailand |
| TJ | Tajikistan |
| TK | Tokelau |
| TL | Timor-Leste |
| TM | Turkmenistan |
| TN | Tunisia |
| TO | Tonga |
| TR | Turkey |
| TT | Trinidad and Tobago |
| TV | Tuvalu |
| TW | Taiwan, China |
| TZ | Tanzania |
| UA | Ukraine |
| UG | Uganda |
| UM | United States Minor Outlying Islands |
| US | United States |
| UY | Uruguay |
| UZ | Uzbekistan |
| VA | Holy See (Vatican City State) |
| VC | Saint Vincent and the Grenadines |
| VE | Venezuela |
| VG | British Virgin Islands |
| VI | U.S. Virgin Islands |
| VN | Vietnam |
| VU | Vanuatu |
| WF | Wallis and Futuna |
| WS | Samoa |
| XK | Kosovo |
| YE | Yemen |
| YT | Mayotte |
| ZA | South Africa |
| ZM | Zambia |
| ZW | Zimbabwe |
1.13. Inventory journal operation type
| Enum | Description |
|---|---|
| INBOUND | Receipt and warehousing |
| INVENTORY_IMPORT | Inventory import |
| ORDER_OUTBOUND | The order is out of the warehouse |
| INVENTORY_ADJUSTMENT | Inventory adjustments |
| PURCHASE | Purchase ordering |
| PURCHASE_CHANGE | Procurement Changes |
| FIRST_LEG | The first shipment |
| FIRST_LEG_WITHDRAW_SHIPPED | The first leg is revoked |
| PHYSICAL_INVENTORY | Inventory counts |
| TRANSFER | Allocation and shipment |
| MANUAL | Manual warehousing |
| MANUAL_ODO | Outbound orders of the manual outbound type |
| PURCHASE_RETURN_ODO | Outbound orders of the purchase return type |
| ASSEMBLY | Inventory processing |
| RESTORE_ORDER | Split the order |
1.14. Inventory journal sub-operation type
| Enum | Description |
|---|---|
| COUNT_EXTRA | Profit increase |
| COUNT_MISSING | Inventory loss adjustment |
| I_ASSEMBLY | Inventory processing orders are put into storage |
| O_ASSEMBLY | Inventory processing order is out of the warehouse |
| I_RESTORE | Split order put-away |
| O_RESTORE | Split the order out of the warehouse |
1.15. Inventory modify record modification type
| Enum | Description |
|---|---|
| ALLOCATE | Inventory allocation |
| REVERT | Frozen |
| DECREASE | deducted |
| MODIFY | modify |
| SHIPPING | SHIPPING |
1.16. Purchase order status
| Enum | Description |
|---|---|
| NEW | new |
| WAIT_CHECK | To be reviewed |
| WAIT_REVIEW | Pending review |
| DENIED | The review is not passed |
| APPROVED | Approved |
| ORDERED | An order has been placed |
| RECEIVING | Receiving goods |
| CLOSED | Closed |
| FINISH | Done |
1.17. Headway status
| Enum | Description |
|---|---|
| NEW | new |
| COMMITTED | Submitted |
| SHIPPING | On the way |
| RECEIVING | Receiving goods |
| FINISHED | Done |
| CLOSED | Closed |
1.18. Inbound order status
| Enum | Description |
|---|---|
| NEW | new |
| DELETED | Deleted |
| SHIPPING | On the way |
| RECEIVING | Receiving goods |
| FINISHED | Done |
| CLOSED | Closed |
1.19. Outbound order status
| Enum | Description |
|---|---|
| WAIT_OUTBOUND | To be shipped |
| FINISHED | Done |
1.20. Business order type
| Enum | Description |
|---|---|
| PURCHASE | Purchase inbound list |
| MANUAL | Manual inbound list |
| INVENTORY_IMPORT | Inventory import inbound order |
| SALE_RETURN | Return inbound order |
| FIRST_LEG | The first mileage is planned to be inbound |
| TRANSFER_PLAN | Plan inventory inbound orders |
| TRANSFER_AVAILABLE | Available inventory inbound orders |
| ASSEMBLY_ORDER | Processing order warehousing |
| RESTORE_ORDER | Split the order |
1.21. Outbound order type
| Enum | Description |
|---|---|
| PURCHASE_RETURN | Purchase Returns |
| MANUAL | Manual outbound order |
| FIRST_LEG | The first trip is out of the warehouse |
| TRANSFER | Allocate out of the warehouse |
| LABEL_REPLACEMENT | Change the label out of the warehouse |
| OTHER | Other |
1.22. Adjustment order type
| Enum | Description |
|---|---|
| MANUAL | Manual |
| AUTO | auto |
1.23. Adjustment order sub type
| Enum | Description |
|---|---|
| EXTERNAL_ADJUST | External adjustments |
| EXT_ADJUST_TRANSFER | External (adjusted) transfers |
| SYNC_INVENTORY | Inventory synchronization |
| WITHDRAW_SHIPPED | The first leg is cancelled from delivery |
| COUNT_EXTRA | Profit increase |
| COUNT_MISSING | Inventory loss adjustment |
1.24. Purchase order type
| Enum | Description |
|---|---|
| DIRECT | Domestic warehouse procurement |
| TRANSFER | Overseas warehouse procurement |
1.25. Transport principal
| Enum | Description |
|---|---|
| SUPPLIER | Supply-side |
| PURCHASER | Purchaser |
1.26. Shipping method
| Enum | Description |
|---|---|
| SELF | Self-pickup |
| EXPRESS | Express |
| LOGISTICS | Logistical |
| DELIVERY | Delivery |
1.27. Payment method
| Enum | Description |
|---|---|
| CASH | Cash |
| TRANSFER | Transfer |
1.28. Billing method
| Enum | Description |
|---|---|
| DELIVERY_ON_CASH | Pick up the goods with the money |
| FIXED_ACCOUNT_PERIOD | Fixed billing periods |
| DYNAMIC_ACCOUNT_PERIOD | Dynamic billing periods |
1.29. Node effect type
| Enum | Description |
|---|---|
| RECEIVE | Receiving |
| FIRST_LEG_SHIP | The first shipment |
1.30. 1688 order type
| Enum | Description |
|---|---|
| general | Large market orders |
| fenxiao | Tao source order |
| saleproxy | Consignment marketing orders |
1.31. 1688 trade types
| Enum | Description |
|---|---|
| FXASSURE | Transaction 4.0 General Secured Transactions |
| ALIPAY | Alipay |
| PERIOD | Ordinary Billing Period Transactions |
| ASSURE | Guaranteed transactions for large buyers |
| CREDITBUY | Honest E credit |
| BANK | Bank transfer |
| STAGED_163 | 631 Phased Payments |
| STAGED_37 | 37 phases |
1.32. Logistics tracking status
| Enum | Description |
|---|---|
| CREATED | To be collected |
| IN_TRANSIT | In transit |
| OUT_FOR_DELIVERY | Delivering |
| DELIVERED | Signed |
| NOT_FOUND | Not found |
| UNDELIVERABLE | Abnormal |
1.33. Return order status
| Enum | Description |
|---|---|
| NEW | To be submitted |
| WAIT_STORAGE | To be put into storage |
| RECEIVING | Receiving goods |
| FINISH | Done |
| CLOSE | Closed |
| WAIT_AUDIT | Pending approval |
| WAIT_BUYER_RETURN | Wait for the seller to return it |
1.34. Adjust type
| Enum | Description |
|---|---|
| AVL_DIFFERENCE | Available inventory – Incremental adjustments |
| AVL_FINAL | Available inventory – Full adjustment |
1.35. Transfer order status
| Status | code |
|---|---|
| new | NEW |
| Submitted | COMMITTED |
| On the way | SHIPPING |
| Receiving goods | RECEIVING |
| Done | FINISHED |
| Closed | CLOSED |
1.36. Transfer order charge status
| Status | code |
|---|---|
| new | NEW |
| Requested | APPLIED |
| Paid | PAID |
| Partial payment | PART_PAID |
| Deprecated | INVALID |