Goods-out (sales order) confirmation

EVENTsales-order-confirmationGoods Out Confirmations in Fuse

POSTed to your registered webhook URL when a sales order confirmation is processed.

The body is a plain JSON array of records — invariant across all confirmation types. Any 2xx response is treated as acknowledgement; anything else is retried up to three times with exponential backoff (1 s → 2 s → 4 s), then the failure is recorded for redrive. Fuse waits 30 s for your response.

Headers

Every delivery arrives with these.

Delivered with

x-webhook-secret-keyrequired
The secret registered against your connector. Compare it before trusting the payload — it is how you know the call came from Fuse.
x-correlation-idrequired
Trace id for the delivery. Log it: quoting it back is the fastest way for ILG support to find the record.
User-AgentBifrost-API-Gateway/1.0required
Always this fixed value.
Content-Typeapplication/jsonrequired
Always JSON.

Payload schema

Delivered to your registered webhook as a plain JSON array of records in this shape.

▶identifiersobjectHow this despatch and its owner are identified.
- shipmentIdstringThe shipment reference — matches the order you submitted.
- consignmentIdstringWarehouse consignment reference grouping the stock involved.
- bizIdstring
- businessIdstringYour Fuse business ID.
- ownerIdstringStock owner the shipment was despatched against.
- queueIdstringInternal reference of the warehouse outbound-queue entry this confirmation was built from — useful when raising a support query.
▶orderobjectThe sales order this despatch confirms.
- typestring
- classstringThe outbound order class the shipment was processed under.
- priorityAllocationstring
- priorityDespatchstring
- salesOrderstringYour sales order number.
- customerOrderstringThe end customer own order number.
- customerRefstringThe customer-facing order reference from the original order.
- primestring
- grnNumberstring
- manifestNumberstring
- billOfLadingstring
- masterBillOfLadingstring
- invoiceNumberstringInvoice number, where invoicing applies.
- podstringProof-of-delivery reference, where captured.
▶customerobjectWho the order shipped to.
- idstringThe retail/customer account.
- bizCustomerIdstring
- groupstringCustomer group, where set.
- namestringCustomer name from the order.
- orderstring
▶locationobjectWhere the shipment despatched from.
- sitestringDespatching site code.
- warehousestringWarehouse code within the site.
- regionstring
- distributionCenterstring
- storestring
- shippingLanestringShipping lane the order despatched through.
- packStationstringPack station that packed the order.
▶stockobjectWarehouse-internal operational detail — safe to ignore for most integrations.
- statusstring
▶quantitiesobjectHeader-level despatch quantities.
- orderednumberQuantity ordered.
- requirednumberQuantity the warehouse was asked to allocate.
- allocatednumberQuantity allocated from stock.
- taskednumber
- shippednumberQuantity actually despatched.
- deliverednumberQuantity confirmed delivered, where tracked.
- dueOutnumber
- linesnumberNumber of lines on the shipment.
- lineQtynumber
- stockTrackingUnitQtynumber
▶physicalobjectMeasured volume and weights of the despatch.
- volumenumber
- actualWeightnumber
- catchWeightnumber
▶shippingobjectCarrier and tracking for the despatch.
- methodstringShipment method the order went out under.
- addressIdstring
- invoiceAddressIdstring
- carrierIdstringCarrier code.
- carrierScacstringCarrier SCAC code.
- carrierTrackingNumberstringLead carrier tracking number.
- carrierTrackingNumberUrlstringTracking link for the lead tracking number.
- returnTrackingNumberstringReturn-label tracking number, where a return label was produced.
- returnTrackingNumberUrlstring
- routestringRouting code the order despatched under.
- loadIdstring
- loadSequencenumber
▶financialsobjectOrder financials as despatched.
- currencystringCurrency of the order values.
- lineValuenumberTotal order value.
- discountnumber
- packingnumber
- freightnumber
- insurancenumber
- chargesnumber
- allowancesnumber
- taxnumber
- invoiceValuenumberInvoiced value, where invoicing applies.
▶statusobjectShipment state.
- shipmentstring
- consignmentstring
- stagestringWarehouse processing stage the shipment reached.
- maintenancestring
- variancestring
- supervisorstring
- reasonstring
- returnReasonstring
- acceptanceCodestring
- dateExpirystring
▶tasksobjectWarehouse-internal operational detail — safe to ignore for most integrations.
- countNewnumber
- countCurrentnumber
- countActionednumber
- timeToPicknumber
- timeToPacknumber
- timeToChecknumber
- timeToLoadnumber
- timeToDelivernumber
- timeOthernumber
▶datesobjectDespatch lifecycle dates.
- createdstring
- closedstring
- suspendedstring
- dueOutstringWhen the order was due to leave.
- shipmentstringWhen the order actually despatched.
- deliverystringDelivery date, where tracked.
- invoicestring
▶indicatorsobjectWarehouse-internal operational detail — safe to ignore for most integrations.
- asnstring
- paperworkstring
- overduestring
- ignorestring
- backOrderstring
- attachmentstring
- specialConditionstring
- pairstring
- cutOffstring
- invoicestring
▶linesarray of objectThe despatched lines.
- roleenumone of "standard", "kit_component"
- ▶identifiersobjectLine identification.
  - shipmentIdstringThe shipment this line belongs to.
  - linestringLine number within the shipment.
  - levelstring
  - consignmentIdstring
  - siteIdstring
  - warehousestring
  - solLineIdnumber
  - batchIdstringBatch the line was picked from, for batch-tracked products.
