Get Inbound Method Detail

POST

/fbt/202602/inbound_method_detail

Retrieves placement details for an inbound plan. First call the List Available Inbound Methods API for the plan, then use the inbound_method and estimated arrival window from the same returned option. The response reports the placement task status and, when available, placement options with shipment allocations; ONE_HUB options can also include an estimated placement fee.

Authorizations

• accessToken

Parameters

Query Parameters

shop_cipher

required

string

Identifies the shop. Obtain it from the Get Authorized Shops API.

Request Body^required

Media typeapplication/json

object

plan_id

required

Inbound plan identifier

string

inbound_method

required

Possible values:

• D2FC (Direct to fulfillment center, may be split into multiple shipments)
• ONE_HUB (Single destination; can include an estimated placement fee)

string

Allowed values: D2FC ONE_HUB

estimate_arrival_time

required

Estimated arrival window for the selected inbound_method. Use the start_timestamp and end_timestamp from the same entry in the available_time_window_list returned by the List Available Inbound Methods API for this plan.

object

start_timestamp

required

Start of the estimated arrival time window as a Unix timestamp in seconds. For example, 1774162800 corresponds to Sunday, 2026-03-22 at 00:00 PDT (2026-03-22T07:00:00Z). Use the exact start_timestamp returned in available_time_window_list by the ListAvailableInboundMethod API.

string

end_timestamp

required

End of the estimated arrival time window as a Unix timestamp in seconds. For example, 1774767600 corresponds to Sunday, 2026-03-29 at 00:00 PDT (2026-03-29T07:00:00Z). Use the exact end_timestamp returned in available_time_window_list by the ListAvailableInboundMethod API.

string

Example

{
  "plan_id": "5766071177167344427",
  "inbound_method": "D2FC",
  "estimate_arrival_time": {
    "start_timestamp": "1774162800",
    "end_timestamp": "1774767600"
  }
}

Responses

200

Success

Media typeapplication/json

object

code

Status code; 0 means success.

integer format: int64

message

Success or failure message.

string

request_id

Request log ID.

string

data

object

info

Placement options for the current placement task. If placement_task_status is Executing, repeat this request with the same plan_id, inbound_method, and estimated arrival window to retrieve the latest status. When the status is Succeed, select an option from info and pass its placement_option_id to the Confirm Inbound Method API. Do not confirm an option when the status is Failed. After expiration_timestamp, call this API again with the same selection inputs to obtain a new placement option or task.

Array<object>

object

allocation_shipments

List of shipments for this placement option.

Array<object>

object

warehouse_id

Warehouse identifier.

string

goods_items

Goods item list.

Array<object>

object

goods_id

Goods identifier.

string

quantity

Quantity of this goods.

integer format: int64

cartons

Carton List.

Array<object>

object

carton_type

Indicates if this is a single SKU carton or multi SKU carton. Possible values:

• SINGLE_SKU
• MULTI_SKU

string

Allowed values: SINGLE_SKU MULTI_SKU

items

Goods item list of a carton.

Array<object>

object

goods_id

Goods identifier.

string

quantity

Quantity of this goods.

integer format: int64

lot_code

Lot code of this goods.

string

expiration_timestamp

The expiration date for this item, Unix timestamp in seconds.

string

quantity

Carton quantity.

integer format: int64

carton_nums

Carton numbers.

Array<string>

box_measurements

Carton measurement.

object

weight

Carton weight.

string

weight_unit

The unit used for the carton’s weight value.

Possible values:

• KILOGRAM (kg)
• GRAM (g)
• MILLIGRAM (mg)
• POUNDS (lbs)
• OUNCE (oz)

string

Allowed values: KILOGRAM GRAM MILLIGRAM POUNDS OUNCE

width

Carton width.

string

height

Carton height.

string

length

Carton length.

string

length_unit

The unit used for the carton’s length, width, and height values.

Possible values:

• METER (m)
• CENTIMETER (cm)
• MILLIMETER (mm)
• FOOT (ft)
• MICRON (μm)
• INCH (in)

string

Allowed values: METER CENTIMETER MILLIMETER FOOT MICRON INCH

shipment_options

Shipment options.

Array<object>

object

shipping_method

Shipping method for this shipment option. Possible values: SMALL_PARCEL, a parcel shipment method; FREIGHT, a freight shipment method.

string

placement_option_id

Placement option id. A placement option represents the shipment splits and destinations.

string

placement_fee_estimate

Estimated placement fee for a ONE_HUB placement option.

object

amount

Placement fee amount.

string

currency

The currency of the placement fee amount.

Possible values:

• USD
• CNY
• EUR
• GBP
• SAR

string

Allowed values: USD CNY EUR GBP SAR

placement_task_status

Possible values:

• Executing
• Succeed
• Failed

string

Allowed values: Executing Succeed Failed

expiration_timestamp

Unix timestamp in seconds when the placement result expires. For ONE_HUB, the expiration is set to 24 hours after this API processes the request. For other methods, it is 24 hours after the placement task’s trigger time. After expiration, call this API again to generate a new placement task.

string

Example

{
  "code": 0,
  "data": {
    "info": [
      {
        "allocation_shipments": [
          {
            "warehouse_id": "7542187927317874487",
            "goods_items": [
              {
                "goods_id": "2134566",
                "quantity": 400
              }
            ],
            "cartons": [
              {
                "carton_type": "SINGLE_SKU",
                "items": [
                  {
                    "goods_id": "12345",
                    "quantity": 20,
                    "lot_code": "sfsfnjkfvv",
                    "expiration_timestamp": "1623812664"
                  }
                ],
                "quantity": 2,
                "carton_nums": [
                  "C0001",
                  "C0002"
                ],
                "box_measurements": {
                  "weight": "3.5",
                  "weight_unit": "POUNDS",
                  "width": "1.2",
                  "height": "2",
                  "length": "5",
                  "length_unit": "INCH"
                }
              }
            ],
            "shipment_options": [
              {
                "shipping_method": "SMALL_PARCEL"
              }
            ]
          }
        ],
        "placement_option_id": "5766071177167344420",
        "placement_fee_estimate": {
          "amount": "13.50",
          "currency": "USD"
        }
      }
    ],
    "placement_task_status": "Executing",
    "expiration_timestamp": "1774767600"
  },
  "message": "Success",
  "request_id": "202203070749000101890810281E8C70B7"
}