OPEN-API-English
  1. Inbound Plan
OPEN-API-English
  • Default Group
    • Product
      • Create/Edit Products
      • Create Product Identification Code
      • Query SKU
      • SKU Batch Query
    • Inbound Plan
      • Create Inbound Plan
        POST
      • Inbound Plan Shipping Operation
        POST
      • Add Inbound Plan Attachment
        POST
      • Cancel Inbound Plan
        POST
      • Inbound Plan Information Query
        POST
    • 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. Inbound Plan

Inbound Plan Shipping Operation

POST
/v1/inbound/ship

Request

Header Params
x-api-key
string 
required
Example:
abc123(认证信息)
Content-Type
string 
required
Example:
application/json
Body Params application/json
orderNo
string 
required
Inbound Plan Number (Source Number)
shipmentNo
string 
required
Shipment Number
actualShipDate
string 
required
Actual Shipping Date
estimateDeliveryDate
string 
required
Estimated Arrival Date (yyyy-MM-dd)
gp20Containerqty
integer 
required
Quantity of 20GP Container
gp20Containerno
string 
required
20GP Container Number, separated by commas
gp40Containerqty
integer 
required
Quantity of 40GP Container
gp40Containerno
string 
required
40GP Container Number, separated by commas
hq40Containerqty
integer 
required
Quantity of 40HQ Container
hq40Containerno
string 
required
40HQ Container Number, separated by commas
hq45Containerqty
integer 
required
Quantity of 45HQ Container
hq45Containerno
string 
required
45HQ Container Number, separated by commas
remark
string 
required
Remark
Example
{
    "orderNo": "string",
    "shipmentNo": "string",
    "actualShipDate": "string",
    "estimateDeliveryDate": "string",
    "gp20Containerqty": 0,
    "gp20Containerno": "string",
    "gp40Containerqty": 0,
    "gp40Containerno": "string",
    "hq40Containerqty": 0,
    "hq40Containerno": "string",
    "hq45Containerqty": 0,
    "hq45Containerno": "string",
    "remark": "string"
}

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/inbound/ship' \
--header 'x-api-key: abc123(认证信息)' \
--header 'Content-Type: application/json' \
--data-raw '{
    "orderNo": "string",
    "shipmentNo": "string",
    "actualShipDate": "string",
    "estimateDeliveryDate": "string",
    "gp20Containerqty": 0,
    "gp20Containerno": "string",
    "gp40Containerqty": 0,
    "gp40Containerno": "string",
    "hq40Containerqty": 0,
    "hq40Containerno": "string",
    "hq45Containerqty": 0,
    "hq45Containerno": "string",
    "remark": "string"
}'

Responses

🟢200成功
application/json
Body
code
string 
required
Return Code 200 is successful
message
string 
required
Return message
Example
{
  "statusCode": 200,
  "status": 0,
  "code": 200,
  "message": "操作成功"
}
🔴500失败
Modified at 2023-12-07 21:49:41
Previous
Create Inbound Plan
Next
Add Inbound Plan Attachment
Built with