Bring

developer

Order Management API

Introduction

There are different customer types in Order Management and depending on what kind of customer you are setts the usage pattern for Order Management API.

This is a step-by-step guide on how to use the API.

A typical usage pattern for an Warehousing cutomer type is to create an order in Order Management that will go to the correct warehouse for picking, packing and sending. Then follow up with creating a packing list from the warehouse with transport information. All steps can be followed in Order Management.

An other usage pattern is for an purchase order customer that create purchase orders and lets all of his suppliers get the order from Order Management. The suppliers will check whether a customer is a Order Management customer. Follow up with creating a packing list with transport information. All events and status changes will go back to purchase order owner.

Order Management has several interfaces (SOAP and XML/JSON). Choose the option that fits your needs best (see table below). The SOAP interface is the core interface with complete functionality.

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.

SOAP

Versioning

Order Management makes an effort to always be backwards compatible regarding data format for requests and responses of the Web Service. To achieve this, a SchemaVersion element is used in the request, indicating which version the client is on and what data-format the client expects in the result.

We make an effort not to return new elements in the response when an old schema version is specified. When changes in the schema are made, the SchemaVersion is incremented by one. The new schema is used at the same endpoint URL as before and uses the same namespace for its XML elements. A TraceMessage element (info message) in the response is added to inform the client that its schema should be updated. Old schema versions might in the future be unsupported.

Regarding the XML API (not Web Services), an XML Schema is not used at all. Therefore, clients of the XML API are expected to handle new elements that appear. Nevertheless, the response will be backwards compatible in the sense that elements are not renamed or deleted.

WSDL

https://api.bring.com/po/api/ws/purchaseorder-v1.wsdl

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.

Authentication

The Order Management API requires authentication for all its endpoints. See the getting started guide on authentication if you’re not sure what this means.

Header Example Comment
X-MyBring-API-Uid john.doe@example.com Mybring login ID
X-MyBring-API-Key 1234abc-abcd-1234-5678-abcd1234abcd Mybring login’s API key
X-Bring-Client-URL https://example.com/ A URL that sort of identifies where you’re using the APIs.

Those headers must be set for all endpoints documented below.

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
GET /order/{customerId}/{orderId} List order information
POST /order Send an order
GET /items/{customerId}/{orderId} List order items
GET /packaginglist/{customerId}/{orderId} List packaging list for order
POST /packaginglist Add packaging list
GET /senderStatus/{customerId}/{orderId} Get status for order
POST /event Create TMSEvents
POST /articlebalance Create or update article balance list
GET /articlebalance/{customerId} Get stock balance and info for all articles
GET /articlebalance/{customerId}/{articleNo} Get stock balance and info for one article
GET /articlebalance/info/{customerId}/{articleSearchString} Get stock balance and info for all articles matching search string
GET /errorCodes List error codes

Check if customer is valid for order management

Check if a given customer number is an valid Order Management customer.

URL

https://api.bring.com/po/api/v1/purchaseorderCustomer/{customerId}

Request params

URI parameter Type Description
customerId string

Required.

Possible values

Response

Success (200)

Returns true if given customer is a valid for order management.

<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>

{
  "ResponseProperties": {
    "SchemaVersion": 1,
    "Locale": "en",
    "DateAndTimes": {
      "value": 1504473107935,
      "subClass": "RESPONSE_DATE"
    }
  },
  "IsPurchaseOrderCustomer": true
}

List order information

Get all information on a given order.

URL

https://api.bring.com/po/api/v1/order/{customerId}/{orderId}

Request params

URI parameter Type Description
customerId string

Required.

Possible values
orderId string

Required.

Possible values

Response

Success (200)

Complete order information including order items.

