ILGFUSE

Return Goods Authorization

SCHEMAReturnGoodsAuthorization
  • ▶identifiersobjectHow this return is identified.
    • idstringYour unique reference for this return authorisation.
    • queueIdstring
    • businessIdstringYour Fuse business ID. Must match the businessId you authenticate with.
    • businessRgaNumberstringLead return reference the warehouse books the arrival against (limited to roughly 20 characters downstream).
    • customerIdstringThe returning party — a supplier code registered for your business (for some businesses this is your own business ID, for others a distinct code; confirm at onboarding).
    • businessCustomerIdstring
    • originalPurchaseOrderstringThe original order this return relates to, where known.
    • primestring
    • consignmentIdstring
    • grnNumberstring
    • manifestNumberstring
    • pocstring
    • shippingAddressIdstring
    • invoiceAddressIdstring
  • ▶orderobjectReturn classification.
    • statusstring
    • typestring
    • classstringThe return discriminator — customer return vs wholesale return code from your onboarding configuration. This, not order.type, marks the receipt as a return.
    • stagestring
    • prioritystring
    • maintenanceIndicatorstring
  • ▶customerobjectThe end customer returning the goods.
    • groupstring
    • namestring
    • referencestringThe customer's own returns (RMA) reference.
  • ▶locationobjectWhere the return is arriving.
    • sitestringReceiving site code.
    • warehousestringWarehouse code within the site.
    • ownerIdstringStock owner the return books against.
    • stockStatusstring
    • regionstring
    • receiptLanestringReturns lane, where your site uses lane routing.
  • ▶shippingobjectInbound carrier details for the return, where captured.
    • methodstring
    • ▶carrierobject
      • idstring
      • trackingNumberstring
    • routestring
    • loadIdstring
    • loadSequencenumber
  • ▶qualityobjectReturn reasons and inspection.
    • qualityAssurancestring
    • acceptanceCodestringInspection acceptance code, where QC applies.
    • variancestring
    • returnReasonstringNumeric return-reason lookup code for your account — not a descriptive string. Required at header and line level.
  • ▶quantitiesobjectHeader-level return totals.
    • totalLinesnumber
    • totalQuantitynumber
    • storeUnitsQuantitynumber
    • volumenumber
    • weightnumber
    • actualWeightnumber
  • ▶tasksobject
    • countNewnumber
    • countCurrentnumber
    • countActionednumber
  • ▶timesobjectWarehouse-internal operational detail — safe to ignore for most integrations.
    • toUnloadnumber
    • toInspectnumber
    • toPutawaynumber
    • othernumber
    • toCollectnumber
  • ▶personnelobjectWarehouse-internal operational detail — safe to ignore for most integrations.
    • supervisorstring
    • reasonstring
  • ▶datesobjectReturn dates.
    • createdany
    • suspendedany
    • closedany
    • collectedany
    • dueInanyExpected arrival date.
    • arrivalanyWhen the return arrived on site.
    • receiptanyReceipt date — required at header and line level.
  • ▶indicatorsobjectWarehouse-internal operational detail — safe to ignore for most integrations.
    • asnstring
    • paperworkstring
    • overduestring
  • ▶metadataobjectReturn-level notes. The return carries a single note field — there is no customisations array.
    • notesstringFree-text note for the returns team (e.g. reported damage to inspect for).
  • ▶linesarray of objectThe returned lines.
    • ▶identifiersobjectLine identification.
      • returnAuthorizationIdstringThe return this line belongs to — repeat the header id.
      • lineNumberstringLine number within the return, as a string.
      • levelstring
      • idnumber
      • consignmentIdstring
      • businessIdstring
      • skuIdstringThe SKU being returned.
      • businessSkuIdstringYour SKU code for the product — usually the same value as skuId.
      • batchIdstring
    • ▶productobjectLine-level product details.
      • unitOfMeasurestringA real warehouse unit code — "EA" is the common each/unit code; "EACH" is rejected.
      • upcDescriptionstring
    • ▶locationobjectLine-level placement overrides. owner is required whenever this block is present.
      • sitestring
      • warehousestring
      • ownerstringStock owner for this line — required whenever a line location block is present.
      • stockStatusstringReceive the returned units under a non-default stock status code (e.g. quarantine for inspection before resale).
    • ▶quantitiesobjectReturn quantities. Send both ordered and advised — ordered does not default from advised.
      • orderednumberQuantity authorised for return.
      • advisednumberQuantity advised as actually on its way back.
      • receivednumberQuantity actually received back into stock on this line.
      • rejectednumberQuantity rejected at inspection on this line.
      • dueInnumber
    • ▶qualityobjectLine-level return reason.
      • returnReasonstringNumeric return-reason lookup code — required alongside the header code.
      • qualityAssurancestring
      • acceptancestring
      • variancestring
    • ▶datesobjectLine dates.
      • receiptanyLine receipt date — required alongside the header date.
      • expiryany
    • ▶metadataobjectWarehouse-internal operational detail — safe to ignore for most integrations.
      • ownerstring
      • stockStatusstring
      • hasAttachmentstring
      • hasSpecialConditionsstring
      • stagestring
      • backOrderIndicatorstring
  • ▶returnAddressesarray of objectReturn address records, where supplied on the authorisation.
    • tablestring
    • returnAuthorizationIdstring
    • addressIdstring
    • ▶addressobject
      • namestring
      • line1string
      • line2string
      • line3string
      • citystring
      • statestring
      • postcodestring
      • countrystring
      • regionstring
    • ▶coordinatesobject
      • latitudenumber
      • longitudenumber