PrepBusiness LogoAPI Documentation

FBA Plans

GET/fba-transport/v2024/plans

List FBA transport v2024 plans

Optional attributes

  • Name
    outbound_shipment_id
    Type
    integer
    Description
    Filter plans by outbound shipment ID 1

Request

GET/fba-transport/v2024/plans
curl -G https://YOUR_DOMAIN/api/fba-transport/v2024/plans \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json"
Loading response...
POST/fba-transport/v2024/plans

Create an FBA transport v2024 shipping plan

Creates a new Amazon FBA inbound shipping plan for an outbound shipment. The plan is created asynchronously via Amazon's Fulfillment Inbound API. Once created, use the returned plan to configure packing options, placement options, and transportation options before confirming the shipment.

Required attributes

  • Name
    outbound_shipment_id
    Type
    integer
    Description
    The ID of the outbound shipment to create a plan for 5
  • Name
    channel_id
    Type
    integer
    Description
    The ID of the Amazon channel (must be an active Amazon channel) 1
  • Name
    items
    Type
    array<Item>
    Description
    The items to include in the shipping plan
  • Name
    items.*.msku
    Type
    string
    Description
    The merchant SKU for this item Mini-Porta-276810
  • Name
    items.*.quantity
    Type
    integer
    Description
    The quantity of this item to include in the plan 40
  • Name
    items.*.label_owner
    Type
    string
    Description
    Who will own the labeling responsibility for this item SELLER
  • Name
    items.*.prep_owner
    Type
    string
    Description
    Who will own the prep responsibility for this item SELLER

Optional attributes

  • Name
    destination_marketplace
    Type
    string
    Description
    The Amazon marketplace identifier for the destination (e.g. ATVPDKIKX0DER for US). Defaults to the channel's marketplace if not provided. ATVPDKIKX0DER
  • Name
    items.*.expiration
    Type
    string
    Description
    Optional expiration date for the item (YYYY-MM-DD)
  • Name
    items.*.manufacturing_lot_code
    Type
    string
    Description
    Optional manufacturing lot code (1-256 characters)

Request

POST/fba-transport/v2024/plans
curl -X POST https://YOUR_DOMAIN/api/fba-transport/v2024/plans \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "outbound_shipment_id": 5,
    "channel_id": 1,
    "destination_marketplace": "ATVPDKIKX0DER",
    "items": [
        {
            "msku": "Mini-Porta-276810",
            "quantity": 40,
            "label_owner": "SELLER",
            "prep_owner": "SELLER",
            "expiration": null,
            "manufacturing_lot_code": null
        }
    ]
}'
Loading response...
GET/fba-transport/v2024/plans/{plan}

Get a FBA transport v2024 plan

Required attributes

  • Name
    plan
    Type
    string
    Description
    The ID of the FBA transport v2024 plan plan_abc123

Request

GET/fba-transport/v2024/plans/{plan}
curl -G https://YOUR_DOMAIN/api/fba-transport/v2024/plans/{plan} \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json"
Loading response...
GET/fba-transport/v2024/plans/{plan}/labels

Get shipment labels for an FBA transport v2024 plan

Required attributes

  • Name
    plan
    Type
    string
    Description
    The ID of the FBA transport v2024 plan plan_abc123
  • Name
    shipment_id
    Type
    string
    Description
    The Amazon shipment ID to retrieve labels for shipment_abc123

Request

GET/fba-transport/v2024/plans/{plan}/labels
curl -G https://YOUR_DOMAIN/api/fba-transport/v2024/plans/{plan}/labels \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json"
Loading response...
POST/fba-transport/v2024/plans/{plan}/request-package-labels

Request package labels

Required attributes

  • Name
    plan
    Type
    string
    Description
    The ID of the FBA transport v2024 plan 019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    shipment_id
    Type
    string
    Description
    shipment-1

Request

POST/fba-transport/v2024/plans/{plan}/request-package-labels
curl -X POST https://YOUR_DOMAIN/api/fba-transport/v2024/plans/{plan}/request-package-labels \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "shipment_id": "shipment-1"
}'
Loading response...
POST/fba-transport/v2024/plans/{plan}/request-box-labels

Request box labels

Required attributes

  • Name
    plan
    Type
    string
    Description
    The ID of the FBA transport v2024 plan 019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    shipment_id
    Type
    string
    Description
    shipment-1

Optional attributes

  • Name
    box_group_id
    Type
    string
    Description
  • Name
    box_numbers
    Type
    array
    Description
  • Name
    sort_by_internal_number
    Type
    boolean
    Description
    false

Request

POST/fba-transport/v2024/plans/{plan}/request-box-labels
curl -X POST https://YOUR_DOMAIN/api/fba-transport/v2024/plans/{plan}/request-box-labels \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "shipment_id": "shipment-1",
    "box_numbers": [
        1
    ],
    "sort_by_internal_number": false
}'
Loading response...
POST/fba-transport/v2024/plans/{plan}/request-individual-box-labels

Request individual box labels

Required attributes

  • Name
    plan
    Type
    string
    Description
    The ID of the FBA transport v2024 plan 019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    shipment_id
    Type
    string
    Description
    shipment-1
  • Name
    box_numbers
    Type
    array<integer>
    Description

Optional attributes

  • Name
    sort_by_internal_number
    Type
    boolean
    Description
    false

Request

POST/fba-transport/v2024/plans/{plan}/request-individual-box-labels
curl -X POST https://YOUR_DOMAIN/api/fba-transport/v2024/plans/{plan}/request-individual-box-labels \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "shipment_id": "shipment-1",
    "box_numbers": [
        1
    ],
    "sort_by_internal_number": false
}'
Loading response...
POST/fba-transport/v2024/plans/{plan}/request-pallet-labels

Request pallet labels

Required attributes

  • Name
    plan
    Type
    string
    Description
    The ID of the FBA transport v2024 plan 019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    pallets
    Type
    array<Pallet>
    Description
  • Name
    pallets.*.number
    Type
    integer
    Description
    1
  • Name
    shipment_id
    Type
    string
    Description
    shipment-1

Request

POST/fba-transport/v2024/plans/{plan}/request-pallet-labels
curl -X POST https://YOUR_DOMAIN/api/fba-transport/v2024/plans/{plan}/request-pallet-labels \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "pallets": [
        {
            "number": 1
        }
    ],
    "shipment_id": "shipment-1"
}'
Loading response...
POST/fba-transport/v2024/plans/{plan}/download-pallet-labels

Download pallet labels

Required attributes

  • Name
    plan
    Type
    string
    Description
    The ID of the FBA transport v2024 plan 019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    shipment_id
    Type
    string
    Description
    shipment-1

Request

POST/fba-transport/v2024/plans/{plan}/download-pallet-labels
curl -X POST https://YOUR_DOMAIN/api/fba-transport/v2024/plans/{plan}/download-pallet-labels \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "shipment_id": "shipment-1"
}'
Loading response...
POST/fba-transport/v2024/plans/{plan}/request-bill-of-lading

Request bill of lading

Required attributes

  • Name
    plan
    Type
    string
    Description
    The ID of the FBA transport v2024 plan 019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    shipment_id
    Type
    string
    Description
    shipment-1

