Warehousing API
Endpoints
Base URL
https://api.bring.com/warehousing/api/v1
Usage | Method | Endpoint |
---|---|---|
Send an order | POST |
/omorder
|
List order information | GET |
/omorder/{customerId}/{orderId}
|
List order items | GET |
/items/{customerId}/{orderId}
|
Create or update article balance list | POST |
/articlebalance
|
Get stock balance and info for all articles | GET |
/articlebalance/{customerId}
|
Get stock balance and info for one article | GET |
/articlebalance/{customerId}/{articleNo}
|
Get stock balance and info for all articles matching search string | GET |
/articlebalance/info/{customerId}/{articleSearchString}
|
List error codes | GET |
/errorCodes
|
Send an order
Send an order to Warehousing system. There are different types of order supported in Warehousing system.
- Order / SalesOrder (as an pickorder for Warehousing)
- Warehousing functionality sends it to Warhousing system for picking and delivery.
- PurchaseOrder (as an receiving order for Warehousing)
- Warehousing functionality sends it to Warhousing system for receiving orderinfo.
URL
POST https://api.bring.com/warehousing/api/v1/omorder
Request parameters
Query param | Type | Description |
---|---|---|
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.0 |
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. An GLN number for Warehousing. Always use 7080003388100. Example: 7080003388100 |
MessageSender partyId |
string |
Required
Customer Number which Bring has provided. It cannot be demo customer number. An 6 digits number. Example: 999999 |
Order/DateAndTimes Date & Time with subClass DeliveryDateRequested |
dateTime |
Required
The date on which order is requested delivered. Example: Date 22.01.2017 Time 11:36:22 |
Order/DateAndTimes Date & Time with subClass DocumentDate |
dateTime |
Required
The date on which order is booked. Example: Date 22.01.2017 Time 11:36:22 |
Order/ExternalOrderType |
string |
Optional
Type of order. Order types 220 = Standard order 224 = Rush order Or other agreed by Warehouse. PurchaseOrder types R = Return order S = Sampakk Example: For Order: 220 / For PurchaseOrder: R |
Order/Reference |
sequence |
Optional Set of references. |
Order/Reference ReferenceNo |
String |
Required
Reference. Example: 10003455TT |
Order/Reference referenceType |
String |
Required
Type of reference coded. https://www.stylusstudio.com/edifact/D04A/1153.htm ACD = Additional reference number CU = Sellers reference ON = Buyers reference Example: CU |
Order/TermsOfDelivery TODConditionCode |
dateTime |
Optional
Ordernumber. Example: DDP |
Order/orderId |
string |
Required
Ordernumber. Example: 101010 |
OrderItem/ArticleId |
sequence |
Required
Article number or id. Example: 123-4000 |
OrderItem/ArticleId codeListAgencyIdentifier |
string |
Required
Sets type of ArticleId. “CustomerItemNo” = Your article number/id “VendorItemNo” = Supplier article number/id “EAN” = EAN article id If not used ArticleId default is CustomerItemNo. Example: CustomerItemNo |
OrderItem/ArticleMonetaryAmounts |
float |
Optional
Article unit sales price. Example: 230.30 |
OrderItem/ArticleName |
string |
Optional
Article name. Example: Spear parts |
OrderItem/ArticleQuantity |
float |
Required
Quantity ordered. Example: 2.0 |
OrderItem/ArticleQuantity unitCode |
string |
Required
Unit code for quantity ordered. Example: STK |
OrderItem/Description |
string |
Optional
Article description. Example: Spear parts with all parts |
OrderItem/Description usageCode |
string |
Optional
Article description type. If description used set to AAA. Example: AAA |
OrderItem/articleLineId |
integer |
Required
Unique line id for this order line. Counter that identify orderline. Example: (10) First line / (20) Second line |
OrderLineSet |
sequence |
Required Set of order items. |
OrderSet updateIndicator |
string |
Required
Type of order data. Original, Update or Delete 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 |
Required
Warehouse id for order. Required if order to Warehousing system. 4033 = Stavanger (Norway) 5500 = Haugesund (Norway) AES = Ålesund (Norway) BERGER = Berger/Skedsmokorset (Norway) BS02 = Kongshavn (Norway) BS07 = Trollåsen (Norway) BS17 = Bergen (Norway) BS26 = Trondheim (Norway) BS34 = Tromsø (Norway) FI01 = Vantaa (Finland) JKPG01 = Jönköping (Sweden) NCD = Lierstrand (Norway) Example: BERGER |
Party/subClass Supplier |
string |
Optional Required when sending purchaseorder.Details of supplier. Must have Name, Street, City, CountryCode if used. |
TransportLeg ModeOfTransport |
String |
Optional
Optional for PurchaseOrder. Type of transport. 1 = Sea 2 = Train 3 = Road 4 = Air. Example: 3 |
TransportLeg TransportLegType |
String |
Optional
Optional for PurchaseOrder. TransportLegType id. Default value 30. Example: 30 |
TransportService AdditionalService AdditionalServiceCode |
String |
Optional
Optional for PurchaseOrder. Transport services for shipment to customer. https://developer.bring.com/api/services/ Example: EVARSLING |
TransportService BasicServiceCode |
String |
Required
Optional for PurchaseOrder. Transport service for shipment to customer. https://developer.bring.com/api/services/ Example: SERVICEPAKKE |
Request body
Media type: application/json
{
"messageFunction": "Order",
"MessageDetails": {
"MessageSender": {
"partyId": "999999"
},
"MessageDate": {
"value": "2019-01-02"
}
},
"SupplyStructure": {
"OrderSet": [{
"updateIndicator": "Original",
"Order": {
"Reference": [{
"ReferenceNo": "10000-2",
"Text": "Additional reference number",
"referenceType": "ACD"
}],
"DateAndTimes": [
{
"Date": "2019-01-02",
"Time": "23:00:00",
"subClass": "DocumentDate"
},
{
"Date": "2019-01-06",
"Time": "23:00:00",
"subClass": "DeliveryDateRequested"
}
],
"orderId": "10000-2"
},
"TransportService": {
"BasicServiceCode": {
"value": "SERVICEPAKKE"
}
},
"Party": [{
"subClass": "DeliveryParty",
"partyId": "32628",
"Name": "Customer 1",
"Address": [{
"PostalCode": "0181",
"City": "Oslo",
"StateOrRegion": "",
"CountryCode": {
"value": "NO"
},
"Street": "Torggata 5",
"AddressLine": [null],
"subClass": "PhysicalAddress"
}],
"Contact": [{
"CellPhoneNo": "99999999",
"EMailAddress": "contact@mottaker.no"
}]
},
{
"subClass": "OrderingParty",
"partyId": "32628",
"Name": "Customer 1",
"Address": [{
"PostalCode": "4391",
"City": "SANDNES",
"StateOrRegion": "SANDNES",
"CountryCode": {
"value": "NO"
},
"Street": "Postboks 1126",
"AddressLine": [""],
"subClass": "PostalAddress"
}],
"Contact": [{
"EMailAddress": "torggata@kitchn.no"
}],
"VATNo": "XXXXXXXXX"
},
{
"subClass": "Supplier",
"partyId": "999999",
"Name": "Warehousecustomer",
"Address": [{
"PostalCode": "0257",
"City": "Oslo",
"StateOrRegion": "Oslo",
"CountryCode": {
"value": "NO"
},
"Street": "Skovveien 6",
"AddressLine": [""],
"subClass": "PhysicalAddress"
}],
"VATNo": "XXXXXXXXX"
},
{
"subClass": "PerformingUnit",
"Name": "BERGER"
}],
"OrderLineSet": [{
"OrderItem": [{
"articleLineId": 1,
"ArticleId": [{
"value": "478015",
"codeListAgencyIdentifier": "CustomerItemNo"
}],
"ArticleQuantity": {
"value": 1,
"unitCode": "STK"
},
"Description": [{
"Text": [{
"value": "Article Text"
}],
"usageCode": "AAA"
}],
"ArticleMonetaryAmounts": {
"UnitPrice": {
"value": 120,
"currencyIdentificationCode": "NOK"
}
},
"ItemTotals": {
"GrossWeight": {
"unitCode": "GRM",
"value": 106
}
}
}]
}]
}]
}
}
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.
List order information
Get all information on a given order.
URL
GET https://api.bring.com/warehousing/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 items
List all item lines on an order.
URL
GET https://api.bring.com/warehousing/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>
Create or update article balance list
URL
POST https://api.bring.com/warehousing/api/v1/articlebalance
Request body
<CreateArticleBalanceRequest xmlns="http://api.bring.com/po">
<RequestProperties>
<SchemaVersion>1</SchemaVersion>
<Locale>en</Locale>
<DateAndTimes subClass="RequestDate">2016-09-12T00:06:21.635+02:00</DateAndTimes>
</RequestProperties>
<CustomerNo>9999999</CustomerNo>
<ArticleBalanceSet>
<ArticleBalance>
<ArticleNumber>1111111</ArticleNumber>
<PhysicalBalance>251.000</PhysicalBalance>
<AllocatedBalance>0.000</AllocatedBalance>
<InOrderBalance>0.000</InOrderBalance>
<FreeBalance>251.000</FreeBalance>
<ArticleName>Article 1</ArticleName>
</ArticleBalance>
<ArticleBalance>
<ArticleNumber>2222222</ArticleNumber>
<PhysicalBalance>5896.000</PhysicalBalance>
<AllocatedBalance>0.000</AllocatedBalance>
<InOrderBalance>0.000</InOrderBalance>
<FreeBalance>5896.000</FreeBalance>
<ArticleName>Article 2</ArticleName>
</ArticleBalance>
<ArticleBalance>
<ArticleNumber>3333333</ArticleNumber>
<PhysicalBalance>758.000</PhysicalBalance>
<AllocatedBalance>0.000</AllocatedBalance>
<InOrderBalance>0.000</InOrderBalance>
<FreeBalance>758.000</FreeBalance>
<ArticleName>Article 3</ArticleName>
</ArticleBalance>
</ArticleBalanceSet>
</CreateArticleBalanceRequest>
Responses
HTTP status code 200
Successfully created balance list
Get stock balance and info for all articles
URL
GET https://api.bring.com/warehousing/api/v1/articlebalance/{customerId}
Request parameters
URI param | Type | Description |
---|---|---|
customerId |
string |
Required |
Responses
HTTP status code 200
Media type: application/json
{
"ResponseProperties": {
"SchemaVersion": 1,
"Locale": "en",
"DateAndTimes": {
"value": 1504460506061,
"subClass": "RESPONSE_DATE"
}
},
"ArticleBalanceSet": {
"ArticleBalance": [
{
"ArticleNumber": "5300363",
"ArticleName": "ADB 5812WX Dekoder PVR",
"PhysicalBalance": 251,
"AllocatedBalance": 0,
"InOrderBalance": 0,
"FreeBalance": 251,
"CreatedDateTime": "2017-05-03T01:37:17+02:00",
"LastUpdatedDateTime": "2017-05-03T01:37:17+02:00"
},
{
"ArticleNumber": "5300311",
"ArticleName": "ADB ABX-2720W HD dekoder",
"PhysicalBalance": 5896,
"AllocatedBalance": 0,
"InOrderBalance": 0,
"FreeBalance": 5896,
"CreatedDateTime": "2017-05-03T01:37:17+02:00",
"LastUpdatedDateTime": "2017-05-03T01:37:17+02:00"
},
{
"ArticleNumber": "5300352",
"ArticleName": "ADB ABX-2720WX PVR dekoder",
"PhysicalBalance": 758,
"AllocatedBalance": 0,
"InOrderBalance": 0,
"FreeBalance": 758,
"CreatedDateTime": "2017-05-03T01:37:17+02:00",
"LastUpdatedDateTime": "2017-05-03T01:37:17+02:00"
},
{
"ArticleNumber": "5300741",
"ArticleName": "Altibox emballasje for rekit Mellomstor",
"PhysicalBalance": 5484,
"AllocatedBalance": 0,
"InOrderBalance": 0,
"FreeBalance": 5484,
"CreatedDateTime": "2017-05-03T01:37:17+02:00",
"LastUpdatedDateTime": "2017-05-03T01:37:17+02:00"
},
{
"ArticleNumber": "5301761",
"ArticleName": "Altibox WifiPluss Installasjon",
"PhysicalBalance": 720,
"AllocatedBalance": 0,
"InOrderBalance": 0,
"FreeBalance": 720,
"CreatedDateTime": "2017-05-03T01:37:17+02:00",
"LastUpdatedDateTime": "2017-05-03T01:37:17+02:00"
},
{
"ArticleNumber": "5300301",
"ArticleName": "CTS HET-3012BTFC",
"PhysicalBalance": 2,
"AllocatedBalance": 0,
"InOrderBalance": 0,
"FreeBalance": 2,
"CreatedDateTime": "2017-05-03T01:37:17+02:00",
"LastUpdatedDateTime": "2017-05-03T01:37:17+02:00"
},
{
"ArticleNumber": "5300531",
"ArticleName": "ZyXEL strømforsyning til hjemm",
"PhysicalBalance": 211,
"AllocatedBalance": 0,
"InOrderBalance": 0,
"FreeBalance": 211,
"CreatedDateTime": "2017-05-03T01:37:17+02:00",
"LastUpdatedDateTime": "2017-05-03T01:37:17+02:00"
}
]
}
}
Media type: application/xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<GetArticleBalanceResponse xmlns="http://api.bring.com/po">
<ResponseProperties>
<SchemaVersion>1</SchemaVersion>
<Locale>en</Locale>
<DateAndTimes subClass="ResponseDate">2017-09-03T19:55:02.410+02:00</DateAndTimes>
</ResponseProperties>
<ArticleBalanceSet>
<ArticleBalance>
<ArticleNumber>5300363</ArticleNumber>
<ArticleName>ADB 5812WX Dekoder PVR</ArticleName>
<PhysicalBalance>251.00</PhysicalBalance>
<AllocatedBalance>0.00</AllocatedBalance>
<InOrderBalance>0.00</InOrderBalance>
<FreeBalance>251.00</FreeBalance>
<CreatedDateTime>2017-05-03T01:37:17+02:00</CreatedDateTime>
<LastUpdatedDateTime>2017-05-03T01:37:17+02:00</LastUpdatedDateTime>
</ArticleBalance>
<ArticleBalance>
<ArticleNumber>5300311</ArticleNumber>
<ArticleName>ADB ABX-2720W HD dekoder</ArticleName>
<PhysicalBalance>5896.00</PhysicalBalance>
<AllocatedBalance>0.00</AllocatedBalance>
<InOrderBalance>0.00</InOrderBalance>
<FreeBalance>5896.00</FreeBalance>
<CreatedDateTime>2017-05-03T01:37:17+02:00</CreatedDateTime>
<LastUpdatedDateTime>2017-05-03T01:37:17+02:00</LastUpdatedDateTime>
</ArticleBalance>
<ArticleBalance>
<ArticleNumber>5300352</ArticleNumber>
<ArticleName>ADB ABX-2720WX PVR dekoder</ArticleName>
<PhysicalBalance>758.00</PhysicalBalance>
<AllocatedBalance>0.00</AllocatedBalance>
<InOrderBalance>0.00</InOrderBalance>
<FreeBalance>758.00</FreeBalance>
<CreatedDateTime>2017-05-03T01:37:17+02:00</CreatedDateTime>
<LastUpdatedDateTime>2017-05-03T01:37:17+02:00</LastUpdatedDateTime>
</ArticleBalance>
<ArticleBalance>
<ArticleNumber>5300741</ArticleNumber>
<ArticleName>Altibox emballasje for rekit Mellomstor</ArticleName>
<PhysicalBalance>5484.00</PhysicalBalance>
<AllocatedBalance>0.00</AllocatedBalance>
<InOrderBalance>0.00</InOrderBalance>
<FreeBalance>5484.00</FreeBalance>
<CreatedDateTime>2017-05-03T01:37:17+02:00</CreatedDateTime>
<LastUpdatedDateTime>2017-05-03T01:37:17+02:00</LastUpdatedDateTime>
</ArticleBalance>
<ArticleBalance>
<ArticleNumber>5301761</ArticleNumber>
<ArticleName>Altibox WifiPluss Installasjon</ArticleName>
<PhysicalBalance>720.00</PhysicalBalance>
<AllocatedBalance>0.00</AllocatedBalance>
<InOrderBalance>0.00</InOrderBalance>
<FreeBalance>720.00</FreeBalance>
<CreatedDateTime>2017-05-03T01:37:17+02:00</CreatedDateTime>
<LastUpdatedDateTime>2017-05-03T01:37:17+02:00</LastUpdatedDateTime>
</ArticleBalance>
<ArticleBalance>
<ArticleNumber>5300531</ArticleNumber>
<ArticleName>ZyXEL strømforsyning til hjemm</ArticleName>
<PhysicalBalance>211.00</PhysicalBalance>
<AllocatedBalance>0.00</AllocatedBalance>
<InOrderBalance>0.00</InOrderBalance>
<FreeBalance>211.00</FreeBalance>
<CreatedDateTime>2017-05-03T01:37:17+02:00</CreatedDateTime>
<LastUpdatedDateTime>2017-05-03T01:37:17+02:00</LastUpdatedDateTime>
</ArticleBalance>
</ArticleBalanceSet>
</GetArticleBalanceResponse>
Get stock balance and info for one article
URL
GET https://api.bring.com/warehousing/api/v1/articlebalance/{customerId}/{articleNo}
Request parameters
URI param | Type | Description |
---|---|---|
articleNo |
string |
Required |
customerId |
string |
Required |
Responses
HTTP status code 200
Media type: application/json
{
"ResponseProperties": {
"SchemaVersion": 1,
"Locale": "en",
"DateAndTimes": {
"value": 1504472821784,
"subClass": "RESPONSE_DATE"
}
},
"ArticleBalanceSet": {
"ArticleBalance": [
{
"ArticleNumber": "5300311",
"ArticleName": "HD dekoder",
"PhysicalBalance": 5896,
"AllocatedBalance": 0,
"InOrderBalance": 0,
"FreeBalance": 5896,
"CreatedDateTime": "2017-05-03T01:37:17+02:00",
"LastUpdatedDateTime": "2017-05-03T01:37:17+02:00"
}
]
}
}
Media type: application/xml
<GetArticleBalanceResponse xmlns="http://api.bring.com/po">
<ResponseProperties>
<SchemaVersion>1</SchemaVersion>
<Locale>en</Locale>
<DateAndTimes subClass="ResponseDate">2017-06-01T22:42:28.169+02:00</DateAndTimes>
</ResponseProperties>
<ArticleBalanceSet>
<ArticleBalance>
<ArticleNumber>5300311</ArticleNumber>
<ArticleName>HD dekoder</ArticleName>
<PhysicalBalance>5896.00</PhysicalBalance>
<AllocatedBalance>0.00</AllocatedBalance>
<InOrderBalance>0.00</InOrderBalance>
<FreeBalance>5896.00</FreeBalance>
<CreatedDateTime>2017-05-03T01:37:17+02:00</CreatedDateTime>
<LastUpdatedDateTime>2017-05-03T01:37:17+02:00</LastUpdatedDateTime>
</ArticleBalance>
</ArticleBalanceSet>
</GetArticleBalanceResponse>
Get stock balance and info for all articles matching search string
URL
GET https://api.bring.com/warehousing/api/v1/articlebalance/info/{customerId}/{articleSearchString}
Request parameters
URI param | Type | Description |
---|---|---|
articleSearchString |
string |
Required |
customerId |
string |
Required |
Responses
HTTP status code 200
Media type: application/json
{
"ResponseProperties": {
"SchemaVersion": 1,
"Locale": "en",
"DateAndTimes": {
"value": 1504472727123,
"subClass": "RESPONSE_DATE"
}
},
"ArticleBalanceSet": {
"ArticleBalance": [
{
"ArticleNumber": "5300311",
"ArticleName": "HD dekoder",
"PhysicalBalance": 5896,
"AllocatedBalance": 0,
"InOrderBalance": 0,
"FreeBalance": 5896,
"CreatedDateTime": "2017-05-03T01:37:17+02:00",
"LastUpdatedDateTime": "2017-05-03T01:37:17+02:00"
},
{
"ArticleNumber": "5300601",
"ArticleName": "HDMI 2m M-M",
"PhysicalBalance": 887,
"AllocatedBalance": 0,
"InOrderBalance": 0,
"FreeBalance": 887,
"CreatedDateTime": "2017-05-03T01:37:17+02:00",
"LastUpdatedDateTime": "2017-05-03T01:37:17+02:00"
}
]
}
}
Media type: application/xml
<GetArticleBalanceResponse xmlns="http://api.bring.com/po">
<ResponseProperties>
<SchemaVersion>1</SchemaVersion>
<Locale>en</Locale>
<DateAndTimes subClass="ResponseDate">2017-06-01T22:46:43.614+02:00</DateAndTimes>
</ResponseProperties>
<ArticleBalanceSet>
<ArticleBalance>
<ArticleNumber>5300311</ArticleNumber>
<ArticleName>HD dekoder</ArticleName>
<PhysicalBalance>5896.00</PhysicalBalance>
<AllocatedBalance>0.00</AllocatedBalance>
<InOrderBalance>0.00</InOrderBalance>
<FreeBalance>5896.00</FreeBalance>
<CreatedDateTime>2017-05-03T01:37:17+02:00</CreatedDateTime>
<LastUpdatedDateTime>2017-05-03T01:37:17+02:00</LastUpdatedDateTime>
</ArticleBalance>
<ArticleBalance>
<ArticleNumber>5300601</ArticleNumber>
<ArticleName>HDMI 2m M-M</ArticleName>
<PhysicalBalance>887.00</PhysicalBalance>
<AllocatedBalance>0.00</AllocatedBalance>
<InOrderBalance>0.00</InOrderBalance>
<FreeBalance>887.00</FreeBalance>
<CreatedDateTime>2017-05-03T01:37:17+02:00</CreatedDateTime>
<LastUpdatedDateTime>2017-05-03T01:37:17+02:00</LastUpdatedDateTime>
</ArticleBalance>
</ArticleBalanceSet>
</GetArticleBalanceResponse>
List error codes
URL
GET https://api.bring.com/warehousing/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>