Skip to main content

Send order/article update

The Warehousing API is used to submit order and article information to Bring’s warehouses. Users are also able to extract/subscribe for detailed order information from our warehouses while the orders are being processed. Further, the API provides information about articles in stock, with methods for retrieving information about single items or configurable list of items.

Authentication

To make API requests, you will need an API key from Mybring. Steps for getting a key and description of headers can be found on the general API Getting Started / Authentication page.

Formats

REST XML/JSON over HTTPS. This API doesn’t support JSON for all methods yet. Look in the example section to see which are supported.

Endpoints

Base URL
https://bapi.bring.com/wh/api/v1
UsageMethodEndpoint
Send an OrderPOST/order
Post item dataPOST/itemdata
List error codesGET/errorCodes

Send an Order

This endpoint is used to submit orders to Bring Warehousing. There are two different types of order you can submit.

• Order / SalesOrder
• PurchaseOrder

To send information to Bring, the following base endpoint URL must be used:

post
      https://bapi.bring.com/wh/api/v1/order
    

Request parameters

HTTP headerTypeDescription
AcceptstringRequired Specify response format (application/xml, application/json)
Possible values:
• application/xml
• application/json
Content-TypestringRequired Specify response format (application/xml, application/json)
Possible values:
• application/xml
• application/json

Request body

