Box Contents

Box contents are organized by group, which is a configuration of identical boxes (dimensions and items).

To add box contents, first create a box group, and then add an item in a separate request.

Create Box Group

Add a box group to the FBA plan. It will be created without any boxes, so you must also call Set Box Quantity to specify how many boxes of identical configuration this group contains.

POST /fba-transport/v0/plans/{PLAN_ID}/box-groups
Parameter Type Examples Description
length_mm integer 400 Box length in millimeters
width_mm integer 400 Box width in millimeters
height_mm integer 400 Box height in millimeters
weight_gm integer 250 Box weight in grams

Example Response

{
    "box_group_id": "38921ad7-90ac-4935-835a-ee10785460d4",
    "message": "Box group created"
}

Update Box Group

Update the dimensions of a box group.

PUT /fba-transport/v0/plans/{PLAN_ID}/box-groups/{BOX_GROUP_ID}
Parameter Type Examples Description
length_mm integer 400 Box length in millimeters
width_mm integer 400 Box width in millimeters
height_mm integer 400 Box height in millimeters
weight_gm integer 250 Box weight in grams

Example Response

{
    "message": "Box group updated"
}

Delete Box Group

Delete a box group from the FBA plan.

DELETE /fba-transport/v0/plans/{PLAN_ID}/box-groups/{BOX_GROUP_ID}

Example Response

{
    "message": "Box group removed"
}

Set Box Quantity for Group

Set the number of boxes of identical configuration this box contains.

POST /fba-transport/v0/plans/{PLAN_ID}/box-groups/{BOX_GROUP_ID}/set-box-quantity
Parameter Type Examples Description
quantity integer 2 The number of boxes in the group

Example Response

{
    "message": "Box quantity updated"
}

Add Item To Group

Add an item to the group configuration

POST /fba-transport/v0/plans/{PLAN_ID}/box-groups/{BOX_GROUP_ID}/items
Parameter Type Examples Description
plan_item_id uuid d290f1ee-6c54-4b01-90e6-d701748f0851 (Required) The ID of the plan item to add to the box
quantity integer 2 (Required) The quantity of the item to add to the box
expiration string 2027-12-31 The expiration date of the item

Example Response

{
    "box_group_item": {
        "id": "0015a286-c6ad-4134-bfdc-14abfa2868f5",
        "plan_item_id": "79d85220-133a-4dcb-93b0-74f2351a4e78",
        "quantity": 8,
        "expiration": null
    }
}

Update Item In Group

Update the quantity of the item in the group

PUT /fba-transport/v0/plans/{PLAN_ID}/box-groups/{BOX_GROUP_ID}/items/{BOX_GROUP_ITEM_ID}
Parameter Type Examples Description
quantity integer 2 The updated quantity of the item in the box

Example Response

{
    "box_group_item": {
        "id": "0015a286-c6ad-4134-bfdc-14abfa2868f5",
        "plan_item_id": "79d85220-133a-4dcb-93b0-74f2351a4e78",
        "quantity": 8,
        "expiration": null
    },
    "message": "Item updated"
}

Remove Item From Group

Remove an item from the group

DELETE /fba-transport/v0/plans/{PLAN_ID}/box-groups/{BOX_GROUP_ID}/items/{BOX_GROUP_ITEM_ID}

Example Response

{
    "message": "Item removed"
}