Shipment and Delivery SLAs\nAll orders are assigned a shipping date based on when they were originally placed.\nAll orders are assigned a shipping SLA for expected shipment time and delivery time after being imported.\nTo meet buyer expectations it's vital that this reflects customer expectations when the order is placed.
\nThe logic of evaluating the provided field is:
\n
\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 |\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-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-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":"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":"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"}}}}}}}}