# PrepBusiness API Documentation > REST API for fulfillment, inventory, orders, and shipping operations. --- ## Channels Viewing and managing channels and listings ### List channels **GET** `/channels` --- ## Channel Listings Viewing and managing channels and listings ### List listings for a channel **GET** `/channels/{channel_id}/listings` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | channel_id | integer | Yes | The ID of the channel | ### Create a listing for a channel **POST** `/channels/{channel_id}/listings` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | channel_id | integer | Yes | The ID of the channel | | channel_identifier | string | Yes | The channel-specific identifier for the listing (e.g. ASIN for Amazon) | | item_id | integer | Yes | The ID of the inventory item to link to this listing | | merchant_sku | string | No | The merchant SKU to use for this listing. If omitted, the item's SKU will be used. | | condition | string | No | The condition of the listed item | ### Link a listing to a product **POST** `/channels/listings/{listing}/link` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | listing | integer | Yes | The ID of the listing | | item_id | integer | Yes | The ID of the inventory item to link to this listing | --- ## Charges View and manage billing charges for fulfillment services. ### List charges **GET** `/billing/charges` ### Show a charge **GET** `/billing/charges/{charge}` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | charge | integer | Yes | The ID of the charge | ### Store a quick adjustment charge **POST** `/billing/charges/quick-adjustment` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | amount | number | Yes | The amount of the adjustment | | description | string | Yes | A description of the adjustment | --- ## Invoices View and manage billing invoices. ### List invoices **GET** `/billing/invoices` ### Create an invoice **POST** `/billing/invoices` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | charge_ids | array | No | Optional array of charge IDs to include in the invoice. If omitted, all uninvoiced charges will be included. | ### Finalize an invoice Locks a draft invoice, preventing further modification to its charges. Once finalized, the invoice will be queued for creation on Stripe. This is a required step before attempting to collect payment. **POST** `/billing/invoices/{invoice}/finalize` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | invoice | integer | Yes | The ID of the invoice to finalize | ### Collect payment for an invoice Triggers an immediate charge attempt against the merchant's credit card on file for a finalized invoice. The invoice must be finalized before collection can be attempted. If the invoice has not yet been created on Stripe, this endpoint will create and finalize it on Stripe before attempting collection. **POST** `/billing/invoices/{invoice}/collect` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | invoice | integer | Yes | The ID of the invoice to collect payment for | --- ## Inventory Viewing and managing inventory items ### List inventory items Get a paginated list of inventory items for the current merchant or service provider. **GET** `/inventory` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | q | string | No | A search query to filter items by title, SKU, identifier, tag, or condition | | ids | array | No | Filter items by a list of item IDs | | merchant_skus | array | No | Filter items by a list of merchant SKUs | | tag_ids | array | No | Filter items by a list of tag IDs | | available_quantity_gt | integer | No | Filter items with available quantity greater than this value | | available_quantity_lt | integer | No | Filter items with available quantity less than this value | | quantity_in_stock_gt | integer | No | Filter items with quantity in stock greater than this value | | quantity_in_stock_lt | integer | No | Filter items with quantity in stock less than this value | | missing_dimensions_only | boolean | No | When true, only return items missing dimension data | | sort_by | string | No | The field to sort results by | | sort_dir | string | No | The sort direction | | page | integer | No | The page number to retrieve (1-indexed) | | per_page | integer | No | The number of items per page | ### Create an inventory item Create a new inventory item for the current merchant. **POST** `/inventory` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | merchant_sku | string | Yes | The merchant's own SKU for this item | | title | string | Yes | The title or name of the item | | condition | string | No | The condition of the item | | condition_note | string | No | Additional notes about the condition | | length_mm | integer | No | The length in millimetres | | width_mm | integer | No | The width in millimetres | | height_mm | integer | No | The height in millimetres | | weight_gm | integer | No | The weight in grams | ### Search inventory items Search for inventory items using a text query and optional filters. **POST** `/inventory/search` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | q | string | Yes | The search query string | | mode | string | No | The search mode to use. Defaults to 'default'. | | filters | object | No | Optional filters to apply to the search | ### Show an inventory item Get a single inventory item by its ID. **GET** `/inventory/{item}` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | item | integer | Yes | The ID of the inventory item | ### Update an inventory item Update an existing inventory item. **PUT** `/inventory/{item}` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | item | integer | Yes | The ID of the inventory item | | title | string | No | The title or name of the item | | condition | string | No | The condition of the item | | condition_note | string | No | Additional notes about the condition | | length_mm | integer | No | The length in millimetres | | width_mm | integer | No | The width in millimetres | | height_mm | integer | No | The height in millimetres | | weight_gm | integer | No | The weight in grams | ### Add an identifier to an inventory item Add a new identifier (ASIN, EAN, UPC, FNSKU, GTIN, or CUSTOM) to an inventory item. **POST** `/inventory/{item}/identifier` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | item | integer | Yes | The ID of the inventory item | | identifier_type | string | Yes | The type of identifier to add | | identifier | string | Yes | The identifier value | ### Manage services for an inventory item Sync the company services associated with an inventory item. **POST** `/inventory/services` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | item_id | integer | Yes | The ID of the inventory item | | services | array | Yes | The list of company service IDs to associate with the item | ### Delete an inventory item identifier Delete an identifier (ASIN, EAN, UPC, FNSKU, GTIN, or CUSTOM) from an inventory item. **DELETE** `/identifier/{identifier}` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | identifier | integer | Yes | The ID of the inventory item identifier to delete | ### Batch delete inventory items Delete multiple inventory items at once. **POST** `/inventory/batch/delete` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | items | array | Yes | The inventory items to delete | | items.*.id | integer | Yes | The ID of the inventory item to delete | --- ## Inbound Shipments Viewing and managing inbound shipments and their items ### List inbound shipments Get a paginated list of active (non-archived) inbound shipments. **GET** `/shipments/inbound` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | filters[not_received] | boolean | No | When true, only return shipments that have not yet been received | | page | integer | No | The page number to retrieve (1-indexed) | | per_page | integer | No | The number of items per page | ### Create an inbound shipment Create a new inbound shipment for the current merchant. **POST** `/shipments/inbound` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | name | string | Yes | The name of the shipment | | warehouse_id | integer | Yes | The ID of the destination warehouse | | notes | string | No | Optional notes about the shipment | ### List archived inbound shipments Get a paginated list of archived inbound shipments. **GET** `/shipments/inbound/archived` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | page | integer | No | The page number to retrieve (1-indexed) | | per_page | integer | No | The number of items per page | ### Show an inbound shipment Get a single inbound shipment by its ID, including attachments, service lines, warehouse, and tags. **GET** `/shipments/inbound/{inbound_shipment}` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | inbound_shipment | integer | Yes | The ID of the inbound shipment | ### Update an inbound shipment Update an existing inbound shipment. **PUT** `/shipments/inbound/{inbound_shipment}` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | inbound_shipment | integer | Yes | The ID of the inbound shipment | | name | string | No | The name of the shipment | | notes | string | No | Notes about the shipment | | internal_notes | string | No | Internal notes visible only to staff | | eta | string | No | The estimated time of arrival | ### Submit an inbound shipment Mark an inbound shipment as shipped. Optionally include a carrier and tracking numbers. **POST** `/shipments/inbound/{inbound_shipment}/submit` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | inbound_shipment | integer | Yes | The ID of the inbound shipment | | carrier | string | No | The carrier used for shipping | | tracking_numbers | array | No | List of tracking numbers. Required when carrier is provided. | ### Receive an inbound shipment Mark an inbound shipment as received at the warehouse. **POST** `/shipments/inbound/{inbound_shipment}/receive` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | inbound_shipment | integer | Yes | The ID of the inbound shipment | ### Batch archive inbound shipments Archive multiple inbound shipments at once. **POST** `/shipments/inbound/batch/archive` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | shipment_ids | array | Yes | The IDs of the shipments to archive | --- ## Inbound Shipment Items Viewing and managing inbound shipments and their items ### List items for an inbound shipment Get the list of items (expected, actual, and unsellable) for an inbound shipment. **GET** `/shipments/inbound/{inbound_shipment}/items` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | inbound_shipment | integer | Yes | The ID of the inbound shipment | | item_ids | array | No | Filter to a specific list of item IDs | ### Add an item to an inbound shipment Add an inventory item with a specified quantity to an inbound shipment. **POST** `/shipments/inbound/{inbound_shipment}/add-item` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | inbound_shipment | integer | Yes | The ID of the inbound shipment | | item_id | integer | Yes | The ID of the inventory item to add | | quantity | integer | Yes | The expected quantity of the item | ### Update an item on an inbound shipment Update the expected and actual quantities for an item on an inbound shipment. **POST** `/shipments/inbound/{inbound_shipment}/update-item` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | inbound_shipment | integer | Yes | The ID of the inbound shipment | | item_id | integer | Yes | The ID of the inventory item to update | | expected | object | Yes | Expected quantity update | | expected.quantity | integer | Yes | The new expected quantity | | expected.item_group_configurations | array | No | Group configuration summaries | | expected.item_group_configurations.*.configuration_id | integer | No | | | expected.item_group_configurations.*.quantity | integer | No | | | expected.item_group_configurations.*.partial_quantity | integer | No | | | actual | object | No | Actual quantity update (only available to service provider staff) | | actual.quantity | integer | Yes | The new actual received quantity | | actual.item_group_configurations | array | No | Group configuration summaries | | actual.item_group_configurations.*.configuration_id | integer | No | | | actual.item_group_configurations.*.quantity | integer | No | | | actual.item_group_configurations.*.partial_quantity | integer | No | | | actual.moves | array | No | Stock move data | ### Remove an item from an inbound shipment Remove an inventory item from an inbound shipment. **POST** `/shipments/inbound/{inbound_shipment}/remove-item` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | inbound_shipment | integer | Yes | The ID of the inbound shipment | | item_id | integer | Yes | The ID of the inventory item to remove | --- ## Outbound Shipments Viewing and managing outbound shipments and their items ### List outbound shipments **GET** `/shipments/outbound` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | filters[not_shipped] | boolean | No | Filter to only return shipments that have not been shipped | ### Create an outbound shipment **POST** `/shipments/outbound` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | name | string | Yes | The name of the outbound shipment | | notes | string | No | Optional notes for the outbound shipment | | warehouse_id | integer | Yes | The ID of the warehouse for this shipment | ### List archived outbound shipments **GET** `/shipments/outbound/archived` ### Get an outbound shipment **GET** `/shipments/outbound/{outbound_shipment}` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | outbound_shipment | integer | Yes | The ID of the outbound shipment | ### Upload an attachment to an outbound shipment **POST** `/shipments/outbound/{outbound_shipment}/attachment` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | outbound_shipment | integer | Yes | The ID of the outbound shipment | --- ## Outbound Shipment Items Viewing and managing outbound shipments and their items ### List items in an outbound shipment **GET** `/shipments/outbound/{outbound_shipment}/outbound-shipment-item` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | outbound_shipment | integer | Yes | The ID of the outbound shipment | ### Add an item to an outbound shipment **POST** `/shipments/outbound/{outbound_shipment}/outbound-shipment-item` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | outbound_shipment | integer | Yes | The ID of the outbound shipment | | item_id | integer | Yes | The ID of the inventory item to add | | quantity | integer | Yes | The quantity of the item to add | | expiry_date | string | No | The expiry date for this item in YYYY-MM-DD format | ### Update an item in an outbound shipment **PATCH** `/shipments/outbound/{outbound_shipment}/outbound-shipment-item/{outbound_shipment_item}` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | outbound_shipment | integer | Yes | The ID of the outbound shipment | | outbound_shipment_item | integer | Yes | The ID of the outbound shipment item | | quantity | integer | No | The updated quantity of the item | | expiry_date | string | No | The updated expiry date in YYYY-MM-DD format | ### Remove an item from an outbound shipment **DELETE** `/shipments/outbound/{outbound_shipment}/outbound-shipment-item/{outbound_shipment_item}` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | outbound_shipment | integer | Yes | The ID of the outbound shipment | | outbound_shipment_item | integer | Yes | The ID of the outbound shipment item | --- ## FBA Plans Viewing and managing FBA transport plans ### List FBA transport v2024 plans **GET** `/fba-transport/v2024/plans` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | outbound_shipment_id | integer | No | Filter plans by outbound shipment ID | ### 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. **POST** `/fba-transport/v2024/plans` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | outbound_shipment_id | integer | Yes | The ID of the outbound shipment to create a plan for | | channel_id | integer | Yes | The ID of the Amazon channel (must be an active Amazon channel) | | destination_marketplace | string | No | The Amazon marketplace identifier for the destination (e.g. ATVPDKIKX0DER for US). Defaults to the channel's marketplace if not provided. | | items | array | Yes | The items to include in the shipping plan | | items.*.msku | string | Yes | The merchant SKU for this item | | items.*.quantity | integer | Yes | The quantity of this item to include in the plan | | items.*.label_owner | string | Yes | Who will own the labeling responsibility for this item | | items.*.prep_owner | string | Yes | Who will own the prep responsibility for this item | | items.*.expiration | string | No | Optional expiration date for the item (YYYY-MM-DD) | | items.*.manufacturing_lot_code | string | No | Optional manufacturing lot code (1-256 characters) | ### Get a FBA transport v2024 plan **GET** `/fba-transport/v2024/plans/{plan}` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | plan | string | Yes | The ID of the FBA transport v2024 plan | ### Get shipment labels for an FBA transport v2024 plan **GET** `/fba-transport/v2024/plans/{plan}/labels` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | plan | string | Yes | The ID of the FBA transport v2024 plan | | shipment_id | string | Yes | The Amazon shipment ID to retrieve labels for | ### 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. **POST** `/fba-transport/v2024/plans/{plan}/box-groups` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | plan | string | Yes | The ID of the FBA transport v2024 plan | | associated_entity_id | string | Yes | The Amazon packing group ID or shipment ID this box group belongs to | | length_mm | integer | Yes | The interior length of the box in millimetres | | width_mm | integer | Yes | The interior width of the box in millimetres | | height_mm | integer | Yes | The interior height of the box in millimetres | | weight_gm | integer | Yes | The total weight of a packed box in grams | ### 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. **PUT** `/fba-transport/v2024/plans/{plan}/box-groups/{box_group_id}` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | plan | string | Yes | The ID of the FBA transport v2024 plan | | box_group_id | string | Yes | The ID of the box group | | length_mm | integer | Yes | The interior length of the box in millimetres | | width_mm | integer | Yes | The interior width of the box in millimetres | | height_mm | integer | Yes | The interior height of the box in millimetres | | weight_gm | integer | Yes | The total weight of a packed box in grams | ### Remove a box group Permanently deletes a box group and all of its boxes and items. **DELETE** `/fba-transport/v2024/plans/{plan}/box-groups/{box_group_id}` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | plan | string | Yes | The ID of the FBA transport v2024 plan | | box_group_id | string | Yes | The ID of the box group | ### 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. **POST** `/fba-transport/v2024/plans/{plan}/box-groups/{box_group_id}/set-box-quantity` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | plan | string | Yes | The ID of the FBA transport v2024 plan | | box_group_id | string | Yes | The ID of the box group | | quantity | integer | Yes | The number of physical boxes in this group | ### 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. **POST** `/fba-transport/v2024/plans/{plan}/box-groups/{box_group_id}/items` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | plan | string | Yes | The ID of the FBA transport v2024 plan | | box_group_id | string | Yes | The ID of the box group | | plan_item_id | string | Yes | The ID of the plan item (SKU) to add to this box group | | quantity | integer | Yes | The number of units of this SKU packed in each box in the group | ### 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. **PUT** `/fba-transport/v2024/plans/{plan}/box-groups/{box_group_id}/items/{box_group_item_id}` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | plan | string | Yes | The ID of the FBA transport v2024 plan | | box_group_id | string | Yes | The ID of the box group | | box_group_item_id | string | Yes | The ID of the box group item | | quantity | integer | Yes | The updated number of units of this SKU packed in each box in the group | ### Remove an item from a box group Removes a plan item (SKU) from a box group. **DELETE** `/fba-transport/v2024/plans/{plan}/box-groups/{box_group_id}/items/{box_group_item_id}` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | plan | string | Yes | The ID of the FBA transport v2024 plan | | box_group_id | string | Yes | The ID of the box group | | box_group_item_id | string | Yes | The ID of the box group item | ### 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. **POST** `/fba-transport/v2024/plans/{plan}/set-packing-information` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | plan | string | Yes | The ID of the FBA transport v2024 plan | | plan_id | string | Yes | The ID of the FBA transport v2024 plan | ### Reset packing information submissions Clears the packing information submission from the plan, allowing box contents to be modified and re-submitted. **POST** `/fba-transport/v2024/plans/{plan}/reset-submissions` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | plan | string | Yes | | ### 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. **POST** `/fba-transport/v2024/plans/{plan}/generate-placement-options` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | plan | string | Yes | | | plan_id | string | Yes | The ID of the FBA transport v2024 plan | ### 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. **GET** `/fba-transport/v2024/plans/{plan}/placement-options` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | plan | string | Yes | | ### 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. **POST** `/fba-transport/v2024/plans/{plan}/select-placement-option` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | plan | string | Yes | | | plan_id | string | Yes | The ID of the FBA transport v2024 plan | | placement_option_id | string | Yes | The Amazon placement option ID to select | ### 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. **POST** `/fba-transport/v2024/plans/{plan}/confirm-placement-option` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | plan | string | Yes | | | plan_id | string | Yes | The ID of the FBA transport v2024 plan | | placement_option_id | string | Yes | The Amazon placement option ID to confirm | ### 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. **POST** `/fba-transport/v2024/plans/{plan}/mark-placement-option-as-confirmed` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | plan | string | Yes | | | plan_id | string | Yes | The ID of the FBA transport v2024 plan | | placement_option_id | string | Yes | The Amazon placement option ID to mark as confirmed | ### Reset placement options for an FBA plan Clears all placement options from the plan, allowing them to be regenerated. **POST** `/fba-transport/v2024/plans/{plan}/reset-placement-options` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | plan | string | Yes | | ### 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. **POST** `/fba-transport/v2024/plans/{plan}/generate-delivery-window-options` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | plan | string | Yes | | | plan_id | string | Yes | The ID of the FBA transport v2024 plan | | shipment_id | string | Yes | The Amazon shipment ID to generate delivery windows for | ### 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. **GET** `/fba-transport/v2024/plans/{plan}/delivery-window-options` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | plan | string | Yes | | | plan_id | string | Yes | | | placement_option_id | string | Yes | | | shipment_id | string | Yes | | ### 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. **POST** `/fba-transport/v2024/plans/{plan}/confirm-delivery-window-option` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | plan | string | Yes | | | plan_id | string | Yes | The ID of the FBA transport v2024 plan | | shipment_id | string | Yes | The Amazon shipment ID | | delivery_window_option_id | string | Yes | The Amazon delivery window option ID to confirm | ### 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. **POST** `/fba-transport/v2024/plans/{plan}/mark-delivery-window-option-as-confirmed` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | plan | string | Yes | | | plan_id | string | Yes | The ID of the FBA transport v2024 plan | | shipment_id | string | Yes | The Amazon shipment ID | | delivery_window_option_id | string | Yes | The Amazon delivery window option ID to mark as confirmed | ### 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. **POST** `/fba-transport/v2024/plans/{plan}/generate-transportation-options` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | plan | string | Yes | | | plan_id | string | Yes | The ID of the FBA transport v2024 plan | | placement_option_id | string | Yes | The Amazon placement option ID | | shipments_dates | array | Yes | The shipments and their earliest ready-to-ship dates | | shipments_dates.*.shipment_id | string | Yes | The Amazon shipment ID | | shipments_dates.*.start_date | string | Yes | The earliest date the shipment will be ready (ISO 8601) | ### 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. **GET** `/fba-transport/v2024/plans/{plan}/transportation-options` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | plan | string | Yes | | | plan_id | string | Yes | | | placement_option_id | string | Yes | | | shipment_id | string | Yes | | ### 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. **POST** `/fba-transport/v2024/plans/{plan}/confirm-transportation-option` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | plan | string | Yes | | | plan_id | string | Yes | The ID of the FBA transport v2024 plan | | shipment_transportation_ids | array | Yes | The shipment and transportation option ID pairs to confirm | | shipment_transportation_ids.*.shipment_id | string | Yes | The Amazon shipment ID | | shipment_transportation_ids.*.transportation_option_id | string | Yes | The Amazon transportation option ID to confirm | ### 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. **POST** `/fba-transport/v2024/plans/{plan}/mark-transportation-option-as-confirmed` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | plan | string | Yes | | | plan_id | string | Yes | The ID of the FBA transport v2024 plan | | shipment_transportation_ids | array | Yes | The shipment and transportation option ID pairs to mark as confirmed | | shipment_transportation_ids.*.shipment_id | string | Yes | The Amazon shipment ID | | shipment_transportation_ids.*.transportation_option_id | string | Yes | The Amazon transportation option ID | ### 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. **GET** `/fba-transport/v2024/operations/{operation}` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | operation | string | Yes | The ID of the operation | ### Fetch an operation status update from Amazon Pulls the latest status for an operation from Amazon and updates local state. Returns the updated operation. **GET** `/fba-transport/v2024/operations/{operation}/update` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | operation | string | Yes | The ID of the operation | --- ## Orders Viewing and managing orders ### List orders **GET** `/orders` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | fulfillable | boolean | No | Filter to only return fulfillable orders | ### Upload orders **POST** `/orders/upload` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | channel_id | integer | No | The ID of the channel to upload orders for | | orders | array | Yes | The list of orders to upload | ### Get an order **GET** `/orders/{order}` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | order | integer | Yes | The ID of the order | ### Upload a shipping label for an order **POST** `/orders/{order}/uploadShippingLabel` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | order | integer | Yes | The ID of the order | ### Mark an order as shipped **POST** `/orders/{order}/markAsShipped` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | order | integer | Yes | The ID of the order | | tracking_number | string | No | The tracking number for the shipment | | carrier | string | No | The carrier for the shipment | | fulfillment_request_id | string | No | The ID of the fulfillment request | --- ## Services Viewing and managing company services ### List company services **GET** `/services` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | type | array | No | Filter services by type | | archived | boolean | No | Filter to only return archived services | --- ## Warehouses Viewing and managing warehouses ### List warehouses **GET** `/warehouses` --- ## Labels Generating and downloading FNSKU and barcode labels ### Request FNSKU labels Submits a request to generate FNSKU labels. Labels are generated asynchronously and will be available for download once processing is complete. **POST** `/labels/fnsku` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | labels | array