<GetPurchaseOrderResponse xmlns="http://api.bring.com/po">
    <ResponseProperties>
        <SchemaVersion>1</SchemaVersion>
        <Locale>en</Locale>
        <DateAndTimes subClass="ResponseDate">2017-06-01T22:29:24.248+02:00</DateAndTimes>
    </ResponseProperties>
    <PurchaseOrderSet updateIndicator="Original">
        <PurchaseOrder orderId="12346789">
            <SenderStatus>OPEN</SenderStatus>
            <OrderStatus>EDIIMPORTED</OrderStatus>
            <Reference>
                <ReferenceNo>12346789</ReferenceNo>
                <ReferenceType>ON</ReferenceType>
                <Text>Buyers order number</Text>
            </Reference>
            <Reference>
                <ReferenceNo>987654321</ReferenceNo>
                <ReferenceType>BC</ReferenceType>
                <Text>Buyer's contract number</Text>
            </Reference>
            <DateAndTimes subClass="DocumentDate">2015-05-26T16:00:49.248+02:00</DateAndTimes>
            <TermsOfDelivery>
                <TODConditionCode>FCA</TODConditionCode>
                <TODConditionCodeList>Incoterms</TODConditionCodeList>
                <TODLocation/>
            </TermsOfDelivery>
        </PurchaseOrder>
        <TransportLeg>
            <TransportLeg>20</TransportLeg>
            <ModeOfTransport>3</ModeOfTransport>
            <MeansOfTransport/>
            <Location locationId="3007" subClass="StartLocation">
                <LocationName>DRAMMEN</LocationName>
                <CountryCode>NO</CountryCode>
            </Location>
            <Location locationId="4035" subClass="EndLocation">
                <LocationName>STAVANGER</LocationName>
                <CountryCode>NO</CountryCode>
            </Location>
        </TransportLeg>
        <Party idType="" partyId="1219" subClass="DeliveryParty">
            <Name>Some place</Name>
            <VATNo/>
            <Address subClass="PostalAddress">
                <StateOrRegion/>
            </Address>
            <Address subClass="PhysicalAddress">
                <PostalCode>3115 JG</PostalCode>
                <City>Schiedam</City>
                <StateOrRegion/>
                <CountryCode>NL</CountryCode>
                <Street>Aasta Hansteen</Street>
            </Address>
            <Contact>
                <ContactName>Aasta Hansteen</ContactName>
            </Contact>
        </Party>
        <Party idType="" partyId="1000" subClass="OrderingParty">
            <Name>Firma AS</Name>
            <VATNo/>
            <Address subClass="PostalAddress">
                <StateOrRegion/>
            </Address>
            <Address subClass="PhysicalAddress">
                <PostalCode>4035</PostalCode>
                <City>STAVANGER</City>
                <StateOrRegion/>
                <CountryCode>NO</CountryCode>
                <AddressLine>veien 250</AddressLine>
            </Address>
            <Contact>
                <ContactName>Person 1</ContactName>
                <PhoneNo>person1@sgmail.com</PhoneNo>
            </Contact>
            <PlantId>1000</PlantId>
        </Party>
        <Party idType="" partyId="LEV-0001088347" subClass="Supplier">
            <Name>TEST AS</Name>
            <VATNo/>
            <Address subClass="PostalAddress">
                <StateOrRegion/>
            </Address>
            <Address subClass="PhysicalAddress">
                <PostalCode>3007</PostalCode>
                <City>DRAMMEN</City>
                <StateOrRegion/>
                <CountryCode>NO</CountryCode>
                <AddressLine>Frydenlund Industriområde Lier, Vit</AddressLine>
            </Address>
            <Contact/>
            <PlantId/>
        </Party>
        <OrderLineSet>
            <OrderItem articleLineId="10">
                <ArticleQuantity>1</ArticleQuantity>
                <RemainingArticleQuantity>1</RemainingArticleQuantity>
                <Description>
                    <Text>Software tool</Text>
                    <Usage/>
                </Description>
                <DateAndTimes subClass="DeliveryDateRequested">2015-06-01T12:00:00+02:00</DateAndTimes>
                <ArticleMonetaryAmounts>
                    <UnitPrice currencyIdentificationCode="">0.00</UnitPrice>
                </ArticleMonetaryAmounts>
            </OrderItem>
        </OrderLineSet>
    </PurchaseOrderSet>
</GetPurchaseOrderResponse>

Send an order

Send an order to Order Management. There are different types of order supported in Order Management.

  • Order / SalesOrder (as an pickorder for Warehousing)
    • Order Management act as an order repository.
    • When Warehousing functionality Order Management sends it to Warhousing system for picking and delivery.
  • 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

https://api.bring.com/po/api/v1/order

Request params

Query parameter Type Description
CustomerNo string

Required. Customer Number which Bring has provided. It cannot be demo customer number.


