Create Inbound Plan

POST

/v1/inbound/createInboundPlan

inbound

Request

Header Params

x-api-key

string

required

Example:

abc123(认证信息)

Content-Type

string

required

Example:

application/json

Body Params application/json

warehouseCode

string

required

Inbound Warehouse Code

lineCode

string

optional

Program Name

inventoryType

integer

required

Inventory Type: 0 Normal Inventory, 1 Unsellable Inventory

batchNumber

string

optional

Factory Batch Number

orderNo

string

required

Inbound Order Number

shipmentId

string

optional

Amazon Order Shipment ID

referenceId

string

optional

Amazon Order Reference ID

currency

string

required

Currency is default to USD, affecting inventory cost calculation

estimateArriveTime

string

optional

Estimated Arrival Time (yyyy-MM-dd)

originCountry

string

optional

Origin Country

expectArriveDate

string

required

Expected Arrival Date (yyyy-MM-dd)

predictionShipDate

string

required

Estimated Shipping Date (yyyy-MM-dd)

shipperName

string

required

Shipper Name

shipperAddress

string

required

Shipper Address

shipperContact

string

required

Shipper Contact Person

shipperPhone

string

required

Shipper Phone Number

containerNo

string

optional

The shipping container number must be a combination of 4 uppercase letters and 7 digits, for example: ABCD1234567

remark

string

optional

Remark

productItems

array [object {3}]

required

Product Details

sku

string

optional

Inbound product SKU

qty

integer

optional

Inbound quantity

cost

number

optional

Procurement costs, affecting inventory costs, and other data

attachInfoItems

array [object {5}]

optional

Attachment Information (Optional, if provided, please fill in the required items below)

name

string

optional

Attachment name

url

string

optional

Attachment URL

file

string

optional

64 string; if filled, do not recognize the content in the URL above (either URL or file must be filled in)

type

string

optional

Attachment Type: ShippingLabel, PackingList, BOL, Other

remark

string

optional

Remark

cartonItems

array [object {8}]

optional

Carton Information

sku

string

optional

Inbound SKU

qty

integer

optional

Quantity

cartonQty

integer

optional

Carton Quantity

cartonNo

string

optional

Carton Number

cartonWeight

number

optional

Carton Weight(g)

cartonLength

number

optional

Carton Length(cm)

cartonWidth

number

optional

Carton Width(cm)

cartonHeight

number

optional

Carton Height(cm)

Example

{
    "warehouseCode": "string",
    "lineCode": "string",
    "inventoryType": 0,
    "batchNumber": "string",
    "orderNo": "string",
    "shipmentId": "string",
    "referenceId": "string",
    "currency": "string",
    "estimateArriveTime": "string",
    "originCountry": "string",
    "expectArriveDate": "string",
    "predictionShipDate": "string",
    "shipperName": "string",
    "shipperAddress": "string",
    "shipperContact": "string",
    "shipperPhone": "string",
    "containerNo": "string",
    "remark": "string",
    "productItems": [
        {
            "sku": "string",
            "qty": 0,
            "cost": 0
        }
    ],
    "attachInfoItems": [
        {
            "name": "string",
            "url": "string",
            "file": "string",
            "type": "string",
            "remark": "string"
        }
    ],
    "cartonItems": [
        {
            "sku": "string",
            "qty": 0,
            "cartonQty": 0,
            "cartonNo": "string",
            "cartonWeight": 0,
            "cartonLength": 0,
            "cartonWidth": 0,
            "cartonHeight": 0
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://127.0.0.1/v1/inbound/createInboundPlan' \
--header 'x-api-key: abc123(认证信息)' \
--header 'Content-Type: application/json' \
--data-raw '{
    "warehouseCode": "string",
    "lineCode": "string",
    "inventoryType": 0,
    "batchNumber": "string",
    "orderNo": "string",
    "shipmentId": "string",
    "referenceId": "string",
    "currency": "string",
    "estimateArriveTime": "string",
    "originCountry": "string",
    "expectArriveDate": "string",
    "predictionShipDate": "string",
    "shipperName": "string",
    "shipperAddress": "string",
    "shipperContact": "string",
    "shipperPhone": "string",
    "containerNo": "string",
    "remark": "string",
    "productItems": [
        {
            "sku": "string",
            "qty": 0,
            "cost": 0
        }
    ],
    "attachInfoItems": [
        {
            "name": "string",
            "url": "string",
            "file": "string",
            "type": "string",
            "remark": "string"
        }
    ],
    "cartonItems": [
        {
            "sku": "string",
            "qty": 0,
            "cartonQty": 0,
            "cartonNo": "string",
            "cartonWeight": 0,
            "cartonLength": 0,
            "cartonWidth": 0,
            "cartonHeight": 0
        }
    ]
}'

Responses

🟢200成功

application/json

Body

code

string

required

Return Code 200 is successful

message

string

required

Return description

data

object

required

Return Data

inboundPlanOrderNo

string

required

Inbound plan no

Example

{
    "statusCode": 200,
    "status": 0,
    "code": 200,
    "message": "创建入库计划成功",
    "data": {
        "inboundPlanOrderNo": "IP20122300023"
    }
}

🔴500失败

Modified at 2023-12-12 01:12:36

SKU Batch Query

Inbound Plan Shipping Operation