Request

POST/fba-transport/v2024/plans/{plan}/request-bill-of-lading
curl -X POST https://YOUR_DOMAIN/api/fba-transport/v2024/plans/{plan}/request-bill-of-lading \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "shipment_id": "shipment-1"
}'
Loading response...
POST/fba-transport/v2024/plans/{plan}/labels/{label_id}/resize-to-4x6

Resize a shipment label to 4x6

Required attributes

  • Name
    plan
    Type
    string
    Description
    The ID of the FBA transport v2024 plan 019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    label_id
    Type
    string
    Description
    019b2286-9fee-71de-9f64-154824d3aa4d
  • Name
    shipment_id
    Type
    string
    Description
    shipment-1

Optional attributes

  • Name
    sort_by_internal_number
    Type
    boolean
    Description
    false

Request

POST/fba-transport/v2024/plans/{plan}/labels/{label_id}/resize-to-4x6
curl -X POST https://YOUR_DOMAIN/api/fba-transport/v2024/plans/{plan}/labels/{label-id}/resize-to-4x6 \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "shipment_id": "shipment-1",
    "sort_by_internal_number": false
}'
Loading response...
POST/fba-transport/v2024/plans/{plan}/box-groups

Create a box group for an FBA plan

Creates a new box group defining the dimensions, weight, and associated packing entity for boxes in an FBA transport plan. Items (SKUs) and the number of physical boxes are configured separately after creation.

Required attributes

  • Name
    plan
    Type
    string
    Description
    The ID of the FBA transport v2024 plan 019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    associated_entity_id
    Type
    string
    Description
    The Amazon packing group ID or shipment ID this box group belongs to packingGroupId-abc123
  • Name
    length_mm
    Type
    integer
    Description
    The interior length of the box in millimetres 300
  • Name
    width_mm
    Type
    integer
    Description
    The interior width of the box in millimetres 200
  • Name
    height_mm
    Type
    integer
    Description
    The interior height of the box in millimetres 150
  • Name
    weight_gm
    Type
    integer
    Description
    The total weight of a packed box in grams 5000

Request

POST/fba-transport/v2024/plans/{plan}/box-groups
curl -X POST https://YOUR_DOMAIN/api/fba-transport/v2024/plans/{plan}/box-groups \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "associated_entity_id": "packingGroupId-abc123",
    "length_mm": 300,
    "width_mm": 200,
    "height_mm": 150,
    "weight_gm": 5000
}'
Loading response...
PUT/fba-transport/v2024/plans/{plan}/box-groups/{box_group_id}

Update a box group

Updates the dimensions and weight of a box group. Cannot be called after packing information has been submitted — reset submissions first.

Required attributes

  • Name
    plan
    Type
    string
    Description
    The ID of the FBA transport v2024 plan 019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    box_group_id
    Type
    string
    Description
    The ID of the box group 019953ae-8047-71b6-8214-cafa0b1eff32
  • Name
    length_mm
    Type
    integer
    Description
    The interior length of the box in millimetres 350
  • Name
    width_mm
    Type
    integer
    Description
    The interior width of the box in millimetres 250
  • Name
    height_mm
    Type
    integer
    Description
    The interior height of the box in millimetres 180
  • Name
    weight_gm
    Type
    integer
    Description
    The total weight of a packed box in grams 6000

Request

PUT/fba-transport/v2024/plans/{plan}/box-groups/{box_group_id}
curl -X PUT https://YOUR_DOMAIN/api/fba-transport/v2024/plans/{plan}/box-groups/{box-group-id} \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "length_mm": 350,
    "width_mm": 250,
    "height_mm": 180,
    "weight_gm": 6000
}'
Loading response...
DELETE/fba-transport/v2024/plans/{plan}/box-groups/{box_group_id}

Remove a box group

Permanently deletes a box group and all of its boxes and items.

Required attributes

  • Name
    plan
    Type
    string
    Description
    The ID of the FBA transport v2024 plan 019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    box_group_id
    Type
    string
    Description
    The ID of the box group 019953ae-8047-71b6-8214-cafa0b1eff32

Request

DELETE/fba-transport/v2024/plans/{plan}/box-groups/{box_group_id}
curl -X DELETE https://YOUR_DOMAIN/api/fba-transport/v2024/plans/{plan}/box-groups/{box-group-id} \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json"
Loading response...
POST/fba-transport/v2024/plans/{plan}/box-groups/{box_group_id}/set-box-quantity

Set the number of boxes in a box group

Sets the number of physical boxes in a box group. Increasing the quantity creates new boxes with sequentially assigned numbers across all box groups in the plan. Decreasing the quantity removes the newest boxes.

Required attributes

  • Name
    plan
    Type
    string
    Description
    The ID of the FBA transport v2024 plan 019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    box_group_id
    Type
    string
    Description
    The ID of the box group 019953ae-8047-71b6-8214-cafa0b1eff32
  • Name
    quantity
    Type
    integer
    Description
    The number of physical boxes in this group 5

Request

POST/fba-transport/v2024/plans/{plan}/box-groups/{box_group_id}/set-box-quantity
curl -X POST https://YOUR_DOMAIN/api/fba-transport/v2024/plans/{plan}/box-groups/{box-group-id}/set-box-quantity \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "quantity": 5
}'
Loading response...
POST/fba-transport/v2024/plans/{plan}/box-groups/{box_group_id}/items

Add an item to a box group

Adds a plan item (SKU) to a box group, specifying how many units of that SKU are packed into each box in the group. Each plan item can only appear once per box group.

Required attributes

  • Name
    plan
    Type
    string
    Description
    The ID of the FBA transport v2024 plan 019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    box_group_id
    Type
    string
    Description
    The ID of the box group 019953ae-8047-71b6-8214-cafa0b1eff32
  • Name
    plan_item_id
    Type
    string
    Description
    The ID of the plan item (SKU) to add to this box group 019953ae-7a0d-7342-956a-881dce3b8a23
  • Name
    quantity
    Type
    integer
    Description
    The number of units of this SKU packed in each box in the group 10

Request

POST/fba-transport/v2024/plans/{plan}/box-groups/{box_group_id}/items
curl -X POST https://YOUR_DOMAIN/api/fba-transport/v2024/plans/{plan}/box-groups/{box-group-id}/items \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "plan_item_id": "019953ae-7a0d-7342-956a-881dce3b8a23",
    "quantity": 10
}'
Loading response...
PUT/fba-transport/v2024/plans/{plan}/box-groups/{box_group_id}/items/{box_group_item_id}

Update an item in a box group

Updates the quantity of a plan item (SKU) in a box group. Cannot be called after packing information has been submitted — reset submissions first.

Required attributes

  • Name
    plan
    Type
    string
    Description
    The ID of the FBA transport v2024 plan 019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    box_group_id
    Type
    string
    Description
    The ID of the box group 019953ae-8047-71b6-8214-cafa0b1eff32
  • Name
    box_group_item_id
    Type
    string
    Description
    The ID of the box group item 019953ae-7a0d-7342-956a-881dcdbe42ae
  • Name
    quantity
    Type
    integer
    Description
    The updated number of units of this SKU packed in each box in the group 12

