Order Management API
Introduction
Order management is an application that serves customers from different business areas to create, track and extract report on order (e.g. Purchase order, Sales order) level. As a customer of Bring, one gets complete overview of status on order level throughout the lifecycle of an order. This can certainly help in achieving better planning and control at customer’s end.
A typical usage pattern is that a customer creates order and lets all of its suppliers get the order and order details from Order Management. The suppliers will first check whether a customer is a Order Management customer before creating a packing list with transport information. All events and status changes will go back to the order owner.
This is a step-by-step guide on how to use the API.
Order Management has rest interfaces (XML/JSON). Choose the option that fits your needs best (see table below).
Please note that this API currently doesn’t support json on all of its methods yet. Look in the example section to see which are supported.
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.
Error handling
When using the Order Management, errors or service unavailability can occur, although we do our utmost to prevent any downtime. Thus it is important to use timeouts and other error handling techniques when making requests to the service.
How you handle errors depends on the nature of your application, but one strategy for handling such situations is by providing a failover if the shipping guide responds with an error or does not respond at all (timeout).
See the list of error codes for hints on how to implement error handling.
Overview of endpoints
Base URL
https://api.bring.com/po/api/v1
| Method | Endpoint | Usage |
|---|---|---|
| GET | /purchaseorderCustomer/{customerId} | Check if customer is valid for order management |
| POST | /omorder | Send an order |
| GET | /omorder/{customerId}/{orderId} | Provide order information |
| GET | /items/{customerId}/{orderId} | List order lines |
| GET | /packaginglist/{customerId}/{orderId} | Provide packaging list information for the order |
| POST | /packaginglist | Add packaging list |
| GET | /senderStatus/{customerId}/{orderId} | Get status for order (delivered/locked) |
| POST | /event | Create TMSEvents |
| GET | /errorCodes | List error codes |
Check if customer is valid for order management
Check if a given customer number is allowed to use Order management functionalities.
URL
GET
https://api.bring.com/po/api/v1/purchaseorderCustomer/{customerId}
Request parameters
| URI param | Type | Description |
|---|---|---|
customerId |
string |
Required |
Responses
HTTP status code 200
Returns true if given customer is a valid for order management.
Media type: application/json
{
"ResponseProperties": {
"SchemaVersion": 1,
"Locale": "en",
"DateAndTimes": {
"value": 1504473107935,
"subClass": "RESPONSE_DATE"
}
},
"IsPurchaseOrderCustomer": true
}
Media type: application/xml
<IsPurchaseorderCustomerResponse xmlns="http://api.bring.com/po">
<ResponseProperties>
<SchemaVersion>
1
</SchemaVersion>
<Locale>
en
</Locale>
<DateAndTimes subClass="ResponseDate">
2015-12-01T08:10:01.163+01:00
</DateAndTimes>
</ResponseProperties>
<IsPurchaseOrderCustomer>
true
</IsPurchaseOrderCustomer>
</IsPurchaseorderCustomerResponse>
Create an order
Customer create and send an order to Order Management. There are different types of order supported in Order Management.
- Order/PurchaseOrder
- Order Management can give your suppliers access to purchase orders so they can get info, confirm, accept and deliver on them.
- When Warehousing functionality Order Management sends it to Warhousing system for receiving notice.
URL
POST
https://api.bring.com/po/api/v1/omorder
Request parameters
| Query param | Type | Description |
|---|---|---|
ArticleId |
sequence |
Required
Article number or id. Example: 123-4000 |
ArticleId codeListAgencyIdentifier |
string |
Optional
Sets type of ArticleId. “CustomerItemNo” “VendorItemNo” “EAN” If not used ArticleId default is CustomerItemNo. Example: VendorItemNo |
ArticleName |
string |
Optional
Article name. Example: Spear parts |
ArticleQuantity |
float |
Required
Quantity ordered. Example: 2 |
ArticleQuantity unitCode |
string |
Required
Unit code for quantity ordered. Example: STK |
CreateOrderRequest messageFunction |
string |
Required
Type of order. “Order” “SalesOrder (Not in use)" “PurchaseOrder” Example: Order |
CreateOrderRequest messageId |
string |
Required
Unique id for this message. Example: 3dcc8b71-2bf7-4574-813d-9295bd5db8c0 |
CreateOrderRequest version |
string |
Required
Version of request, current 2.0. Example: 2 |
DateAndTimes subClass DeliveryDateRequested |
dateTime |
Required
The date on which order is requested delivered. Example: 22.01.2017 11:36:22 |
DateAndTimes subClass DocumentDate |
dateTime |
Required
The date on which order is booked. Example: 22.01.2017 11:36:22 |
Description |
string |
Optional
Article description. Example: Spear parts with all parts |
Description usageCode |
string |
Optional
Article description type. If description used set to AAA. Example: AAA |
MessageDate |
dateTime |
Required
The date on which message is sent. Example: 22.01.2017 11:36:22 |
MessageRecipient partyId |
string |
Required
Receiving Bring system. Constant value. Example: NO98466118506 |
MessageSender partyId |
string |
Required
Customer Number which Bring has provided. It cannot be demo customer number. Example: 10000000000 |
Order orderId |
dateTime |
Required
Ordernumber. Example: 101010 |
OrderItem articleLineId |
integer |
Required
Line id for this order line. Example: 10 |
OrderLineSet |
sequence |
Required Set of order items. |
OrderSet updateIndicator |
string |
Required
Type of order data. Original, Update or Deletion Example: Original |
Party/subClass DeliveryParty |
string |
Required Details of recipient. Must have Name, Street, City, CountryCode. |
Party/subClass OrderingParty |
string |
Required Details of sender. Must have Name, Street, City, CountryCode. |
Party/subClass PerformingUnit partyId |
string |
Optional
Warehouse id for order. Required if order to Warehousing system. Example: BERGER |
Party/subClass Supplier |
string |
Optional Details of supplier. Must have Name, Street, City, CountryCode if used. |
Reference |
sequence |
Optional Set of references. |
Reference ReferenceNo |
String |
Required
Reference. Example: 10003455TT |
Reference referenceType |
String |
Required
Type of reference coded. https://www.stylusstudio.com/edifact/D04A/1153.htm Example: CMR |
TransportLeg ModeOfTransport |
String |
Required
Type of transport. 1 = Sea 2 = Train 3 = Road 4 = Air. Example: 3 |
TransportLeg TransportLegType |
String |
Required
TransportLegType id. Default value 30. Example: 30 |
TransportService AdditionalService AdditionalServiceCode |
String |
Required
Transport services for shipment to customer. https://developer.bring.com/api/services/ Example: EVARSLING |
TransportService BasicServiceCode |
String |
Required
Transport service for shipment to customer. https://developer.bring.com/api/services/ Example: SERVICEPAKKE |
Request body
Media type: application/json
{
"version": "4.0",
"definedBy": "BIG",
"domain": "String",
"collaboration": "Order",
"messageFunction": "ArticleBalance",
"profile": "String",
"language": "String",
"messageId": "String",
"updateIndicator": "Deletion",
"testIndicator": "NO",
"MessageDetails": {
"MessageSender": {
"partyId": "String",
"idCodeList": "CNO",
"idType": "String",
"subPartyId": "String",
"subPartyIdType": "String"
},
"MessageRecipient": {
"partyId": "String",
"idCodeList": "CID",
"idType": "String",
"subPartyId": "String",
"subPartyIdType": "String"
},
"MessageDate": {
"dstIndicator": "YES",
"timeZone": "+00:00",
"value": 1504460506061
}
},
"SupplyStructure": {
"structureType": "Summary",
"OrderSet": {
"updateIndicator": "Other",
"Order": {
"orderId": "String",
"idType": "String",
"Reference": [
{
"referenceType": "String",
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"ReferenceNo": "String",
"Text": "String",
"ReferenceDate": {
"subClass": "DeliveryDate",
"timeZone": "String",
"dstIndicator": "String",
"Date": "1967-08-13",
"Time": "14:20:00.0Z"
}
},
{
"referenceType": "String",
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"ReferenceNo": "String",
"Text": "String",
"ReferenceDate": {
"subClass": "LoadingDate",
"timeZone": "String",
"dstIndicator": "String",
"Date": "1967-08-13",
"Time": "14:20:00.0Z"
}
}
],
"DateAndTimes": {
"subClass": "DeliveryDateActual",
"timeZone": "String",
"dstIndicator": "String",
"Date": "1967-08-13",
"Time": "14:20:00.0Z"
},
"TermsOfDelivery": [
{
"TODConditionCode": {
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"value": "String"
},
"TODConditionCodeList": {
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"value": "String"
},
"TODLocation": "String"
},
{
"TODConditionCode": {
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"value": "String"
},
"TODConditionCodeList": {
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"value": "String"
},
"TODLocation": "String"
}
],
"POResponse": {
"ResponseTypeCoded": "RejectWithExceptionDetailOnly",
"ResponseTypeCodedOther": "String"
},
"FreeText": [
{
"usageCode": "String",
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"Text": [
{
"sequence": "String",
"code": "String",
"value": "String"
},
{
"sequence": "String",
"code": "String",
"value": "String"
}
],
"LanguageCode": {
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"value": "String"
}
},
{
"usageCode": "String",
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"Text": [
{
"sequence": "String",
"code": "String",
"value": "String"
},
{
"sequence": "String",
"code": "String",
"value": "String"
}
],
"LanguageCode": {
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"value": "String"
}
}
]
},
"TransportService": {
"BasicServiceCode": {
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"value": "String"
},
"AdditionalService": [
{
"AdditionalServiceCode": {
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"value": "String"
},
"ServiceRequirements": [
{
"usageCode": "String",
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"value": "String"
},
{
"usageCode": "String",
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"value": "String"
}
],
"ServiceContact": [
{
"comType": "CellPhone",
"channel": "String",
"value": "String"
},
{
"comType": "CellPhone",
"channel": "String",
"value": "String"
}
]
},
{
"AdditionalServiceCode": {
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"value": "String"
},
"ServiceRequirements": [
{
"usageCode": "String",
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"value": "String"
},
{
"usageCode": "String",
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"value": "String"
}
],
"ServiceContact": [
{
"comType": "Mail",
"channel": "String",
"value": "String"
},
{
"comType": "Email",
"channel": "String",
"value": "String"
}
]
}
],
"TariffReference": {
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"value": "String"
},
"NatureOfCargo": {
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"value": "String"
},
"Priority": {
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"value": "String"
},
"Utility": [
{
"usageCode": "String",
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"Value": [
{
"sequence": "String",
"valueType": "String",
"valueCode": "text",
"value": "String"
},
{
"sequence": "String",
"valueType": "String",
"valueCode": "text",
"value": "String"
}
]
},
{
"usageCode": "String",
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"Value": [
{
"sequence": "String",
"valueType": "String",
"valueCode": "text",
"value": "String"
},
{
"sequence": "String",
"valueType": "String",
"valueCode": "text",
"value": "String"
}
]
}
]
},
"TransportLeg": {
"TransportLegType": {
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"value": "String"
},
"TransportLegId": "String",
"ModeOfTransport": {
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"value": "String"
},
"MeansOfTransport": {
"MeansOfTransportId": "String",
"CountryCode": {
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"value": "String"
},
"Name": "String",
"MeansOfTransportType": {
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"value": "String"
}
},
"Location": [
{
"subClass": "UltimateEndLocation",
"locationId": "String",
"idType": "String",
"LocationType": {
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"value": "String"
},
"LocationName": "String",
"CountryCode": {
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"value": "String"
}
},
{
"subClass": "CustomsDepartment",
"locationId": "String",
"idType": "String",
"LocationType": {
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"value": "String"
},
"LocationName": "String",
"CountryCode": {
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"value": "String"
}
}
]
},
"Party": [
{
"subClass": "MessageCopyRecipient",
"partyId": "String",
"idCodeList": "AMP",
"idType": "String",
"subPartyId": "String",
"subPartyIdType": "String",
"Name": "String",
"VATNo": "String",
"CustomsCreditNo": "String",
"AccountNo": "String",
"BankName": "String",
"SwiftCode": "String",
"Address": [
{
"subClass": "PostalAddress",
"PostalCode": "String",
"City": "String",
"ZIPCode": "String",
"StateOrRegion": "String",
"CountryCode": {
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"value": "String"
},
"Street": "String",
"StreetNo": "String",
"AddressLine": [
"String",
"String"
],
"POBox": "String",
"PostOffice": "String"
},
{
"subClass": "PhysicalAddress",
"PostalCode": "String",
"City": "String",
"ZIPCode": "String",
"StateOrRegion": "String",
"CountryCode": {
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"value": "String"
},
"Street": "String",
"StreetNo": "String",
"AddressLine": [
"String",
"String"
],
"POBox": "String",
"PostOffice": "String"
}
],
"Contact": [
{
"PhoneNo": "String",
"CellPhoneNo": "String",
"TelefaxNo": "String",
"EMailAddress": "String",
"WebAddress": "String",
"ContactName": "String",
"ContactFunction": "String"
},
{
"PhoneNo": "String",
"CellPhoneNo": "String",
"TelefaxNo": "String",
"EMailAddress": "String",
"WebAddress": "String",
"ContactName": "String",
"ContactFunction": "String"
}
],
"Reference": [
{
"referenceType": "String",
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"ReferenceNo": "String",
"Text": "String",
"ReferenceDate": {
"subClass": "MessageDate",
"timeZone": "String",
"dstIndicator": "String",
"Date": "1967-08-13",
"Time": "14:20:00.0Z"
}
},
{
"referenceType": "String",
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"ReferenceNo": "String",
"Text": "String",
"ReferenceDate": {
"subClass": "DepartureDateRequested",
"timeZone": "String",
"dstIndicator": "String",
"Date": "1967-08-13",
"Time": "14:20:00.0Z"
}
}
],
"FreeText": [
{
"usageCode": "String",
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"Text": [
{
"sequence": "String",
"code": "String",
"value": "String"
},
{
"sequence": "String",
"code": "String",
"value": "String"
}
],
"LanguageCode": {
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"value": "String"
}
},
{
"usageCode": "String",
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"Text": [
{
"sequence": "String",
"code": "String",
"value": "String"
},
{
"sequence": "String",
"code": "String",
"value": "String"
}
],
"LanguageCode": {
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"value": "String"
}
}
]
},
{
"subClass": "OrderingParty",
"partyId": "String",
"idCodeList": "FNR",
"idType": "String",
"subPartyId": "String",
"subPartyIdType": "String",
"Name": "String",
"VATNo": "String",
"CustomsCreditNo": "String",
"AccountNo": "String",
"BankName": "String",
"SwiftCode": "String",
"Address": [
{
"subClass": "PostalAddress",
"PostalCode": "String",
"City": "String",
"ZIPCode": "String",
"StateOrRegion": "String",
"CountryCode": {
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"value": "String"
},
"Street": "String",
"StreetNo": "String",
"AddressLine": [
"String",
"String"
],
"POBox": "String",
"PostOffice": "String"
},
{
"subClass": "PostalAddress",
"PostalCode": "String",
"City": "String",
"ZIPCode": "String",
"StateOrRegion": "String",
"CountryCode": {
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"value": "String"
},
"Street": "String",
"StreetNo": "String",
"AddressLine": [
"String",
"String"
],
"POBox": "String",
"PostOffice": "String"
}
],
"Contact": [
{
"PhoneNo": "String",
"CellPhoneNo": "String",
"TelefaxNo": "String",
"EMailAddress": "String",
"WebAddress": "String",
"ContactName": "String",
"ContactFunction": "String"
},
{
"PhoneNo": "String",
"CellPhoneNo": "String",
"TelefaxNo": "String",
"EMailAddress": "String",
"WebAddress": "String",
"ContactName": "String",
"ContactFunction": "String"
}
],
"Reference": [
{
"referenceType": "String",
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"ReferenceNo": "String",
"Text": "String",
"ReferenceDate": {
"subClass": "DeliveryDateLatest",
"timeZone": "String",
"dstIndicator": "String",
"Date": "1967-08-13",
"Time": "14:20:00.0Z"
}
},
{
"referenceType": "String",
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"ReferenceNo": "String",
"Text": "String",
"ReferenceDate": {
"subClass": "ProductionDate",
"timeZone": "String",
"dstIndicator": "String",
"Date": "1967-08-13",
"Time": "14:20:00.0Z"
}
}
],
"FreeText": [
{
"usageCode": "String",
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"Text": [
{
"sequence": "String",
"code": "String",
"value": "String"
},
{
"sequence": "String",
"code": "String",
"value": "String"
}
],
"LanguageCode": {
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"value": "String"
}
},
{
"usageCode": "String",
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"Text": [
{
"sequence": "String",
"code": "String",
"value": "String"
},
{
"sequence": "String",
"code": "String",
"value": "String"
}
],
"LanguageCode": {
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"value": "String"
}
}
]
}
],
"OrderLineSet": [
{
"articleLineId": "String",
"idType": "String",
"ArticleId": [
{
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"value": "String"
},
{
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"value": "String"
}
],
"ArticleQuantity": {
"unitCode": "String",
"value": 32.50
},
"ArticleBalanceQuantity": {
"unitCode": "String",
"value": 32.50
},
"ArticleWorkQuantity": {
"unitCode": "String",
"value": 32.50
},
"ArticleVariance": [
{
"varianceCode": "String",
"value": "String"
},
{
"varianceCode": "String",
"value": "String"
}
],
"ArticleOwner": [
"String",
"String"
],
"PackageTypeCode": [
{
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"value": "String"
},
{
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"value": "String"
}
],
"ArticleReference": [
{
"referenceType": "String",
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"ReferenceNo": "String",
"Text": "String",
"ReferenceDate": {
"subClass": "DepartureDateRequested",
"timeZone": "String",
"dstIndicator": "String",
"Date": "1967-08-13",
"Time": "14:20:00.0Z"
}
},
{
"referenceType": "String",
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"ReferenceNo": "String",
"Text": "String",
"ReferenceDate": {
"subClass": "ProductionDate",
"timeZone": "String",
"dstIndicator": "String",
"Date": "1967-08-13",
"Time": "14:20:00.0Z"
}
}
],
"Description": [
{
"usageCode": "String",
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"Text": [
{
"sequence": "String",
"code": "String",
"value": "String"
},
{
"sequence": "String",
"code": "String",
"value": "String"
}
],
"LanguageCode": {
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"value": "String"
}
},
{
"usageCode": "String",
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"Text": [
{
"sequence": "String",
"code": "String",
"value": "String"
},
{
"sequence": "String",
"code": "String",
"value": "String"
}
],
"LanguageCode": {
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"value": "String"
}
}
],
"DateAndTimes": [
{
"subClass": "ReceivedDateEstimated",
"timeZone": "String",
"dstIndicator": "String",
"Date": "1967-08-13",
"Time": "14:20:00.0Z"
},
{
"subClass": "OrderDeliveryDateEstimated",
"timeZone": "String",
"dstIndicator": "String",
"Date": "1967-08-13",
"Time": "14:20:00.0Z"
}
],
"ArticleMonetaryAmounts": {
"UnitPrice": {
"currencyIdentificationCode": "String",
"value": 32.50
},
"ArticleTax": {
"TaxType": "String",
"ArticleTaxRate": {
"currencyIdentificationCode": "String",
"value": 32.50
},
"GrossAmount": {
"currencyIdentificationCode": "String",
"value": 32.50
},
"TaxAmount": {
"currencyIdentificationCode": "String",
"value": 32.50
}
},
"ReductionInformation": {
"ReductionRate": "String",
"ValidFrom": {
"subClass": "OrderDeliveryDate",
"timeZone": "String",
"dstIndicator": "String",
"Date": "1967-08-13",
"Time": "14:20:00.0Z"
},
"ValidUntil": {
"subClass": "OrderDeliveryDate",
"timeZone": "String",
"dstIndicator": "String",
"Date": "1967-08-13",
"Time": "14:20:00.0Z"
}
}
},
"ItemTotals": {
"NumberOfPackages": {
"unitCode": "String",
"value": 10
},
"GrossWeight": {
"unitCode": "String",
"value": 32.50
},
"GrossVolume": {
"unitCode": "String",
"value": 32.50
},
"LoadingMetres": {
"unitCode": "String",
"value": 32.50
},
"PalletFootPrints": {
"unitCode": "String",
"value": 32.50
},
"Measures": [
{
"subClass": "String",
"MeasureEntity": {
"attributeCode": "String"
},
"Measure": {
"unitCode": "String",
"value": 3.5
}
},
{
"subClass": "String",
"MeasureEntity": {
"attributeCode": "String"
},
"Measure": {
"unitCode": "String",
"value": 3.5
}
}
]
},
"Utility": [
{
"usageCode": "String",
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"Text": [
{
"sequence": "String",
"code": "String",
"value": "String"
},
{
"sequence": "String",
"code": "String",
"value": "String"
}
],
"LanguageCode": {
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"value": "String"
}
},
{
"usageCode": "String",
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"Text": [
{
"sequence": "String",
"code": "String",
"value": "String"
},
{
"sequence": "String",
"code": "String",
"value": "String"
}
],
"LanguageCode": {
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"value": "String"
}
}
],
"ItemResponse": {
"ResponseTypeCoded": "MeetingHeld",
"ResponseTypeCodedOther": "String"
},
"ArticleStatus": "String",
"ArticleSerialNo": "String",
"ArticleBatchNo": "String",
"FreeText": [
{
"usageCode": "String",
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"Text": [
{
"sequence": "String",
"code": "String",
"value": "String"
},
{
"sequence": "String",
"code": "String",
"value": "String"
}
],
"LanguageCode": {
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"value": "String"
}
},
{
"usageCode": "String",
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"Text": [
{
"sequence": "String",
"code": "String",
"value": "String"
},
{
"sequence": "String",
"code": "String",
"value": "String"
}
],
"LanguageCode": {
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"value": "String"
}
}
],
"ArticleName": "String"
},
{
"articleLineId": "String",
"idType": "String",
"ArticleId": [
{
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"value": "String"
},
{
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"value": "String"
}
],
"ArticleQuantity": {
"unitCode": "String",
"value": 32.50
},
"ArticleBalanceQuantity": {
"unitCode": "String",
"value": 32.50
},
"ArticleWorkQuantity": {
"unitCode": "String",
"value": 32.50
},
"ArticleVariance": [
{
"varianceCode": "String",
"value": "String"
},
{
"varianceCode": "String",
"value": "String"
}
],
"ArticleOwner": [
"String",
"String"
],
"PackageTypeCode": [
{
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"value": "String"
},
{
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"value": "String"
}
],
"ArticleReference": [
{
"referenceType": "String",
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"ReferenceNo": "String",
"Text": "String",
"ReferenceDate": {
"subClass": "OrderDeliveryDateEstimated",
"timeZone": "String",
"dstIndicator": "String",
"Date": "1967-08-13",
"Time": "14:20:00.0Z"
}
},
{
"referenceType": "String",
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"ReferenceNo": "String",
"Text": "String",
"ReferenceDate": {
"subClass": "ArrivalDateActual",
"timeZone": "String",
"dstIndicator": "String",
"Date": "1967-08-13",
"Time": "14:20:00.0Z"
}
}
],
"Description": [
{
"usageCode": "String",
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"Text": [
{
"sequence": "String",
"code": "String",
"value": "String"
},
{
"sequence": "String",
"code": "String",
"value": "String"
}
],
"LanguageCode": {
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"value": "String"
}
},
{
"usageCode": "String",
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"Text": [
{
"sequence": "String",
"code": "String",
"value": "String"
},
{
"sequence": "String",
"code": "String",
"value": "String"
}
],
"LanguageCode": {
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"value": "String"
}
}
],
"DateAndTimes": [
{
"subClass": "LoadingDate",
"timeZone": "String",
"dstIndicator": "String",
"Date": "1967-08-13",
"Time": "14:20:00.0Z"
},
{
"subClass": "ProductionDate",
"timeZone": "String",
"dstIndicator": "String",
"Date": "1967-08-13",
"Time": "14:20:00.0Z"
}
],
"ArticleMonetaryAmounts": {
"UnitPrice": {
"currencyIdentificationCode": "String",
"value": 32.50
},
"ArticleTax": {
"TaxType": "String",
"ArticleTaxRate": {
"currencyIdentificationCode": "String",
"value": 32.50
},
"GrossAmount": {
"currencyIdentificationCode": "String",
"value": 32.50
},
"TaxAmount": {
"currencyIdentificationCode": "String",
"value": 32.50
}
},
"ReductionInformation": {
"ReductionRate": "String",
"ValidFrom": {
"subClass": "ArrivalDate",
"timeZone": "String",
"dstIndicator": "String",
"Date": "1967-08-13",
"Time": "14:20:00.0Z"
},
"ValidUntil": {
"subClass": "DeliveryDate",
"timeZone": "String",
"dstIndicator": "String",
"Date": "1967-08-13",
"Time": "14:20:00.0Z"
}
}
},
"ItemTotals": {
"NumberOfPackages": {
"unitCode": "String",
"value": 10
},
"GrossWeight": {
"unitCode": "String",
"value": 32.50
},
"GrossVolume": {
"unitCode": "String",
"value": 32.50
},
"LoadingMetres": {
"unitCode": "String",
"value": 32.50
},
"PalletFootPrints": {
"unitCode": "String",
"value": 32.50
},
"Measures": [
{
"subClass": "String",
"MeasureEntity": {
"attributeCode": "String"
},
"Measure": {
"unitCode": "String",
"value": 3.5
}
},
{
"subClass": "String",
"MeasureEntity": {
"attributeCode": "String"
},
"Measure": {
"unitCode": "String",
"value": 3.5
}
}
]
},
"Utility": [
{
"usageCode": "String",
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"Text": [
{
"sequence": "String",
"code": "String",
"value": "String"
},
{
"sequence": "String",
"code": "String",
"value": "String"
}
],
"LanguageCode": {
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"value": "String"
}
},
{
"usageCode": "String",
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"Text": [
{
"sequence": "String",
"code": "String",
"value": "String"
},
{
"sequence": "String",
"code": "String",
"value": "String"
}
],
"LanguageCode": {
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"value": "String"
}
}
],
"ItemResponse": {
"ResponseTypeCoded": "ApprovedAsSubmitted",
"ResponseTypeCodedOther": "String"
},
"ArticleStatus": "String",
"ArticleSerialNo": "String",
"ArticleBatchNo": "String",
"FreeText": [
{
"usageCode": "String",
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"Text": [
{
"sequence": "String",
"code": "String",
"value": "String"
},
{
"sequence": "String",
"code": "String",
"value": "String"
}
],
"LanguageCode": {
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"value": "String"
}
},
{
"usageCode": "String",
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"Text": [
{
"sequence": "String",
"code": "String",
"value": "String"
},
{
"sequence": "String",
"code": "String",
"value": "String"
}
],
"LanguageCode": {
"codeListIdentifier": "String",
"codeListAgencyIdentifier": "String",
"name": "String",
"value": "String"
}
}
],
"ArticleName": "String"
}
],
"DateAndTimes": [
{
"subClass": "ExpirationDate",
"timeZone": "String",
"dstIndicator": "String",
"Date": "1967-08-13",
"Time": "14:20:00.0Z"
},
{
"subClass": "DepartureDateRequested",
"timeZone": "String",
"dstIndicator": "String",
"Date": "1967-08-13",
"Time": "14:20:00.0Z"
}
]
}
}
}
Media type: application/xml
<CreateOrderRequest version="4.0" definedBy="BIG" domain="String" collaboration="Order" messageFunction="ArticleBalance" profile="String" language="String" messageId="String" updateIndicator="Deletion" testIndicator="NO">
<MessageDetails>
<MessageSender partyId="String" idCodeList="CNO" idType="String" subPartyId="String" subPartyIdType="String"/>
<MessageRecipient partyId="String" idCodeList="CID" idType="String" subPartyId="String" subPartyIdType="String"/>
<MessageDate dstIndicator="YES" timeZone="+00:00">2001-12-17T09:30:47Z</MessageDate>
</MessageDetails>
<SupplyStructure structureType="Summary">
<OrderSet updateIndicator="Other">
<Order orderId="String" idType="String">
<Reference referenceType="String" codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">
<ReferenceNo>String</ReferenceNo>
<Text>String</Text>
<ReferenceDate subClass="DeliveryDate" timeZone="String" dstIndicator="String">
<Date>1967-08-13</Date>
<Time>14:20:00.0Z</Time>
</ReferenceDate>
</Reference>
<Reference referenceType="String" codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">
<ReferenceNo>String</ReferenceNo>
<Text>String</Text>
<ReferenceDate subClass="LoadingDate" timeZone="String" dstIndicator="String">
<Date>1967-08-13</Date>
<Time>14:20:00.0Z</Time>
</ReferenceDate>
</Reference>
<DateAndTimes subClass="DeliveryDateActual" timeZone="String" dstIndicator="String">
<Date>1967-08-13</Date>
<Time>14:20:00.0Z</Time>
</DateAndTimes>
<TermsOfDelivery>
<TODConditionCode codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">String</TODConditionCode>
<TODConditionCodeList codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">String</TODConditionCodeList>
<TODLocation>String</TODLocation>
</TermsOfDelivery>
<TermsOfDelivery>
<TODConditionCode codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">String</TODConditionCode>
<TODConditionCodeList codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">String</TODConditionCodeList>
<TODLocation>String</TODLocation>
</TermsOfDelivery>
<POResponse>
<ResponseTypeCoded>RejectWithExceptionDetailOnly</ResponseTypeCoded>
<ResponseTypeCodedOther>String</ResponseTypeCodedOther>
</POResponse>
<FreeText usageCode="String" codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">
<Text sequence="String" code="String">String</Text>
<Text sequence="String" code="String">String</Text>
<LanguageCode codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">String</LanguageCode>
</FreeText>
<FreeText usageCode="String" codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">
<Text sequence="String" code="String">String</Text>
<Text sequence="String" code="String">String</Text>
<LanguageCode codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">String</LanguageCode>
</FreeText>
</Order>
<TransportService>
<BasicServiceCode codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">String</BasicServiceCode>
<AdditionalService>
<AdditionalServiceCode codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">String</AdditionalServiceCode>
<ServiceRequirements usageCode="String" codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">String</ServiceRequirements>
<ServiceRequirements usageCode="String" codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">String</ServiceRequirements>
<ServiceContact comType="CellPhone" channel="String">String</ServiceContact>
<ServiceContact comType="CellPhone" channel="String">String</ServiceContact>
</AdditionalService>
<AdditionalService>
<AdditionalServiceCode codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">String</AdditionalServiceCode>
<ServiceRequirements usageCode="String" codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">String</ServiceRequirements>
<ServiceRequirements usageCode="String" codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">String</ServiceRequirements>
<ServiceContact comType="Mail" channel="String">String</ServiceContact>
<ServiceContact comType="Email" channel="String">String</ServiceContact>
</AdditionalService>
<TariffReference codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">String</TariffReference>
<NatureOfCargo codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">String</NatureOfCargo>
<Priority codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">String</Priority>
<Utility usageCode="String" codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">
<Value sequence="String" valueType="String" valueCode="text">String</Value>
<Value sequence="String" valueType="String" valueCode="text">String</Value>
</Utility>
<Utility usageCode="String" codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">
<Value sequence="String" valueType="String" valueCode="text">String</Value>
<Value sequence="String" valueType="String" valueCode="text">String</Value>
</Utility>
</TransportService>
<TransportLeg>
<TransportLegType codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">String</TransportLegType>
<TransportLegId>String</TransportLegId>
<ModeOfTransport codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">String</ModeOfTransport>
<MeansOfTransport>
<MeansOfTransportId>String</MeansOfTransportId>
<CountryCode codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">String</CountryCode>
<Name>String</Name>
<MeansOfTransportType codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">String</MeansOfTransportType>
</MeansOfTransport>
<Location subClass="UltimateEndLocation" locationId="String" idType="String">
<LocationType codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">String</LocationType>
<LocationName>String</LocationName>
<CountryCode codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">String</CountryCode>
</Location>
<Location subClass="CustomsDepartment" locationId="String" idType="String">
<LocationType codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">String</LocationType>
<LocationName>String</LocationName>
<CountryCode codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">String</CountryCode>
</Location>
</TransportLeg>
<Party subClass="MessageCopyRecipient" partyId="String" idCodeList="AMP" idType="String" subPartyId="String" subPartyIdType="String">
<Name>String</Name>
<VATNo>String</VATNo>
<CustomsCreditNo>String</CustomsCreditNo>
<AccountNo>String</AccountNo>
<BankName>String</BankName>
<SwiftCode>String</SwiftCode>
<Address subClass="PostalAddress">
<PostalCode>String</PostalCode>
<City>String</City>
<ZIPCode>String</ZIPCode>
<StateOrRegion>String</StateOrRegion>
<CountryCode codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">String</CountryCode>
<Street>String</Street>
<StreetNo>String</StreetNo>
<AddressLine>String</AddressLine>
<AddressLine>String</AddressLine>
<POBox>String</POBox>
<PostOffice>String</PostOffice>
</Address>
<Address subClass="PhysicalAddress">
<PostalCode>String</PostalCode>
<City>String</City>
<ZIPCode>String</ZIPCode>
<StateOrRegion>String</StateOrRegion>
<CountryCode codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">String</CountryCode>
<Street>String</Street>
<StreetNo>String</StreetNo>
<AddressLine>String</AddressLine>
<AddressLine>String</AddressLine>
<POBox>String</POBox>
<PostOffice>String</PostOffice>
</Address>
<Contact>
<PhoneNo>String</PhoneNo>
<CellPhoneNo>String</CellPhoneNo>
<TelefaxNo>String</TelefaxNo>
<EMailAddress>String</EMailAddress>
<WebAddress>String</WebAddress>
<ContactName>String</ContactName>
<ContactFunction>String</ContactFunction>
</Contact>
<Contact>
<PhoneNo>String</PhoneNo>
<CellPhoneNo>String</CellPhoneNo>
<TelefaxNo>String</TelefaxNo>
<EMailAddress>String</EMailAddress>
<WebAddress>String</WebAddress>
<ContactName>String</ContactName>
<ContactFunction>String</ContactFunction>
</Contact>
<Reference referenceType="String" codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">
<ReferenceNo>String</ReferenceNo>
<Text>String</Text>
<ReferenceDate subClass="MessageDate" timeZone="String" dstIndicator="String">
<Date>1967-08-13</Date>
<Time>14:20:00.0Z</Time>
</ReferenceDate>
</Reference>
<Reference referenceType="String" codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">
<ReferenceNo>String</ReferenceNo>
<Text>String</Text>
<ReferenceDate subClass="DepartureDateRequested" timeZone="String" dstIndicator="String">
<Date>1967-08-13</Date>
<Time>14:20:00.0Z</Time>
</ReferenceDate>
</Reference>
<FreeText usageCode="String" codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">
<Text sequence="String" code="String">String</Text>
<Text sequence="String" code="String">String</Text>
<LanguageCode codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">String</LanguageCode>
</FreeText>
<FreeText usageCode="String" codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">
<Text sequence="String" code="String">String</Text>
<Text sequence="String" code="String">String</Text>
<LanguageCode codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">String</LanguageCode>
</FreeText>
</Party>
<Party subClass="OrderingParty" partyId="String" idCodeList="FNR" idType="String" subPartyId="String" subPartyIdType="String">
<Name>String</Name>
<VATNo>String</VATNo>
<CustomsCreditNo>String</CustomsCreditNo>
<AccountNo>String</AccountNo>
<BankName>String</BankName>
<SwiftCode>String</SwiftCode>
<Address subClass="PostalAddress">
<PostalCode>String</PostalCode>
<City>String</City>
<ZIPCode>String</ZIPCode>
<StateOrRegion>String</StateOrRegion>
<CountryCode codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">String</CountryCode>
<Street>String</Street>
<StreetNo>String</StreetNo>
<AddressLine>String</AddressLine>
<AddressLine>String</AddressLine>
<POBox>String</POBox>
<PostOffice>String</PostOffice>
</Address>
<Address subClass="PostalAddress">
<PostalCode>String</PostalCode>
<City>String</City>
<ZIPCode>String</ZIPCode>
<StateOrRegion>String</StateOrRegion>
<CountryCode codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">String</CountryCode>
<Street>String</Street>
<StreetNo>String</StreetNo>
<AddressLine>String</AddressLine>
<AddressLine>String</AddressLine>
<POBox>String</POBox>
<PostOffice>String</PostOffice>
</Address>
<Contact>
<PhoneNo>String</PhoneNo>
<CellPhoneNo>String</CellPhoneNo>
<TelefaxNo>String</TelefaxNo>
<EMailAddress>String</EMailAddress>
<WebAddress>String</WebAddress>
<ContactName>String</ContactName>
<ContactFunction>String</ContactFunction>
</Contact>
<Contact>
<PhoneNo>String</PhoneNo>
<CellPhoneNo>String</CellPhoneNo>
<TelefaxNo>String</TelefaxNo>
<EMailAddress>String</EMailAddress>
<WebAddress>String</WebAddress>
<ContactName>String</ContactName>
<ContactFunction>String</ContactFunction>
</Contact>
<Reference referenceType="String" codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">
<ReferenceNo>String</ReferenceNo>
<Text>String</Text>
<ReferenceDate subClass="DeliveryDateLatest" timeZone="String" dstIndicator="String">
<Date>1967-08-13</Date>
<Time>14:20:00.0Z</Time>
</ReferenceDate>
</Reference>
<Reference referenceType="String" codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">
<ReferenceNo>String</ReferenceNo>
<Text>String</Text>
<ReferenceDate subClass="ProductionDate" timeZone="String" dstIndicator="String">
<Date>1967-08-13</Date>
<Time>14:20:00.0Z</Time>
</ReferenceDate>
</Reference>
<FreeText usageCode="String" codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">
<Text sequence="String" code="String">String</Text>
<Text sequence="String" code="String">String</Text>
<LanguageCode codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">String</LanguageCode>
</FreeText>
<FreeText usageCode="String" codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">
<Text sequence="String" code="String">String</Text>
<Text sequence="String" code="String">String</Text>
<LanguageCode codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">String</LanguageCode>
</FreeText>
</Party>
<OrderLineSet>
<OrderItem articleLineId="String" idType="String">
<ArticleId codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">String</ArticleId>
<ArticleId codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">String</ArticleId>
<ArticleQuantity unitCode="String">3.14159E0</ArticleQuantity>
<ArticleBalanceQuantity unitCode="String">3.14159E0</ArticleBalanceQuantity>
<ArticleWorkQuantity unitCode="String">3.14159E0</ArticleWorkQuantity>
<ArticleVariance varianceCode="String">String</ArticleVariance>
<ArticleVariance varianceCode="String">String</ArticleVariance>
<ArticleOwner>String</ArticleOwner>
<ArticleOwner>String</ArticleOwner>
<PackageTypeCode codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">String</PackageTypeCode>
<PackageTypeCode codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">String</PackageTypeCode>
<ArticleReference referenceType="String" codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">
<ReferenceNo>String</ReferenceNo>
<Text>String</Text>
<ReferenceDate subClass="DepartureDateRequested" timeZone="String" dstIndicator="String">
<Date>1967-08-13</Date>
<Time>14:20:00.0Z</Time>
</ReferenceDate>
</ArticleReference>
<ArticleReference referenceType="String" codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">
<ReferenceNo>String</ReferenceNo>
<Text>String</Text>
<ReferenceDate subClass="ProductionDate" timeZone="String" dstIndicator="String">
<Date>1967-08-13</Date>
<Time>14:20:00.0Z</Time>
</ReferenceDate>
</ArticleReference>
<Description usageCode="String" codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">
<Text sequence="String" code="String">String</Text>
<Text sequence="String" code="String">String</Text>
<LanguageCode codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">String</LanguageCode>
</Description>
<Description usageCode="String" codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">
<Text sequence="String" code="String">String</Text>
<Text sequence="String" code="String">String</Text>
<LanguageCode codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">String</LanguageCode>
</Description>
<DateAndTimes subClass="ReceivedDateEstimated" timeZone="String" dstIndicator="String">
<Date>1967-08-13</Date>
<Time>14:20:00.0Z</Time>
</DateAndTimes>
<DateAndTimes subClass="OrderDeliveryDateEstimated" timeZone="String" dstIndicator="String">
<Date>1967-08-13</Date>
<Time>14:20:00.0Z</Time>
</DateAndTimes>
<ArticleMonetaryAmounts>
<UnitPrice currencyIdentificationCode="String">3.14159E0</UnitPrice>
<ArticleTax>
<TaxType>String</TaxType>
<ArticleTaxRate currencyIdentificationCode="String">3.14159E0</ArticleTaxRate>
<GrossAmount currencyIdentificationCode="String">3.14159E0</GrossAmount>
<TaxAmount currencyIdentificationCode="String">3.14159E0</TaxAmount>
</ArticleTax>
<ReductionInformation>
<ReductionRate>String</ReductionRate>
<ValidFrom subClass="OrderDeliveryDate" timeZone="String" dstIndicator="String">
<Date>1967-08-13</Date>
<Time>14:20:00.0Z</Time>
</ValidFrom>
<ValidUntil subClass="OrderDeliveryDate" timeZone="String" dstIndicator="String">
<Date>1967-08-13</Date>
<Time>14:20:00.0Z</Time>
</ValidUntil>
</ReductionInformation>
</ArticleMonetaryAmounts>
<ItemTotals>
<NumberOfPackages unitCode="String">0</NumberOfPackages>
<GrossWeight unitCode="String">3.14159E0</GrossWeight>
<GrossVolume unitCode="String">3.14159E0</GrossVolume>
<LoadingMetres unitCode="String">3.14159E0</LoadingMetres>
<PalletFootPrints unitCode="String">3.14159E0</PalletFootPrints>
<Measures subClass="String">
<MeasureEntity attributeCode="String"/>
<Measure unitCode="String">0</Measure>
</Measures>
<Measures subClass="String">
<MeasureEntity attributeCode="String"/>
<Measure unitCode="String">0</Measure>
</Measures>
</ItemTotals>
<Utility usageCode="String" codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">
<Text sequence="String" code="String">String</Text>
<Text sequence="String" code="String">String</Text>
<LanguageCode codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">String</LanguageCode>
</Utility>
<Utility usageCode="String" codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">
<Text sequence="String" code="String">String</Text>
<Text sequence="String" code="String">String</Text>
<LanguageCode codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">String</LanguageCode>
</Utility>
<ItemResponse>
<ResponseTypeCoded>MeetingHeld</ResponseTypeCoded>
<ResponseTypeCodedOther>String</ResponseTypeCodedOther>
</ItemResponse>
<ArticleStatus>String</ArticleStatus>
<ArticleSerialNo>String</ArticleSerialNo>
<ArticleBatchNo>String</ArticleBatchNo>
<FreeText usageCode="String" codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">
<Text sequence="String" code="String">String</Text>
<Text sequence="String" code="String">String</Text>
<LanguageCode codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">String</LanguageCode>
</FreeText>
<FreeText usageCode="String" codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">
<Text sequence="String" code="String">String</Text>
<Text sequence="String" code="String">String</Text>
<LanguageCode codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">String</LanguageCode>
</FreeText>
<ArticleName>String</ArticleName>
</OrderItem>
<OrderItem articleLineId="String" idType="String">
<ArticleId codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">String</ArticleId>
<ArticleId codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">String</ArticleId>
<ArticleQuantity unitCode="String">3.14159E0</ArticleQuantity>
<ArticleBalanceQuantity unitCode="String">3.14159E0</ArticleBalanceQuantity>
<ArticleWorkQuantity unitCode="String">3.14159E0</ArticleWorkQuantity>
<ArticleVariance varianceCode="String">String</ArticleVariance>
<ArticleVariance varianceCode="String">String</ArticleVariance>
<ArticleOwner>String</ArticleOwner>
<ArticleOwner>String</ArticleOwner>
<PackageTypeCode codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">String</PackageTypeCode>
<PackageTypeCode codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">String</PackageTypeCode>
<ArticleReference referenceType="String" codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">
<ReferenceNo>String</ReferenceNo>
<Text>String</Text>
<ReferenceDate subClass="OrderDeliveryDateEstimated" timeZone="String" dstIndicator="String">
<Date>1967-08-13</Date>
<Time>14:20:00.0Z</Time>
</ReferenceDate>
</ArticleReference>
<ArticleReference referenceType="String" codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">
<ReferenceNo>String</ReferenceNo>
<Text>String</Text>
<ReferenceDate subClass="ArrivalDateActual" timeZone="String" dstIndicator="String">
<Date>1967-08-13</Date>
<Time>14:20:00.0Z</Time>
</ReferenceDate>
</ArticleReference>
<Description usageCode="String" codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">
<Text sequence="String" code="String">String</Text>
<Text sequence="String" code="String">String</Text>
<LanguageCode codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">String</LanguageCode>
</Description>
<Description usageCode="String" codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">
<Text sequence="String" code="String">String</Text>
<Text sequence="String" code="String">String</Text>
<LanguageCode codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">String</LanguageCode>
</Description>
<DateAndTimes subClass="LoadingDate" timeZone="String" dstIndicator="String">
<Date>1967-08-13</Date>
<Time>14:20:00.0Z</Time>
</DateAndTimes>
<DateAndTimes subClass="ProductionDate" timeZone="String" dstIndicator="String">
<Date>1967-08-13</Date>
<Time>14:20:00.0Z</Time>
</DateAndTimes>
<ArticleMonetaryAmounts>
<UnitPrice currencyIdentificationCode="String">3.14159E0</UnitPrice>
<ArticleTax>
<TaxType>String</TaxType>
<ArticleTaxRate currencyIdentificationCode="String">3.14159E0</ArticleTaxRate>
<GrossAmount currencyIdentificationCode="String">3.14159E0</GrossAmount>
<TaxAmount currencyIdentificationCode="String">3.14159E0</TaxAmount>
</ArticleTax>
<ReductionInformation>
<ReductionRate>String</ReductionRate>
<ValidFrom subClass="ArrivalDate" timeZone="String" dstIndicator="String">
<Date>1967-08-13</Date>
<Time>14:20:00.0Z</Time>
</ValidFrom>
<ValidUntil subClass="DeliveryDate" timeZone="String" dstIndicator="String">
<Date>1967-08-13</Date>
<Time>14:20:00.0Z</Time>
</ValidUntil>
</ReductionInformation>
</ArticleMonetaryAmounts>
<ItemTotals>
<NumberOfPackages unitCode="String">0</NumberOfPackages>
<GrossWeight unitCode="String">3.14159E0</GrossWeight>
<GrossVolume unitCode="String">3.14159E0</GrossVolume>
<LoadingMetres unitCode="String">3.14159E0</LoadingMetres>
<PalletFootPrints unitCode="String">3.14159E0</PalletFootPrints>
<Measures subClass="String">
<MeasureEntity attributeCode="String"/>
<Measure unitCode="String">0</Measure>
</Measures>
<Measures subClass="String">
<MeasureEntity attributeCode="String"/>
<Measure unitCode="String">0</Measure>
</Measures>
</ItemTotals>
<Utility usageCode="String" codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">
<Text sequence="String" code="String">String</Text>
<Text sequence="String" code="String">String</Text>
<LanguageCode codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">String</LanguageCode>
</Utility>
<Utility usageCode="String" codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">
<Text sequence="String" code="String">String</Text>
<Text sequence="String" code="String">String</Text>
<LanguageCode codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">String</LanguageCode>
</Utility>
<ItemResponse>
<ResponseTypeCoded>ApprovedAsSubmitted</ResponseTypeCoded>
<ResponseTypeCodedOther>String</ResponseTypeCodedOther>
</ItemResponse>
<ArticleStatus>String</ArticleStatus>
<ArticleSerialNo>String</ArticleSerialNo>
<ArticleBatchNo>String</ArticleBatchNo>
<FreeText usageCode="String" codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">
<Text sequence="String" code="String">String</Text>
<Text sequence="String" code="String">String</Text>
<LanguageCode codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">String</LanguageCode>
</FreeText>
<FreeText usageCode="String" codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">
<Text sequence="String" code="String">String</Text>
<Text sequence="String" code="String">String</Text>
<LanguageCode codeListIdentifier="String" codeListAgencyIdentifier="String" name="String">String</LanguageCode>
</FreeText>
<ArticleName>String</ArticleName>
</OrderItem>
</OrderLineSet>
<DateAndTimes subClass="ExpirationDate" timeZone="String" dstIndicator="String">
<Date>1967-08-13</Date>
<Time>14:20:00.0Z</Time>
</DateAndTimes>
<DateAndTimes subClass="DepartureDateRequested" timeZone="String" dstIndicator="String">
<Date>1967-08-13</Date>
<Time>14:20:00.0Z</Time>
</DateAndTimes>
</OrderSet>
</SupplyStructure>
</CreateOrderRequest>
Responses
HTTP status code 200
Successfully created an order.
Provide order information
Get all information on a given order and customer. Order is unique in combination with customer number.
URL
GET
https://api.bring.com/po/api/v1/omorder/{customerId}/{orderId}
Request parameters
| URI param | Type | Description |
|---|---|---|
customerId |
string |
Required |
orderId |
string |
Required |
Responses
HTTP status code 200
Complete order information including order items.
Media type: application/json
{
"ResponseProperties": {
"SchemaVersion": 1,
"Locale": "en",
"DateAndTimes": {
"value": 1511357057879,
"subClass": "RESPONSE_DATE"
}
},
"OrderSet": {
"Order": {
"OrderStatus": "Picked",
"Reference": [
{
"ReferenceNo": "0003277",
"Text": "Additional reference number",
"referenceType": "ACD",
"codeListIdentifier": null,
"codeListAgencyIdentifier": null,
"name": null
},
{
"ReferenceNo": "1234567,AVD.",
"Text": "Consignee's shipment reference number",
"referenceType": "AAO",
"codeListIdentifier": null,
"codeListAgencyIdentifier": null,
"name": null
},
{
"ReferenceNo": "70707730124779733",
"Text": "Road consignment note number",
"referenceType": "CMR",
"codeListIdentifier": null,
"codeListAgencyIdentifier": null,
"name": null
},
{
"ReferenceNo": "BERGER",
"Text": "Warehouse storage location number",
"referenceType": "WS",
"codeListIdentifier": null,
"codeListAgencyIdentifier": null,
"name": null
}
],
"DateAndTimes": {
"Date": 1511115771355,
"Time": 1511115771355,
"subClass": "DOCUMENT_DATE",
"timeZone": null,
"dstIndicator": null
},
"TermsOfDelivery": [
{
"TODConditionCode": {
"value": "FOB",
"codeListIdentifier": null,
"codeListAgencyIdentifier": null,
"name": null
},
"TODConditionCodeList": {
"value": "Incoterms",
"codeListIdentifier": null,
"codeListAgencyIdentifier": null,
"name": null
},
"TODLocation": ""
}
],
"orderId": "11873875-status_med_2",
"idType": null
},
"TransportLeg": {
"TransportLegType": {
"value": "30",
"codeListIdentifier": null,
"codeListAgencyIdentifier": null,
"name": null
},
"ModeOfTransport": {
"value": "3",
"codeListIdentifier": null,
"codeListAgencyIdentifier": null,
"name": null
},
"Location": [
{
"LocationName": "DRAMMEN",
"CountryCode": {
"value": "NO",
"codeListIdentifier": null,
"codeListAgencyIdentifier": null,
"name": null
},
"subClass": "START_LOCATION",
"locationId": "3015",
"idType": null
},
{
"LocationName": "LAKSEVÅG",
"CountryCode": {
"value": "NO",
"codeListIdentifier": null,
"codeListAgencyIdentifier": null,
"name": null
},
"subClass": "END_LOCATION",
"locationId": "5161",
"idType": null
}
]
},
"Party": [
{
"Name": "Selger Norge AS",
"VATNo": "",
"Address": [
{
"StateOrRegion": "",
"CountryCode": {
"value": null,
"codeListIdentifier": null,
"codeListAgencyIdentifier": null,
"name": null
},
"AddressLine": [
null
],
"subClass": "POSTAL_ADDRESS"
},
{
"PostalCode": "3015",
"City": "DRAMMEN",
"StateOrRegion": "",
"CountryCode": {
"value": "NO",
"codeListIdentifier": null,
"codeListAgencyIdentifier": null,
"name": null
},
"AddressLine": [
"Nedre Storgate 37"
],
"subClass": "PHYSICAL_ADDRESS"
}
],
"Contact": [
{}
],
"subClass": "DELIVERY_PARTY",
"partyId": "104520",
"idCodeList": null,
"idType": "",
"subPartyId": "",
"subPartyIdType": null
},
{
"Name": "Kjøper AS/Laksevåg",
"VATNo": "",
"Address": [
{
"StateOrRegion": "",
"CountryCode": {
"value": null,
"codeListIdentifier": null,
"codeListAgencyIdentifier": null,
"name": null
},
"AddressLine": [
null
],
"subClass": "POSTAL_ADDRESS"
},
{
"PostalCode": "5161",
"City": "LAKSEVÅG",
"StateOrRegion": "",
"CountryCode": {
"value": "NO",
"codeListIdentifier": null,
"codeListAgencyIdentifier": null,
"name": null
},
"Street": "Johan Berentsensvei 4",
"AddressLine": [
null
],
"subClass": "PHYSICAL_ADDRESS"
}
],
"Contact": [
{}
],
"subClass": "ORDERING_PARTY",
"partyId": "",
"idCodeList": null,
"idType": "",
"subPartyId": "",
"subPartyIdType": null
},
{
"Name": "Selger Norge AS",
"VATNo": "",
"Address": [
{
"StateOrRegion": "",
"CountryCode": {
"value": null,
"codeListIdentifier": null,
"codeListAgencyIdentifier": null,
"name": null
},
"AddressLine": [
null
],
"subClass": "POSTAL_ADDRESS"
},
{
"PostalCode": "3015",
"City": "DRAMMEN",
"StateOrRegion": "",
"CountryCode": {
"value": "NO",
"codeListIdentifier": null,
"codeListAgencyIdentifier": null,
"name": null
},
"AddressLine": [
"Nedre Storgate 37"
],
"subClass": "PHYSICAL_ADDRESS"
}
],
"Contact": [
{}
],
"subClass": "SUPPLIER",
"partyId": "104520",
"idCodeList": null,
"idType": "",
"subPartyId": "",
"subPartyIdType": null
},
{
"Name": "BCN",
"VATNo": "",
"Address": [
{
"StateOrRegion": "",
"CountryCode": {
"value": null,
"codeListIdentifier": null,
"codeListAgencyIdentifier": null,
"name": null
},
"AddressLine": [
null
],
"subClass": "POSTAL_ADDRESS"
},
{
"StateOrRegion": "",
"CountryCode": {
"value": null,
"codeListIdentifier": null,
"codeListAgencyIdentifier": null,
"name": null
},
"AddressLine": [
null
],
"subClass": "PHYSICAL_ADDRESS"
}
],
"Contact": [
{}
],
"subClass": "TRANSPORT_COMPANY",
"partyId": "",
"idCodeList": null,
"idType": "",
"subPartyId": "",
"subPartyIdType": null
}
],
"OrderLineSet": [
{
"OrderItem": [
{
"ArticleId": [
{
"value": "100001",
"codeListIdentifier": null,
"codeListAgencyIdentifier": "",
"name": null
},
{
"value": "2200001",
"codeListIdentifier": null,
"codeListAgencyIdentifier": "VendorItemNo",
"name": null
}
],
"ArticleReference": [],
"Description": [
{
"Text": [
{
"value": "STAR B 90/190 V AC/R S51 SØLV Vidar igjen",
"sequence": null,
"code": null
}
],
"usageCode": "AAA",
"codeListIdentifier": null,
"codeListAgencyIdentifier": null,
"name": null
}
],
"ArticleMonetaryAmounts": {
"UnitPrice": {
"value": 23.0,
"currencyIdentificationCode": "NOK"
}
},
"FreeText": [],
"articleLineId": "1",
"idType": null
},
{
"ArticleId": [
{
"value": "100002",
"codeListIdentifier": null,
"codeListAgencyIdentifier": "",
"name": null
},
{
"value": "3300001",
"codeListIdentifier": null,
"codeListAgencyIdentifier": "VendorItemNo",
"name": null
}
],
"ArticleReference": [],
"Description": [
{
"Text": [
{
"value": "STAR B 80/190 H AC/R S51 SØLV",
"sequence": null,
"code": null
}
],
"usageCode": "AAA",
"codeListIdentifier": null,
"codeListAgencyIdentifier": null,
"name": null
}
],
"ArticleMonetaryAmounts": {
"UnitPrice": {
"value": 42.0,
"currencyIdentificationCode": "NOK"
}
},
"FreeText": [],
"articleLineId": "2",
"idType": null
},
{
"ArticleId": [
{
"value": "100003",
"codeListIdentifier": null,
"codeListAgencyIdentifier": "",
"name": null
},
{
"value": "4400001",
"codeListIdentifier": null,
"codeListAgencyIdentifier": "VendorItemNo",
"name": null
}
],
"ArticleReference": [],
"Description": [
{
"Text": [
{
"value": "STAR B 90/190 V AC/R S51 SØLV",
"sequence": null,
"code": null
}
],
"usageCode": "AAA",
"codeListIdentifier": null,
"codeListAgencyIdentifier": null,
"name": null
}
],
"ArticleMonetaryAmounts": {
"UnitPrice": {
"value": 55.0,
"currencyIdentificationCode": "NOK"
}
},
"FreeText": [],
"articleLineId": "3",
"idType": null
}
]
}
],
"DateAndTimes": [],
"updateIndicator": "ORIGINAL"
}
}
Media type: application/xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<GetOrderResponse xmlns="http://api.bring.com/om">
<ResponseProperties>
<SchemaVersion>1</SchemaVersion>
<Locale>en</Locale>
<DateAndTimes subClass="ResponseDate">2017-11-22T14:16:15.462+01:00</DateAndTimes>
</ResponseProperties>
<OrderSet updateIndicator="Original">
<Order orderId="11873875-status_med_2">
<OrderStatus>Picked</OrderStatus>
<Reference referenceType="ACD">
<ReferenceNo>0003277</ReferenceNo>
<Text>Additional reference number</Text>
</Reference>
<Reference referenceType="AAO">
<ReferenceNo>1234567,AVD.</ReferenceNo>
<Text>Consignee's shipment reference number</Text>
</Reference>
<Reference referenceType="CMR">
<ReferenceNo>70707730124779733</ReferenceNo>
<Text>Road consignment note number</Text>
</Reference>
<Reference referenceType="WS">
<ReferenceNo>BERGER</ReferenceNo>
<Text>Warehouse storage location number</Text>
</Reference>
<DateAndTimes subClass="DocumentDate">
<Date>2017-11-19+01:00</Date>
<Time>19:22:51.355+01:00</Time>
</DateAndTimes>
<TermsOfDelivery>
<TODConditionCode>FOB</TODConditionCode>
<TODConditionCodeList>Incoterms</TODConditionCodeList>
<TODLocation></TODLocation>
</TermsOfDelivery>
</Order>
<TransportLeg>
<TransportLegType>30</TransportLegType>
<ModeOfTransport>3</ModeOfTransport>
<Location locationId="3015" subClass="StartLocation">
<LocationName>DRAMMEN</LocationName>
<CountryCode>NO</CountryCode>
</Location>
<Location locationId="5161" subClass="EndLocation">
<LocationName>LAKSEVÅG</LocationName>
<CountryCode>NO</CountryCode>
</Location>
</TransportLeg>
<Party subPartyId="" idType="" partyId="104520" subClass="DeliveryParty">
<Name>Selger Norge AS</Name>
<VATNo></VATNo>
<Address subClass="PostalAddress">
<StateOrRegion></StateOrRegion>
<CountryCode/>
</Address>
<Address subClass="PhysicalAddress">
<PostalCode>3015</PostalCode>
<City>DRAMMEN</City>
<StateOrRegion></StateOrRegion>
<CountryCode>NO</CountryCode>
<AddressLine>Nedre Storgate 37</AddressLine>
</Address>
<Contact/>
</Party>
<Party subPartyId="" idType="" partyId="" subClass="OrderingParty">
<Name>Kjøper AS/Laksevåg</Name>
<VATNo></VATNo>
<Address subClass="PostalAddress">
<StateOrRegion></StateOrRegion>
<CountryCode/>
</Address>
<Address subClass="PhysicalAddress">
<PostalCode>5161</PostalCode>
<City>LAKSEVÅG</City>
<StateOrRegion></StateOrRegion>
<CountryCode>NO</CountryCode>
<Street>Johan Berentsensvei 4</Street>
</Address>
<Contact/>
</Party>
<Party subPartyId="" idType="" partyId="104520" subClass="Supplier">
<Name>Selger Norge AS</Name>
<VATNo></VATNo>
<Address subClass="PostalAddress">
<StateOrRegion></StateOrRegion>
<CountryCode/>
</Address>
<Address subClass="PhysicalAddress">
<PostalCode>3015</PostalCode>
<City>DRAMMEN</City>
<StateOrRegion></StateOrRegion>
<CountryCode>NO</CountryCode>
<AddressLine>Nedre Storgate 37</AddressLine>
</Address>
<Contact/>
</Party>
<Party subPartyId="" idType="" partyId="" subClass="TransportCompany">
<Name>BCN</Name>
</Party>
<OrderLineSet>
<OrderItem articleLineId="1">
<ArticleId>100001</ArticleId>
<ArticleId codeListAgencyIdentifier="VendorItemNo">2200001</ArticleId>
<Description usageCode="AAA">
<Text>STAR B 90/190 V AC/R S51 SØLV Vidar igjen</Text>
</Description>
<ArticleMonetaryAmounts>
<UnitPrice currencyIdentificationCode="NOK">23.0</UnitPrice>
</ArticleMonetaryAmounts>
</OrderItem>
<OrderItem articleLineId="2">
<ArticleId>100002</ArticleId>
<ArticleId codeListAgencyIdentifier="VendorItemNo">3300001</ArticleId>
<Description usageCode="AAA">
<Text>STAR B 80/190 H AC/R S51 SØLV</Text>
</Description>
<ArticleMonetaryAmounts>
<UnitPrice currencyIdentificationCode="NOK">42.0</UnitPrice>
</ArticleMonetaryAmounts>
</OrderItem>
<OrderItem articleLineId="3">
<ArticleId>100003</ArticleId>
<ArticleId codeListAgencyIdentifier="VendorItemNo">4400001</ArticleId>
<Description usageCode="AAA">
<Text>STAR B 90/190 V AC/R S51 SØLV</Text>
</Description>
<ArticleMonetaryAmounts>
<UnitPrice currencyIdentificationCode="NOK">55.0</UnitPrice>
</ArticleMonetaryAmounts>
</OrderItem>
</OrderLineSet>
</OrderSet>
</GetOrderResponse>
List order lines
List all item lines that is ordered on an order.
URL
GET
https://api.bring.com/po/api/v1/items/{customerId}/{orderId}
Request parameters
| URI param | Type | Description |
|---|---|---|
customerId |
string |
Required |
orderId |
string |
Required |
Responses
HTTP status code 200
List of order items.
Media type: application/json
{
"ResponseProperties": {
"SchemaVersion": 1,
"Locale": "en",
"DateAndTimes": {
"value": 1504471843840,
"subClass": "RESPONSE_DATE"
}
},
"PurchaseOrderItem": {
"OrderLineSet": [
{
"OrderItem": [
{
"ArticleQuantity": 4,
"RemainingArticleQuantity": 0,
"Description": {
"Text": "Fjernkontroll TV",
"Usage": ""
},
"ArticleMonetaryAmounts": {
"UnitPrice": {
"value": 0,
"currencyIdentificationCode": ""
}
},
"articleLineId": "1"
},
{
"ArticleQuantity": 1,
"RemainingArticleQuantity": 0,
"Description": {
"Text": "HD Module 500",
"Usage": ""
},
"ArticleMonetaryAmounts": {
"UnitPrice": {
"value": 0,
"currencyIdentificationCode": ""
}
},
"articleLineId": "2"
},
{
"ArticleQuantity": 3,
"RemainingArticleQuantity": 0,
"Description": {
"Text": "HD dekoder",
"Usage": ""
},
"ArticleMonetaryAmounts": {
"UnitPrice": {
"value": 0,
"currencyIdentificationCode": ""
}
},
"articleLineId": "3"
}
],
"orderLineId": null
}
]
},
"updateIndicator": "ORIGINAL"
}
Media type: application/xml
<GetPurchaseOrderItemResponse xmlns="http://api.bring.com/po" updateIndicator="Original">
<ResponseProperties>
<SchemaVersion>1</SchemaVersion>
<Locale>en</Locale>
<DateAndTimes subClass="ResponseDate">2017-09-03T22:48:51.108+02:00</DateAndTimes>
</ResponseProperties>
<PurchaseOrderItem>
<OrderLineSet>
<OrderItem articleLineId="1">
<ArticleQuantity>4</ArticleQuantity>
<RemainingArticleQuantity>0</RemainingArticleQuantity>
<Description>
<Text>Fjernkontroll TV</Text>
<Usage></Usage>
</Description>
<ArticleMonetaryAmounts>
<UnitPrice currencyIdentificationCode="">0.00</UnitPrice>
</ArticleMonetaryAmounts>
</OrderItem>
<OrderItem articleLineId="2">
<ArticleQuantity>1</ArticleQuantity>
<RemainingArticleQuantity>0</RemainingArticleQuantity>
<Description>
<Text>HD Module 500</Text>
<Usage></Usage>
</Description>
<ArticleMonetaryAmounts>
<UnitPrice currencyIdentificationCode="">0.00</UnitPrice>
</ArticleMonetaryAmounts>
</OrderItem>
<OrderItem articleLineId="3">
<ArticleQuantity>3</ArticleQuantity>
<RemainingArticleQuantity>0</RemainingArticleQuantity>
<Description>
<Text>HD dekoder</Text>
<Usage></Usage>
</Description>
<ArticleMonetaryAmounts>
<UnitPrice currencyIdentificationCode="">0.00</UnitPrice>
</ArticleMonetaryAmounts>
</OrderItem>
</OrderLineSet>
</PurchaseOrderItem>
</GetPurchaseOrderItemResponse>
Provide packaging list information for the order
List all packaging list information for this order. One order can have multiple packaging lists.
URL
GET
https://api.bring.com/po/api/v1/packaginglist/{customerId}/{orderId}
Request parameters
| URI param | Type | Description |
|---|---|---|
customerId |
string |
Required |
orderId |
string |
Required |
Responses
HTTP status code 200
List of packaging list for given order, if any.
Media type: application/json
{
"ResponseProperties": {
"SchemaVersion": 1,
"Locale": "en",
"DateAndTimes": {
"value": 1504471398361,
"subClass": "RESPONSE_DATE"
}
},
"PackagingListSet": {
"PackagingList": [
{
"ConsignmentId": "70707730122339403",
"PackingListSet": [
{
"PackingListItem": [
{
"ArticleQuantity": 1,
"articleLineId": "4"
},
{
"ArticleQuantity": 3,
"articleLineId": "3"
},
{
"ArticleQuantity": 1,
"articleLineId": "2"
},
{
"ArticleQuantity": 4,
"articleLineId": "1"
}
],
"orderLineId": null
}
]
}
]
}
}
Media type: application/xml
<GetPackagingListResponse xmlns="http://api.bring.com/po">
<ResponseProperties>
<SchemaVersion>1</SchemaVersion>
<Locale>en</Locale>
<DateAndTimes subClass="ResponseDate">2017-09-03T22:44:34.733+02:00</DateAndTimes>
</ResponseProperties>
<PackagingListSet>
<PackagingList>
<ConsignmentId>70707730122339403</ConsignmentId>
<PackingListSet>
<PackingListItem articleLineId="4">
<ArticleQuantity>1</ArticleQuantity>
</PackingListItem>
<PackingListItem articleLineId="3">
<ArticleQuantity>3</ArticleQuantity>
</PackingListItem>
<PackingListItem articleLineId="2">
<ArticleQuantity>1</ArticleQuantity>
</PackingListItem>
<PackingListItem articleLineId="1">
<ArticleQuantity>4</ArticleQuantity>
</PackingListItem>
</PackingListSet>
</PackagingList>
</PackagingListSet>
</GetPackagingListResponse>
Add packaging list
When an order have been picked and sent, add packing list on order with transport information.
URL
POST
https://api.bring.com/po/api/v1/packaginglist
Request body
<CreatePackagingListRequest>
<RequestProperties>
<SchemaVersion>1</SchemaVersion>
<Locale>no</Locale>
<DateAndTimes subClass="DocumentDate">2014-11-11T07:32:54.284+01:00</DateAndTimes>
</RequestProperties>
<CustomerNo>99999999</CustomerNo>
<PurchaseOrderNo>12345678</PurchaseOrderNo>
<PackingList>
<ConsignmentId>70703223343223526</ConsignmentId>
<PackageId>370794836448493247</PackageId>
<PackingListSet orderLineId="1">
<PackingListItem articleLineId="10">
<ArticleQuantity>10</ArticleQuantity>
</PackingListItem>
</PackingListSet>
<PackingListSet orderLineId="1">
<PackingListItem articleLineId="20">
<ArticleQuantity>3</ArticleQuantity>
</PackingListItem>
</PackingListSet>
<PackingListSet orderLineId="1">
<PackingListItem articleLineId="30">
<ArticleQuantity>5</ArticleQuantity>
</PackingListItem>
</PackingListSet>
</PackingList>
</CreatePackagingListRequest>
Responses
HTTP status code 200
Successfully added packaging list.
Get status for order (delivered/locked)
Check sender status for an order. Open when not fully delivered or locked when fully delivered.
URL
GET
https://api.bring.com/po/api/v1/senderStatus/{customerId}/{orderId}
Request parameters
| URI param | Type | Description |
|---|---|---|
customerId |
string |
Required |
orderId |
string |
Required |
Responses
HTTP status code 200
Open or Locked.
Media type: application/json
{
"ResponseProperties": {
"SchemaVersion": 1,
"Locale": "en",
"DateAndTimes": {
"value": 1508306674284,
"subClass": "RESPONSE_DATE"
}
},
"SenderStatus": "OPEN"
}
Media type: application/xml
<GetSenderStatusResponse xmlns="http://api.bring.com/po">
<ResponseProperties>
<SchemaVersion>1</SchemaVersion>
<Locale>en</Locale>
<DateAndTimes subClass="ResponseDate">2017-06-02T23:00:32.972+02:00</DateAndTimes>
</ResponseProperties>
<SenderStatus>OPEN</SenderStatus>
</GetSenderStatusResponse>Create TMSEvents
Create tracking events on transports associated with orders in Order Management.
URL
POST
https://api.bring.com/po/api/v1/event
Request body
<CreateEventRequest xmlns="http://api.bring.com/po">
<RequestProperties>
<SchemaVersion>1</SchemaVersion>
<Locale>no</Locale>
<DateAndTimes subClass="RequestDate">2014-07-03T08:03:56.040+02:00</DateAndTimes>
</RequestProperties>
<Event>
<ConsignmentId>12345</ConsignmentId>
<EventType>{event type}</EventType>
<PerformedBy>{some value}</PerformedBy>
<Timestamp>2014-07-04T00:00:00+02:00</Timestamp>
</Event>
</CreateEventRequest>
Responses
HTTP status code 200
Successfully created a new resource
List error codes
URL
GET
https://api.bring.com/po/api/v1/errorCodes
Responses
HTTP status code 200
Dynamic list of error codes used in the solution.
Media type: application/json
{
"errorTypes": [
{
"Code": "PO_INPUT_001",
"Description": "Must provide valid customer ID"
},
{
"Code": "PO_INPUT_002",
"Description": "Must provide valid purchase order"
},
{
"Code": "PO_INPUT_003",
"Description": "Must provide valid schema version. See developer.bring.com for latest schema version"
},
{
"Code": "PO_INPUT_004",
"Description": "Request properties must contain valid datetime"
},
{
"Code": "PO_INPUT_005",
"Description": "Request properties must contain valid locale"
},
{
"Code": "PO_INPUT_006",
"Description": "Request properties must be present"
},
{
"Code": "PO_INPUT_007",
"Description": "Consignment ID is required"
},
{
"Code": "PO_INPUT_008",
"Description": "Must provide valid EventType. See xsd for list of valid types."
},
{
"Code": "PO_INPUT_009",
"Description": "Must provide valid ISO timestamp for event"
},
{
"Code": "PO_INPUT_010",
"Description": "Purchase order not found. You can not have orderlines to a non-existing purchase order."
},
{
"Code": "PO_INPUT_011",
"Description": "Negative quantity not allowed."
},
{
"Code": "PO_INPUT_012",
"Description": "Item on transport order does not exist on purchase order. OrderLineId and ArticleLineId must match purchase order."
},
{
"Code": "PO_INPUT_013",
"Description": "Shipping container ID is required"
},
{
"Code": "PO_INPUT_014",
"Description": "A valid container type required for the shipping container and the content"
},
{
"Code": "PO_INPUT_015",
"Description": "Content for shipping container is required"
},
{
"Code": "PO_INOUT_016",
"Description": "Content in shipping container requires either consignment ID or shipping container ID"
},
{
"Code": "PO_INPUT_017",
"Description": "The request contained invalid content."
},
{
"Code": "PO_INPUT_018",
"Description": "The request contains input that is not supported."
},
{
"Code": "PO_INPUT_019",
"Description": "Some required parameters are missing."
},
{
"Code": "PO_INPUT_020",
"Description": "Must provide valid transport order"
},
{
"Code": "PO_INPUT_021",
"Description": "Article number is required"
},
{
"Code": "PO_INPUT_022",
"Description": "Article number is required"
},
{
"Code": "PO_INPUT_023",
"Description": "Content for article balance is required"
},
{
"Code": "PO_INPUT_024",
"Description": "Attempted to create/insert a purchase order that already existed. Maybe wrong updateIndicator"
},
{
"Code": "PO_STATE_001",
"Description": "Purchase order not found"
},
{
"Code": "PO_STATE_002",
"Description": "You must log in to use this endpoint. See developer.bring.com for details about login with HTTP-headers."
},
{
"Code": "PO_STATE_003",
"Description": "Order items for requested purchase order not found"
},
{
"Code": "PO_STATE_004",
"Description": "Access is denied to read this purchaseorder"
},
{
"Code": "PO_STATE_005",
"Description": "Transport order not found"
}
]
}Media type: application/xml
<ErrorList xmlns="http://api.bring.com/po">
<errorTypes>
<Code>PO_INPUT_001</Code>
<Description>Must provide valid customer ID</Description>
</errorTypes>
<errorTypes>
<Code>PO_INPUT_002</Code>
<Description>Must provide valid purchase order</Description>
</errorTypes>
<errorTypes>
<Code>PO_INPUT_003</Code>
<Description>Must provide valid schema version. See developer.bring.com for latest schema version</Description>
</errorTypes>
<errorTypes>
<Code>PO_INPUT_004</Code>
<Description>Request properties must contain valid datetime</Description>
</errorTypes>
<errorTypes>
<Code>PO_INPUT_005</Code>
<Description>Request properties must contain valid locale</Description>
</errorTypes>
<errorTypes>
<Code>PO_INPUT_006</Code>
<Description>Request properties must be present</Description>
</errorTypes>
<errorTypes>
<Code>PO_INPUT_007</Code>
<Description>Consignment ID is required</Description>
</errorTypes>
<errorTypes>
<Code>PO_INPUT_008</Code>
<Description>Must provide valid EventType. See xsd for list of valid types.</Description>
</errorTypes>
<errorTypes>
<Code>PO_INPUT_009</Code>
<Description>Must provide valid ISO timestamp for event</Description>
</errorTypes>
<errorTypes>
<Code>PO_INPUT_010</Code>
<Description>Purchase order not found. You can not have orderlines to a non-existing purchase order.</Description>
</errorTypes>
<errorTypes>
<Code>PO_INPUT_011</Code>
<Description>Negative quantity not allowed.</Description>
</errorTypes>
<errorTypes>
<Code>PO_INPUT_012</Code>
<Description>Item on transport order does not exist on purchase order. OrderLineId and ArticleLineId must match purchase order.</Description>
</errorTypes>
<errorTypes>
<Code>PO_INPUT_013</Code>
<Description>Shipping container ID is required</Description>
</errorTypes>
<errorTypes>
<Code>PO_INPUT_014</Code>
<Description>A valid container type required for the shipping container and the content</Description>
</errorTypes>
<errorTypes>
<Code>PO_INPUT_015</Code>
<Description>Content for shipping container is required</Description>
</errorTypes>
<errorTypes>
<Code>PO_INOUT_016</Code>
<Description>Content in shipping container requires either consignment ID or shipping container ID</Description>
</errorTypes>
<errorTypes>
<Code>PO_INPUT_017</Code>
<Description>The request contained invalid content.</Description>
</errorTypes>
<errorTypes>
<Code>PO_INPUT_018</Code>
<Description>The request contains input that is not supported.</Description>
</errorTypes>
<errorTypes>
<Code>PO_INPUT_019</Code>
<Description>Some required parameters are missing.</Description>
</errorTypes>
<errorTypes>
<Code>PO_INPUT_020</Code>
<Description>Must provide valid transport order</Description>
</errorTypes>
<errorTypes>
<Code>PO_INPUT_021</Code>
<Description>Article number is required</Description>
</errorTypes>
<errorTypes>
<Code>PO_INPUT_022</Code>
<Description>Article number is required</Description>
</errorTypes>
<errorTypes>
<Code>PO_INPUT_023</Code>
<Description>Content for article balance is required</Description>
</errorTypes>
<errorTypes>
<Code>PO_INPUT_024</Code>
<Description>Attempted to create/insert a purchase order that already existed. Maybe wrong updateIndicator</Description>
</errorTypes>
<errorTypes>
<Code>PO_STATE_001</Code>
<Description>Purchase order not found</Description>
</errorTypes>
<errorTypes>
<Code>PO_STATE_002</Code>
<Description>You must log in to use this endpoint. See developer.bring.com for details about login with HTTP-headers.</Description>
</errorTypes>
<errorTypes>
<Code>PO_STATE_003</Code>
<Description>Order items for requested purchase order not found</Description>
</errorTypes>
<errorTypes>
<Code>PO_STATE_004</Code>
<Description>Access is denied to read this purchaseorder</Description>
</errorTypes>
<errorTypes>
<Code>PO_STATE_005</Code>
<Description>Transport order not found</Description>
</errorTypes>
</ErrorList>