Skip to main content

Pull order/article

You are able to extract detailed order information from our warehouse while the orders are being processed. Further, the API provides information about articles in stock, with methods for retrieving information about single items or configurable list of items.

Authentication

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

Formats

REST XML/JSON and SOAP over HTTP. Warehousing API has several interfaces (SOAP and XML/JSON). Choose the option that fits your needs best (see table below). The XML/JSON 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.

Error handling

When using the Warehousing API, 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.

Endpoints

Base URL
                    https://api.bring.com/po/api/v1
                
Usage Method Endpoint
Get order information GET /order/{customerId}/{orderId}
List order items GET /items/{customerId}/{orderId}
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

Get order information

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

Get all information on a given order.

Request parameters

URI param Type Description
customerId string Required
orderId string Required

Responses

HTTP status code 200

Complete order information including order items.

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

List order items

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

List all item lines on an order.

Request parameters

URI param Type Description
customerId string Required
orderId string Required

Responses

HTTP status code 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"
}

Get stock balance and info for all articles

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

Request parameters

URI param Type Description
customerId string Required

Responses

HTTP status code 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

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

Request parameters

URI param Type Description
articleNo string Required
customerId string Required

Responses

HTTP status code 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

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

Request parameters

URI param Type Description
articleSearchString string Required
customerId string Required

Responses

HTTP status code 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

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

Responses

HTTP status code 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"
        }
    ]
}
comments powered by Disqus