Request

PUT/fba-transport/v2024/plans/{plan}/box-groups/{box_group_id}/items/{box_group_item_id}
curl -X PUT https://YOUR_DOMAIN/api/fba-transport/v2024/plans/{plan}/box-groups/{box-group-id}/items/{box-group-item-id} \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "quantity": 12
}'
Loading response...
DELETE/fba-transport/v2024/plans/{plan}/box-groups/{box_group_id}/items/{box_group_item_id}

Remove an item from a box group

Removes a plan item (SKU) from a box group.

Required attributes

  • Name
    plan
    Type
    string
    Description
    The ID of the FBA transport v2024 plan 019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    box_group_id
    Type
    string
    Description
    The ID of the box group 019953ae-8047-71b6-8214-cafa0b1eff32
  • Name
    box_group_item_id
    Type
    string
    Description
    The ID of the box group item 019953ae-7a0d-7342-956a-881dcdbe42ae

Request

DELETE/fba-transport/v2024/plans/{plan}/box-groups/{box_group_id}/items/{box_group_item_id}
curl -X DELETE https://YOUR_DOMAIN/api/fba-transport/v2024/plans/{plan}/box-groups/{box-group-id}/items/{box-group-item-id} \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json"
Loading response...
POST/fba-transport/v2024/plans/{plan}/add-carton-request-to-submission

Add carton requests to a packing submission

Required attributes

  • Name
    plan
    Type
    string
    Description
    The ID of the FBA transport v2024 plan 019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    packing_group_ids
    Type
    array<string>
    Description

Request

POST/fba-transport/v2024/plans/{plan}/add-carton-request-to-submission
curl -X POST https://YOUR_DOMAIN/api/fba-transport/v2024/plans/{plan}/add-carton-request-to-submission \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "packing_group_ids": [
        "packing-group-1"
    ]
}'
Loading response...
POST/fba-transport/v2024/plans/{plan}/generate-packing-options

Generate packing options for an FBA plan

Required attributes

  • Name
    plan
    Type
    string
    Description
    The ID of the FBA transport v2024 plan 019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    plan_id
    Type
    string
    Description
    The ID of the FBA transport v2024 plan 019953ae-7a0d-7342-956a-881dcdbe42ad

Request

POST/fba-transport/v2024/plans/{plan}/generate-packing-options
curl -X POST https://YOUR_DOMAIN/api/fba-transport/v2024/plans/{plan}/generate-packing-options \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "plan_id": "019953ae-7a0d-7342-956a-881dcdbe42ad"
}'
GET/fba-transport/v2024/plans/{plan}/packing-options

Fetch packing options from Amazon

Required attributes

  • Name
    plan
    Type
    string
    Description
    The ID of the FBA transport v2024 plan 019953ae-7a0d-7342-956a-881dcdbe42ad

Request

GET/fba-transport/v2024/plans/{plan}/packing-options
curl -G https://YOUR_DOMAIN/api/fba-transport/v2024/plans/{plan}/packing-options \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json"
POST/fba-transport/v2024/plans/{plan}/confirm-packing-option

Confirm a packing option with Amazon

Required attributes

  • Name
    plan
    Type
    string
    Description
    The ID of the FBA transport v2024 plan 019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    plan_id
    Type
    string
    Description
    The ID of the FBA transport v2024 plan 019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    packing_option_id
    Type
    string
    Description
    packing-option-1

Request

POST/fba-transport/v2024/plans/{plan}/confirm-packing-option
curl -X POST https://YOUR_DOMAIN/api/fba-transport/v2024/plans/{plan}/confirm-packing-option \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "plan_id": "019953ae-7a0d-7342-956a-881dcdbe42ad",
    "packing_option_id": "packing-option-1"
}'
GET/fba-transport/v2024/plans/{plan}/packing-group-items

Fetch packing group items from Amazon

Required attributes

  • Name
    plan
    Type
    string
    Description
    The ID of the FBA transport v2024 plan 019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    plan_id
    Type
    string
    Description
    019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    packing_option_id
    Type
    string
    Description
    packing-option-1
  • Name
    packing_group_id
    Type
    string
    Description
    packing-group-1

Request

GET/fba-transport/v2024/plans/{plan}/packing-group-items
curl -G https://YOUR_DOMAIN/api/fba-transport/v2024/plans/{plan}/packing-group-items \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json"
POST/fba-transport/v2024/plans/{plan}/mark-packing-option-as-confirmed

Mark a packing option as confirmed

Required attributes

  • Name
    plan
    Type
    string
    Description
    The ID of the FBA transport v2024 plan 019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    plan_id
    Type
    string
    Description
    The ID of the FBA transport v2024 plan 019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    packing_option_id
    Type
    string
    Description
    packing-option-1

Request

POST/fba-transport/v2024/plans/{plan}/mark-packing-option-as-confirmed
curl -X POST https://YOUR_DOMAIN/api/fba-transport/v2024/plans/{plan}/mark-packing-option-as-confirmed \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "plan_id": "019953ae-7a0d-7342-956a-881dcdbe42ad",
    "packing_option_id": "packing-option-1"
}'
Loading response...
POST/fba-transport/v2024/plans/{plan}/set-packing-information

Submit box contents to Amazon

Submits the plan's box contents (box groups, dimensions, weights, and items) to Amazon's Fulfillment Inbound API as packing information. The plan must have a confirmed packing option (when packing info is known) or a confirmed placement option (when packing info is unknown), and all box groups must have at least one item. Returns an operation ID that can be polled to check completion.

Required attributes

  • Name
    plan
    Type
    string
    Description
    The ID of the FBA transport v2024 plan 019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    plan_id
    Type
    string
    Description
    The ID of the FBA transport v2024 plan 019953ae-7a0d-7342-956a-881dcdbe42ad

Request

POST/fba-transport/v2024/plans/{plan}/set-packing-information
curl -X POST https://YOUR_DOMAIN/api/fba-transport/v2024/plans/{plan}/set-packing-information \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "plan_id": "019953ae-7a0d-7342-956a-881dcdbe42ad"
}'
POST/fba-transport/v2024/plans/{plan}/reset-submissions

Reset packing information submissions

Clears the packing information submission from the plan, allowing box contents to be modified and re-submitted.

Required attributes

  • Name
    plan
    Type
    string
    Description
    019953ae-7a0d-7342-956a-881dcdbe42ad

Request

POST/fba-transport/v2024/plans/{plan}/reset-submissions
curl -X POST https://YOUR_DOMAIN/api/fba-transport/v2024/plans/{plan}/reset-submissions \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json"
POST/fba-transport/v2024/plans/{plan}/generate-placement-options

Generate placement options for an FBA plan

Triggers an asynchronous operation to generate placement options (fulfilment centre assignments) from Amazon for the plan. Poll the returned operation ID until complete, then call GET /placement-options to retrieve the results.

Required attributes

  • Name
    plan
    Type
    string
    Description
    019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    plan_id
    Type
    string
    Description
    The ID of the FBA transport v2024 plan 019953ae-7a0d-7342-956a-881dcdbe42ad

Request

