ILGFUSE

Sales Order

SCHEMASalesOrderRecordDto
  • ▶identifiersobjectHow this order, its customer, and its warehouse placement are identified.
    • idstring
    • shipmentIdstringYour unique reference for this shipment. Reusing a value replays as the same shipment.
    • businessIdstringmandatoryYour Fuse business ID. Must match the businessId you authenticate with.
    • businessSalesOrderIdstring
    • customerIdstringmandatoryThe retail/customer account this order ships for.
    • businessCustomerIdstring
    • shippingAddressIdstring
    • invoiceAddressIdstring
    • sitestringFulfilment site code, from your onboarding configuration.
    • warehousestringmandatoryWarehouse code within the site, from your onboarding configuration.
    • ownerIdstringStock owner code, from your onboarding configuration.
    • consignmentIdstring
    • pickGroupIdstring
    • carrierIdstring
    • loadIdstring
    • salesOrderstringmandatoryYour sales-order number. One of order.customerRef or this is required — the warehouse shipment ID is derived from it.
  • ▶orderobjectOrder-level classification, references, and instructions.
    • typestring
    • classstringmandatoryYour business's outbound order class, from your onboarding configuration. Not interchangeable with the purchase-order class.
    • statusstring
    • stagestring
    • priorityPrimestring
    • priorityAllocationstringAllocation priority, where used.
    • priorityDespatchstringDespatch priority, where your operation uses prioritisation.
    • customerRefstringmandatoryThe customer-facing order reference. One of this or identifiers.salesOrder is required.
    • returnReasonstring
    • generalReasonstring
    • maintenanceIndicatorstring
    • supervisorstring
    • notesstringFree-text delivery/packing instructions, delivered to the warehouse as an instruction attachment. Use customisations for value-added services instead.
  • ▶customerobjectWho the order is for.
    • groupstringCustomer group code. Drives group-level rules such as minimum-life-on-receipt stock attribution.
    • namestringmandatoryCustomer name as it should appear on paperwork and the carrier label.
    • orderstringThe customer's own order number (secondary reference).
  • ▶locationobject
    • regionstring
    • distributionCenterstring
    • storestring
  • ▶ownershipobject
    • stockStatusstring
  • ▶documentsobject
    • asnNumberstring
    • dNoteNumberstring
    • invoiceNumberstring
    • manifestNumberstring
    • billOfLadingstring
    • masterBillOfLadingstring
    • proofOfDeliverystring
  • ▶shippingobjectCarrier and routing selections.
    • methodstringmandatoryShipment-method label, matched against your configured shipment methods. An unmatched value falls back to a default rather than erroring.
    • carrierScacCodestring
    • trackingNumberstring
    • routestringmandatoryRouting code, from your onboarding configuration.
    • loadSequencestring
    • shippingLanestringShipping lane, from your onboarding configuration.
    • packStationstring
    • carrierstringmandatoryCarrier code, from your onboarding configuration.
  • ▶qualityControlobject
    • qualityControlstring
    • shortageCodestring
    • quantityVariancestring
    • cutOffIndstring
  • ▶quantitiesobject
    • linesnumber
    • lineQuantitynumber
    • stockTransferUnitQuantitynumber
    • volumenumber
    • weightnumber
    • actualWeightnumber
  • ▶tasksobject
    • countNewnumber
    • countCurrentnumber
    • countActionednumber
  • ▶timingobject
    • timeToPicknumber
    • timeToPacknumber
    • timeToChecknumber
    • timeToLoadnumber
    • timeOthernumber
    • timeToDelivernumber
  • ▶financialobjectOrder-level financials, used for invoicing, customs, and duty handling.
    • invoiceIndstring
    • currencystringmandatoryISO 4217 currency code for the order values.
    • lineValuenumbermandatoryTotal order value across lines — required for customs on export orders.
    • discountnumber
    • packingCostnumber
    • freightCostnumber
    • insurancenumber
    • chargesnumber
    • allowancesnumber
    • taxnumber
    • invoiceValuenumber
    • dutyPaidanytrue marks the order delivered-duty-paid: a duty attachment is written for the warehouse and carrier. Omitted is the same as false. If your DDP rules run in a connector they set this for you; calling the API directly, you set it per order.
  • ▶datesobjectOrder lifecycle dates.
    • createdstringISO 8601 date or date-time
    • suspendedstringISO 8601 date or date-time
    • closedstringISO 8601 date or date-time
    • dueOutstringWhen the order must leave the warehouse. Accepts an ISO 8601 date or date-time.
    • shipmentstringPlanned shipment date.
    • deliverystringISO 8601 date or date-time
    • invoicestringISO 8601 date or date-time
  • ▶indicatorsobject
    • advanceShippingNoticeIndicatorstring
    • overdueIndstring
  • ▶miscobject
    • valuesstring
  • ▶customisationsarray of objectHeader-level value-added-service instructions and attachments as name/value pairs. Names are matched case-sensitively downstream.
    • namestringAttachment/instruction type name — must match the configured production name exactly (case-sensitive).
    • valuestringThe instruction content.
  • ▶shipmentLinesarray of objectThe order lines.
    • shipmentIdstringThe shipment this line belongs to — repeat the header shipmentId.
    • linestringmandatoryLine number within the order, as a string ("1", "2", …).
    • levelstring
    • skuIdstringmandatoryThe SKU being ordered — must exist as master data first.
    • businessSKUstring
    • customerSKUstring
    • soLineIdnumber
    • ▶productobjectLine-level product details.
      • upcstring
      • upcDescriptionstring
      • categorystring
      • unitOfMeasurestringmandatoryA real warehouse unit code — "EA" is the common each/unit code; "EACH" is rejected.
    • ▶ownershipobject
      • lineOwnerstring
      • lineStockStatusstring
      • ownerIdstring
      • stockStatusstring
    • ▶quantitiesobjectLine quantities.
      • orderednumbermandatoryQuantity the customer ordered.
      • requirednumbermandatoryQuantity the warehouse should allocate — send it alongside ordered; it does not default from it.
      • allocatednumber
      • taskednumber
      • pickednumber
      • shippednumber
      • deliverednumber
      • dueOutnumber
    • ▶financialobjectLine-level pricing.
      • pricenumberUnit price, in the order currency.
      • discountnumber
      • taxRatenumber
    • ▶qualityobject
      • returnReasonstring
      • qualityControlstring
      • shortagestring
      • quantityVariancestring
    • ▶indicatorsobject
      • backOrderIndicatorstring
      • attachmentIndstring
      • specialConditionIndstring
    • ▶locationobject
      • consignmentIdstring
      • pickGroupIdstring
      • siteIdstring
      • warehousestring
    • ▶businessobject
      • businessIdstring
    • ▶timingobject
      • dateShipmentstringISO 8601 date or date-time
      • stagestring
    • ▶miscobject
      • lineValuesstring
    • ▶customisationsarray of objectLine-level value-added-service instructions (e.g. per-item personalisation).
      • namestring
      • valuestring
    • ▶extensionsobject
      • ▶shopifyobject
        • fulfillmentIdstring
  • ▶shipAddressesarray of objectDelivery address for the shipment. table is the fixed record discriminator "SHH".
    • tableenumone of "SHH"Fixed discriminator — always "SHH".
    • shipmentIdstringThe shipment this address belongs to — repeat the header shipmentId.
    • addressIdstringAddress sequence within the shipment; "1" for a single delivery address.
    • ▶addressobjectThe postal address.
      • namestringmandatoryRecipient/company name printed on the label.
      • line1stringmandatoryFirst address line.
      • line2string
      • line3string
      • citystringmandatoryCity or town.
      • statestring
      • postcodestringmandatoryPostal code.
      • countrystringmandatoryISO 3166 country code.
      • regionstring
    • ▶coordinatesobject
      • latitudenumber
      • longitudenumber
  • ▶shipContactsarray of objectDelivery contact — carriers reject bookings without one.
    • tableenumone of "SHH"Fixed discriminator — always "SHH".
    • shipmentIdstringThe shipment this contact belongs to — repeat the header shipmentId.
    • lineIdstringContact sequence within the shipment; "1" for a single contact.
    • ▶personalobjectThe contact's name.
      • titlestring
      • firstNamestringmandatoryContact first name.
      • lastNamestringmandatoryContact last name.
      • salutationstring
      • positionstring
    • ▶contactobjectHow the carrier reaches the recipient.
      • emailstringmandatoryContact email — used for carrier notifications.
      • faxstring
      • phonestringmandatoryContact phone in international format — used for delivery coordination.
      • mobilestring
      • pagerstring
    • ▶preferencesobject
      • languagestring