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 Information Query

POST
/v1/inbound/getInboundPlanInfo
inbound

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
Example
{
    "orderNo": "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/getInboundPlanInfo' \
--header 'x-api-key: abc123(认证信息)' \
--header 'Content-Type: application/json' \
--data-raw '{
    "orderNo": "string"
}'

Responses

🟢200成功
application/json
Body
code
string 
required
Code 200 indicates a successful query
message
string 
required
Return Message
data
object 
required
Inbound Data
orgWarehouseCode
string 
required
Warehouse Code
lineName
string 
required
Program Name
inventoryType
string 
required
Inventory Type
inboundPlanOrderNo
string 
required
Inbound plan number
inboundPlanOrderStatus
string 
required
Status:Pending approval, Reject, To be packed, To be shipped, To be received, Receiving, Received, Canceled
sourceNo
string 
required
Source Number
shipmentId
string 
required
Amazon Shipment ID
referenceId
string 
required
Amazon Reference ID
shipmentNo
string 
required
Shipment Number
estimateArriveTime
string 
required
Estimated Arrival Date
actualArriveTime
string 
required
Actual Arrival Date
firstReceptionDate
string 
required
First Receipt Date
shipperName
string 
required
Shipper Name
shipperAddress
string 
required
Shipper Address
shipperContact
string 
required
Shipper Contact Person
shipperPhone
string 
required
Shipper Phone Number
goodsType
string 
required
Goods Type
gpQuantity20
string 
required
Quantity of 20GP Container
gpCartonNo20
string 
required
20GP Container Number
gpQuantity40
string 
required
Quantity of 40GP Container
gpCartonNo40
string 
required
40GP Container Number
hqQuantity40
string 
required
Quantity of 40HQ Container
hqCartonNo40
string 
required
40HQ Container Number
hqQuantity45
string 
required
Quantity of 45HQ Container
hqCartonNo45
string 
required
45HQ Container Number
cartonQty
string 
required
Carton Quanity
planQty
integer 
required
Plan Quantity
packedQty
integer 
required
Total Packing Quantity
receivedQty
integer 
required
Total Received Quantity
totalWeight
number 
required
Total Weight(KG)
totalVolume
number 
required
Total Volume(CBM)
actualShipDate
string 
required
Actual Shipping Date
cartonTotalWeight
number 
required
Total Carton Weight(KG)
cartonTotalVolume
number 
required
Total Carton Volum(CBM)
packingLabelUrl
string 
required
Carton Label File
remark
string 
required
Remarks
planProductDetailParamList
array [object {6}] 
required
Product Detail
Example
{
  "statusCode": 200,
  "status": 0,
  "code": 200,
  "message": "获取入库信息成功",
  "data": {
    "orgWarehouseCode": "HF_CA_US",
    "lineName": "finnhomy-rack",
    "inventoryType": "可售库存",
    "inboundPlanOrderNo": "SH191023AAE01",
    "inboundPlanOrderStatus": "入库中",
    "sourceNo": "SH191023AAE01",
    "shipmentId": "",
    "referenceId": "",
    "shipmentNo": null,
    "estimateArriveTime": null,
    "actualArriveTime": "2020-02-07 07:08:16",
    "firstReceptionDate": "2019-10-23 00:00:00",
    "shipperName": "Hangzhou Finnkarelia International Ecommerce Co., ",
    "shipperAddress": "No. 111, South Hushu Road, Hangzhou, China.",
    "shipperContact": "13666600962",
    "shipperPhone": "13666600962",
    "goodsType": "集装箱",
    "gpQuantity20": 0,
    "gpCartonNo20": null,
    "gpQuantity40": 0,
    "gpCartonNo40": null,
    "hqQuantity40": 0,
    "hqCartonNo40": null,
    "hqQuantity45": 0,
    "hqCartonNo45": null,
    "cartonQty": 110,
    "planQty": 110,
    "packedQty": 110,
    "receivedQty": 5,
    "totalWeight": 32.5600,
    "totalVolume": 0.2093,
    "actualShipDate": null,
    "cartonTotalWeight": 1045000.0000,
    "cartonTotalVolume": 610579.2000,
    "packingLabelUrl": "",
    "remark": "ds",
    "planProductDetailParamList": [
      {
        "sku": "F20WKI6J1309",
        "qty": 50,
        "qtyPacked": 50,
        "qtyReceived": 2,
        "qtyReceivedSaleable": 2,
        "qtyReceivedUnsaleable": 0
      },
      {
        "sku": "F20WKI6L1310",
        "qty": 60,
        "qtyPacked": 60,
        "qtyReceived": 3,
        "qtyReceivedSaleable": 3,
        "qtyReceivedUnsaleable": 5
      }
    ]
  }
}
🔴500失败
Modified at 2023-12-07 22:17:35
Previous
Cancel Inbound Plan
Next
Batch Inventory Query
Built with