POST/fba-transport/v2024/plans/{plan}/generate-placement-options
curl -X POST https://YOUR_DOMAIN/api/fba-transport/v2024/plans/{plan}/generate-placement-options \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "plan_id": "019953ae-7a0d-7342-956a-881dcdbe42ad"
}'
GET/fba-transport/v2024/plans/{plan}/placement-options

Fetch placement options from Amazon

Pulls the latest placement options from Amazon and stores them on the plan. Call this after the generate-placement-options operation completes. View the resulting options via the plan resource.

Required attributes

  • Name
    plan
    Type
    string
    Description
    019953ae-7a0d-7342-956a-881dcdbe42ad

Request

GET/fba-transport/v2024/plans/{plan}/placement-options
curl -G https://YOUR_DOMAIN/api/fba-transport/v2024/plans/{plan}/placement-options \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json"
POST/fba-transport/v2024/plans/{plan}/select-placement-option

Select a placement option

Marks a placement option as selected locally. This does not submit anything to Amazon — call confirm-placement-option to submit the selection.

Required attributes

  • Name
    plan
    Type
    string
    Description
    019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    plan_id
    Type
    string
    Description
    The ID of the FBA transport v2024 plan 019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    placement_option_id
    Type
    string
    Description
    The Amazon placement option ID to select placementOptionId-abc123

Request

POST/fba-transport/v2024/plans/{plan}/select-placement-option
curl -X POST https://YOUR_DOMAIN/api/fba-transport/v2024/plans/{plan}/select-placement-option \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "plan_id": "019953ae-7a0d-7342-956a-881dcdbe42ad",
    "placement_option_id": "placementOptionId-abc123"
}'
POST/fba-transport/v2024/plans/{plan}/confirm-placement-option

Confirm a placement option with Amazon

Submits the selected placement option to Amazon asynchronously. Poll the returned operation ID until complete, then call mark-placement-option-as-confirmed to update local state.

Required attributes

  • Name
    plan
    Type
    string
    Description
    019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    plan_id
    Type
    string
    Description
    The ID of the FBA transport v2024 plan 019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    placement_option_id
    Type
    string
    Description
    The Amazon placement option ID to confirm placementOptionId-abc123

Request

POST/fba-transport/v2024/plans/{plan}/confirm-placement-option
curl -X POST https://YOUR_DOMAIN/api/fba-transport/v2024/plans/{plan}/confirm-placement-option \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "plan_id": "019953ae-7a0d-7342-956a-881dcdbe42ad",
    "placement_option_id": "placementOptionId-abc123"
}'
POST/fba-transport/v2024/plans/{plan}/mark-placement-option-as-confirmed

Mark a placement option as confirmed

Updates local state to reflect that Amazon has confirmed the placement option. Call this after the confirm-placement-option operation completes successfully.

Required attributes

  • Name
    plan
    Type
    string
    Description
    019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    plan_id
    Type
    string
    Description
    The ID of the FBA transport v2024 plan 019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    placement_option_id
    Type
    string
    Description
    The Amazon placement option ID to mark as confirmed placementOptionId-abc123

Request

POST/fba-transport/v2024/plans/{plan}/mark-placement-option-as-confirmed
curl -X POST https://YOUR_DOMAIN/api/fba-transport/v2024/plans/{plan}/mark-placement-option-as-confirmed \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "plan_id": "019953ae-7a0d-7342-956a-881dcdbe42ad",
    "placement_option_id": "placementOptionId-abc123"
}'
POST/fba-transport/v2024/plans/{plan}/reset-placement-options

Reset placement options for an FBA plan

Clears all placement options from the plan, allowing them to be regenerated.

Required attributes

  • Name
    plan
    Type
    string
    Description
    019953ae-7a0d-7342-956a-881dcdbe42ad

Request

POST/fba-transport/v2024/plans/{plan}/reset-placement-options
curl -X POST https://YOUR_DOMAIN/api/fba-transport/v2024/plans/{plan}/reset-placement-options \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json"
POST/fba-transport/v2024/plans/{plan}/generate-delivery-window-options

Generate delivery window options for a shipment

Triggers an asynchronous operation to generate delivery window options for a specific shipment from Amazon. Poll the returned operation ID until complete, then call GET /delivery-window-options to retrieve the results.

Required attributes

  • Name
    plan
    Type
    string
    Description
    019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    plan_id
    Type
    string
    Description
    The ID of the FBA transport v2024 plan 019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    shipment_id
    Type
    string
    Description
    The Amazon shipment ID to generate delivery windows for shipmentId-abc123

Request

POST/fba-transport/v2024/plans/{plan}/generate-delivery-window-options
curl -X POST https://YOUR_DOMAIN/api/fba-transport/v2024/plans/{plan}/generate-delivery-window-options \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "plan_id": "019953ae-7a0d-7342-956a-881dcdbe42ad",
    "shipment_id": "shipmentId-abc123"
}'
GET/fba-transport/v2024/plans/{plan}/delivery-window-options

Fetch delivery window options from Amazon

Pulls the latest delivery window options from Amazon for a specific shipment and stores them locally. Call this after the generate-delivery-window-options operation completes.

Required attributes

  • Name
    plan
    Type
    string
    Description
    019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    plan_id
    Type
    string
    Description
    019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    placement_option_id
    Type
    string
    Description
    placementOptionId-abc123
  • Name
    shipment_id
    Type
    string
    Description
    shipmentId-abc123

Request

GET/fba-transport/v2024/plans/{plan}/delivery-window-options
curl -G https://YOUR_DOMAIN/api/fba-transport/v2024/plans/{plan}/delivery-window-options \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json"
POST/fba-transport/v2024/plans/{plan}/confirm-delivery-window-option

Confirm a delivery window option with Amazon

Submits the selected delivery window option for a shipment to Amazon asynchronously. Poll the returned operation ID until complete, then call mark-delivery-window-option-as-confirmed.

Required attributes

  • Name
    plan
    Type
    string
    Description
    019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    plan_id
    Type
    string
    Description
    The ID of the FBA transport v2024 plan 019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    shipment_id
    Type
    string
    Description
    The Amazon shipment ID shipmentId-abc123
  • Name
    delivery_window_option_id
    Type
    string
    Description
    The Amazon delivery window option ID to confirm deliveryWindowOptionId-abc123

Request

POST/fba-transport/v2024/plans/{plan}/confirm-delivery-window-option
curl -X POST https://YOUR_DOMAIN/api/fba-transport/v2024/plans/{plan}/confirm-delivery-window-option \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "plan_id": "019953ae-7a0d-7342-956a-881dcdbe42ad",
    "shipment_id": "shipmentId-abc123",
    "delivery_window_option_id": "deliveryWindowOptionId-abc123"
}'
POST/fba-transport/v2024/plans/{plan}/mark-delivery-window-option-as-confirmed

Mark a delivery window option as confirmed

Updates local state to reflect that Amazon has confirmed the delivery window option. Call this after the confirm-delivery-window-option operation completes successfully.

Required attributes

  • Name
    plan
    Type
    string
    Description
    019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    plan_id
    Type
    string
    Description
    The ID of the FBA transport v2024 plan 019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    shipment_id
    Type
    string
    Description
    The Amazon shipment ID shipmentId-abc123
  • Name
    delivery_window_option_id
    Type
    string
    Description
    The Amazon delivery window option ID to mark as confirmed deliveryWindowOptionId-abc123