XML SampleJSON Sample
  • CreateOrderRequestobjectRequiredCreate Order Request
    • versionstring (attribute)RequiredVersion of Request.
      • Default value:
        • 5.0
    • definedBystring (attribute)RequiredDefined By.
      • Default value:
        • BIG
    • domainstring (attribute)RequiredDomain.
      • Default value:
        • SupplyChain
    • collaborationstring (attribute)RequiredCollaboration.
      • Default value:
        • Order
    • messageFunctionstring (attribute)RequiredType of order.

      • Example:
        For salesorder/customer order = "Order"
        For purchaseOrder = "PurchaseOrder"
    • profilestring (attribute)RequiredProfile.
      • Default value:
        • BringXML
    • messageIdstring (attribute)RequiredUnique id for this message.

      • Example:
        3dcc8b71-2bf7-4574-813d-9295bd5db8c0
    • updateIndicatorstring (attribute)RequiredUpdate Indicator.

      • Example:
        updateIndicator="Deletion"
    • testIndicatorstring (attribute)RequiredWhether this is a test message.

      • Example:
        testIndicator="NO"
    • MessageDetailsobjectRequiredMessage Details
      • MessageDatedatetimeRequiredThe date on which the message was sent.

        • Example:
          <MessageDate>2021-02-12T13:38:08</MessageDate>
      • MessageRecipientobjectRequiredMessage Recipient
        • partyIdstring (attribute)RequiredCustomer number (6 or 11 digits) provided by Bring.

          • Example:
            <MessageRecipient partyId="20001234567" idType="14" />
        • idTypestring (attribute)OptionalpartyId type.

          • Possible values:
            14 - EAN International
            30 - ISO 6523: Organization identification
            ZZ - Mutually defined

            Example:
            <MessageRecipient partyId="20001234567" idType="14" />
      • MessageSenderobjectRequiredMessage Sender
        • partyIdstring (attribute)RequiredCustomer number (6 or 11 digits) provided by Bring.

          • Example:
            <MessageSender partyId="20001234567" idType="14" />
        • idTypestring (attribute)OptionalpartyId type.

          • Possible values:
            14 - EAN International
            30 - ISO 6523: Organization identification
            ZZ - Mutually defined

            Example:
            <MessageSender partyId="20001234567" idType="14" />
    • SupplyStructureobjectRequiredSupply Structure
      • ORDERSETobjectRequiredOrder Set
        • updateIndicatorstring (attribute)OptionalUpdate Indicator.

          • Possible values:
            Original
            Update
            Delete
        • ORDERobjectRequiredOrder
          • orderIdstring (attribute)RequiredUnique ID for this order.

            • Example:
              <Order orderId="123456" />
          • ExternalOrderTypestringOptionalType of Order.

            • Example CustomerOrder(CO):
              220 - Standard Order
              224 - Rush Order
              237 - Special Order (used for crosslocking)
              Or other agreed by Warehousing

              e.g.
              <OrderSet updateIndicator="Original">
                  <Order orderId="123456">
              <ExternalOrderType>220</ExternalOrderType>

              Example PurchaseOrder(PO):
              R - Return order

              e.g.
              <OrderSet updateIndicator="Original">
                  <Order orderId="123456">
              <ExternalOrderType>R</ExternalOrderType>
          • ReferencearrayRequiredOrder Reference.
            • The first 3 referenceTypes are required:
              ACD - Additional reference number. Used for Bring WH clients order number
              CU - Consignor's reference number. Reference number assigned by a consignor to a particular shipment for his own purposes or for those of the consignee.

              Used for "Vår.ref/our reference".
              Varies on PO and CO.
              For PO "sellers ref" = supplier to the WH
              For CO "sellers ref" = Bring WH client selling items to their customer.

              ON - Order number (purchase)/Buyer"s reference.
              Reference number assigned by the buyer to an order.
              Used for "Deres ref/your/their reference"

              Example:
              <Reference referenceType="ACD">
                  <ReferenceNo>1234</ReferenceNo>
              </Reference>

              <Reference referenceType="CU">
                  <ReferenceNo>12345</ReferenceNo>
              </Reference>

              <Reference referenceType="ON">
                  <ReferenceNo>123456</ReferenceNo>
              </Reference>

              The following referenceTypes are optional:

              SS - Sellers reference number.
              Reference number assigned to a transaction by the seller.
              COI - Your reference. Takes precedence over ON.

              You can find more general information on referenceTypes here

              Example:
              <Reference referenceType="SS">
                  <ReferenceNo>1234</ReferenceNo>
              </Reference>
            • referenceTypestringRequiredType of reference used in order
            • ReferenceNostringRequiredReference Number
          • DateAndTimesarrayRequiredDate and time of the order.
            • There are many different options for date and time, but the most frequently used subClasses are:
              DocumentDate The date on which the order is booked.
              DeliveryDateRequested The date on which the order is requested to be delivered
              ExpirationDate

              Example:
              <DateAndTimes subClass="DocumentDate">
                  <Date>2021-02-12</Date>
                  <Time>13:29:45</Time>
              </DateAndTimes>

              <DateAndTimes subClass="DeliveryDateRequested">
                  <Date>2021-02-15</Date>
                  <Time>00:00:00</Time>
              </DateAndTimes>
            • subClassstring (attribute)RequiredsubClass.

              • The most frequently used subclasses are:
                ExpirationDate
            • DatestringRequiredDate.
            • TimestringRequiredTime.
          • TermsOfDeliveryarrayOptionalTerms of Delivery
            • The regulations are used to clarify the distribution of obligations between seller and buyer when shipping goods / Incoterms

              Example:
              <TermsOfDelivery>
                  <TODConditionCode>DDP</TODConditionCode>
              </TermsOfDelivery>
            • TODConditionCodestringOptionalTerms of Delivery Condition Code.

              • The most frequently used subclasses are:
                ExpirationDate
          • FreeTextarrayOptionalReference on an order.

            • Used for information to the WH or for the delivery of the order, seperated by usagecode.

              Possible values:
              DEL - Information to WH
              DIN - Message to carrier
              ZZZ - Message to recipient. Mutually defined reference number
              ON - Notes in M4N

              Example:
              <FreeText usageCode="DEL">
                  <Text>Send this order together with order XXX</Text>
              </FreeText>

              <FreeText usageCode="DIN">
                  <Text>delivery instruction</Text>
              </FreeText>

              <FreeText usageCode="ZZZ">
                  <Text>123456</Text>
              </FreeText>

              <FreeText usageCode="ON">
                  <Text>ABCDEF</Text>
              </FreeText>
            • usageCodestring (attribute)Optionalusage Code.
            • TextstringOptionalFreeText text.
          • CODarrayOptionalIf goods are to be paid on delivery.


            • Example:
              <COD>
                  <AccountNo idType="idType_0">AccountNo_0</AccountNo>
                  <CodAmount>10</CodAmount>
                  <ControlDigit>10</ControlDigit>
                  <Kid>Kid_0</Kid>
                  <Message>Message_0</Message>
              </COD>
            • AccountNoObjectOptionalAccount No.
              • idTypestring (attribute)OptionalID Type.
            • CODAmountNumber (float)OptionalCOD Amount
            • ControlDigitNumber (int)OptionalControl Digit
            • KidStringOptionalKid
            • MessageStringOptionalMessage
          • TermsOfPaymentarrayOptionalPayment for the order.

            • Example:
              <TermsOfPayment otherDesc="Vipps">
                  <TOPConditionCode>Vipps</TOPConditionCode>
              < /TermsOfPayment>
            • otherDescstring (attribute)OptionalOther Description.

              • Possible values:
                Vipps
                Invoice
            • TOPConditionCodestringOptionalCondition Code.

              • Possible values:
                Cash
                Visa
                Mastercard
                COD
                Net30days
                Net15days
                Net14days
                Net10days
                Vipps
                Other
          • PriorityCodestringOptionalPriority Code.

            • If the order should have a priority you can add value here.
              If no value is added the default value is set to "Normal".

              M4N Values:
              X - Express

              Example:
              <PriorityCode>X</PriorityCode>
        • TransportServiceobjectRequiredTransport service for shipment to customer.

          • Example:
            <TransportService>
                <BasicServiceCode>Servicepakke</BasicServiceCode>
                <AdditionalService>
                    <AdditionalServiceCode>EVARSLING</AdditionalServiceCode>
                </AdditionalService>
                <AdditionalService>
                    <AdditionalServiceCode>PickUpPoint</AdditionalServiceCode>
                </AdditionalService>
                <TariffReference>TariffReference_0</TariffReference>
                <NatureOfCargo>NatureOfCargo_0</NatureOfCargo>
                <Priority>Priority_0</Priority>
                <Utility usageCode="">
                    <Value sequence="" valueType="" valueCode="">Value_0</Value>
                </Utility>
            </TransportService>
          • BasicServiceCodestringRequiredBasic Service Code.

            • Required for a Customer order.
              Optional for PurchaseOrder.

              You will find information on all outgoing Services
              for Posten Norge and Bring here

              Example:
              <BasicServiceCode>Servicepakke</BasicServiceCode>
          • AdditionalServicearrayRequiredAdditional Service.

            • If Recipient notification is over SMS or E-Mail, a value must be added for either email and/or cellphone number within Contact in Party [subClass="Buyer"]

              You will find information on all outgoing Services for Posten Norge and Bring here

              And more information about PickUpPoint (PuP) here.

              Example:
              <AdditionalService>
                  <AdditionalServiceCode>EVARSLING</AdditionalServiceCode>
              </AdditionalService>
              <AdditionalService>
                  <AdditionalServiceCode>PickUpPoint</AdditionalServiceCode>
              </AdditionalService>
            • PriorityCodestringOptionalPriority Code.

              • If the order should have a priority you can add value here.
                If no value is added the default value is set to "Normal".

                M4N Values:
                X - Express

                Example:
                <PriorityCode>X</PriorityCode>
            • AdditionalServiceCodestringRequiredAdditional Service Code.
          • TariffReferencestringOptionalTariff Reference.
          • NatureOfCargostringOptionalNature of Cargo.
          • PrioritystringOptionalNature of Cargo.
          • UtilityobjectOptionalUtility
            • usageCodestring (attribute)Optionalusage Code.
            • ValueobjectOptionalUtility Value.
              • sequencestring (attribute)OptionalPriority Code.
              • valueTypestring (attribute)Optionalvalue Type.
              • ValuestringOptionalService Utility Value.
        • TransportLeg (not in use)
          • TransportLegType
            • codeListIdentifier
            • codeListAgencyIdentifier
            • name
            • Value
          • ± TransportLegId
          • ModeOfTransport
            • codeListIdentifier
            • codeListAgencyIdentifier
            • name
            • Value
          • MeansOfTransport
            • ± MeansOfTransportId
            • CountryCode
              • codeListIdentifier
              • codeListAgencyIdentifier
              • name
              • Value
            • ± Name
            • MeansOfTransportType
              • codeListIdentifier
              • codeListAgencyIdentifier
              • name
              • Value
          • Location
            • ± subClass
            • ± locationId
            • ± idType
            • LocationType
              • codeListIdentifier
              • codeListAgencyIdentifier
              • name
              • Value
            • ± LocationName
            • CountryCode
              • codeListIdentifier
              • codeListAgencyIdentifier
              • name
              • Value
        • PartyobjectRequiredParty

          • An order consists of several Parties; a supplier, a sender, a receiver, etc.
            The subClass code defines each type of party.
            Must have Name, Street, City, CountryCode

            Example:
            <Party subClass="OrderingParty" partyId="11223">
                <Name>Testcompany</Name>
                <Address subClass="PhysicalAddress">
                    <PostalCode>0123</PostalCode>
                    <City>OSLO</City>
                    <CountryCode>NO</CountryCode>
                    <Street>Teststreet 2</Street>
                </Address>
                <Contact>
                    <CellPhoneNo>99010100</CellPhoneNo>
                    <EMailAddress>john.doe@posten.no</EMailAddress>
                    <ContactName>John Doe</ContactName>
                </Contact>
            </Party>
          • subClassstring (attribute)RequiredDefines the type of Party.

            • Possible values:

              Details on Supplier/Sender/Receiver (required)
              OrderingParty - Details of Sender
              DeliveryParty - Details of recipient
              Supplier - Details of supplier
              For a PO, the supplier is the one providing the goods to the WH.
              For a SO, the supplier is you/Bring WH customer.
              (Optional for SO)
              Buyer - Details of buyer
              Optional
              Seller - Details of seller.
              Optional

              WareHouse ID/Location (required)
              PerformingUnit

              Information on Transport Company (optional)
              TransportCompany
          • partyIdstring (attribute)RequiredParty id for the subClass.

            • Possible values:

              Supplier/Sender/Receiver
              provided by user

              Example:
              <Party subClass="OrderingParty" partyId="112233" />

              Warehouse ID/Location
              105075 - Bergen
              780132 - Berger/Skedsmokorset
              105091 - Drammen
              780448 - Fredrikstad
              780446 - Haugesund
              780429 - KongShavn
              105090 - Trollåsen
              780135 - Trondheim

              Example:
              <Party subClass="PerformingUnit" partyId="780132" />

              Transport Company
              Bring
              Example:
              <Party subClass="TransportCompany" partyId="Bring" />
          • subPartyIdstring (attribute)RequiredThe value of the actual Pick up point site.

            • Example:
              <Party subClass="DeliveryParty" partyId="123456"
              subPartyId="109847">
          • NamestringRequiredName of the Supplier/Sender/Receiver.

            • Example:
              <Name>TestCompany</Name>
          • AddressobjectRequiredAddress of the Supplier/Sender/Receiver

            • Example:
              <Address subClass="PhysicalAddress">
                  <PostalCode>0123</PostalCode>
                  <City>OSLO</City>
                  <CountryCode>NO</CountryCode>
                  <Street>Teststreet 2</Street>
              </Address>
            • subClassstring (attribute)Requiredsub Class.
            • PostalCodestringRequiredPostal Code.
            • CitystringRequiredCity.
            • CountycodestringRequiredCountry Code.
            • StreetstringRequiredStreet.
          • ContactobjectReq/OptContact.
            • (subClass determines whether required)
              Details of contact

              Must be provided if using "EVARSLING" within TransportService of AdditionalService [subClass="AdditionalServiceCode"]

              Must have Name, Cellphone and emailAddress.

              Example:
              <Contact>
                  <CellPhoneNo>99010100</CellPhoneNo>
                  <EMailAddress>john.doe@posten.no</EMailAddress>
                  <ContactName>John Doe</ContactName>
              </Contact>
            • CellPhoneNostringRequiredCell Phone Number.
            • EMailAddressstringRequiredEmail address.
            • ContactNamestringRequiredContact Name.
        • OrderLineSetobjectRequiredOrder Line Set
          • OrderItemarrayRequiredDetails of the order lines.

            • Example:
              <OrderLineSet>
                  <OrderItem articleLineId="1">
                      <ArticleId codeListIdentifier="EAN">123456</ArticleId>
                      <ArticleId codeListIdentifier="CustomerItemNo">7020-180</ArticleId>
                      <ArticleQuantity unitCode="">1000</ArticleQuantity>
                      <Description usageCode="AAA">
                          <Text>White, electric table fan</Text>
                      </Description>
                      <ArticleStatus/>
                      <ArticleBatchNo>123456</ArticleBatchNo>
                      <ArticleName>Electric Fan 18cm</ArticleName>
                  </OrderItem>
              </OrderLineSet>
            • articleLineIDstring (attribute)RequiredArticle Line Id.
            • ArticleIdarrayRequiredArticle Numbers
              • codeListIdentifierstring (attribute)RequiredSets type of Article number/id.
              • ValuestringRequiredArticle Id Value
            • ArticleQuantityarrayRequiredQuantity Ordered.
              • codeListIdentifierstring (attribute)RequiredSets type of Article quantity/id.
              • unitCodestring (attribute)RequiredUnit Code for quantity ordered.

                • Possible values:
                  STK - Norwegian
                  PCE - English
                  KGM - Kilogram

                  Example:
                  <ArticleQuantity unitCode="STK">2.0</ArticleQuantity>
              • Valuenumber (float)RequiredArticle Quantity.
            • ArticleReferencearrayOptionalArticle Reference.
              • referenceTypestring (attribute)RequiredType of references used in orderline.

                • Possible values:
                  LI - LINEREFERENCE1
                  PE - PLANT
                  OP - RESERVEDORDERID
                  AEP - PROJECTNUMBER

                  Example:
                  <ArticleReference referenceType="LI">
                      <ReferenceNo>123456</ReferenceNo>
                  </ArticleReference>
              • ReferenceNonumber (float)RequiredArticle Quantity.
            • DescriptionobjectRequiredArticle Description.

              • Example:
                <Description usageCode="AAA">
                    <Text>White, electric table fan</Text>
                </Description>
              • usageCodestring (attribute)RequiredArticle Description Type.

                • Possible values:
                  AAA - if description is used
              • TextstringRequiredDescription.
            • DateAndTimesobjectOptionalDate and Time at the Orderline level.
              • There are many different options for date and time.

                Example:
                <DateAndTimes subClass="ExpirationDate">
                    <Date>2028-02-07</Date>
                    <Time>00:00:00</Time>
                </DateAndTimes>
              • subClassstring (attribute)RequiredSubClass.

                • The most frequently used subclasses are:
                  ExpirationDate
                  ProductionDate
              • DatestringRequiredDate.
              • TimestringRequiredTime.
            • ArticleMonetaryAmountsobjectOptionalArticle unit sales price and currency.
              • UnitPriceobjectOptionalUnit Price.
                • currencyIdentificationCodestring (attribute)OptionalCurrency Identification Code.

                  • Example:
                    <UnitPrice currencyIdentificationCode="NOK">
                        230.30
                    </UnitPrice>
                • Valuenumber (float)OptionalUnit Price Value.
            • UtilityobjectOptionalUtility.
              • usageCodestring (attribute)Optionalusage Code.
              • codeListIdentifierstring (attribute)OptionalCode List Identifier.

                • Possible values:
                  DaysExpire - MINSHELFLIFE
                  CustomStorage - ERPCode
                  ClientStorage - ERPCode
                  AAQ - SHIPPINGCONTAINER

                  Example:
                  <Utility usageCode="N" codeListIdentifier="CustomStorage" />
              • ValuestringOptionalUtility value.
            • ArticleStatusstringRequiredArticle Status.
            • ArticleSerialNosarrayOptionalSerial numbers for the article.
              • ArticleSerialNostringOptionalArticle Serial No.

                • Example:
                  <ArticleSerialNos>
                      <ArticleSerialNo>123</ArticleSerialNo>
                  </ArticleSerialNos>
            • ArticleBatchNostringOptionalBatch number connected to the article.

              • Example:
                <ArticleBatchNo>123456</ArticleBatchNo>
            • FreeTextobjectOptionalUsed for additional information

              • Example:
                <FreeText usageCode="LIN">
                    <Text>0002292492</Text>
                </FreeText>
              • usageCodestring (attribute)OptionalUsage Code.

                • Possible values:
                  ACB - Notes
                  LIN - LINEREFERENCE
              • TextstringOptionalText.
            • ArticleNamestringOptionalArticle Name.

              • Example:
                <ArticleName>Electric Fan 18cm</ArticleName>
          • PalletInfoarrayOptionalPallet Info
            • EPDCodestringOptionalEPD Code.

              • Example:
                <EPDCode>1234</EPDCode>
            • PalletQuantitystringOptionalPallet Quantity.

              • Example:
                <PalletQuantity>10</PalletQuantity>
        • CustomsClearanceobjectOptionalCustoms Clearance
          • FreightChargeAmountobjectOptionalFreight Cost
            • currencyIdentificationCodestring (attribute)OptionalCurrency Identification Code.

              • Example:
                <FreightChargeAmount currencyIdentificationCode="NOK">
                    230.30
                </FreightChargeAmount>
            • Valuenumber (float)OptionalValue of the Freight Charge Amount.
          • FreightChargeCarrierstringOptionalCustoms Carrier.

            • Example:<FreightChargeCarrier></FreightChargeCarrier>

