Type = API Reference,; Topic = Multienterprise Information Network Tower (MINT), Transforms,;Persona = TraceLink Administrator, User,; Orchestration = Commerce, Transportation,; Function = Supply Chain, IT, Procurement,

Sales Order Outbound APIs

Sales order outbound refers to the process of fulfilling a sales order and managing the outbound logistics associated with delivering goods or services to the customer. It encompasses the operational steps involved after a sales order is confirmed, ensuring the correct products are picked, packed, shipped, and delivered to the customer as per the terms of the order. Key outbound documents include packing slips, which list the shipment's contents for the customer, and a bill of lading used for logistics purposes when needed. For example, a sales order begins with its confirmation, where the order is created, and key details such as products, quantities, prices, and delivery preferences are finalized. The order status is then updated to Confirmed, initiating the outbound process. A picking list is generated to assist warehouse staff in locating the required products, which are then packed according to specific order requirements, including any special handling or packaging needs. The inventory is adjusted to reflect the shipped items, ensuring accurate stock levels for future orders. A shipment carrier, is assigned, shipping labels are created, and delivery tracking details are updated in the system. Once the order is delivered, its status is updated to Delivered, and an invoice is generated for the customer based on the agreed payment terms.

  • Transform Name:
    • STD_MSDynamics_Business_Central_SalesOrder_OB

The following are the MS Dynamics Elements that are mapped with the Canonical Output Path.