Request

POST/fba-transport/v2024/plans/{plan}/mark-delivery-window-option-as-confirmed
curl -X POST https://YOUR_DOMAIN/api/fba-transport/v2024/plans/{plan}/mark-delivery-window-option-as-confirmed \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "plan_id": "019953ae-7a0d-7342-956a-881dcdbe42ad",
    "shipment_id": "shipmentId-abc123",
    "delivery_window_option_id": "deliveryWindowOptionId-abc123"
}'
POST/fba-transport/v2024/plans/{plan}/generate-transportation-options

Generate transportation options for shipments

Triggers an asynchronous operation to generate transportation options (carrier and mode selections) from Amazon for one or more shipments. Poll the returned operation ID until complete, then call GET /transportation-options to fetch the results.

Required attributes

  • Name
    plan
    Type
    string
    Description
    019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    plan_id
    Type
    string
    Description
    The ID of the FBA transport v2024 plan 019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    placement_option_id
    Type
    string
    Description
    The Amazon placement option ID placementOptionId-abc123
  • Name
    shipments_dates
    Type
    array<ShipmentsDate>
    Description
    The shipments and their earliest ready-to-ship dates
  • Name
    shipments_dates.*.shipment_id
    Type
    string
    Description
    The Amazon shipment ID shipmentId-abc123
  • Name
    shipments_dates.*.start_date
    Type
    string
    Description
    The earliest date the shipment will be ready (ISO 8601) 2024-06-01

Request

POST/fba-transport/v2024/plans/{plan}/generate-transportation-options
curl -X POST https://YOUR_DOMAIN/api/fba-transport/v2024/plans/{plan}/generate-transportation-options \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "plan_id": "019953ae-7a0d-7342-956a-881dcdbe42ad",
    "placement_option_id": "placementOptionId-abc123",
    "shipments_dates": [
        {
            "shipment_id": "shipmentId-abc123",
            "start_date": "2024-06-01"
        }
    ]
}'
GET/fba-transport/v2024/plans/{plan}/transportation-options

Fetch transportation options from Amazon

Pulls the latest transportation options from Amazon for a specific shipment and stores them locally. Call this after the generate-transportation-options operation completes.

Required attributes

  • Name
    plan
    Type
    string
    Description
    019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    plan_id
    Type
    string
    Description
    019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    placement_option_id
    Type
    string
    Description
    placementOptionId-abc123
  • Name
    shipment_id
    Type
    string
    Description
    shipmentId-abc123

Request

GET/fba-transport/v2024/plans/{plan}/transportation-options
curl -G https://YOUR_DOMAIN/api/fba-transport/v2024/plans/{plan}/transportation-options \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json"
POST/fba-transport/v2024/plans/{plan}/confirm-transportation-option

Confirm transportation options with Amazon

Submits the selected transportation options (carrier and mode) for one or more shipments to Amazon asynchronously. Poll the returned operation ID until complete, then call mark-transportation-option-as-confirmed.

Required attributes

  • Name
    plan
    Type
    string
    Description
    019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    plan_id
    Type
    string
    Description
    The ID of the FBA transport v2024 plan 019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    shipment_transportation_ids
    Type
    array<ShipmentTransportationId>
    Description
    The shipment and transportation option ID pairs to confirm
  • Name
    shipment_transportation_ids.*.shipment_id
    Type
    string
    Description
    The Amazon shipment ID shipmentId-abc123
  • Name
    shipment_transportation_ids.*.transportation_option_id
    Type
    string
    Description
    The Amazon transportation option ID to confirm transportationOptionId-abc123

Request

POST/fba-transport/v2024/plans/{plan}/confirm-transportation-option
curl -X POST https://YOUR_DOMAIN/api/fba-transport/v2024/plans/{plan}/confirm-transportation-option \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "plan_id": "019953ae-7a0d-7342-956a-881dcdbe42ad",
    "shipment_transportation_ids": [
        {
            "shipment_id": "shipmentId-abc123",
            "transportation_option_id": "transportationOptionId-abc123"
        }
    ]
}'
POST/fba-transport/v2024/plans/{plan}/mark-transportation-option-as-confirmed

Mark transportation options as confirmed

Updates local state to reflect that Amazon has confirmed the transportation options. Call this after the confirm-transportation-option operation completes successfully.

Required attributes

  • Name
    plan
    Type
    string
    Description
    019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    plan_id
    Type
    string
    Description
    The ID of the FBA transport v2024 plan 019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    shipment_transportation_ids
    Type
    array<ShipmentTransportationId>
    Description
    The shipment and transportation option ID pairs to mark as confirmed
  • Name
    shipment_transportation_ids.*.shipment_id
    Type
    string
    Description
    The Amazon shipment ID shipmentId-abc123
  • Name
    shipment_transportation_ids.*.transportation_option_id
    Type
    string
    Description
    The Amazon transportation option ID transportationOptionId-abc123

Request

POST/fba-transport/v2024/plans/{plan}/mark-transportation-option-as-confirmed
curl -X POST https://YOUR_DOMAIN/api/fba-transport/v2024/plans/{plan}/mark-transportation-option-as-confirmed \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "plan_id": "019953ae-7a0d-7342-956a-881dcdbe42ad",
    "shipment_transportation_ids": [
        {
            "shipment_id": "shipmentId-abc123",
            "transportation_option_id": "transportationOptionId-abc123"
        }
    ]
}'
GET/fba-transport/v2024/plans/{plan}/get-shipment

Fetch shipments for a placement option from Amazon

Required attributes

  • Name
    plan
    Type
    string
    Description
    The ID of the FBA transport v2024 plan 019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    plan_id
    Type
    string
    Description
    019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    placement_option_id
    Type
    string
    Description
    placement-option-1

Request

GET/fba-transport/v2024/plans/{plan}/get-shipment
curl -G https://YOUR_DOMAIN/api/fba-transport/v2024/plans/{plan}/get-shipment \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json"
GET/fba-transport/v2024/plans/{plan}/list-shipment-boxes

List shipment boxes

Required attributes

  • Name
    plan
    Type
    string
    Description
    The ID of the FBA transport v2024 plan 019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    plan_id
    Type
    string
    Description
    019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    placement_option_id
    Type
    string
    Description
    placement-option-1
  • Name
    shipment_id
    Type
    string
    Description
    shipment-1

Request

GET/fba-transport/v2024/plans/{plan}/list-shipment-boxes
curl -G https://YOUR_DOMAIN/api/fba-transport/v2024/plans/{plan}/list-shipment-boxes \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json"
GET/fba-transport/v2024/plans/{plan}/list-shipment-items

Fetch shipment items from Amazon

Required attributes

  • Name
    plan
    Type
    string
    Description
    The ID of the FBA transport v2024 plan 019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    placement_option_id
    Type
    string
    Description
    placement-option-1
  • Name
    shipment_id
    Type
    string
    Description
    shipment-1

Request

