All products must be available in a single reserve storage warehouse","summary":"Create Order","tags":["Outbounds"],"security":[{"BEARER":["write_logistics_orders_b2b"]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReplenishmentOrderRequestV2"}}}}}},"/logistics/api/2026-02/orders/rs/{orderId}":{"get":{"operationId":"GetOrderV2","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReplenishmentOrderResponseV2"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}}},"description":"Get order information for a reserve storage outbound order by orderId.","summary":"Get Order","tags":["Outbounds"],"security":[{"BEARER":["read_logistics_orders_b2b"]}],"parameters":[{"description":"The unique order id returned during creation process.","in":"path","name":"orderId","required":true,"schema":{"type":"string"}}]}},"/logistics/api/2026-02/orders/rs/external_id/{externalId}":{"get":{"operationId":"GetOrderByExternalId","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReplenishmentOrderResponseV2"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}}},"description":"Get order information for an order created via the \"Create order\" endpoint, using the external ID given during order creation.","summary":"Get Order By External ID","tags":["Outbounds"],"security":[{"BEARER":["read_logistics_orders_b2b"]}],"parameters":[{"description":"The external ID given during order creation.","in":"path","name":"externalId","required":true,"schema":{"type":"string"}}]}},"/logistics/api/2026-02/orders/rs/{shipmentId}/attachments":{"post":{"operationId":"GetShipmentAttachmentUrl","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShipmentAttachmentUploadResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}}},"description":"Get shipment attachment url for uploading shipment attachment document.","summary":"Get Shipment Attachment Url","tags":["Outbounds"],"security":[{"BEARER":["write_logistics_orders_b2b"]}],"parameters":[{"description":"The unique shipment id returned during creation process.","in":"path","name":"shipmentId","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The request object for getting upload url for uploading shipment attachment document.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShipmentAttachmentUploadRequest","description":"The request object for getting upload url for uploading shipment attachment document."}}}}}},"/logistics/api/2026-02/orders/rs/{orderId}/cancel":{"post":{"operationId":"CancelOrder","responses":{"200":{"description":"OK"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}}},"description":"Cancel a reserve storage outbound order using order id.\nOnly order in submitted state is allowed to be cancelled.","tags":["Outbounds"],"security":[{"BEARER":["write_logistics_orders_b2b"]}],"parameters":[{"description":"The unique order id returned during creation process.","in":"path","name":"orderId","required":true,"schema":{"type":"string"}}]}},"/logistics/api/2026-02/reports/{reportReference}":{"get":{"operationId":"GetReportStatus","responses":{"200":{"description":"Report status and url","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reports_Report"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reports_UnauthorizedError"}}}},"404":{"description":"A report with the given report reference was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reports_NotFoundError"}}}}},"description":"Returns a report or report status identified by the reportReference id","tags":["Reports"],"security":[{"BEARER":["read_logistics_reports"]}],"parameters":[{"in":"path","name":"reportReference","required":true,"schema":{"type":"string"}}]}},"/logistics/api/2026-02/reports":{"post":{"operationId":"GenerateReport","responses":{"200":{"description":"Report is being created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reports_ReportGenerationResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reports_BadRequestError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reports_UnauthorizedError"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reports_UnprocessableEntityError"}}}}},"description":"Creates a new report that can be downloaded in CSV format","tags":["Reports"],"security":[{"BEARER":["write_logistics_reports"]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/reports_ReportGenerationRequest"}}}}}},"/logistics/api/2026-02/returns":{"post":{"operationId":"ReturnsCreateOrder","responses":{"201":{"description":"Return order details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReturnsApiOrder"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}}},"description":"Creates return order for inspection.","tags":["Returns"],"security":[{"BEARER":["write_logistics_returns"]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateReturnRequest"}}}}},"get":{"operationId":"GetReturns","responses":{"200":{"description":"Paginated Return Orders","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ReturnsApiOrder"},"type":"array"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}}},"tags":["Returns"],"security":[{"BEARER":["read_logistics_returns"]}],"parameters":[{"in":"query","name":"externalReturnId","required":false,"schema":{"type":"string"}},{"in":"query","name":"rma","required":false,"schema":{"type":"string"}},{"in":"query","name":"trackingCode","required":false,"schema":{"type":"string"}},{"in":"query","name":"status","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/LogisticsReturnStatus"}}},{"in":"query","name":"limit","required":false,"schema":{"format":"int32","type":"integer","maxLength":250,"minLength":1}},{"in":"query","name":"page_info","required":false,"schema":{"type":"string"}}]}},"/logistics/api/2026-02/returns/{returnId}/cancel":{"post":{"operationId":"ReturnsCancelOrder","responses":{"204":{"description":"Successfully cancelled the return"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}}},"description":"Cancel a return that was created. Return will not be cancelled if it is received.","tags":["Returns"],"security":[{"BEARER":["write_logistics_returns"]}],"parameters":[{"description":"Unique ID used to track the return.","in":"path","name":"returnId","required":true,"schema":{"type":"string"}}]}},"/logistics/api/2026-02/returns/{returnId}":{"get":{"operationId":"ReturnsGetOrder","responses":{"200":{"description":"Return details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReturnsApiOrder"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}}},"description":"Get return by returnId. This will include ReturnOrder, ReturnItems with inspection\nstatus and ShippingLabel.","tags":["Returns"],"security":[{"BEARER":["read_logistics_returns"]}],"parameters":[{"description":"Unique ID used to track the return.","in":"path","name":"returnId","required":true,"schema":{"format":"double","type":"number"}}]}},"/logistics/api/2026-02/warehouses/active":{"get":{"operationId":"GetActiveWarehouses","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"type":"string"},"type":"array"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}}},"description":"Get all available active warehouses from all countries.","tags":["Warehouses"],"security":[{"BEARER":["read_logistics_warehouses"]}],"parameters":[{"description":"Filter warehouses by country code.\nCurrently Available values:\n- \"US\" - United States\n- \"NL\" - Netherlands","in":"query","name":"countryCode","required":false,"schema":{"type":"string"}}]}},"/logistics/api/2026-02/webhooks":{"post":{"operationId":"CreateWebhook","responses":{"202":{"description":"Webhook has been created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookModel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictError"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntityError"}}}}},"description":"Create a webhook to subscribe to a type of event.\n\nCurrent retry behavior for webhooks (subject to change) is as follows:\n- If there is an error calling the endpoint it is first retried after about 5 minutes\n- It is then retried with exponentially increasing interval\n- Maximum interval between two retries is one hour\n- Total number of attempts is 10","tags":["Webhooks"],"security":[{"BEARER":["write_logistics_webhooks"]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookCreateModel"}}}}},"get":{"operationId":"GetWebhooks","responses":{"200":{"description":"List of webhook entries","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/WebhookModel"},"type":"array"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}}},"description":"Get all webhooks currently registered and active.","tags":["Webhooks"],"security":[{"BEARER":["read_logistics_webhooks"]}],"parameters":[]}},"/logistics/api/2026-02/webhooks/{webhookId}":{"get":{"operationId":"GetWebhook","responses":{"200":{"description":"Webhook details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookModel"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"404":{"description":"A webhook with the webhook id provided was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}}},"description":"Get a specific webhook using the webhook identifier.","tags":["Webhooks"],"security":[{"BEARER":["read_logistics_webhooks"]}],"parameters":[{"in":"path","name":"webhookId","required":true,"schema":{"$ref":"#/components/schemas/WebhookIdType"}}]},"delete":{"operationId":"DeleteWebhook","responses":{"204":{"description":"Webhook has been deleted"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"404":{"description":"A webhook with the webhook id provided was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}}},"description":"Delete a webhook that has been created.","tags":["Webhooks"],"security":[{"BEARER":["write_logistics_webhooks"]}],"parameters":[{"in":"path","name":"webhookId","required":true,"schema":{"$ref":"#/components/schemas/WebhookIdType"}}]}},"/logistics/api/2026-02/inbounds/shipment/archive":{"post":{"operationId":"ArchiveInboundingShipment","responses":{"204":{"description":""},"400":{"description":"Shipment cannot be archived","content":{"application/json":{"schema":{"$ref":"#/components/schemas/inbounds_BadRequestError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/inbounds_UnauthorizedError"}}}},"404":{"description":"Shipment not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/inbounds_NotFoundError"}}}}},"description":"Archive an inbounding shipment.","summary":"Archive a shipment","tags":["Inbounds"],"security":[{"BEARER":["write_logistics_inbounds"]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/inbounds_ArchiveShipmentRequest"}}}}}},"/logistics/api/2026-02/products/{logisticsSku}/barcode":{"post":{"operationId":"CreateProductBarcode","responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/products_ApiProductResponse"}}}},"400":{"description":"Barcode value provided not unique","content":{"application/json":{"schema":{"$ref":"#/components/schemas/products_BadRequestError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/products_UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/products_ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/products_NotFoundError"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/products_UnprocessableEntityError"}}}}},"description":"Validates and assigns a new barcode to a product provided logisticsSku.","tags":["Products"],"security":[{"BEARER":["write_logistics_products"]}],"parameters":[{"description":"The globally unique product identifier created by Flexport and assigned on product creation.","in":"path","name":"logisticsSku","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/products_BarcodeOption"}}}}}},"/logistics/api/2026-02/products/update/{logisticsSku}":{"patch":{"operationId":"UpdateProduct","responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/products_ApiProductResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/products_BadRequestError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/products_UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/products_ForbiddenError"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/products_UnprocessableEntityError"}}}}},"description":"Update a product","tags":["Products"],"security":[{"BEARER":["write_logistics_products"]}],"parameters":[{"in":"path","name":"logisticsSku","required":true,"schema":{"$ref":"#/components/schemas/products_ProductIdType"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/products_UpdateProductModel"}}}}}}},"servers":[{"url":"https://logistics-api.flexport.com","description":"Logistics API"}],"tags":[{"name":"Bundles","description":"The Bundles API allows you to create and retrieve bundles.\n"},{"name":"Bundles","description":"The Bundles API allows you to create and retrieve bundles.\n"},{"name":"Events","description":"The Events API allows you to retrieve historical events.\n"},{"name":"Events","description":"The Events API allows you to retrieve historical events.\n"},{"name":"Inbounds","description":"The Inbounds API allows you to create, track, and update inbound shipments. \nYou can also request and purchase rate quotes for those shipments. \nInbounds created using the API can either be sent to our LAX forwarding facility, a select reserve-storage facility, or direct to your assigned one-node facility (applies only to select Merchants).\nUnless you have an assigned one-node facility, you cannot use the API to create an inbound that is sent directly to a specific Fulfillment-Network warehouse.\n"},{"name":"Inbounds","description":"The Inbounds API allows you to create, track, and update inbound shipments. You can also request and purchase rate quotes for those shipments.\nInbounds created using the API can either be sent to our LAX forwarding facility, a select reserve-storage facility, or direct to your assigned one-node facility (applies only to select Merchants). Unless you have an assigned one-node facility, you cannot use the API to create an inbound that is sent directly to a specific Fulfillment-Network warehouse."},{"name":"OAuth","description":"OAuth 2.0 implementation endpoints.\n"},{"name":"Orders","description":"The Orders API allows you to\ncreate orders, track order lifecycles and get current order status\n(including shipment information) for those orders.\n"},{"name":"Outbounds","description":"Outbounds API allows you to create outbound orders from reserve storage warehouses to \nfulfilment centres. The APIs also allow you to track the status of the reserve storage outbound orders and cancel them.\n"},{"name":"Parcels","description":"Parcel is a new offering from Deliverr that allows merchants to\naffordably deliver across the US hassle-free. \nParcel is currently only available to select merchants.\n"},{"name":"Products","description":"The Products API allows you to create and retrieve products and their respective inventory and warehouse details.
\nProduct records are the primary entities for tracking physical product attributes, including inventory and dimensions.\nA product record represents a physical item in the Deliverr network.\nProduct records with at least one barcode are required to be present before inbounding inventory.
\n
Dimensions
\nProduct weight and dimensions attributes are vital values for proper billing and material handling.\nIf these values are known with high confidence, they can be passed through when creating Product records.\nHowever, once the dimensions have been verified, the Product record will show a dimsLocked value of true, and updates to\n weight or dimensions will no longer be accepted after that point.\n If dimensions are not provided when products are first received to the Deliverr network, they will be measured and updated as part of the inbounding process.
\n"},{"name":"Products","description":"The Products API allows you to create and retrieve products and their respective inventory and warehouse details.\nProduct records are the primary entities for tracking physical product attributes, including inventory and dimensions.\nA product record represents a physical item in the Deliverr network.\nProduct records with at least one barcode are required to be present before inbounding inventory.
\n
Dimensions
\nProduct weight and dimensions attributes are vital values for proper billing and material handling.\nIf these values are known with high confidence, they can be passed through when creating Product records.\nHowever, once the dimensions have been verified, the Product record will show a dimsLocked value of true, and updates to\n weight or dimensions will no longer be accepted after that point.\n If dimensions are not provided when products are first received to the Deliverr network, they will be measured and updated as part of the inbounding process.
\n"},{"name":"Reports","description":"The Reports API allows you to generate new reports and download them as CSV files. Here is a complete list of available reports\n\n| Report Code | Report Name and Link | startDate/endDate parameters used |\n| ----------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------- |\n| Claims-Claims_Submitted | Claims - Claims Submitted | YES |\n| Inbounds-Packages | Inbounds - Packages Report | YES |\n| Inbounds-Shipments | Inbounds - Shipments Report | YES |\n| Inbounds-Shipping_Plan_Reconciliation | Inbounds - Inventory / Shipping Plan Reconciliation Report | NO |\n| Inbounds-Inventory_Reconciliation | Inbounds - Inventory / Shipping Plan Reconciliation Report | NO |\n| Inventory-Levels_Today | Inventory - Levels Today Report | NO |\n| Inventory-Units_In_Long_Term_Storage | Inventory - Units in Long Term Storage Report | NO |\n| Orders-All_Orders | Orders - Orders Report | YES |\n| Orders-Shipments | Orders - Shipments Report | YES |\n| Products-All_SKUs_With_Alias_Counts | Products - All SKUs With Alias Counts Report | NO |\n| Products-All_SKUs_With_Dims_And_Alias_Counts | Products - All SKUs With Dims And Alias Counts Report | NO |\n| Products-All_CasePacks_With_Dims_And_Inventory | Products - All Case Packs With Dims And Inventory Report | NO |\n| Products-Available_SKUs_With_Alias_Counts | Products - Available SKUs With Alias Counts Report | NO |\n| Products-Available_SKUs_With_No_Aliases | Products - Available SKUs With No Aliases Report | NO |\n| Products-Catalog_Item_Master | Products - Catalog Item Master | NO |\n| Products-SKUs_With_Linked_Aliases | Products - SKUs with Linked Aliases Report | NO |\n| Returns-All_Returns | Returns - All Returns | YES |\n| Returns-All_SKUs | Returns - All Return Items by MSKU | YES |\n"},{"name":"Reports","description":"The Reports API allows you to generate new reports and download them as CSV files. Here is a complete list of available reports\n\n| Report Code | Report Name and Link | startDate/endDate parameters used | countryCode supported |\n| ----------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------- | --------------------- |\n| Claims-Claims_Submitted | Claims - Claims Submitted | YES | NO |\n| Inbounds-Packages | Inbounds - Packages Report | YES | NO |\n| Inbounds-Shipments | Inbounds - Shipments Report | YES | NO |\n| Inbounds-Shipping_Plan_Reconciliation | Inbounds - Inventory / Shipping Plan Reconciliation Report | NO | NO |\n| Inbounds-Inventory_Reconciliation | Inbounds - Inventory / Shipping Plan Reconciliation Report | NO | NO |\n| Inventory-Levels_Today | Inventory - Levels Today Report | NO | NO |\n| Inventory-Units_In_Long_Term_Storage | Inventory - Units in Long Term Storage Report | NO | NO |\n| Orders-All_Orders | Orders - Orders Report | YES | NO |\n| Orders-Shipments | Orders - Shipments Report | YES | NO |\n| Products-All_SKUs_With_Alias_Counts | Products - All SKUs With Alias Counts Report | NO | NO |\n| Products-Available_SKUs_With_Alias_Counts | Products - Available SKUs With Alias Counts Report | NO | NO |\n| Products-Available_SKUs_With_No_Aliases | Products - Available SKUs With No Aliases Report | NO | NO |\n| Products-SKUs_With_Linked_Aliases | Products - SKUs with Linked Aliases Report | NO | NO |\n| Returns-All_Returns | Returns - All Returns | YES | NO |\n| Returns-All_SKUs | Returns - All Return Items by MSKU | YES | NO |\n"},{"name":"Returns","description":"The returns API allows you to do following:\n1. Create return orders\n2. Get return order details\n3. Cancel return order\n"},{"name":"Warehouses","description":"The Warehouses API allows you to retrieve active warehouse information.\n"},{"name":"Webhooks","description":"The Webhooks API allows you to subscribe for updates to events by registering your endpoint that will receive event notifications.
\nIf webhook callout cannot be delivered because the endpoint was down, or for any other reason,\nit is retried multiple times for a period of at least one day.\n"}],"x-tagGroups":[{"name":"Logistics","tags":["Accounts","Bundles","Channels","Freight","Inbounds","OAuth","Orders","Outbounds","Parcel-Integration","Parcels","Products","Reports","Returns","Tracking","Uploads","Warehouses"]},{"name":"Webhooks","tags":["Events","Webhooks"]}],"webhooks":{"Parcel.TrackingUpdated":{"post":{"summary":"Parcel.TrackingUpdated","description":"Event for a parcel tracking update.","tags":["Events"],"security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ParcelTrackingUpdatedEvent"}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}}}},"Return.Updated":{"post":{"summary":"Return.Updated","description":"Event when a return order has been updated.","tags":["Events"],"security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReturnUpdatedEvent"}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}}}},"Inventory.Adjusted":{"post":{"summary":"Inventory.Adjusted","description":"Event when inventory changed.","tags":["Events"],"security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryAdjustedEvent"}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}}}},"Shipment.Created":{"post":{"summary":"Shipment.Created","description":"Event when a new shipment was created.","tags":["Events"],"security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShipmentCreatedEvent"}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}}}},"Shipment.Cancelled":{"post":{"summary":"Shipment.Cancelled","description":"Event when a new shipment was cancelled.","tags":["Events"],"security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShipmentCancelledEvent"}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}}}},"Shipment.Shipped":{"post":{"summary":"Shipment.Shipped","description":"Order may contain one or more shipments. Each shipment triggers a Shipment.Shipped event. After the entire order ships, Order.Shipped is triggered.","tags":["Events"],"security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShipmentShippedEvent"}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}}}},"Shipment.PartiallyShipped":{"post":{"summary":"Shipment.PartiallyShipped","description":"Event when a new shipment was partially shipped.","tags":["Events"],"security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShipmentPartiallyShippedEvent"}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}}}},"Inbound.Received":{"post":{"summary":"Inbound.Received","description":"Event when an inbound was received.","tags":["Events"],"security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboundReceivedEvent"}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}}}},"Inbound.ShipmentStatusChanged":{"post":{"summary":"Inbound.ShipmentStatusChanged","description":"Event when an inbound shipment status has changed.","tags":["Events"],"security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboundShipmentStatusChangeEvent"}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}}}},"Freight.TrackingUpdated":{"post":{"summary":"Freight.TrackingUpdated","description":"Event for a freight tracking update.","tags":["Events"],"security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreightTrackingUpdatedEvent"}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}}}},"Order.Cancelled":{"post":{"summary":"Order.Cancelled","description":"Event if an order was cancelled.","tags":["Events"],"security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderCancelledEvent"}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}}}},"Order.Shipped":{"post":{"summary":"Order.Shipped","description":"Order.Shipped is sent when the entire order has shipped. If order consists of multiple shipments, each shipment also triggers a Shipment.Shipped event.","tags":["Events"],"security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderShippedEvent"}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}}}},"Order.Held":{"post":{"summary":"Order.Held","description":"Order.Held is sent when an order is held.","tags":["Events"],"security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderHeldEvent"}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}}}},"Order.Submitted":{"post":{"summary":"Order.Submitted","description":"Event when an order was submitted.","tags":["Events"],"security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderSubmittedEvent"}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}}}},"Order.PickingStarted":{"post":{"summary":"Order.PickingStarted","description":"Event when order picking has started at the warehouse.","tags":["Events"],"security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderPickingStartedEvent"}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}}}},"Order.Packed":{"post":{"summary":"Order.Packed","description":"Event when an order was packed at the warehouse.","tags":["Events"],"security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderPackedEvent"}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}}}},"Order.Delivered":{"post":{"summary":"Order.Delivered","description":"Event when an order was delivered.","tags":["Events"],"security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderDeliveredEvent"}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}}}},"Shipment.Submitted":{"post":{"summary":"Shipment.Submitted","description":"Event when a shipment was submitted.","tags":["Events"],"security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShipmentSubmittedEvent"}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}}}},"Shipment.PickingStarted":{"post":{"summary":"Shipment.PickingStarted","description":"Event when shipment picking has started at the warehouse.","tags":["Events"],"security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShipmentPickingStartedEvent"}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}}}},"Shipment.Packed":{"post":{"summary":"Shipment.Packed","description":"Event when a shipment was packed at the warehouse.","tags":["Events"],"security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShipmentPackedEvent"}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}}}},"Shipment.Delivered":{"post":{"summary":"Shipment.Delivered","description":"Event when a shipment was delivered.","tags":["Events"],"security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShipmentDeliveredEvent"}}}}}}}}