FBA Transport V0
The FBA Transport API allows you to see and control the FBA plans and transport details for an outbound shipment
Index Plans
Get all the FBA plans created for an outbound shipment
GET
/fba-transport/v0/plans
| Parameter | Type | Examples | Description |
|---|---|---|---|
outbound_shipment_id
| integer | 122 | The ID of the outbound shipment |
Example Response
{
"data": [
{
"id": "6d174247-330a-4a55-aaa6-903e3c404026",
"name": "Test Plans - Split 1",
"created_at": "2024-07-24T11:13:10.000000Z",
"outbound_shipment_id": 5657,
"channel_id": 1,
"mode": "partnered_small_parcel",
"fba_shipment_id": "FBANT8XDAU9CX",
"destination_id": "VUBI",
"ship_from_address": {
"name": "NY Warehouse",
"address_line_1": "1000 State Route 36",
"address_line_2": "Suite 974",
"company_name": null,
"district_or_county": null,
"city": "Hornell",
"state_or_province_code": "NY",
"country_code": "US",
"postal_code": "14843-3091",
"email": null,
"phone": null
},
"destination_address": {
"name": "SUOX",
"address_line_1": "150 Springville Station Blvd",
"address_line_2": null,
"company_name": null,
"district_or_county": null,
"city": "Springville",
"state_or_province_code": "AL",
"country_code": "US",
"postal_code": "35146-7732",
"email": null,
"phone": null
},
"is_accepted": true,
"is_rejected": false,
"is_marked_as_shipped": false,
"is_marked_as_deleted": false,
"partnered_carrier": "UNITED_PARCEL_SERVICE_INC",
"using_2d_barcodes": false,
"items": [
{
"id": "1bf8930e-aaee-496c-b872-d8553b3c097d",
"seller_sku": "Incredibl-746543",
"fnsku": "X00N2VJGHH",
"quantity": 5
}
],
"box_groups": [
{
"id": "f1aebe81-fec9-4a4d-b615-02987c0633d3",
"length_mm": 330,
"width_mm": 305,
"height_mm": 254,
"weight_gm": 4536,
"box_numbers": [
1
],
"items": []
},
{
"id": "4cc6f270-ab5e-4e4d-ae62-ae9480fe6636",
"length_mm": 305,
"width_mm": 305,
"height_mm": 254,
"weight_gm": 4536,
"box_numbers": [],
"items": []
},
{
"id": "38921ad7-90ac-4935-835a-ee10785460d4",
"length_mm": 305,
"width_mm": 305,
"height_mm": 254,
"weight_gm": 4536,
"box_numbers": [
2
],
"items": [
{
"id": "e3fcc931-d26e-41cc-a3fd-02ef1be14b3d",
"plan_item_id": "1bf8930e-aaee-496c-b872-d8553b3c097d",
"quantity": 6,
"expiration": null
}
]
}
],
"pallets": [],
"non_partnered_ltl_tracking": null,
"non_partnered_small_parcel_tracking": null,
"partnered_ltl_details": null,
"partnered_estimate": {
"estimate_amount": 19.99,
"estimate_currency": "USD",
"void_deadline": null,
"is_voided": false
},
"transport_status_check": {
"status": "estimated"
}
}
]
}Show Plan
Get the details of an FBA plan
GET
/fba-transport/v0/plans/{PLAN_ID}
Example Response
{
"data": {
"id": "6d174247-330a-4a55-aaa6-903e3c404026",
"name": "Test Plans - Split 1",
"created_at": "2024-07-24T11:13:10.000000Z",
"outbound_shipment_id": 5657,
"channel_id": 1,
"mode": "partnered_small_parcel",
"fba_shipment_id": "FBANT8XDAU9CX",
"destination_id": "VUBI",
"ship_from_address": {
"name": "NY Warehouse",
"address_line_1": "1000 State Route 36",
"address_line_2": "Suite 974",
"company_name": null,
"district_or_county": null,
"city": "Hornell",
"state_or_province_code": "NY",
"country_code": "US",
"postal_code": "14843-3091",
"email": null,
"phone": null
},
"destination_address": {
"name": "SUOX",
"address_line_1": "150 Springville Station Blvd",
"address_line_2": null,
"company_name": null,
"district_or_county": null,
"city": "Springville",
"state_or_province_code": "AL",
"country_code": "US",
"postal_code": "35146-7732",
"email": null,
"phone": null
},
"is_accepted": true,
"is_rejected": false,
"is_marked_as_shipped": false,
"is_marked_as_deleted": false,
"partnered_carrier": "UNITED_PARCEL_SERVICE_INC",
"using_2d_barcodes": false,
"items": [
{
"id": "1bf8930e-aaee-496c-b872-d8553b3c097d",
"seller_sku": "Incredibl-746543",
"fnsku": "X00N2VJGHH",
"quantity": 5
}
],
"box_groups": [
{
"id": "f1aebe81-fec9-4a4d-b615-02987c0633d3",
"length_mm": 330,
"width_mm": 305,
"height_mm": 254,
"weight_gm": 4536,
"box_numbers": [
1
],
"items": [
{
"id": "586d48e7-3491-43c3-b68e-eabf14775dec",
"plan_item_id": "1bf8930e-aaee-496c-b872-d8553b3c097d",
"quantity": 5,
"expiration": null
}
]
}
],
"pallets": [],
"non_partnered_ltl_tracking": null,
"non_partnered_small_parcel_tracking": null,
"partnered_ltl_details": null,
"partnered_estimate": {
"estimate_amount": 19.99,
"estimate_currency": "USD",
"void_deadline": null,
"is_voided": false
},
"transport_status_check": {
"status": "estimated"
}
}
}