GET/fba-transport/v2024/plans/{plan}/list-shipment-items
curl -G https://YOUR_DOMAIN/api/fba-transport/v2024/plans/{plan}/list-shipment-items \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json"
POST/fba-transport/v2024/plans/{plan}/update

Update an FBA transport v2024 plan from Amazon

Required attributes

  • Name
    plan
    Type
    string
    Description
    The ID of the FBA transport v2024 plan 019953ae-7a0d-7342-956a-881dcdbe42ad

Request

POST/fba-transport/v2024/plans/{plan}/update
curl -X POST https://YOUR_DOMAIN/api/fba-transport/v2024/plans/{plan}/update \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
POST/fba-transport/v2024/plans/{plan}/update-packing-info-known

Update whether packing information is known

Required attributes

  • Name
    plan
    Type
    string
    Description
    The ID of the FBA transport v2024 plan 019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    is_packing_info_known
    Type
    boolean
    Description
    true

Request

POST/fba-transport/v2024/plans/{plan}/update-packing-info-known
curl -X POST https://YOUR_DOMAIN/api/fba-transport/v2024/plans/{plan}/update-packing-info-known \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "is_packing_info_known": true
}'
POST/fba-transport/v2024/plans/{plan}/update-shipment-name

Update an FBA shipment name

Required attributes

  • Name
    plan
    Type
    string
    Description
    The ID of the FBA transport v2024 plan 019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    shipment_id
    Type
    string
    Description
    00000000-0000-0000-0000-000000000001
  • Name
    name
    Type
    string
    Description
    North dock shipment

Request

POST/fba-transport/v2024/plans/{plan}/update-shipment-name
curl -X POST https://YOUR_DOMAIN/api/fba-transport/v2024/plans/{plan}/update-shipment-name \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "shipment_id": "00000000-0000-0000-0000-000000000001",
    "name": "North dock shipment"
}'
POST/fba-transport/v2024/plans/{plan}/change-using-2d-barcodes

Change whether a plan uses 2D barcodes

Required attributes

  • Name
    plan
    Type
    string
    Description
    The ID of the FBA transport v2024 plan 019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    using_2d_barcodes
    Type
    boolean
    Description
    true

Request

POST/fba-transport/v2024/plans/{plan}/change-using-2d-barcodes
curl -X POST https://YOUR_DOMAIN/api/fba-transport/v2024/plans/{plan}/change-using-2d-barcodes \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "using_2d_barcodes": true
}'
GET/fba-transport/v2024/plans/{plan}/set-boxes-ids

Set Amazon box IDs for plan boxes

Required attributes

  • Name
    plan
    Type
    string
    Description
    The ID of the FBA transport v2024 plan 019953ae-7a0d-7342-956a-881dcdbe42ad

Request

GET/fba-transport/v2024/plans/{plan}/set-boxes-ids
curl -G https://YOUR_DOMAIN/api/fba-transport/v2024/plans/{plan}/set-boxes-ids \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json"
POST/fba-transport/v2024/plans/{plan}/pallets

Create a pallet for a shipment

Required attributes

  • Name
    plan
    Type
    string
    Description
    The ID of the FBA transport v2024 plan 019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    placement_option_id
    Type
    string
    Description
    placement-option-1
  • Name
    shipment_id
    Type
    string
    Description
    shipment-1
  • Name
    length_mm
    Type
    integer
    Description
    1200
  • Name
    width_mm
    Type
    integer
    Description
    1000
  • Name
    height_mm
    Type
    integer
    Description
    1500
  • Name
    weight_gm
    Type
    integer
    Description
    25000
  • Name
    repeat
    Type
    integer
    Description
    1
  • Name
    stackable
    Type
    boolean
    Description
    true

Request

POST/fba-transport/v2024/plans/{plan}/pallets
curl -X POST https://YOUR_DOMAIN/api/fba-transport/v2024/plans/{plan}/pallets \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "placement_option_id": "placement-option-1",
    "shipment_id": "shipment-1",
    "length_mm": 1200,
    "width_mm": 1000,
    "height_mm": 1500,
    "weight_gm": 25000,
    "repeat": 1,
    "stackable": true
}'
Loading response...
PUT/fba-transport/v2024/plans/{plan}/pallets/{pallet_id}

Update a shipment pallet

Required attributes

  • Name
    plan
    Type
    string
    Description
    The ID of the FBA transport v2024 plan 019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    pallet_id
    Type
    string
    Description
    019b2286-9fee-71de-9f64-154824d3aa4d
  • Name
    placement_option_id
    Type
    string
    Description
    placement-option-1
  • Name
    shipment_id
    Type
    string
    Description
    shipment-1
  • Name
    length_mm
    Type
    integer
    Description
    1200
  • Name
    width_mm
    Type
    integer
    Description
    1000
  • Name
    height_mm
    Type
    integer
    Description
    1500
  • Name
    weight_gm
    Type
    integer
    Description
    25000
  • Name
    repeat
    Type
    integer
    Description
    1
  • Name
    stackable
    Type
    boolean
    Description
    true

Request

PUT/fba-transport/v2024/plans/{plan}/pallets/{pallet_id}
curl -X PUT https://YOUR_DOMAIN/api/fba-transport/v2024/plans/{plan}/pallets/{pallet-id} \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "placement_option_id": "placement-option-1",
    "shipment_id": "shipment-1",
    "length_mm": 1200,
    "width_mm": 1000,
    "height_mm": 1500,
    "weight_gm": 25000,
    "repeat": 1,
    "stackable": true
}'
Loading response...
DELETE/fba-transport/v2024/plans/{plan}/pallets/{pallet_id}

Remove a shipment pallet

Required attributes

  • Name
    plan
    Type
    string
    Description
    The ID of the FBA transport v2024 plan 019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    pallet_id
    Type
    string
    Description
    019b2286-9fee-71de-9f64-154824d3aa4d
  • Name
    placement_option_id
    Type
    string
    Description
    placement-option-1
  • Name
    shipment_id
    Type
    string
    Description
    shipment-1

Request

DELETE/fba-transport/v2024/plans/{plan}/pallets/{pallet_id}
curl -X DELETE https://YOUR_DOMAIN/api/fba-transport/v2024/plans/{plan}/pallets/{pallet-id} \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "placement_option_id": "placement-option-1",
    "shipment_id": "shipment-1"
}'
Loading response...
GET/fba-transport/v2024/plans/{plan}/contact-information

Get shipment contact information

Required attributes

  • Name
    plan
    Type
    string
    Description
    The ID of the FBA transport v2024 plan 019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    plan_id
    Type
    string
    Description
    019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    placement_option_id
    Type
    string
    Description
    placement-option-1
  • Name
    shipment_id
    Type
    string
    Description
    shipment-1

Request

GET/fba-transport/v2024/plans/{plan}/contact-information
curl -G https://YOUR_DOMAIN/api/fba-transport/v2024/plans/{plan}/contact-information \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json"
POST/fba-transport/v2024/plans/{plan}/update-contact-information

Update shipment contact information

Required attributes

  • Name
    plan
    Type
    string
    Description
    The ID of the FBA transport v2024 plan 019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    plan_id
    Type
    string
    Description
    019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    placement_option_id
    Type
    string
    Description
    placement-option-1
  • Name
    shipment_id
    Type
    string
    Description
    shipment-1