Example: 10000000000
DateAndTimes subClass DocumentDate dateTime

Required. The date on which order is booked.


Example: 22.01.2017 11:36:22
updateIndicator string

Required. Type of order data. Original, Update or Delete


Example: Original
Party/subClass OrderingParty string

Required. Details of sender. Must have Name, Street, City, CountryCode.
Party/subClass DeliveryParty string

Required. Details of recipient. Must have Name, Street, City, CountryCode.
Party/subClass Supplier string

Optional. Details of supplier. Must have Name, Street, City, CountryCode if used.
OrderLineSet sequence

Required. Set of order items.
OrderItem articleLineId integer

Required. Line id for this order line.


Example: 10
ArticleId string

Optional. Article number or id.


Example: 123-4000
ArticleQuantity float

Required. Quantity ordered.


Example: 2.0
Description string

Required. Article description / name.


Example: Spear parts
DateAndTimes subClass DeliveryDateRequested dateTime

Required. The date on which order is requested delivered.


Example: 22.01.2017 11:36:22

Request body

<CreatePurchaseOrderRequest>
  <RequestProperties>
    <SchemaVersion>?</SchemaVersion>
    <Locale>?</Locale>
    <DateAndTimes subClass="?">?</DateAndTimes>
  </RequestProperties>
  <CustomerNo>?</CustomerNo>
  <!--Optional:-->
  <PurchaseOrderSet updateIndicator="?">
    <PurchaseOrder orderId="?">
      <!--Optional:-->
      <SenderStatus>?</SenderStatus>
      <!--Optional:-->
      <OrderStatus>?</OrderStatus>
      <!--1 or more repetitions:-->
      <Reference>
        <ReferenceNo>?</ReferenceNo>
        <ReferenceType>?</ReferenceType>
        <Text>?</Text>
      </Reference>
      <DateAndTimes subClass="?">?</DateAndTimes>
      <TermsOfDelivery>
        <TODConditionCode>?</TODConditionCode>
        <TODConditionCodeList>?</TODConditionCodeList>
        <TODLocation>?</TODLocation>
      </TermsOfDelivery>
    </PurchaseOrder>
    <TransportLeg>
      <TransportLeg>?</TransportLeg>
      <ModeOfTransport>?</ModeOfTransport>
      <MeansOfTransport>
        <MeansOfTransportId/>
        <Name>?</Name>
      </MeansOfTransport>
      <!--1 or more repetitions:-->
      <Location locationId="?" subClass="?">
        <LocationName>?</LocationName>
        <CountryCode>?</CountryCode>
      </Location>
    </TransportLeg>
    <!--1 or more repetitions:-->
    <Party idType="?" partyId="?" subClass="?">
      <Name>?</Name>
      <!--Optional:-->
      <VATNo>?</VATNo>
      <Address subClass="?">
        <!--Optional:-->
        <PostalCode>?</PostalCode>
        <City>?</City>
        <!--Optional:-->
        <StateOrRegion>?</StateOrRegion>
        <CountryCode>?</CountryCode>
        <!--Optional:-->
        <AddressLine>?</AddressLine>
        <!--Optional:-->
        <Street>?</Street>
      </Address>
      <Contact>
        <ContactName>?</ContactName>
        <PhoneNo>?</PhoneNo>
        <!--Optional:-->
        <TelefaxNo>?</TelefaxNo>
        <!--Optional:-->
        <CellPhoneNo>?</CellPhoneNo>
        <!--Optional:-->
        <Mail>?</Mail>
      </Contact>
      <!--Optional:-->
      <PlantId>?</PlantId>
    </Party>
    <!--1 or more repetitions:-->
    <OrderLineSet orderLineId="?">
      <!--1 or more repetitions:-->
      <OrderItem articleLineId="?">
        <ArticleId>?</ArticleId>
        <ArticleQuantity>?</ArticleQuantity>
        <!--Optional:-->
        <RemainingArticleQuantity>?</RemainingArticleQuantity>
        <Description>
          <Text>?</Text>
          <Usage>?</Usage>
        </Description>
        <!--1 or more repetitions:-->
        <DateAndTimes subClass="?">?</DateAndTimes>
        <ArticleMonetaryAmounts>
          <UnitPrice currencyIdentificationCode="?">?</UnitPrice>
        </ArticleMonetaryAmounts>
      </OrderItem>
    </OrderLineSet>
    <!--1 or more repetitions:-->
    <DateAndTimes subClass="?">?</DateAndTimes>
    <!--Zero or more repetitions:-->
    <TransportOrder>
      <ConsignmentId>?</ConsignmentId>
      <!--Optional:-->
      <PackageId>?</PackageId>
      <!--Zero or more repetitions:-->
      <PackingListSet orderLineId="?">
        <!--Zero or more repetitions:-->
        <PackingListItem articleLineId="?">
          <ArticleQuantity>?</ArticleQuantity>
        </PackingListItem>
      </PackingListSet>
      <!--Zero or more repetitions:-->
      <PackingListAdditionalSet>
        <!--Zero or more repetitions:-->
        <PackingListAdditionalItem>
          <ArticleId>?</ArticleId>
          <ArticleQuantity>?</ArticleQuantity>
          <!--Optional:-->
          <Description>
            <Text>?</Text>
            <Usage>?</Usage>
          </Description>
          <!--Optional:-->
          <DateAndTimes subClass="?">?</DateAndTimes>
          <!--Optional:-->
          <ArticleMonetaryAmounts>
            <UnitPrice currencyIdentificationCode="?">?</UnitPrice>
          </ArticleMonetaryAmounts>
        </PackingListAdditionalItem>
      </PackingListAdditionalSet>
    </TransportOrder>
  </PurchaseOrderSet>