MS Dynamics Field Input Element MS Dynamics Output Path MS Dynamics Output Element Mapping Rules
messageBody
  canonicalPurchaseOrderHeader
    processingFunctionTypeCode
    purchaseOrderType
    acknowledgmentType
    isAcknowledgmentRequired
    transactionReferenceIdentifierList(1)
      b2bTransactionIdentifierType
      b2bTransactionIdentifierValue externalDocumentNumber "Move source to target where b2bTransactionIdentifierType = PURCHASEORDER"
      transactionDate orderDate where b2bTransactionIdentifierType = PURCHASEORDER
      lineItemNumber
    transactionReferenceIdentifierList(2)
      b2bTransactionIdentifierType
      b2bTransactionIdentifierValue
      transactionDate
    mpcDates(1)
      dateType
      dateValue
      timeZone
    mpcDates(2)
      dateType
      dateValue requestedDeliveryDate "Move source to target where dateType= DELIVERYREQUESTED"
      timeZone
    mpcDates(3)
      dateType
      dateValue
      timeZone
    mpcDates(4)
      dateType
      dateValue
      timeZone
    mpcCurrency
      currencyCode currencyCode Move source to target Select first value from the array
      exchangeRateCurrencyCode
      exchangeRate
      validityDate
      currencyEntityCode
    manufacturerBusinessInformation
      businessName
      companyLocationContactInformation
        contactName
        contactTitle
        contactEmail
        contactPhone
      mpcCompanyLocationIdentifierList
        isIdentifierPresentInEvent
        companyIdentifierType
        companyIdentifierValue
        alternateCompanyLocationIdentifierValue
      address
        address1
        address2
        city
        state
        postalCode
        country
        telephone
        fax
        url
        district
        buildingNumber
        plantNumber
        floorNumber
        lscAddressIdentifier
        village
        houseNumber
        township
        premisesCode
    supplierBusinessInformation
      businessName rSMUSTracelinkVendorName
      companyLocationContactInformation
        contactTitle
        contactEmail
        contactName
        contactPhone
      mpcCompanyLocationIdentifierList
        isIdentifierPresentInEvent
        companyIdentifierType
        companyIdentifierValue rSMUSTracelinkVendorNo Where companyIdentifierType=COMPANYSITEID
        alternateCompanyLocationIdentifierValue
      address
        address1
        address2
        city
        state
        postalCode
        country
        telephone
        fax
        url
        district
        buildingNumber
        plantNumber
        floorNumber
        lscAddressIdentifier
        village
        houseNumber
        township
        premisesCode
    customerBusinessInformation
      businessName
      companyLocationContactInformation
        contactName
        contactTitle
        contactEmail
        contactPhone
      mpcCompanyLocationIdentifierList
        isIdentifierPresentInEvent
        companyIdentifierType
        companyIdentifierValue customerNumber "Move source to target If not found in customerBusinessInformation take it from shipTOBusinessInformation"
        alternateCompanyLocationIdentifierValue
      address    
        address1 sellToAddressLine1
        address2 sellToAddressLine2
        city sellToCity
        state sellToState
        postalCode sellToPostCode
        country sellToCountry
        telephone
        fax
        url
        district
        buildingNumber
        plantNumber
        floorNumber
        lscAddressIdentifier
        village
        houseNumber
        township
        premisesCode
    shipToLocationInformation    
      businessName shipToName
      companyLocationContactInformation
        contactTitle
        contactEmail
        contactName shipToContact
        contactPhone
      mpcCompanyLocationIdentifierList
        isIdentifierPresentInEvent
        companyIdentifierType
        companyIdentifierValue customerNumber
        alternateCompanyLocationIdentifierValue
      address    
        address1 shipToAddressLine1
        address2 shipToAddressLine2
        city shipToCity
        state shipToState
        postalCode shipToPostCode
        country shipToCountry
        telephone
        fax
        url
        district
        buildingNumber
        plantNumber
        floorNumber
        lscAddressIdentifier
        village
        houseNumber
        township
        premisesCode
    shipFromLocationInformation    
      businessName
      companyLocationContactInformation
        contactName
        contactTitle
        contactEmail
        contactPhone
      mpcCompanyLocationIdentifierList
        isIdentifierPresentInEvent
        companyIdentifierType
        companyIdentifierValue
        alternateCompanyLocationIdentifierValue
      address
        address1
        address2
        city
        state
        postalCode
        country
        telephone
        fax
        url
        district
        buildingNumber
        plantNumber
        floorNumber
        lscAddressIdentifier
        village
        houseNumber
        township
        premisesCode
    distributorBusinessInformation
      businessName
      companyLocationContactInformation
        contactName
        contactTitle
        contactEmail
        contactPhone
      mpcCompanyLocationIdentifierList
        isIdentifierPresentInEvent
        companyIdentifierType
        companyIdentifierValue
        alternateCompanyLocationIdentifierValue
      address
        address1
        address2
        city
        state
        postalCode
        country
        telephone
        fax
        url
        district
        buildingNumber
        plantNumber
        floorNumber
        lscAddressIdentifier
        village
        houseNumber
        township
        premisesCode
    billToBusinessInformation
      businessName
      companyLocationContactInformation
        contactTitle
        contactEmail
        contactName
        contactPhone
      mpcCompanyLocationIdentifierList
        isIdentifierPresentInEvent
        companyIdentifierType
        companyIdentifierValue billToCustomerNumber
        alternateCompanyLocationIdentifierValue
      address
        address1
        address2
        city
        state
        postalCode
        country
        telephone
        fax
        url
        district
        buildingNumber
        plantNumber
        floorNumber
        lscAddressIdentifier
        village
        houseNumber
        township
        premisesCode
    remitToBusinessInformation
      businessName
      companyLocationContactInformation
        contactName
        contactTitle
        contactEmail
        contactPhone
      mpcCompanyLocationIdentifierList
        isIdentifierPresentInEvent
        companyIdentifierType
        companyIdentifierValue
        alternateCompanyLocationIdentifierValue
      address
        address1
        address2
        city
        state
        postalCode
        country
        telephone
        fax
        url
        district
        buildingNumber
        plantNumber
        floorNumber
        lscAddressIdentifier
        village
        houseNumber
        township
        premisesCode
    carrierInformation
      businessName
      companyLocationContactInformation
        contactName
        contactTitle
        contactEmail
        contactPhone
      mpcCompanyLocationIdentifierList
        isIdentifierPresentInEvent
        companyIdentifierType
        companyIdentifierValue
        alternateCompanyLocationIdentifierValue
      address
        address1
        address2
        city
        state
        postalCode
        country
        telephone
        fax
        url
        district
        buildingNumber
        plantNumber
        floorNumber
        lscAddressIdentifier
        village
        houseNumber
        township
        premisesCode
    mpcOrganizationList
      organizationType
      organizationValue
    creditsAndCharges
      creditChargeKeyType
      creditChargeType
      creditChargeAmount creditChargeAmount "Move Source To Target where creditChargeType= DISCOUNT"
      qualifyingAmount
      creditChargePercentRate
      percentRateBasisTypeCode
      creditChargeCurrencyCode
      creditChargeHandlingCode
      description
      unitPriceAmount
      unitPriceBasisQuantity
      itemQuantity
      unitOfMeasure
      baseValue
    deliveryTerms
      deliveryTermCode
      description
      deliveryChargePaymentMethodType
      fobTransferLocation
      deliveryTermsConditionCode
    salesRequirementCode
    transportationInformation
      routingSequenceCode (v1)
      companyIdentifierType
      companyIdentifierValue
      transportMethod
      shipmentOrderStatusCode
    freeTextNote
      textReferenceCode
      textFunctionCode
      language
      textFormatCode
      freeFormText
    salesRequirementCode (v3)
    transportationInformation (v3)
      routingSequenceCode (v1)
      companyIdentifierType
      companyIdentifierValue
      transportMethod
      shipmentOrderStatusCode
    termsOfPayment
      CONSTANT[1]
      termsOfPaymentKey
      termsOfPaymentTypeCode paymentTermsId
      termsOfPaymentDateBasis
      numberOfDays
      termsOfPaymentPercent
      invoicePayablePercent
      paymentDueDate
      paymentDeferredToDate
      paymentDeferredDueAmount
      description
  canonicalPurchaseOrderItemDetails
    lineItemNumber
    processingFunctionTypeCode
    isAcknowledgmentRequired
    productCodesIdentifiers
      productCodeType
      productItemCodeValue lineObjectNumber Select first value from the array
      productItemCodeType
    productCodesIdentifiers
      productCodeType
      productItemCodeValue
      productItemCodeType
    productItemInformation
      productLanguageCode
      productName description
      genericName
      productDescription
      longDescription
    itemQuantity
      quantityType
      quantityValue quantity Select first value from the array
      unitOfMeasure unitOfMeasureCode