Responses

HTTP status code 200

Complete Create Order

XML SampleJSON Sample

HTTP status code 400

Error in validation of request or error in data structure of request.

HTTP status code 417

Missing Authentication Headers

HTTP status code 500

Unknown error. Error sending data to destination.

Post Item Data

This endpoint is used to submit article information to Bring Warehousing.

post
      https://bapi.bring.com/wh/api/v1/itemdata
    
HTTP headerTypeDescription
AcceptstringRequired Specify response format (application/xml, application/json)
Possible values:
• application/xml
• application/json
Content-TypestringRequired Specify response format (application/xml, application/json)
Possible values:
• application/xml
• application/json

Request body

XML SampleJSON Sample
  • CreateItemDataRequestobjectRequiredSend Item Data Request
    • versionstring (attribute)RequiredVersion of Request.
      • Default value:
        • 5.0
    • definedBystring (attribute)RequiredDefined By.
      • Default value:
        • BIG
    • domainstring (attribute)RequiredDomain.
      • Default value:
        • SupplyChain
    • collaborationstring (attribute)RequiredCollaboration.
      • Default value:
        • Order
    • messageFunctionstring (attribute)RequiredType of order.

      • Example:
        For salesorder/customer order = "Order"
        For purchaseOrder = "PurchaseOrder"
    • profilestring (attribute)RequiredProfile.
      • Default value:
        • BringXML
    • messageIdstring (attribute)RequiredUnique id for this message.

      • Example:
        3dcc8b71-2bf7-4574-813d-9295bd5db8c0
    • updateIndicatorstring (attribute)RequiredUpdate Indicator.

      • Example:
        updateIndicator="Deletion"
    • testIndicatorstring (attribute)RequiredWhether this is a test message.

      • Example:
        testIndicator="NO"
    • MessageDetailsobjectRequiredMessage Details
      • MessageDatedatetimeRequiredThe date on which the message was sent.

        • Example:
          <MessageDate>2021-02-12T13:38:08</MessageDate>
      • MessageRecipientobjectRequiredMessage Recipient
        • partyIdstring (attribute)RequiredCustomer number (6 or 11 digits) provided by Bring.

          • Example:
            <MessageRecipient partyId="20001234567" idType="14" />
        • idTypestring (attribute)OptionalpartyId type.

          • Possible values:
            14 - EAN International
            30 - ISO 6523: Organization identification
            ZZ - Mutually defined

            Example:
            <MessageRecipient partyId="20001234567" idType="14" />
    • PerformingUnitobjectRequiredPerforming Unit
      • Namestring (attribute)RequiredPerforming Unit Name
      • ValuestringRequiredPerforming Unit Value
    • SupplyStructureobjectRequiredSupply Structure
      • ArticleInformationSetarrayRequiredArticle Information Set Array
        • ArticleInformationarrayRequiredArticle Information Array
          • articleLineIdstring (attribute)RequiredArticle Line Id
          • ArticleNumberarrayRequiredArticle Number
            • usageCodestring (attribute)RequiredUsage Code
            • codeListIdentifierstring (attribute)RequiredList Identifier
            • codeListAgencyIdentifierstring (attribute)RequiredList Agency Identifier
            • namestring (attribute)RequiredName
            • ValuestringRequiredUsage Code Value
          • ArticlePhysicalBalanceQuantityobjectRequiredPhysical Balance Quantity
            • unitCodestring (attribute)RequiredUnit Code
            • ValuestringRequiredItem Quantity Value
          • ArticleAllocatedBalanceQuantityobjectRequiredAllocated Balance Quantity
            • unitCodestring (attribute)RequiredUnit Code
            • ValuestringRequiredItem Quantity Value
          • ArticleInOrderBalanceQuantityobjectRequiredIn Order Balance Quantity
            • unitCodestring (attribute)RequiredUnit Code
            • ValuestringRequiredItem Quantity Value
          • ArticleFreeBalanceQuantityobjectRequiredFree Balance Quantity
            • unitCodestring (attribute)RequiredUnit Code
            • ValuestringRequiredItem Quantity Value
          • ArticleAdjustedQuantityobjectRequiredAdjusted Balance Quantity
            • unitCodestring (attribute)RequiredUnit Code
            • ValuestringRequiredItem Quantity Value
          • ArticleCountedQuantityobjectRequiredCounted Balance Quantity
            • unitCodestring (attribute)RequiredUnit Code
            • ValuestringRequiredItem Quantity Value
          • DescriptionarrayRequiredDescription
            • usageCodestring (attribute)RequiredUsage Code
            • codeListIdentifierstring (attribute)RequiredCode List Identifier
            • codeListAgencyIdentifierstring (attribute)RequiredCode List Agency Identifier
            • namestring (attribute)RequiredName
            • LanguageCodeobjectRequiredLanguage Code
              • codeListIdentifierstring (attribute)RequiredCode List Identifier
              • codeListAgencyIdentifierstring (attribute)RequiredCode List Agency Identifier
              • namestring (attribute)RequiredName
              • ValuestringRequiredCode Value
            • TextarrayRequiredFree Text Type Text
              • sequencestring (attribute)RequiredSequence
              • codestring (attribute)RequiredCode
              • ValuestringRequiredFree Text Value
          • DateAndTimesarrayRequiredDate and Times
            • subClassstring (attribute)RequiredTime zone.

              • Possible values:
                DocumentDate
                MessageDate
                TransportOrderDate
                OrderDate
                OrderDeliveryDate
                OrderDeliveryDateRequested
                OrderDeliveryDateActual
                OrderDeliveryDateEstimated
                DepartureDate
                DepartureDateRequested
                DepartureDateActual
                DepartureDateEstimated
                DeliveryDate
                DeliveryDateRequested
                DeliveryDateActual
                DeliveryDateEstimated
                ArrivalDate
                ArrivalDateActual
                ArrivalDateEstimated
                LoadingDate
                PickupDate
                PickupDateActual
                PickupDateEarliest
                PickupDateLatest
                DeliveryDateEarliest
                DeliveryDateLatest
                DeadLine
                UpdatedDate
                ExpirationDate
                ReceivedDate
                ReceivedDateRequested
                ReceivedDateEstimated
                FinishedDate
                ProductionDate
                FreezeDate
                EffectiveDate
            • timeZonestring (attribute)RequiredSub Class
            • dstIndicatorstringstring (attribute)RequiredDestination Indicator
            • DatestringRequiredDate
            • TimestringRequiredTime
          • UtilityarrayRequiredUtility
            • usageCodestring (attribute)RequiredUsage Code
            • codeListIdentifierstring (attribute)RequiredCode List Identifier
            • codeListAgencyIdentifierstring (attribute)RequiredCode List Agency Identifier
            • namestring (attribute)RequiredName
            • LanguageCodeobjectRequiredLanguage Code
              • codeListIdentifierstring (attribute)RequiredCode List Identifier
              • codeListAgencyIdentifierstring (attribute)RequiredCode List Agency Identifier
              • namestring (attribute)RequiredName
              • ValuestringRequiredCode Value
            • TextarrayRequiredFree Text Type Text
              • sequencestring (attribute)RequiredSequence
              • codestring (attribute)RequiredCode
              • ValuestringRequiredFree Text Value
          • ArticleQuantityobjectRequiredArticle Quantity
            • usageCodestring (attribute)RequiredUsage Code
            • codeListIdentifierstring (attribute)RequiredList Identifier
            • codeListAgencyIdentifierstring (attribute)RequiredList Agency Identifier
            • namestring (attribute)RequiredName
            • ValuestringRequiredUsage Code Value
          • ArticleUnitCodearrayRequiredArticle Unit Code
            • usageCodestring (attribute)RequiredUsage Code
            • codeListIdentifierstring (attribute)RequiredList Identifier
            • codeListAgencyIdentifierstring (attribute)RequiredList Agency Identifier
            • namestring (attribute)RequiredName
            • ValuestringRequiredUsage Code Value
          • ArticleNamestringRequiredArticle Name
          • ArticleStatusstringRequiredArticle Status
          • ArticleSerialNosobjectRequiredArticle Serial Nos
            • ArticleSerialNostringRequiredArticle serial number
          • ArticleBatchNostringRequiredArticle Batch No
          • ArticleUNnostringRequiredArticle UN no
          • ArticleVariantIdentifierstringRequiredArticle Variant Identifier
          • ArticleCountryOfOriginstringRequiredArticle Country Of Origin
          • ArticleWeightAndDimensionobjectRequiredArticle Weight And Dimension
            • DepthobjectRequiredDepth
              • unitCodestring (attribute)RequiredUnit Code
              • Valuenumber (float)RequiredMeasure value
            • HeightobjectRequiredHeight
              • unitCodestring (attribute)RequiredUnit Code
              • Valuenumber (float)RequiredMeasure value
            • NetWeightobjectRequiredNet Weight
              • unitCodestring (attribute)RequiredUnit Code
              • Valuenumber (float)RequiredMeasure value
            • WidthobjectRequiredWidth
              • unitCodestring (attribute)RequiredUnit Code
              • Valuenumber (float)RequiredMeasure value
            • GrossWeightobjectRequiredGross Weight
              • unitCodestring (attribute)RequiredUnit Code
              • Valuenumber (float)RequiredMeasure value
          • FreeTextarrayRequiredFree Text
            • usageCodestring (attribute)RequiredUsage Code
            • codeListIdentifierstring (attribute)RequiredCode List Identifier
            • codeListAgencyIdentifierstring (attribute)RequiredCode List Agency Identifier
            • namestring (attribute)RequiredName
            • LanguageCodeobjectRequiredLanguage Code
              • codeListIdentifierstring (attribute)RequiredCode List Identifier
              • codeListAgencyIdentifierstring (attribute)RequiredCode List Agency Identifier
              • namestring (attribute)RequiredName
              • ValuestringRequiredCode Value
            • TextarrayRequiredFree Text Type Text
              • sequencestring (attribute)RequiredSequence
              • codestring (attribute)RequiredCode
              • ValuestringRequiredFree Text Value
          • ReferencearrayRequiredReference
            • referenceTypestring (attribute)RequiredReference type
            • codeListIdentifierstring (attribute)RequiredList Identifier
            • codeListAgencyIdentifierstring (attribute)RequiredList Agency Identifier
            • namestring (attribute)RequiredName
            • ReferenceNostringRequiredReference number
            • TextstringRequiredReference Text
            • ReferenceDatearrayRequiredReference Date
              • subClassstring (attribute)RequiredTime zone.

                • Possible values:
                  DocumentDate
                  MessageDate
                  TransportOrderDate
                  OrderDate
                  OrderDeliveryDate
                  OrderDeliveryDateRequested
                  OrderDeliveryDateActual
                  OrderDeliveryDateEstimated
                  DepartureDate
                  DepartureDateRequested
                  DepartureDateActual
                  DepartureDateEstimated
                  DeliveryDate
                  DeliveryDateRequested
                  DeliveryDateActual
                  DeliveryDateEstimated
                  ArrivalDate
                  ArrivalDateActual
                  ArrivalDateEstimated
                  LoadingDate
                  PickupDate
                  PickupDateActual
                  PickupDateEarliest
                  PickupDateLatest
                  DeliveryDateEarliest
                  DeliveryDateLatest
                  DeadLine
                  UpdatedDate
                  ExpirationDate
                  ReceivedDate
                  ReceivedDateRequested
                  ReceivedDateEstimated
                  FinishedDate
                  ProductionDate
                  FreezeDate
                  EffectiveDate
              • timeZonestring (attribute)RequiredSub Class
              • dstIndicatorstring (attribute)RequiredDestination Indicator
              • DatestringRequiredDate
              • TimestringRequiredTime
          • ArticleTotalsobjectRequiredArticle Totals
            • NumberOfPackagesobjectRequiredNumber of packages
              • unitCodestring (attribute)RequiredUnit code
              • Valuenumber (int)RequiredQuantity value
            • GrossWeightobjectRequiredGross Weight
              • unitCodestring (attribute)RequiredUnit code
              • Valuenumber (float)RequiredQuantity value
            • GrossVolumeobjectRequiredGross Weight
              • unitCodestring (attribute)RequiredUnit code
              • Valuenumber (float)RequiredQuantity value
            • LoadingMetresobjectRequiredLoading Metres
              • unitCodestring (attribute)RequiredUnit code
              • Valuenumber (float)RequiredQuantity value
            • PalletFootPrintsobjectRequiredPalette Foot Prints
              • unitCodestring (attribute)RequiredUnit code
              • Valuenumber (float)RequiredQuantity value
            • MeasuresarrayRequiredMeasures
              • subClassstring (attribute)RequiredSub class
              • MeasureEntityarrayRequiredMeasure Entity
                • attributeCodestring (attribute)RequiredAttribute code
              • MeasureobjectRequiredMeasure
                • unitCodestring (attribute)RequiredUnit code
                • Valuenumber (float)RequiredMeasure value
          • ArticleBatchesobjectRequiredArticle Batches
            • ArticleBatcharrayRequiredArticle Batch
              • BatchNostringRequiredBatch No
              • WarehouseIdstringRequiredWarehouse Id
              • WarehouseAreastringRequiredWarehouse Area
              • WarehouseLocationstringRequiredWarehouse Location
              • ParcelNumberstringRequiredParcel Number
              • DateAndTimesarrayRequiredDate and Times
                • subClassstring (attribute)RequiredTime zone.

                  • Possible values:
                    DocumentDate
                    MessageDate
                    TransportOrderDate
                    OrderDate
                    OrderDeliveryDate
                    OrderDeliveryDateRequested
                    OrderDeliveryDateActual
                    OrderDeliveryDateEstimated
                    DepartureDate
                    DepartureDateRequested
                    DepartureDateActual
                    DepartureDateEstimated
                    DeliveryDate
                    DeliveryDateRequested
                    DeliveryDateActual
                    DeliveryDateEstimated
                    ArrivalDate
                    ArrivalDateActual
                    ArrivalDateEstimated
                    LoadingDate
                    PickupDate
                    PickupDateActual
                    PickupDateEarliest
                    PickupDateLatest
                    DeliveryDateEarliest
                    DeliveryDateLatest
                    DeadLine
                    UpdatedDate
                    ExpirationDate
                    ReceivedDate
                    ReceivedDateRequested
                    ReceivedDateEstimated
                    FinishedDate
                    ProductionDate
                    FreezeDate
                    EffectiveDate
                • timeZonestring (attribute)RequiredSub Class
                • dstIndicatorstring (attribute)RequiredDestination Indicator
                • DatestringRequiredDate
                • TimestringRequiredTime
              • DeliveredQuantityobjectRequiredDelivered Quantity
                • unitCodestring (attribute)RequiredUnit code
                • Valuenumber (float)RequiredMeasure value
              • ExpectedQuantityobjectRequiredExpected Quantity
                • unitCodestring (attribute)RequiredUnit code
                • Valuenumber (float)RequiredMeasure value
              • ReceivedQuantityobjectRequiredReceived Quantity
                • unitCodestring (attribute)RequiredUnit code
                • Valuenumber (float)RequiredMeasure value
              • PhysicalBalanceQuantityobjectRequiredPhysical Balance Quantity
                • unitCodestring (attribute)RequiredUnit code
                • Valuenumber (float)RequiredMeasure value
              • AllocatedBalanceQuantityobjectRequiredAllocated Balance Quantity
                • unitCodestring (attribute)RequiredUnit code
                • Valuenumber (float)RequiredMeasure value
              • NetWeightobjectRequiredNet Weight
                • unitCodestring (attribute)RequiredUnit code
                • Valuenumber (float)RequiredMeasure value
              • LockedstringRequiredLocked
              • ArticleSerialNosarrayRequiredArticle Serial Nos
                • ArticleSerialNostringRequiredArticle serial number
              • SSCCNostringRequiredSSCC No
              • BatchStatusstringRequiredBatch Status
          • ArticleGroupstringRequiredArticle Group

Responses

HTTP status code 200

Complete Post Item Data

XML SampleJSON Sample

List Error Codes

Responses

HTTP status code 400

Error in validation of request or error in data structure of request.

HTTP status code 417

Missing Authentication Headers

HTTP status code 500

Unknown error. Error sending data to destination.

Dynamic list of error codes used in the solution.

XML SampleJSON Sample

comments powered by Disqus