</CreatePurchaseOrderRequest>

Response

Success (200)

Successfully created a order.

List order items

List all item lines on an order.

URL

https://api.bring.com/po/api/v1/items/{customerId}/{orderId}

Request params

URI parameter Type Description
customerId string

Required.

Possible values
orderId string

Required.

Possible values

Response

Success (200)

List of order items.

<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>

{
  "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"
}

List packaging list for order

List all packaging list information for this order. One order can have multiple packaging lists.

URL

https://api.bring.com/po/api/v1/packaginglist/{customerId}/{orderId}

Request params

URI parameter Type Description
customerId string

Required.

Possible values
orderId string

Required.

Possible values

Response

Success (200)

List of packaging list for given order, if any.

<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>

{
  "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
          }
        ]
      }
    ]
  }
}

Add packaging list

When an order have been picked and sent, add packing list on order with transport information.

URL

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>

Response

Success (200)

Successfully added packaging list.

Get status for order

Check status for an order. Open when not fully delivered or locked when fully delivered.

URL

https://api.bring.com/po/api/v1/senderStatus/{customerId}/{orderId}

Request params

URI parameter Type Description
customerId string

Required.

Possible values
orderId string

Required.

Possible values

Response

Success (200)

Open or Locked.

<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>

    
        1
        en
        2017-06-02T23:00:32.972+02:00
    
    OPEN

Create TMSEvents

Create tracking events on shipments associated with orders in Order Management.

URL

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>

Response

Success (200)

Successfully created a new resource

Create or update article balance list

URL

https://api.bring.com/po/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>

Response

Success (200)

Successfully created balance list

Get stock balance and info for all articles

URL

https://api.bring.com/po/api/v1/articlebalance/{customerId}

Request params

URI parameter Type Description
customerId string

Required.

Possible values

Response

Success (200)

<?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>

{
  "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"
      }
    ]
  }
}

Get stock balance and info for one article

URL

https://api.bring.com/po/api/v1/articlebalance/{customerId}/{articleNo}

Request params

URI parameter Type Description
customerId string

Required.

Possible values
articleNo string

Required.

Possible values

Response

Success (200)

<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>
{
  "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"
      }
    ]
  }
}

Get stock balance and info for all articles matching search string

URL

https://api.bring.com/po/api/v1/articlebalance/info/{customerId}/{articleSearchString}

Request params

URI parameter Type Description
customerId string

Required.

Possible values
articleSearchString string

Required.

Possible values

Response

Success (200)

<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>
{
  "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"
      }
    ]
  }
}

List error codes

URL

https://api.bring.com/po/api/v1/errorCodes

Response

Success (200)

Dynamic list of error codes used in the solution.

<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>
{
    "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"
        }
    ]
}