UOMCodeMapping

    orderPricing
      pricingType
      pricingAmount
      currencyCode
      priceUOM
      unitPriceBasisQuantity unitPrice where pricingType= UNIT
      altUOMDenominator
      altUOMNumerator
      numberOfUnitsInPriceUOM
    itemWeight
      weightType
      weightValue
      unitOfMeasure
    mpcDates
      dateType
      dateValue requestedDeliveryDate Where dateType= DELIVERYREQUESTED
      timeZone
    maximumPartialDeliveries
    materialClass
    itemCategory
    transactionReferenceIdentifierList
      b2bTransactionIdentifierType
      b2bTransactionIdentifierValue
      transactionDate
      lineItemNumber
    deliverySchedule
      scheduledQuantity quantity Select first value from the array
      previouslyScheduledQuantity
      scheduledDateTime requestedDeliveryDate
    creditsAndCharges
      creditChargeKeyType
      creditChargeType
      creditChargeAmount saleorderLines discountAmount "Move Source To Target where creditChargeType= DISCOUNT"
      qualifyingAmount
      creditChargePercentRate saleorderLines discountPercent creditChargeType= DISCOUNT
      percentRateBasisTypeCode
      creditChargeCurrencyCode
      creditChargeHandlingCode
      description
      unitPriceAmount
      unitPriceBasisQuantity
      itemQuantity
      unitOfMeasure
      baseValue
    deliveryTerms
      deliveryTermCode
      description
      deliveryChargePaymentMethodType
      fobTransferLocation
      deliveryTermsConditionCode
    freeTextNote
      textReferenceCode
      textFunctionCode
      language
      textFormatCode
      freeFormText

Tag end