Optional attributes

  • Name
    email
    Type
    string
    Description
    ops@example.com
  • Name
    name
    Type
    string
    Description
    Ops Contact
  • Name
    phone_number
    Type
    string
    Description
    1234567890

Request

POST/fba-transport/v2024/plans/{plan}/update-contact-information
curl -X POST https://YOUR_DOMAIN/api/fba-transport/v2024/plans/{plan}/update-contact-information \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "plan_id": "019953ae-7a0d-7342-956a-881dcdbe42ad",
    "placement_option_id": "placement-option-1",
    "shipment_id": "shipment-1",
    "email": "ops@example.com",
    "name": "Ops Contact",
    "phone_number": "1234567890"
}'
Loading response...
GET/fba-transport/v2024/plans/{plan}/freight-information

Get shipment freight information

Required attributes

  • Name
    plan
    Type
    string
    Description
    The ID of the FBA transport v2024 plan 019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    plan_id
    Type
    string
    Description
    019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    placement_option_id
    Type
    string
    Description
    placement-option-1
  • Name
    shipment_id
    Type
    string
    Description
    shipment-1

Request

GET/fba-transport/v2024/plans/{plan}/freight-information
curl -G https://YOUR_DOMAIN/api/fba-transport/v2024/plans/{plan}/freight-information \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json"
POST/fba-transport/v2024/plans/{plan}/update-freight-information

Update shipment freight information

Required attributes

  • Name
    plan
    Type
    string
    Description
    The ID of the FBA transport v2024 plan 019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    plan_id
    Type
    string
    Description
    019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    placement_option_id
    Type
    string
    Description
    placement-option-1
  • Name
    shipment_id
    Type
    string
    Description
    shipment-1

Optional attributes

  • Name
    freight_class
    Type
    string
    Description
    FC_100
  • Name
    amount
    Type
    string
    Description
    100.00
  • Name
    code
    Type
    string
    Description
    USD

Request

POST/fba-transport/v2024/plans/{plan}/update-freight-information
curl -X POST https://YOUR_DOMAIN/api/fba-transport/v2024/plans/{plan}/update-freight-information \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "plan_id": "019953ae-7a0d-7342-956a-881dcdbe42ad",
    "placement_option_id": "placement-option-1",
    "shipment_id": "shipment-1",
    "freight_class": "FC_100",
    "amount": "100.00",
    "code": "USD"
}'
Loading response...
POST/fba-transport/v2024/plans/{plan}/set-first-availability-date

Set shipment first availability date

Required attributes

  • Name
    plan
    Type
    string
    Description
    The ID of the FBA transport v2024 plan 019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    plan_id
    Type
    string
    Description
    019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    placement_option_id
    Type
    string
    Description
    placement-option-1
  • Name
    shipment_id
    Type
    string
    Description
    shipment-1
  • Name
    first_availability_date
    Type
    string
    Description
    2026-05-15T00:00:00Z

Request

POST/fba-transport/v2024/plans/{plan}/set-first-availability-date
curl -X POST https://YOUR_DOMAIN/api/fba-transport/v2024/plans/{plan}/set-first-availability-date \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "plan_id": "019953ae-7a0d-7342-956a-881dcdbe42ad",
    "placement_option_id": "placement-option-1",
    "shipment_id": "shipment-1",
    "first_availability_date": "2026-05-15T00:00:00Z"
}'
POST/fba-transport/v2024/plans/{plan}/set-transport-mode-preference

Set shipment transport mode preference

Required attributes

  • Name
    plan
    Type
    string
    Description
    The ID of the FBA transport v2024 plan 019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    plan_id
    Type
    string
    Description
    019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    placement_option_id
    Type
    string
    Description
    placement-option-1
  • Name
    shipment_id
    Type
    string
    Description
    shipment-1
  • Name
    transport_mode_preference
    Type
    string
    Description
    PARTNERED_GROUND_SMALL_PARCEL

Request

POST/fba-transport/v2024/plans/{plan}/set-transport-mode-preference
curl -X POST https://YOUR_DOMAIN/api/fba-transport/v2024/plans/{plan}/set-transport-mode-preference \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "plan_id": "019953ae-7a0d-7342-956a-881dcdbe42ad",
    "placement_option_id": "placement-option-1",
    "shipment_id": "shipment-1",
    "transport_mode_preference": "PARTNERED_GROUND_SMALL_PARCEL"
}'
POST/fba-transport/v2024/plans/{plan}/update-tracking-small-details

Update small parcel tracking details

Required attributes

  • Name
    plan
    Type
    string
    Description
    The ID of the FBA transport v2024 plan 019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    plan_id
    Type
    string
    Description
    019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    shipment_id
    Type
    string
    Description
    shipment-1
  • Name
    box_tracking_ids
    Type
    array<BoxTrackingId>
    Description
  • Name
    box_tracking_ids.*.amazon_box_id
    Type
    string
    Description
    FBA1U000001
  • Name
    box_tracking_ids.*.tracking_id
    Type
    string
    Description
    1Z999AA10123456784

Request

POST/fba-transport/v2024/plans/{plan}/update-tracking-small-details
curl -X POST https://YOUR_DOMAIN/api/fba-transport/v2024/plans/{plan}/update-tracking-small-details \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "plan_id": "019953ae-7a0d-7342-956a-881dcdbe42ad",
    "shipment_id": "shipment-1",
    "box_tracking_ids": [
        {
            "amazon_box_id": "FBA1U000001",
            "tracking_id": "1Z999AA10123456784"
        }
    ]
}'
POST/fba-transport/v2024/plans/{plan}/update-tracking-ltl-details

Update LTL tracking details

Required attributes

  • Name
    plan
    Type
    string
    Description
    The ID of the FBA transport v2024 plan 019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    plan_id
    Type
    string
    Description
    019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    shipment_id
    Type
    string
    Description
    shipment-1
  • Name
    freight_bill_number
    Type
    array<string>
    Description

Optional attributes

  • Name
    bill_of_lading_number
    Type
    string
    Description
    BOL123

Request

POST/fba-transport/v2024/plans/{plan}/update-tracking-ltl-details
curl -X POST https://YOUR_DOMAIN/api/fba-transport/v2024/plans/{plan}/update-tracking-ltl-details \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "plan_id": "019953ae-7a0d-7342-956a-881dcdbe42ad",
    "shipment_id": "shipment-1",
    "bill_of_lading_number": "BOL123",
    "freight_bill_number": [
        "FB123"
    ]
}'
POST/fba-transport/v2024/plans/{plan}/cancel-plan

Cancel an FBA transport plan with Amazon

Required attributes

  • Name
    plan
    Type
    string
    Description
    The ID of the FBA transport v2024 plan 019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    plan_id
    Type
    string
    Description
    The ID of the FBA transport v2024 plan 019953ae-7a0d-7342-956a-881dcdbe42ad

Request

POST/fba-transport/v2024/plans/{plan}/cancel-plan
curl -X POST https://YOUR_DOMAIN/api/fba-transport/v2024/plans/{plan}/cancel-plan \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "plan_id": "019953ae-7a0d-7342-956a-881dcdbe42ad"
}'
POST/fba-transport/v2024/plans/{plan}/cancel-plan-checker