- ▶productobjectWhat was despatched.
  - skuIdstringThe SKU despatched.
  - bizSkuIdstringYour SKU code for the product.
  - customerSkuIdstring
  - upcstring
  - upcDescriptionstring
  - categorystring
  - unitOfMeasurestringUnit the line quantities are expressed in.
- ▶quantitiesobjectLine quantities through pick, despatch, and delivery.
  - orderednumberQuantity ordered on this line.
  - requirednumber
  - allocatednumber
  - taskednumber
  - pickednumberQuantity picked.
  - shippednumberQuantity despatched.
  - deliverednumberQuantity confirmed delivered, where tracked.
  - dueOutnumber
  - catchWeightnumber
- ▶statusobjectLine state.
  - stockStatusstring
  - stagestring
  - variancestring
  - ignorestring
  - backOrderIndicatorstring
  - attachmentIndicatorstring
  - specialConditionIndicatorstring
  - returnReasonstring
  - qcstring
  - shortagestring
  - dateExpirystring
- ▶businessobjectLine-level warehouse placement.
  - warehousestring
  - bizIdstring
  - ownerIdstring
  - lineOwnerstring
  - lineStockStatusstring
- ▶datesobjectLine-level dates.
  - shipmentstring
- ▶priceobjectLine pricing from the original order.
  - unitPricenumberUnit price.
  - discountnumber
  - taxRatenumber
- valuesone of
- ▶extensionsobjectChannel-specific extras.
  - ▶shopifyobjectShopify-specific line detail, for orders that originated in Shopify.
    fulfillmentIdstringThe Shopify fulfilment this line was despatched under.
addressesarray of anyDelivery address records as despatched.
contactsarray of anyDelivery contact records as despatched.
despatchesarray of anyCarrier despatch records — one per despatch unit, each with its own tracking.
valuesone ofWarehouse-internal operational detail — safe to ignore for most integrations.
▶consignmentsarray of objectPer-package stock detail — which stock tracking units, batches, and quantities went in each.
- ▶identifiersobjectPackage/stock identification.
  - consignmentIdstring
  - stockIdstring
  - bizIdstring
  - ownerIdstring
  - skuIdstring
- ▶stockobjectStock attributes of the packaged units.
  - stockTrackingUnitstringStock tracking unit (pallet/tote/carton) identifier assigned by the warehouse.
  - stockTrackingTypestring
  - unitOfMeasurestring
  - batchIdstringBatch of the packaged units.
  - countrystring
- ▶quantitiesobjectQuantities in this package.
  - pickednumber
  - productQuantitynumber
  - boxQuantitynumber
- ▶physicalobjectPackage weight and dimensions.
  - weightnumber
  - actualWeightnumber
  - averageWeightnumber
  - boxstring
  - ▶dimensionsobject
    depthnumber
    heightnumber
    widthnumber
- ▶indicatorsobject
  - labelPrintedstring
  - putawaystring
  - pairstring
- ▶assignmentobject
  - typestring
  - refstring
  - pairStockTrackingUnitstring
  - originStockIdstring