Check whether canceling an FBA transport plan may incur fees

Required attributes

  • Name
    plan
    Type
    string
    Description
    The ID of the FBA transport v2024 plan 019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    plan_id
    Type
    string
    Description
    The ID of the FBA transport v2024 plan 019953ae-7a0d-7342-956a-881dcdbe42ad

Request

POST/fba-transport/v2024/plans/{plan}/cancel-plan-checker
curl -X POST https://YOUR_DOMAIN/api/fba-transport/v2024/plans/{plan}/cancel-plan-checker \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "plan_id": "019953ae-7a0d-7342-956a-881dcdbe42ad"
}'
POST/fba-transport/v2024/plans/{plan}/mark-plan-as-canceled

Mark an FBA transport plan as canceled

Required attributes

  • Name
    plan
    Type
    string
    Description
    The ID of the FBA transport v2024 plan 019953ae-7a0d-7342-956a-881dcdbe42ad

Request

POST/fba-transport/v2024/plans/{plan}/mark-plan-as-canceled
curl -X POST https://YOUR_DOMAIN/api/fba-transport/v2024/plans/{plan}/mark-plan-as-canceled \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
Loading response...
GET/fba-transport/v2024/plans/{plan}/pick-list

Generate a pick list PDF

Required attributes

  • Name
    plan
    Type
    string
    Description
    The ID of the FBA transport v2024 plan 019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    placement_option_id
    Type
    string
    Description
    placement-option-1
  • Name
    shipment_id
    Type
    string
    Description
    shipment-1

Request

GET/fba-transport/v2024/plans/{plan}/pick-list
curl -G https://YOUR_DOMAIN/api/fba-transport/v2024/plans/{plan}/pick-list \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json"
GET/fba-transport/v2024/plans/{plan}/pack-list

Generate a pack list PDF

Required attributes

  • Name
    plan
    Type
    string
    Description
    The ID of the FBA transport v2024 plan 019953ae-7a0d-7342-956a-881dcdbe42ad
  • Name
    placement_option_id
    Type
    string
    Description
    placement-option-1
  • Name
    shipment_id
    Type
    string
    Description
    shipment-1

Request

GET/fba-transport/v2024/plans/{plan}/pack-list
curl -G https://YOUR_DOMAIN/api/fba-transport/v2024/plans/{plan}/pack-list \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json"
GET/fba-transport/v2024/operations/{operation}

Get an FBA transport operation

Returns the current state of an async FBA transport operation. Use this to poll for completion after calling any endpoint that returns an operation ID.

Required attributes

  • Name
    operation
    Type
    string
    Description
    The ID of the operation 019953ae-8047-71b6-8214-cafa0b1eff32

Request

GET/fba-transport/v2024/operations/{operation}
curl -G https://YOUR_DOMAIN/api/fba-transport/v2024/operations/{operation} \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json"
Loading response...
GET/fba-transport/v2024/operations/{operation}/update

Fetch an operation status update from Amazon

Pulls the latest status for an operation from Amazon and updates local state. Returns the updated operation.

Required attributes

  • Name
    operation
    Type
    string
    Description
    The ID of the operation 019953ae-8047-71b6-8214-cafa0b1eff32

Request

GET/fba-transport/v2024/operations/{operation}/update
curl -G https://YOUR_DOMAIN/api/fba-transport/v2024/operations/{operation}/update \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json"
GET/fba-transport/v2024/operations

List FBA transport operations

Optional attributes

  • Name
    q
    Type
    string
    Description
    Search operations by ID 019953ae-8047-71b6-8214-cafa0b1eff32
  • Name
    page
    Type
    integer
    Description
    The page number to retrieve (1-indexed) 1
  • Name
    per_page
    Type
    integer
    Description
    The number of items per page 15

Request

GET/fba-transport/v2024/operations
curl -G https://YOUR_DOMAIN/api/fba-transport/v2024/operations \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json"
GET/fba-transport/v2024/item-eligibility

Fetch stored FBA item eligibility

Required attributes

  • Name
    channel_id
    Type
    integer
    Description
    1
  • Name
    asins
    Type
    array<string>
    Description

Request

GET/fba-transport/v2024/item-eligibility
curl -G https://YOUR_DOMAIN/api/fba-transport/v2024/item-eligibility \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json"
Loading response...
GET/fba-transport/v2024/fetch-item-eligibility

Fetch FBA item eligibility from Amazon

Required attributes

  • Name
    channel_id
    Type
    integer
    Description
    1
  • Name
    asin
    Type
    string
    Description
    B00ZB18SIF

Request

GET/fba-transport/v2024/fetch-item-eligibility
curl -G https://YOUR_DOMAIN/api/fba-transport/v2024/fetch-item-eligibility \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json"
Loading response...
GET/fba-transport/v2024/item-prep-details

Fetch FBA item prep details

Required attributes

  • Name
    channel_id
    Type
    integer
    Description
    1
  • Name
    mskus
    Type
    array<string>
    Description

Optional attributes

  • Name
    fresh
    Type
    boolean
    Description
    false

Request

GET/fba-transport/v2024/item-prep-details
curl -G https://YOUR_DOMAIN/api/fba-transport/v2024/item-prep-details \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json"
Loading response...
POST/fba-transport/v2024/item-prep-details

Set FBA item prep details

Required attributes

  • Name
    channel_id
    Type
    integer
    Description
    1
  • Name
    prep_details
    Type
    array<PrepDetail>
    Description
  • Name
    prep_details.*.msku
    Type
    string
    Description
    Mini-Porta-276810
  • Name
    prep_details.*.prep_category
    Type
    string
    Description
    NONE

Optional attributes

  • Name
    prep_details.*.prep_types
    Type
    array<string>
    Description

Request

POST/fba-transport/v2024/item-prep-details
curl -X POST https://YOUR_DOMAIN/api/fba-transport/v2024/item-prep-details \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "channel_id": 1,
    "prep_details": [
        {
            "msku": "Mini-Porta-276810",
            "prep_category": "NONE",
            "prep_types": [
                "ITEM_NO_PREP"
            ]
        }
    ]
}'
GET/fba-transport/v2024/list-v2024-plans

List Amazon FBA inbound plans

Required attributes

  • Name
    warehouse_id
    Type
    integer
    Description
    1

Optional attributes

  • Name
    status
    Type
    string
    Description
    ACTIVE
  • Name
    pagination_token
    Type
    string
    Description

Request

GET/fba-transport/v2024/list-v2024-plans
curl -G https://YOUR_DOMAIN/api/fba-transport/v2024/list-v2024-plans \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json"
GET/fba-transport/v2024/import-plan

Import an Amazon FBA inbound plan

Required attributes

  • Name
    inbound_plan_id
    Type
    string
    Description
    wf123
  • Name
    channel_id
    Type
    string
    Description
    1
  • Name
    warehouse_id
    Type
    integer
    Description
    1
  • Name
    create_inbound
    Type
    boolean
    Description
    true

Request

GET/fba-transport/v2024/import-plan
curl -G https://YOUR_DOMAIN/api/fba-transport/v2024/import-plan \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json"