Skip to main content

Order Management API

Order Management is a solution that lets integrated customers, their suppliers and Bring exchange order level information across the life cycle of customers’ orders. Suppliers can use the API to fetch order details, and to create packaging lists with transport details. Bring collects, structures and enriches the order information with transport and event details, and makes it available to the customer.

Authentication

To integrate with the Bring APIs, you will need a Mybring user account with an API key. Information about prerequisites and authentication headers can be found on the general API Getting Started page.

Formats

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

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

Endpoints

Base URL 
https://api.bring.com/po/
TypeUsage Method Endpoint
REST Get Order GET /api/v1/omorder/{custno}/{ordno}
Packaging list POST /api/v1/packaginglist
SOAP Get Purchase Order POST /api/ws
Create Packaging List POST /api/ws
Create Transport Order POST /api/ws

OpenAPI document

https://www.qa.mybring.com/po/v2/api-docs

Get Order

get 
                  https://api.bring.com/po/api/v1/omorder/{custno}/{ordno}

Get Order by order number and customer number

Request

header parameters

X-Mybring-API-Uid
Required
Description
Mybring login ID
Type
string
X-Mybring-API-Key
Required
Description
Mybring user's API key
Type
string

path parameters

ordno
Required
Description
Order number
Type
string
custno
Required
Description
Customer number
Type
string

Responses

200 Found the Order

Schema

Media type: application/json

object
array of objects
date
string <date-time>
dstIndicator
string
subClass
string
Enum
DOCUMENT_DATE
MESSAGE_DATE
TRANSPORT_ORDER_DATE
ORDER_DATE
ORDER_DELIVERY_DATE
ORDER_DELIVERY_DATE_REQUESTED
ORDER_DELIVERY_DATE_ACTUAL
ORDER_DELIVERY_DATE_ESTIMATED
DEPARTURE_DATE
DEPARTURE_DATE_REQUESTED
DEPARTURE_DATE_ACTUAL
DEPARTURE_DATE_ESTIMATED
DELIVERY_DATE
DELIVERY_DATE_REQUESTED
DELIVERY_DATE_ACTUAL
DELIVERY_DATE_ESTIMATED
ARRIVAL_DATE
ARRIVAL_DATE_ACTUAL
ARRIVAL_DATE_ESTIMATED
LOADING_DATE
PICKUP_DATE
PICKUP_DATE_ACTUAL
PICKUP_DATE_EARLIEST
PICKUP_DATE_LATEST
DELIVERY_DATE_EARLIEST
DELIVERY_DATE_LATEST
DEAD_LINE
UPDATED_DATE
EXPIRATION_DATE
RECEIVED_DATE
RECEIVED_DATE_REQUESTED
RECEIVED_DATE_ESTIMATED
FINISHED_DATE
PRODUCTION_DATE
FREEZE_DATE
EFFECTIVE_DATE
AVAILABILITY_DATE_START
AVAILABILITY_DATE_END
ACCEPTED_DATE
time
string <date-time>
timeZone
string
Required
object
object
object
getidType
string
value
string
codAmount
number <float>
controlDigit
number <float>
kid
string
message
string
Required
array of objects
date
string <date-time>
dstIndicator
string
subClass
string
Enum
DOCUMENT_DATE
MESSAGE_DATE
TRANSPORT_ORDER_DATE
ORDER_DATE
ORDER_DELIVERY_DATE
ORDER_DELIVERY_DATE_REQUESTED
ORDER_DELIVERY_DATE_ACTUAL
ORDER_DELIVERY_DATE_ESTIMATED
DEPARTURE_DATE
DEPARTURE_DATE_REQUESTED
DEPARTURE_DATE_ACTUAL
DEPARTURE_DATE_ESTIMATED
DELIVERY_DATE
DELIVERY_DATE_REQUESTED
DELIVERY_DATE_ACTUAL
DELIVERY_DATE_ESTIMATED
ARRIVAL_DATE
ARRIVAL_DATE_ACTUAL
ARRIVAL_DATE_ESTIMATED
LOADING_DATE
PICKUP_DATE
PICKUP_DATE_ACTUAL
PICKUP_DATE_EARLIEST
PICKUP_DATE_LATEST
DELIVERY_DATE_EARLIEST
DELIVERY_DATE_LATEST
DEAD_LINE
UPDATED_DATE
EXPIRATION_DATE
RECEIVED_DATE
RECEIVED_DATE_REQUESTED
RECEIVED_DATE_ESTIMATED
FINISHED_DATE
PRODUCTION_DATE
FREEZE_DATE
EFFECTIVE_DATE
AVAILABILITY_DATE_START
AVAILABILITY_DATE_END
ACCEPTED_DATE
time
string <date-time>
timeZone
string
externalOrderType
string
array of objects
codeListAgencyIdentifier
string
codeListIdentifier
string
object
codeListAgencyIdentifier
string
codeListIdentifier
string
name
string
value
string
name
string
array of objects
code
string
sequence
string
value
string
usageCode
string
idType
string
orderId
string
orderStatus
string
object
responseTypeCoded
Required
string
Enum
OTHER
ACCEPTED
ACCEPTED_CONTENTS_REJECTED
ACCEPTED_WITH_AMENDMENT
ACCEPTED_WITH_AMENDMENT_IN_DETAIL_SECTION
ACCEPTED_WITH_AMENDMENT_IN_HEADING_SECTION
ACCEPTED_WITH_AMENDMENT_NO_CONFIRMATION_IS_REQUIRED
ACCEPTED_WITHOUT_AMENDMENT
ACCEPTED_WITHOUT_RESERVES
ACCEPTED_WITH_RESERVES
ACKNOWLEDGE_NO_DETAIL_OR_CHANGE
ACKNOWLEDGE_WITH_DETAIL_AND_CHANGE
ACKNOWLEDGE_WITH_DETAIL_NO_CHANGE
ADVICE_WITH_DETAILS
ADVICE_WITHOUT_DETAILS
AGREED
ALREADY_DELIVERED
APPROVED_AS_AMENDED
APPROVED_AS_SUBMITTED
AUCTION_HELD
AUTHORITY_DECLINED
AUTHORITY_TO_DEDUCT
BUYER_CLAIMS_AGAINST_INVOICE
CHARGE_BACK_TO_SELLER
CHECKED
CONDITIONALLY_ACCEPTED
COUNTERSUED
COURT_ACTION_DISMISSED
DIRECT_DOCUMENTARY_CREDIT_COLLECTION
FINAL_RESPONSE
GROUPED_CREDIT_ADVICES
GROUPED_DEBIT_ADVICES
INITIAL_CLAIM_RECEIVED
INTERIM_RESPONSE
LEGAL_ACTION_PURSUED
MEETING_HELD
NOT_ACCEPTED
NOT_ACCEPTED_PROVISIONAL
NOT_CHECKED
NOT_IN_PROCESS
NOT_PROCESSED
ORIGINAL_CONFIRMATION_OF_ORIGINAL_ANNOUNCEMENT
ORIGINAL_CONFIRMATION_OF_REVISED_ANNOUNCEMENT
PAYMENT_DENIED
PENDING
PENDING_AWAITING_ADDITIONAL_MATERIAL
PENDING_AWAITING_REVIEW
PENDING_INCOMPLETE
REJECTED
REJECTED_DUPLICATE
REJECTED_NO_DETAIL
REJECTED_NOT_AS_AGREED
REJECTED_RESUBMIT_WITH_CORRECTIONS
REJECTED_VIOLATES_INDUSTRY_PRACTICE
REJECTED_WITH_COUNTER_OFFER
REJECT_ITEM_CHANGE
REJECT_WITH_DETAIL
REJECT_WITH_EXCEPTION_DETAIL_ONLY
RESULT_DISPUTED
RESULT_OPPOSED
RESULT_SET_ASIDE
SELLER_REJECTS_DISPUTE
SELLER_WILL_ISSUE_CREDIT_NOTE
SETTLEMENT
SINGLE_CREDIT_ITEM_OF_A_GROUP
SINGLE_DEBIT_ITEM_OF_A_GROUP
UNDER_INVESTIGATION
responseTypeCodedOther
string
array of objects
codeListAgencyIdentifier
string
codeListIdentifier
string
name
string
object
date
string <date-time>
dstIndicator
string
subClass
string
Enum
DOCUMENT_DATE
MESSAGE_DATE
TRANSPORT_ORDER_DATE
ORDER_DATE
ORDER_DELIVERY_DATE
ORDER_DELIVERY_DATE_REQUESTED
ORDER_DELIVERY_DATE_ACTUAL
ORDER_DELIVERY_DATE_ESTIMATED
DEPARTURE_DATE
DEPARTURE_DATE_REQUESTED
DEPARTURE_DATE_ACTUAL
DEPARTURE_DATE_ESTIMATED
DELIVERY_DATE
DELIVERY_DATE_REQUESTED
DELIVERY_DATE_ACTUAL
DELIVERY_DATE_ESTIMATED
ARRIVAL_DATE
ARRIVAL_DATE_ACTUAL
ARRIVAL_DATE_ESTIMATED
LOADING_DATE
PICKUP_DATE
PICKUP_DATE_ACTUAL
PICKUP_DATE_EARLIEST
PICKUP_DATE_LATEST
DELIVERY_DATE_EARLIEST
DELIVERY_DATE_LATEST
DEAD_LINE
UPDATED_DATE
EXPIRATION_DATE
RECEIVED_DATE
RECEIVED_DATE_REQUESTED
RECEIVED_DATE_ESTIMATED
FINISHED_DATE
PRODUCTION_DATE
FREEZE_DATE
EFFECTIVE_DATE
AVAILABILITY_DATE_START
AVAILABILITY_DATE_END
ACCEPTED_DATE
time
string <date-time>
timeZone
string
referenceNo
string
referenceType
string
text
string
array of objects
object
codeListAgencyIdentifier
string
codeListIdentifier
string
name
string
value
string
object
codeListAgencyIdentifier
string
codeListIdentifier
string
name
string
value
string
todlocation
string
object
otherDesc
string
topConditionCode
string
Enum
CASH
VISA
MASTERCARD
COD
NET30DAYS
NET15DAYS
NET14DAYS
NET10DAYS
VIPPS
OTHER
array of objects
array of objects
object
unitCode
string
value
number <float>
articleBatchNo
string
object
array of objects
object
unitCode
string
value
number <float>
array of objects
articleSerialNo
string
batchNo
string
array of objects
date
string <date-time>
dstIndicator
string
subClass
string
Enum
DOCUMENT_DATE
MESSAGE_DATE
TRANSPORT_ORDER_DATE
ORDER_DATE
ORDER_DELIVERY_DATE
ORDER_DELIVERY_DATE_REQUESTED
ORDER_DELIVERY_DATE_ACTUAL
ORDER_DELIVERY_DATE_ESTIMATED
DEPARTURE_DATE
DEPARTURE_DATE_REQUESTED
DEPARTURE_DATE_ACTUAL
DEPARTURE_DATE_ESTIMATED
DELIVERY_DATE
DELIVERY_DATE_REQUESTED
DELIVERY_DATE_ACTUAL
DELIVERY_DATE_ESTIMATED
ARRIVAL_DATE
ARRIVAL_DATE_ACTUAL
ARRIVAL_DATE_ESTIMATED
LOADING_DATE
PICKUP_DATE
PICKUP_DATE_ACTUAL
PICKUP_DATE_EARLIEST
PICKUP_DATE_LATEST
DELIVERY_DATE_EARLIEST
DELIVERY_DATE_LATEST
DEAD_LINE
UPDATED_DATE
EXPIRATION_DATE
RECEIVED_DATE
RECEIVED_DATE_REQUESTED
RECEIVED_DATE_ESTIMATED
FINISHED_DATE
PRODUCTION_DATE
FREEZE_DATE
EFFECTIVE_DATE
AVAILABILITY_DATE_START
AVAILABILITY_DATE_END
ACCEPTED_DATE
time
string <date-time>
timeZone
string
object
unitCode
string
value
number <float>
object
unitCode
string
value
number <float>
locked
string
object
unitCode
string
value
number <float>
parcelNumber
string
object
unitCode
string
value
number <float>
object
unitCode
string
value
number <float>
ssccno
string
warehouseArea
string
warehouseId
string
warehouseLocation
string
array of objects
codeListAgencyIdentifier
string
codeListIdentifier
string
name
string
value
string
articleLineId
string
object
object
object
currencyIdentificationCode
string
value
number <float>
object
currencyIdentificationCode
string
value
number <float>
object
currencyIdentificationCode
string
value
number <float>
taxType
string
object
reductionRate
string
object
date
string <date-time>
dstIndicator
string
subClass
string
Enum
DOCUMENT_DATE
MESSAGE_DATE
TRANSPORT_ORDER_DATE
ORDER_DATE
ORDER_DELIVERY_DATE
ORDER_DELIVERY_DATE_REQUESTED
ORDER_DELIVERY_DATE_ACTUAL
ORDER_DELIVERY_DATE_ESTIMATED
DEPARTURE_DATE
DEPARTURE_DATE_REQUESTED
DEPARTURE_DATE_ACTUAL
DEPARTURE_DATE_ESTIMATED
DELIVERY_DATE
DELIVERY_DATE_REQUESTED
DELIVERY_DATE_ACTUAL
DELIVERY_DATE_ESTIMATED
ARRIVAL_DATE
ARRIVAL_DATE_ACTUAL
ARRIVAL_DATE_ESTIMATED
LOADING_DATE
PICKUP_DATE
PICKUP_DATE_ACTUAL
PICKUP_DATE_EARLIEST
PICKUP_DATE_LATEST
DELIVERY_DATE_EARLIEST
DELIVERY_DATE_LATEST
DEAD_LINE
UPDATED_DATE
EXPIRATION_DATE
RECEIVED_DATE
RECEIVED_DATE_REQUESTED
RECEIVED_DATE_ESTIMATED
FINISHED_DATE
PRODUCTION_DATE
FREEZE_DATE
EFFECTIVE_DATE
AVAILABILITY_DATE_START
AVAILABILITY_DATE_END
ACCEPTED_DATE
time
string <date-time>
timeZone
string
object
date
string <date-time>
dstIndicator
string
subClass
string
Enum
DOCUMENT_DATE
MESSAGE_DATE
TRANSPORT_ORDER_DATE
ORDER_DATE
ORDER_DELIVERY_DATE
ORDER_DELIVERY_DATE_REQUESTED
ORDER_DELIVERY_DATE_ACTUAL
ORDER_DELIVERY_DATE_ESTIMATED
DEPARTURE_DATE
DEPARTURE_DATE_REQUESTED
DEPARTURE_DATE_ACTUAL
DEPARTURE_DATE_ESTIMATED
DELIVERY_DATE
DELIVERY_DATE_REQUESTED
DELIVERY_DATE_ACTUAL
DELIVERY_DATE_ESTIMATED
ARRIVAL_DATE
ARRIVAL_DATE_ACTUAL
ARRIVAL_DATE_ESTIMATED
LOADING_DATE
PICKUP_DATE
PICKUP_DATE_ACTUAL
PICKUP_DATE_EARLIEST
PICKUP_DATE_LATEST
DELIVERY_DATE_EARLIEST
DELIVERY_DATE_LATEST
DEAD_LINE
UPDATED_DATE
EXPIRATION_DATE
RECEIVED_DATE
RECEIVED_DATE_REQUESTED
RECEIVED_DATE_ESTIMATED
FINISHED_DATE
PRODUCTION_DATE
FREEZE_DATE
EFFECTIVE_DATE
AVAILABILITY_DATE_START
AVAILABILITY_DATE_END
ACCEPTED_DATE
time
string <date-time>
timeZone
string
object
currencyIdentificationCode
string
value
number <float>
articleName
string
array of objects
value
string
object
unitCode
string
value
number <float>
array of objects
codeListAgencyIdentifier
string
codeListIdentifier
string
name
string
object
date
string <date-time>
dstIndicator
string
subClass
string
Enum
DOCUMENT_DATE
MESSAGE_DATE
TRANSPORT_ORDER_DATE
ORDER_DATE
ORDER_DELIVERY_DATE
ORDER_DELIVERY_DATE_REQUESTED
ORDER_DELIVERY_DATE_ACTUAL
ORDER_DELIVERY_DATE_ESTIMATED
DEPARTURE_DATE
DEPARTURE_DATE_REQUESTED
DEPARTURE_DATE_ACTUAL
DEPARTURE_DATE_ESTIMATED
DELIVERY_DATE
DELIVERY_DATE_REQUESTED
DELIVERY_DATE_ACTUAL
DELIVERY_DATE_ESTIMATED
ARRIVAL_DATE
ARRIVAL_DATE_ACTUAL
ARRIVAL_DATE_ESTIMATED
LOADING_DATE
PICKUP_DATE
PICKUP_DATE_ACTUAL
PICKUP_DATE_EARLIEST
PICKUP_DATE_LATEST
DELIVERY_DATE_EARLIEST
DELIVERY_DATE_LATEST
DEAD_LINE
UPDATED_DATE
EXPIRATION_DATE
RECEIVED_DATE
RECEIVED_DATE_REQUESTED
RECEIVED_DATE_ESTIMATED
FINISHED_DATE
PRODUCTION_DATE
FREEZE_DATE
EFFECTIVE_DATE
AVAILABILITY_DATE_START
AVAILABILITY_DATE_END
ACCEPTED_DATE
time
string <date-time>
timeZone
string
referenceNo
string
referenceType
string
text
string
articleSerialNo
string
articleStatus
string
array of objects
value
string
varianceCode
string
object
unitCode
string
value
number <float>
array of objects
date
string <date-time>
dstIndicator
string
subClass
string
Enum
DOCUMENT_DATE
MESSAGE_DATE
TRANSPORT_ORDER_DATE
ORDER_DATE
ORDER_DELIVERY_DATE
ORDER_DELIVERY_DATE_REQUESTED
ORDER_DELIVERY_DATE_ACTUAL
ORDER_DELIVERY_DATE_ESTIMATED
DEPARTURE_DATE
DEPARTURE_DATE_REQUESTED
DEPARTURE_DATE_ACTUAL
DEPARTURE_DATE_ESTIMATED
DELIVERY_DATE
DELIVERY_DATE_REQUESTED
DELIVERY_DATE_ACTUAL
DELIVERY_DATE_ESTIMATED
ARRIVAL_DATE
ARRIVAL_DATE_ACTUAL
ARRIVAL_DATE_ESTIMATED
LOADING_DATE
PICKUP_DATE
PICKUP_DATE_ACTUAL
PICKUP_DATE_EARLIEST
PICKUP_DATE_LATEST
DELIVERY_DATE_EARLIEST
DELIVERY_DATE_LATEST
DEAD_LINE
UPDATED_DATE
EXPIRATION_DATE
RECEIVED_DATE
RECEIVED_DATE_REQUESTED
RECEIVED_DATE_ESTIMATED
FINISHED_DATE
PRODUCTION_DATE
FREEZE_DATE
EFFECTIVE_DATE
AVAILABILITY_DATE_START
AVAILABILITY_DATE_END
ACCEPTED_DATE
time
string <date-time>
timeZone
string
array of objects
codeListAgencyIdentifier
string
codeListIdentifier
string
object
codeListAgencyIdentifier
string
codeListIdentifier
string
name
string
value
string
name
string
array of objects
code
string
sequence
string
value
string
usageCode
string
array of objects
codeListAgencyIdentifier
string
codeListIdentifier
string
object
codeListAgencyIdentifier
string
codeListIdentifier
string
name
string
value
string
name
string
array of objects
code
string
sequence
string
value
string
usageCode
string
idType
string
object
responseTypeCoded
Required
string
Enum
OTHER
ACCEPTED
ACCEPTED_CONTENTS_REJECTED
ACCEPTED_WITH_AMENDMENT
ACCEPTED_WITH_AMENDMENT_IN_DETAIL_SECTION
ACCEPTED_WITH_AMENDMENT_IN_HEADING_SECTION
ACCEPTED_WITH_AMENDMENT_NO_CONFIRMATION_IS_REQUIRED
ACCEPTED_WITHOUT_AMENDMENT
ACCEPTED_WITHOUT_RESERVES
ACCEPTED_WITH_RESERVES
ACKNOWLEDGE_NO_DETAIL_OR_CHANGE
ACKNOWLEDGE_WITH_DETAIL_AND_CHANGE
ACKNOWLEDGE_WITH_DETAIL_NO_CHANGE
ADVICE_WITH_DETAILS
ADVICE_WITHOUT_DETAILS
AGREED
ALREADY_DELIVERED
APPROVED_AS_AMENDED
APPROVED_AS_SUBMITTED
AUCTION_HELD
AUTHORITY_DECLINED
AUTHORITY_TO_DEDUCT
BUYER_CLAIMS_AGAINST_INVOICE
CHARGE_BACK_TO_SELLER
CHECKED
CONDITIONALLY_ACCEPTED
COUNTERSUED
COURT_ACTION_DISMISSED
DIRECT_DOCUMENTARY_CREDIT_COLLECTION
FINAL_RESPONSE
GROUPED_CREDIT_ADVICES
GROUPED_DEBIT_ADVICES
INITIAL_CLAIM_RECEIVED
INTERIM_RESPONSE
LEGAL_ACTION_PURSUED
MEETING_HELD
NOT_ACCEPTED
NOT_ACCEPTED_PROVISIONAL
NOT_CHECKED
NOT_IN_PROCESS
NOT_PROCESSED
ORIGINAL_CONFIRMATION_OF_ORIGINAL_ANNOUNCEMENT
ORIGINAL_CONFIRMATION_OF_REVISED_ANNOUNCEMENT
PAYMENT_DENIED
PENDING
PENDING_AWAITING_ADDITIONAL_MATERIAL
PENDING_AWAITING_REVIEW
PENDING_INCOMPLETE
REJECTED
REJECTED_DUPLICATE
REJECTED_NO_DETAIL
REJECTED_NOT_AS_AGREED
REJECTED_RESUBMIT_WITH_CORRECTIONS
REJECTED_VIOLATES_INDUSTRY_PRACTICE
REJECTED_WITH_COUNTER_OFFER
REJECT_ITEM_CHANGE
REJECT_WITH_DETAIL
REJECT_WITH_EXCEPTION_DETAIL_ONLY
RESULT_DISPUTED
RESULT_OPPOSED
RESULT_SET_ASIDE
SELLER_REJECTS_DISPUTE
SELLER_WILL_ISSUE_CREDIT_NOTE
SETTLEMENT
SINGLE_CREDIT_ITEM_OF_A_GROUP
SINGLE_DEBIT_ITEM_OF_A_GROUP
UNDER_INVESTIGATION
responseTypeCodedOther
string
object
object
unitCode
string
value
number <float>
object
unitCode
string
value
number <float>
object
unitCode
string
value
number <float>
array of objects
object
unitCode
string
value
integer <int32>
object
attributeCode
string
subClass
string
object
unitCode
string
value
integer <int32>
object
unitCode
string
value
number <float>
object
accountNo
string
array of objects
addressLine
array of strings
string
city
string
object
codeListAgencyIdentifier
string
codeListIdentifier
string
name
string
value
string
pobox
string
postOffice
string
postalCode
string
stateOrRegion
string
street
string
streetNo
string
subClass
string
Enum
PHYSICAL_ADDRESS
POSTAL_ADDRESS
zipcode
string
bankName
string
array of objects
cellPhoneNo
string
contactFunction
string
contactName
string
emailAddress
string
phoneNo
string
telefaxNo
string
webAddress
string
customsCreditNo
string
array of objects
codeListAgencyIdentifier
string
codeListIdentifier
string
object
codeListAgencyIdentifier
string
codeListIdentifier
string
name
string
value
string
name
string
array of objects
code
string
sequence
string
value
string
usageCode
string
idCodeList
string
Enum
CID
CNO
ENH
FMI
FNR
XDC
AMP
idType
string
name
string
partyId
string
array of objects
codeListAgencyIdentifier
string
codeListIdentifier
string
name
string
object
date
string <date-time>
dstIndicator
string
subClass
string
Enum
DOCUMENT_DATE
MESSAGE_DATE
TRANSPORT_ORDER_DATE
ORDER_DATE
ORDER_DELIVERY_DATE
ORDER_DELIVERY_DATE_REQUESTED
ORDER_DELIVERY_DATE_ACTUAL
ORDER_DELIVERY_DATE_ESTIMATED
DEPARTURE_DATE
DEPARTURE_DATE_REQUESTED
DEPARTURE_DATE_ACTUAL
DEPARTURE_DATE_ESTIMATED
DELIVERY_DATE
DELIVERY_DATE_REQUESTED
DELIVERY_DATE_ACTUAL
DELIVERY_DATE_ESTIMATED
ARRIVAL_DATE
ARRIVAL_DATE_ACTUAL
ARRIVAL_DATE_ESTIMATED
LOADING_DATE
PICKUP_DATE
PICKUP_DATE_ACTUAL
PICKUP_DATE_EARLIEST
PICKUP_DATE_LATEST
DELIVERY_DATE_EARLIEST
DELIVERY_DATE_LATEST
DEAD_LINE
UPDATED_DATE
EXPIRATION_DATE
RECEIVED_DATE
RECEIVED_DATE_REQUESTED
RECEIVED_DATE_ESTIMATED
FINISHED_DATE
PRODUCTION_DATE
FREEZE_DATE
EFFECTIVE_DATE
AVAILABILITY_DATE_START
AVAILABILITY_DATE_END
ACCEPTED_DATE
time
string <date-time>
timeZone
string
referenceNo
string
referenceType
string
text
string
subClass
string
Enum
DELIVERY_PARTY
ORDERING_PARTY
FREIGHT_PAYER
TRANSPORT_COMPANY
MESSAGE_RECIPIENT
MESSAGE_COPY_RECIPIENT
MESSAGE_SENDER
SUPPLIER
NOTIFY_PARTY
BUYER
SELLER
MANUFACTURER
PAYER
PERFORMING_UNIT
subPartyId
string
subPartyIdType
string
swiftCode
string
vatno
string
array of objects
codeListAgencyIdentifier
string
codeListIdentifier
string
name
string
value
string
array of objects
codeListAgencyIdentifier
string
codeListIdentifier
string
object
codeListAgencyIdentifier
string
codeListIdentifier
string
name
string
value
string
name
string
array of objects
code
string
sequence
string
value
string
usageCode
string
array of objects
idType
string
orderLineId
string
object
accountNo
string
array of objects
addressLine
array of strings
string
city
string
object
codeListAgencyIdentifier
string
codeListIdentifier
string
name
string
value
string
pobox
string
postOffice
string
postalCode
string
stateOrRegion
string
street
string
streetNo
string
subClass
string
Enum
PHYSICAL_ADDRESS
POSTAL_ADDRESS
zipcode
string
bankName
string
array of objects
cellPhoneNo
string
contactFunction
string
contactName
string
emailAddress
string
phoneNo
string
telefaxNo
string
webAddress
string
customsCreditNo
string
array of objects
codeListAgencyIdentifier
string
codeListIdentifier
string
object
codeListAgencyIdentifier
string
codeListIdentifier
string
name
string
value
string
name
string
array of objects
code
string
sequence
string
value
string
usageCode
string
idCodeList
string
Enum
CID
CNO
ENH
FMI
FNR
XDC
AMP
idType
string
name
string
partyId
string
array of objects
codeListAgencyIdentifier
string
codeListIdentifier
string
name
string
object
date
string <date-time>
dstIndicator
string
subClass
string
Enum
DOCUMENT_DATE
MESSAGE_DATE
TRANSPORT_ORDER_DATE
ORDER_DATE
ORDER_DELIVERY_DATE
ORDER_DELIVERY_DATE_REQUESTED
ORDER_DELIVERY_DATE_ACTUAL
ORDER_DELIVERY_DATE_ESTIMATED
DEPARTURE_DATE
DEPARTURE_DATE_REQUESTED
DEPARTURE_DATE_ACTUAL
DEPARTURE_DATE_ESTIMATED
DELIVERY_DATE
DELIVERY_DATE_REQUESTED
DELIVERY_DATE_ACTUAL
DELIVERY_DATE_ESTIMATED
ARRIVAL_DATE
ARRIVAL_DATE_ACTUAL
ARRIVAL_DATE_ESTIMATED
LOADING_DATE
PICKUP_DATE
PICKUP_DATE_ACTUAL
PICKUP_DATE_EARLIEST
PICKUP_DATE_LATEST
DELIVERY_DATE_EARLIEST
DELIVERY_DATE_LATEST
DEAD_LINE
UPDATED_DATE
EXPIRATION_DATE
RECEIVED_DATE
RECEIVED_DATE_REQUESTED
RECEIVED_DATE_ESTIMATED
FINISHED_DATE
PRODUCTION_DATE
FREEZE_DATE
EFFECTIVE_DATE
AVAILABILITY_DATE_START
AVAILABILITY_DATE_END
ACCEPTED_DATE
time
string <date-time>
timeZone
string
referenceNo
string
referenceType
string
text
string
subClass
string
Enum
DELIVERY_PARTY
ORDERING_PARTY
FREIGHT_PAYER
TRANSPORT_COMPANY
MESSAGE_RECIPIENT
MESSAGE_COPY_RECIPIENT
MESSAGE_SENDER
SUPPLIER
NOTIFY_PARTY
BUYER
SELLER
MANUFACTURER
PAYER
PERFORMING_UNIT
subPartyId
string
subPartyIdType
string
swiftCode
string
vatno
string
array of objects
array of objects
array of objects
codeListAgencyIdentifier
string
codeListIdentifier
string
name
string
usageCode
string
value
string
adviceSequence
integer <int32>
array of objects
date
string <date-time>
dstIndicator
string
subClass
string
Enum
DOCUMENT_DATE
MESSAGE_DATE
TRANSPORT_ORDER_DATE
ORDER_DATE
ORDER_DELIVERY_DATE
ORDER_DELIVERY_DATE_REQUESTED
ORDER_DELIVERY_DATE_ACTUAL
ORDER_DELIVERY_DATE_ESTIMATED
DEPARTURE_DATE
DEPARTURE_DATE_REQUESTED
DEPARTURE_DATE_ACTUAL
DEPARTURE_DATE_ESTIMATED
DELIVERY_DATE
DELIVERY_DATE_REQUESTED
DELIVERY_DATE_ACTUAL
DELIVERY_DATE_ESTIMATED
ARRIVAL_DATE
ARRIVAL_DATE_ACTUAL
ARRIVAL_DATE_ESTIMATED
LOADING_DATE
PICKUP_DATE
PICKUP_DATE_ACTUAL
PICKUP_DATE_EARLIEST
PICKUP_DATE_LATEST
DELIVERY_DATE_EARLIEST
DELIVERY_DATE_LATEST
DEAD_LINE
UPDATED_DATE
EXPIRATION_DATE
RECEIVED_DATE
RECEIVED_DATE_REQUESTED
RECEIVED_DATE_ESTIMATED
FINISHED_DATE
PRODUCTION_DATE
FREEZE_DATE
EFFECTIVE_DATE
AVAILABILITY_DATE_START
AVAILABILITY_DATE_END
ACCEPTED_DATE
time
string <date-time>
timeZone
string
array of objects
codeListAgencyIdentifier
string
codeListIdentifier
string
object
codeListAgencyIdentifier
string
codeListIdentifier
string
name
string
value
string
name
string
array of objects
code
string
sequence
string
value
string
usageCode
string
object
unitCode
string
value
number <float>
itemBatchNo
string
object
unitCode
string
value
number <float>
itemName
string
array of objects
codeListAgencyIdentifier
string
codeListIdentifier
string
name
string
usageCode
string
value
string
object
unitCode
string
value
number <float>
object
currencyIdentificationCode
string
value
number <float>
itemSerialNo
string
itemStatus
string
itemUnity
string
packageId
string
positionNumber
integer <int32>
array of objects
codeListAgencyIdentifier
string
codeListIdentifier
string
name
string
object
date
string <date-time>
dstIndicator
string
subClass
string
Enum
DOCUMENT_DATE
MESSAGE_DATE
TRANSPORT_ORDER_DATE
ORDER_DATE
ORDER_DELIVERY_DATE
ORDER_DELIVERY_DATE_REQUESTED
ORDER_DELIVERY_DATE_ACTUAL
ORDER_DELIVERY_DATE_ESTIMATED
DEPARTURE_DATE
DEPARTURE_DATE_REQUESTED
DEPARTURE_DATE_ACTUAL
DEPARTURE_DATE_ESTIMATED
DELIVERY_DATE
DELIVERY_DATE_REQUESTED
DELIVERY_DATE_ACTUAL
DELIVERY_DATE_ESTIMATED
ARRIVAL_DATE
ARRIVAL_DATE_ACTUAL
ARRIVAL_DATE_ESTIMATED
LOADING_DATE
PICKUP_DATE
PICKUP_DATE_ACTUAL
PICKUP_DATE_EARLIEST
PICKUP_DATE_LATEST
DELIVERY_DATE_EARLIEST
DELIVERY_DATE_LATEST
DEAD_LINE
UPDATED_DATE
EXPIRATION_DATE
RECEIVED_DATE
RECEIVED_DATE_REQUESTED
RECEIVED_DATE_ESTIMATED
FINISHED_DATE
PRODUCTION_DATE
FREEZE_DATE
EFFECTIVE_DATE
AVAILABILITY_DATE_START
AVAILABILITY_DATE_END
ACCEPTED_DATE
time
string <date-time>
timeZone
string
referenceNo
string
referenceType
string
text
string
Required
array of objects
accountNo
string
array of objects
addressLine
array of strings
string
city
string
object
codeListAgencyIdentifier
string
codeListIdentifier
string
name
string
value
string
pobox
string
postOffice
string
postalCode
string
stateOrRegion
string
street
string
streetNo
string
subClass
string
Enum
PHYSICAL_ADDRESS
POSTAL_ADDRESS
zipcode
string
bankName
string
array of objects
cellPhoneNo
string
contactFunction
string
contactName
string
emailAddress
string
phoneNo
string
telefaxNo
string
webAddress
string
customsCreditNo
string
array of objects
codeListAgencyIdentifier
string
codeListIdentifier
string
object
codeListAgencyIdentifier
string
codeListIdentifier
string
name
string
value
string
name
string
array of objects
code
string
sequence
string
value
string
usageCode
string
idCodeList
string
Enum
CID
CNO
ENH
FMI
FNR
XDC
AMP
idType
string
name
string
partyId
string
array of objects
codeListAgencyIdentifier
string
codeListIdentifier
string
name
string
object
date
string <date-time>
dstIndicator
string
subClass
string
Enum
DOCUMENT_DATE
MESSAGE_DATE
TRANSPORT_ORDER_DATE
ORDER_DATE
ORDER_DELIVERY_DATE
ORDER_DELIVERY_DATE_REQUESTED
ORDER_DELIVERY_DATE_ACTUAL
ORDER_DELIVERY_DATE_ESTIMATED
DEPARTURE_DATE
DEPARTURE_DATE_REQUESTED
DEPARTURE_DATE_ACTUAL
DEPARTURE_DATE_ESTIMATED
DELIVERY_DATE
DELIVERY_DATE_REQUESTED
DELIVERY_DATE_ACTUAL
DELIVERY_DATE_ESTIMATED
ARRIVAL_DATE
ARRIVAL_DATE_ACTUAL
ARRIVAL_DATE_ESTIMATED
LOADING_DATE
PICKUP_DATE
PICKUP_DATE_ACTUAL
PICKUP_DATE_EARLIEST
PICKUP_DATE_LATEST
DELIVERY_DATE_EARLIEST
DELIVERY_DATE_LATEST
DEAD_LINE
UPDATED_DATE
EXPIRATION_DATE
RECEIVED_DATE
RECEIVED_DATE_REQUESTED
RECEIVED_DATE_ESTIMATED
FINISHED_DATE
PRODUCTION_DATE
FREEZE_DATE
EFFECTIVE_DATE
AVAILABILITY_DATE_START
AVAILABILITY_DATE_END
ACCEPTED_DATE
time
string <date-time>
timeZone
string
referenceNo
string
referenceType
string
text
string
subClass
string
Enum
DELIVERY_PARTY
ORDERING_PARTY
FREIGHT_PAYER
TRANSPORT_COMPANY
MESSAGE_RECIPIENT
MESSAGE_COPY_RECIPIENT
MESSAGE_SENDER
SUPPLIER
NOTIFY_PARTY
BUYER
SELLER
MANUFACTURER
PAYER
PERFORMING_UNIT
subPartyId
string
subPartyIdType
string
swiftCode
string
vatno
string
object
array of objects
object
codeListAgencyIdentifier
string
codeListIdentifier
string
name
string
value
string
idType
string
locationId
string
locationName
string
object
codeListAgencyIdentifier
string
codeListIdentifier
string
name
string
value
string
subClass
string
Enum
START_LOCATION
CUSTOMS_DEPARTMENT
STORAGE_LOCATION
END_LOCATION
ULTIMATE_END_LOCATION
CUSTOMS_DEPARTURE
CUSTOMS_DESTINATION
CUSTOMS_TRANSIT
DOCUMENT_ISSUE
object
object
codeListAgencyIdentifier
string
codeListIdentifier
string
name
string
value
string
meansOfTransportId
string
object
codeListAgencyIdentifier
string
codeListIdentifier
string
name
string
value
string
name
string
object
codeListAgencyIdentifier
string
codeListIdentifier
string
name
string
value
string
transportLegId
string
object
codeListAgencyIdentifier
string
codeListIdentifier
string
name
string
value
string
object
array of objects
object
codeListAgencyIdentifier
string
codeListIdentifier
string
name
string
value
string
array of objects
channel
string
comType
string
value
string
array of objects
codeListAgencyIdentifier
string
codeListIdentifier
string
name
string
usageCode
string
value
string
object
codeListAgencyIdentifier
string
codeListIdentifier
string
name
string
value
string
object
codeListAgencyIdentifier
string
codeListIdentifier
string
name
string
value
string
object
codeListAgencyIdentifier
string
codeListIdentifier
string
name
string
value
string
object
codeListAgencyIdentifier
string
codeListIdentifier
string
name
string
value
string
array of objects
codeListAgencyIdentifier
string
codeListIdentifier
string
name
string
usageCode
string
array of objects
sequence
string
value
string
valueCode
string
valueType
string
updateIndicator
string
Enum
ORIGINAL
UPDATE
DELETE
Required
object
Required
object
subClass
string
Enum
REQUEST_DATE
DOCUMENT_DATE
RESPONSE_DATE
DELIVERY_DATE_REQUESTED
DEPARTURE_DATE_REQUESTED
ACCEPTED_DATE
ACTUAL_TIME_OF_DEPARTURE
ESTIMATED_TIME_OF_DEPARTURE
ACTUAL_TIME_OF_ARRIVAL
ESTIMATED_TIME_OF_ARRIVAL
ACTUAL_TIME_OF_DELIVERY
ESTIMATED_TIME_OF_DELIVERY
ACTUAL_TIME_OF_PICKUP
ESTIMATED_TIME_OF_PICKUP
value
string <date-time>
object
description
string
errorCodeType
string
Enum
OM_INPUT_001
OM_INPUT_002
OM_INPUT_003
OM_INPUT_004
OM_INPUT_005
OM_INPUT_006
OM_INPUT_007
OM_INPUT_008
OM_INPUT_009
OM_INPUT_010
OM_INPUT_011
OM_INPUT_012
OM_INPUT_013
OM_INPUT_014
OM_INPUT_015
OM_INPUT_016
OM_INPUT_017
OM_INPUT_018
OM_INPUT_019
OM_INPUT_020
OM_INPUT_021
OM_INPUT_022
OM_INPUT_023
OM_INPUT_024
OM_INPUT_025
OM_INPUT_026
OM_STATE_001
OM_STATE_002
OM_STATE_003
OM_STATE_004
OM_STATE_005
locale
Required
string
schemaVersion
Required
integer
400 Bad Request
403 Forbidden
404 Not Found

Response examples

{
  "OrderSet": {
    "dateAndTimes": [
      {
        "date": "2024-11-22T23:00:00.000+00:00",
        "subClass": "DELIVERY_DATE_REQUESTED",
        "time": "1970-01-01T07:43:51.000+00:00"
      },
      {
        "date": "2024-11-19T23:00:00.000+00:00",
        "subClass": "DEPARTURE_DATE_REQUESTED",
        "time": "1970-01-01T07:43:51.000+00:00"
      },
      {
        "date": "2024-11-18T23:00:00.000+00:00",
        "subClass": "ACCEPTED_DATE",
        "time": "1970-01-01T07:43:51.000+00:00"
      },
      {
        "date": "2024-11-18T23:00:00.000+00:00",
        "subClass": "DELIVERY_DATE_ESTIMATED",
        "time": "1970-01-01T07:43:51.000+00:00"
      }
    ],
    "order": {
      "dateAndTimes": [
        {
          "date": "2024-11-22T23:00:00.000+00:00",
          "subClass": "DELIVERY_DATE_REQUESTED",
          "time": "1970-01-01T07:43:51.000+00:00"
        },
        {
          "date": "2024-11-19T23:00:00.000+00:00",
          "subClass": "DEPARTURE_DATE_REQUESTED",
          "time": "1970-01-01T07:43:51.000+00:00"
        },
        {
          "date": "2024-11-18T23:00:00.000+00:00",
          "subClass": "ACCEPTED_DATE",
          "time": "1970-01-01T07:43:51.000+00:00"
        },
        {
          "date": "2024-11-18T23:00:00.000+00:00",
          "subClass": "DELIVERY_DATE_ESTIMATED",
          "time": "1970-01-01T07:43:51.000+00:00"
        }
      ],
      "freeText": [],
      "orderId": "1234",
      "orderStatus": "Received",
      "reference": [],
      "termsOfDelivery": [
        {
          "todconditionCode": {
            "value": "FCI"
          },
          "todconditionCodeList": {
            "value": "Incoterms"
          },
          "todlocation": "term location"
        }
      ]
    },
    "orderLineSet": [
      {
        "orderItem": [
          {
            "articleBalanceQuantity": {
              "value": 0
            },
            "articleId": [
              {
                "codeListIdentifier": "CustomerItemNo",
                "value": "1235"
              },
              {
                "codeListIdentifier": "VendorItemNo",
                "value": "12345"
              },
              {
                "codeListIdentifier": "EAN",
                "value": "EAN"
              }
            ],
            "articleLineId": "1",
            "articleMonetaryAmounts": {
              "unitPrice": {
                "currencyIdentificationCode": "NOK",
                "value": 500
              }
            },
            "articleOwner": [],
            "articleQuantity": {
              "value": 10
            },
            "articleReference": [
              {
                "referenceNo": "12334",
                "referenceType": "AAA",
                "text": "Acknowledgement of order number"
              },
              {
                "referenceNo": "12335",
                "referenceType": "ZZZ",
                "text": "Mutually defined reference number"
              }
            ],
            "articleVariance": [],
            "dateAndTimes": [],
            "description": [
              {
                "text": [
                  {
                    "value": "description"
                  }
                ],
                "usageCode": "AAA"
              }
            ],
            "freeText": [
              {
                "languageCode": {
                  "codeListIdentifier": "",
                  "value": "NO"
                },
                "name": "freetext name",
                "text": [
                  {
                    "value": "free text 1"
                  }
                ],
                "usageCode": "AAA"
              },
              {
                "languageCode": {
                  "codeListIdentifier": "",
                  "value": "NO"
                },
                "name": "freetext name",
                "text": [
                  {
                    "value": "free text 2"
                  }
                ],
                "usageCode": "ACB"
              }
            ],
            "packageTypeCode": [],
            "utility": []
          }
        ],
        "orderLine": []
      }
    ],
    "packingDetailsSet": [],
    "party": [
      {
        "address": [
          {
            "addressLine": [
              "Supplier address line"
            ],
            "city": "Oslo",
            "countryCode": {
              "value": "no"
            },
            "postalCode": "0214",
            "stateOrRegion": "",
            "street": "address line 2",
            "subClass": "PHYSICAL_ADDRESS"
          },
          {
            "addressLine": [
              "Supplier address line"
            ],
            "city": "Oslo",
            "countryCode": {
              "value": "no"
            },
            "postalCode": "0214",
            "stateOrRegion": "",
            "street": "address line 2",
            "subClass": "POSTAL_ADDRESS"
          }
        ],
        "contact": [
          null
        ],
        "freeText": [],
        "idType": "",
        "name": "party name",
        "partyId": "",
        "reference": [],
        "subClass": "SUPPLIER",
        "subPartyId": "",
        "vatno": ""
      },
      {
        "address": [
          {
            "addressLine": [
              "Ordering party address line"
            ],
            "city": "Bergen",
            "countryCode": {
              "value": "no"
            },
            "postalCode": "0314",
            "stateOrRegion": "",
            "subClass": "PHYSICAL_ADDRESS"
          },
          {
            "addressLine": [
              "Ordering party address line"
            ],
            "city": "Bergen",
            "countryCode": {
              "value": "no"
            },
            "postalCode": "0314",
            "stateOrRegion": "",
            "subClass": "POSTAL_ADDRESS"
          }
        ],
        "contact": [
          null
        ],
        "freeText": [],
        "idType": "",
        "name": "party name",
        "partyId": "",
        "reference": [],
        "subClass": "ORDERING_PARTY",
        "subPartyId": "",
        "vatno": ""
      }
    ],
    "transportLeg": {
      "location": [],
      "modeOfTransport": {
        "value": "1234"
      },
      "transportLegType": {
        "value": "30"
      }
    },
    "updateIndicator": "ORIGINAL"
  },
  "ResponsePropertiescgaran": {
    "DateAndTimes": {
      "subClass": "RESPONSE_DATE",
      "value": "2024-11-19T08:43:51.828+01:00"
    },
    "locale": "en",
    "schemaVersion": 0
  }
}

Packaging list

post 
                  https://api.bring.com/po/api/v1/packaginglist

Create Packaging list POST

Request

header parameters

X-Mybring-API-Uid
Required
Description
Mybring login ID
Type
string
X-Mybring-API-Key
Required
Description
Mybring user's API key
Type
string

Body schema

Media type: application/json

customerNo
Required
string
Required
object
consignmentId
Required
string
packageId
string
array of objects
orderLineId
string
array of objects
articleLineId
string
articleNumber
string
articleQuantity
number
articleVendorNumber
string
array of objects
array of objects
articleId
string
object
Required
object
currencyIdentificationCode
string
value
number
articleQuantity
number
object
subClass
string
Enum
REQUEST_DATE
DOCUMENT_DATE
RESPONSE_DATE
DELIVERY_DATE_REQUESTED
DEPARTURE_DATE_REQUESTED
ACCEPTED_DATE
ACTUAL_TIME_OF_DEPARTURE
ESTIMATED_TIME_OF_DEPARTURE
ACTUAL_TIME_OF_ARRIVAL
ESTIMATED_TIME_OF_ARRIVAL
ACTUAL_TIME_OF_DELIVERY
ESTIMATED_TIME_OF_DELIVERY
ACTUAL_TIME_OF_PICKUP
ESTIMATED_TIME_OF_PICKUP
value
string <date-time>
object
text
Required
string
usage
string
purchaseOrderNo
Required
string
Required
object
Required
object
subClass
string
Enum
REQUEST_DATE
DOCUMENT_DATE
RESPONSE_DATE
DELIVERY_DATE_REQUESTED
DEPARTURE_DATE_REQUESTED
ACCEPTED_DATE
ACTUAL_TIME_OF_DEPARTURE
ESTIMATED_TIME_OF_DEPARTURE
ACTUAL_TIME_OF_ARRIVAL
ESTIMATED_TIME_OF_ARRIVAL
ACTUAL_TIME_OF_DELIVERY
ESTIMATED_TIME_OF_DELIVERY
ACTUAL_TIME_OF_PICKUP
ESTIMATED_TIME_OF_PICKUP
value
string <date-time>
locale
Required
string
schemaVersion
Required
integer

Responses

200 OK

Schema

Media type: application/json

Required
object
Required
object
subClass
string
Enum
REQUEST_DATE
DOCUMENT_DATE
RESPONSE_DATE
DELIVERY_DATE_REQUESTED
DEPARTURE_DATE_REQUESTED
ACCEPTED_DATE
ACTUAL_TIME_OF_DEPARTURE
ESTIMATED_TIME_OF_DEPARTURE
ACTUAL_TIME_OF_ARRIVAL
ESTIMATED_TIME_OF_ARRIVAL
ACTUAL_TIME_OF_DELIVERY
ESTIMATED_TIME_OF_DELIVERY
ACTUAL_TIME_OF_PICKUP
ESTIMATED_TIME_OF_PICKUP
value
string <date-time>
object
description
string
errorCodeType
string
Enum
OM_INPUT_001
OM_INPUT_002
OM_INPUT_003
OM_INPUT_004
OM_INPUT_005
OM_INPUT_006
OM_INPUT_007
OM_INPUT_008
OM_INPUT_009
OM_INPUT_010
OM_INPUT_011
OM_INPUT_012
OM_INPUT_013
OM_INPUT_014
OM_INPUT_015
OM_INPUT_016
OM_INPUT_017
OM_INPUT_018
OM_INPUT_019
OM_INPUT_020
OM_INPUT_021
OM_INPUT_022
OM_INPUT_023
OM_INPUT_024
OM_INPUT_025
OM_INPUT_026
OM_STATE_001
OM_STATE_002
OM_STATE_003
OM_STATE_004
OM_STATE_005
locale
Required
string
schemaVersion
Required
integer
statusType
Required
string
Enum
OK
FAILED
400 Bad Request
403 Forbidden
404 Not Found

Request examples

{
  "CreatePackagingListRequest": {
    "CustomerNo": [
      "1234-4321"
    ],
    "PackingList": [
      {
        "ConsignmentId": [
          "98765432123456789"
        ],
        "PackageId": [
          "123456789098765432"
        ],
        "PackingListSet": [
          {
            "PackingListItem": [
              {
                "ArticleQuantity": [
                  "9.000"
                ],
                "articleLineId": "10"
              }
            ]
          }
        ]
      }
    ],
    "PurchaseOrderNo": [
      "121234234"
    ],
    "RequestProperties": [
      {
        "DateAndTimes": [
          {
            "$": {
              "subClass": "DocumentDate"
            },
            "_": "2022-06-08T12:51:23"
          }
        ],
        "Locale": [
          "EN"
        ],
        "SchemaVersion": [
          "1"
        ]
      }
    ]
  }
}

Response examples

{
  "responsePropertiesType": {
    "dateAndTimesType": {
      "subClass": "RESPONSE_DATE",
      "value": "2024-11-19T08:43:51.832+01:00"
    },
    "locale": "en",
    "schemaVersion": 1
  },
  "statusType": "OK"
}

Get Purchase Order

SOAP

post 
                        https://api.bring.com/po/api/ws

Get Purchase Order

WSDL

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

Request

Header parameters

Content-Type
Required
Description
Specify request format text/xml;charset=UTF-8
Type
string
X-Mybring-API-Key
Required
Description
Mybring user's API key
Type
string
X-Mybring-API-Uid
Required
Description
Mybring login ID
Type
string

Body parameters

CustomerNo
Description
Customer number
Type
string
Example
1823-2314
7628173
DateAndTimes
Description
Timestamp
Type
string
Example
2022-05-25T13:32:40.149+02:00
DateAndTimes subClass
Description
DateAndTimes sub class
Type
string
Enum
RequestDate
DocumentDate
ResponseDate
DeliveryDateRequested
DepartureDateRequested
AcceptedDate
ActualTimeOfDeparture
EstimatedTimeOfDeparture
ActualTimeOfArrival
EstimatedTimeOfArrival
ActualTimeOfDelivery
EstimatedTimeOfDelivery
ActualTimeOfPickup
EstimatedTimeOfPickup
PickupDateActual
BookedDate
PreBookedDate
CargoReadyDate
ApprovedForTransportDate
SupplierConfirmedReadyDate
AgentBookingReceivedDate
ExpirationDate
FinishedDate
ReceivedDate
ShippersBookingDate
FollowUpDate
DeliveryDateEstimated
Locale
Description
Locale
Type
string
Example
no
en
PurchaseOrderNo
Description
PurchaseOrder Number
Type
string
Example
231323432
SchemaVersion
Description
Schema Version
Type
string
Example
1

Request example

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:po="http://api.bring.com/po">
  <soapenv:Header/>
  <soapenv:Body>
    <po:GetPurchaseOrderRequest>
      <po:RequestProperties>
        <po:SchemaVersion>1</po:SchemaVersion>
        <po:Locale>no</po:Locale>
        <po:DateAndTimes subClass="ResponseDate">2022-05-25T13:32:40.149+02:00</po:DateAndTimes>
      </po:RequestProperties>
      <po:CustomerNo>Customer Number</po:CustomerNo>
      <po:PurchaseOrderNo>Purchase order number</po:PurchaseOrderNo>
    </po:GetPurchaseOrderRequest>
  </soapenv:Body>
</soapenv:Envelope>

Response examples

<SOAP-ENV:Envelope
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header/>
  <SOAP-ENV:Body>
    <GetPurchaseOrderResponse
      xmlns="http://api.bring.com/po">
      <ResponseProperties>
        <SchemaVersion>1</SchemaVersion>
        <Locale>en</Locale>
        <DateAndTimes subClass="ResponseDate">2022-06-09T15:28:46.725+02:00</DateAndTimes>
      </ResponseProperties>
      <PurchaseOrderSet updateIndicator="Original">
        <PurchaseOrder orderId="4504104664">
          <SenderStatus>OPEN</SenderStatus>
          <OrderStatus>EDIIMPORTED</OrderStatus>
          <Reference>
            <ReferenceNo>897392479234</ReferenceNo>
            <ReferenceType>ZZZ</ReferenceType>
            <Text>Mutually defined reference number</Text>
          </Reference>
          <Reference>
            <ReferenceNo>ReferenceNo</ReferenceNo>
            <ReferenceType>ON</ReferenceType>
            <Text>Buyers order number</Text>
          </Reference>
          <DateAndTimes subClass="DocumentDate">2022-06-01T07:19:10.684+02:00</DateAndTimes>
          <TermsOfDelivery>
            <TODConditionCode>FCA</TODConditionCode>
            <TODConditionCodeList>Incoterms</TODConditionCodeList>
            <TODLocation/>
          </TermsOfDelivery>
        </PurchaseOrder>
        <TransportLeg>
          <TransportLeg>20</TransportLeg>
          <ModeOfTransport>3</ModeOfTransport>
          <MeansOfTransport/>
          <Location locationId="1234" subClass="StartLocation">
            <LocationName>DRAMMEN</LocationName>
            <CountryCode>NO</CountryCode>
          </Location>
          <Location locationId="0123" subClass="EndLocation">
            <LocationName>STAVANGER</LocationName>
            <CountryCode>NO</CountryCode>
          </Location>
        </TransportLeg>
        <Party idType="" partyId="1100" subClass="DeliveryParty">
          <Name>Party Name</Name>
          <VATNo/>
          <Address subClass="PostalAddress">
            <StateOrRegion/>
          </Address>
          <Address subClass="PhysicalAddress">
            <PostalCode>1234</PostalCode>
            <City>Oslo</City>
            <StateOrRegion/>
            <CountryCode>NO</CountryCode>
            <AddressLine>Address line</AddressLine>
            <Street>Street</Street>
          </Address>
          <Contact>
            <ContactName>Contact name</ContactName>
            <PhoneNo>1234567</PhoneNo>
            <TelefaxNo>7654321</TelefaxNo>
          </Contact>
          <PlantId>1000</PlantId>
        </Party>
        <Party idType="" partyId="1000" subClass="OrderingParty">
          <Name>Ordering party name</Name>
          <VATNo/>
          <Address subClass="PostalAddress">
            <StateOrRegion/>
          </Address>
          <Address subClass="PhysicalAddress">
            <PostalCode>1234</PostalCode>
            <City>STAVANGER</City>
            <StateOrRegion/>
            <CountryCode>NO</CountryCode>
            <AddressLine>Address line</AddressLine>
          </Address>
          <Contact>
            <ContactName>Contact name</ContactName>
            <Mail>Email address</Mail>
          </Contact>
          <PlantId>1000</PlantId>
        </Party>
        <Party idType="" partyId="LEV-0000000000" subClass="Supplier">
          <Name>Supplier Name</Name>
          <VATNo>91234567</VATNo>
          <Address subClass="PostalAddress">
            <StateOrRegion/>
          </Address>
          <Address subClass="PhysicalAddress">
            <PostalCode>1234</PostalCode>
            <City>DRAMMEN</City>
            <StateOrRegion/>
            <CountryCode>NO</CountryCode>
            <AddressLine>Address line</AddressLine>
          </Address>
          <Contact>
            <Mail>Email address</Mail>
          </Contact>
          <PlantId/>
        </Party>
        <OrderLineSet>
          <OrderItem articleLineId="10">
            <ArticleQuantity>1</ArticleQuantity>
            <RemainingArticleQuantity>1</RemainingArticleQuantity>
            <Description>
              <Text>Description text</Text>
              <Usage/>
            </Description>
            <DateAndTimes subClass="DeliveryDateRequested">2022-12-31T12:00:00+01:00</DateAndTimes>
            <ArticleMonetaryAmounts>
              <UnitPrice currencyIdentificationCode="">0.00</UnitPrice>
            </ArticleMonetaryAmounts>
          </OrderItem>
        </OrderLineSet>
        <DateAndTimes subClass="DocumentDate">2022-06-15T12:00:00+02:00</DateAndTimes>
      </PurchaseOrderSet>
    </GetPurchaseOrderResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Create Packaging List

SOAP

post 
                        https://api.bring.com/po/api/ws

Create Packaging List

WSDL

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

Request

Header parameters

Content-Type
Required
Description
Specify request format text/xml;charset=UTF-8
Type
string
X-Mybring-API-Key
Required
Description
Mybring user's API key
Type
string
X-Mybring-API-Uid
Required
Description
Mybring login ID
Type
string

Body parameters

ArticleId
Description
Article id
Type
string
Example
646929334
ArticleNumber
Description
Article number
Type
string
Example
7123
ArticleQuantity
Description
Article quantity
Type
string
Example
10
ArticleQuantity
Description
Article quantity
Type
string
Example
10
ArticleVendorNumber
Description
Article vendor number
Type
string
Example
4688273
ConsignmentId
Description
Consignment id
Type
string
Example
739283472918723728
CustomerNo
Description
Customer number
Type
string
Example
1823-2314
7628173
DateAndTimes
Description
Timestamp
Type
string
Example
2022-05-25T13:32:40.149+02:00
DateAndTimes subClass
Description
DateAndTimes sub class
Type
string
Enum
RequestDate
DocumentDate
ResponseDate
DeliveryDateRequested
DepartureDateRequested
AcceptedDate
ActualTimeOfDeparture
EstimatedTimeOfDeparture
ActualTimeOfArrival
EstimatedTimeOfArrival
ActualTimeOfDelivery
EstimatedTimeOfDelivery
ActualTimeOfPickup
EstimatedTimeOfPickup
PickupDateActual
BookedDate
PreBookedDate
CargoReadyDate
ApprovedForTransportDate
SupplierConfirmedReadyDate
AgentBookingReceivedDate
ExpirationDate
FinishedDate
ReceivedDate
ShippersBookingDate
FollowUpDate
DeliveryDateEstimated
Locale
Description
Locale
Type
string
Example
no
en
PackageId
Description
Package id
Type
string
Example
46782991834
PurchaseOrderNo
Description
Purchase order number
Type
string
Example
231323432
SchemaVersion
Description
Schema Version
Type
string
Example
1
UnitPrice
Description
Unit price
Type
string
Example
5382
articleLineId
Description
Article line id
Type
string
Example
10
currencyIdentificationCode
Description
Currency identification code
Type
string
Example
NOK
USD
orderLineId
Description
Order line id
Type
string
Example
1

Request example

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:po="http://api.bring.com/po">
  <soapenv:Header/>
  <soapenv:Body>
    <po:CreatePackagingListRequest>
      <po:RequestProperties>
        <po:SchemaVersion>?</po:SchemaVersion>
        <po:Locale>?</po:Locale>
        <po:DateAndTimes subClass="?">?</po:DateAndTimes>
      </po:RequestProperties>
      <po:CustomerNo>?</po:CustomerNo>
      <po:PurchaseOrderNo>?</po:PurchaseOrderNo>
      <po:PackingList>
        <po:ConsignmentId>?</po:ConsignmentId>
        <!--Optional:-->
        <po:PackageId>?</po:PackageId>
        <!--Zero or more repetitions:-->
        <po:PackingListSet orderLineId="?">
          <!--Zero or more repetitions:-->
          <po:PackingListItem articleLineId="?">
            <po:ArticleQuantity>?</po:ArticleQuantity>
            <!--Optional:-->
            <po:ArticleNumber>?</po:ArticleNumber>
            <!--Optional:-->
            <po:ArticleVendorNumber>?</po:ArticleVendorNumber>
          </po:PackingListItem>
        </po:PackingListSet>
        <!--Zero or more repetitions:-->
        <po:PackingListAdditionalSet>
          <!--Zero or more repetitions:-->
          <po:PackingListAdditionalItem>
            <po:ArticleId>?</po:ArticleId>
            <po:ArticleQuantity>?</po:ArticleQuantity>
            <!--Optional:-->
            <po:Description>
              <po:Text>?</po:Text>
              <po:Usage>?</po:Usage>
            </po:Description>
            <!--Optional:-->
            <po:DateAndTimes subClass="?">?</po:DateAndTimes>
            <!--Optional:-->
            <po:ArticleMonetaryAmounts>
              <po:UnitPrice currencyIdentificationCode="?">?</po:UnitPrice>
            </po:ArticleMonetaryAmounts>
          </po:PackingListAdditionalItem>
        </po:PackingListAdditionalSet>
      </po:PackingList>
    </po:CreatePackagingListRequest>
  </soapenv:Body>
</soapenv:Envelope>

Response examples

<SOAP-ENV:Envelope
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header/>
  <SOAP-ENV:Body>
    <CreatePackagingListResponse
      xmlns="http://api.bring.com/po">
      <ResponseProperties>
        <SchemaVersion>1</SchemaVersion>
        <Locale>en</Locale>
        <DateAndTimes subClass="ResponseDate">2022-06-09T16:54:10.452+02:00</DateAndTimes>
      </ResponseProperties>
      <Status>OK</Status>
    </CreatePackagingListResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Create Transport Order

SOAP

post 
                        https://api.bring.com/po/api/ws

Create Transport Order

WSDL

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

Request

Header parameters

Content-Type
Required
Description
Specify request format text/xml;charset=UTF-8
Type
string
X-Mybring-API-Key
Required
Description
Mybring user's API key
Type
string
X-Mybring-API-Uid
Required
Description
Mybring login ID
Type
string

Body parameters

ArticleId
Description
Article Id
Type
string
Example
646929334
ArticleNumber
Description
Article number
Type
string
Example
7123
ArticleQuantity
Description
Article quantity
Type
string
Example
10
ArticleQuantity
Description
Article quantity
Type
string
Example
10
ArticleVendorNumber
Description
Article vendor number
Type
string
Example
4688273
ConsignmentId
Description
Consignment id
Type
string
Example
739283472918723728
CustomerNo
Description
Customer number
Type
string
Example
1823-2314
7628173
DateAndTimes
Description
Timestamp
Type
string
Example
2022-05-25T13:32:40.149+02:00
DateAndTimes subClass
Description
DateAndTimes sub class
Type
string
Enum
RequestDate
DocumentDate
ResponseDate
DeliveryDateRequested
DepartureDateRequested
AcceptedDate
ActualTimeOfDeparture
EstimatedTimeOfDeparture
ActualTimeOfArrival
EstimatedTimeOfArrival
ActualTimeOfDelivery
EstimatedTimeOfDelivery
ActualTimeOfPickup
EstimatedTimeOfPickup
PickupDateActual
BookedDate
PreBookedDate
CargoReadyDate
ApprovedForTransportDate
SupplierConfirmedReadyDate
AgentBookingReceivedDate
ExpirationDate
FinishedDate
ReceivedDate
ShippersBookingDate
FollowUpDate
DeliveryDateEstimated
Locale
Description
Locale
Type
string
Example
no
en
PackageId
Description
Package id
Type
string
Example
46782991834
PurchaseOrderNo
Description
Purchase order number
Type
string
Example
231323432
SchemaVersion
Description
Schema Version
Type
string
Example
1
UnitPrice
Description
Unit price
Type
string
Example
5382
articleLineId
Description
Article line id
Type
string
Example
10
currencyIdentificationCode
Description
Currency identification code
Type
string
Example
NOK
USD
orderLineId
Description
Order line id
Type
string
Example
1

Request example

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:po="http://api.bring.com/po">
  <soapenv:Header/>
  <soapenv:Body>
    <po:CreateTransportOrderRequest>
      <po:RequestProperties>
        <po:SchemaVersion>?</po:SchemaVersion>
        <po:Locale>?</po:Locale>
        <po:DateAndTimes subClass="?">?</po:DateAndTimes>
      </po:RequestProperties>
      <po:CustomerNo>?</po:CustomerNo>
      <po:PurchaseOrderNo>?</po:PurchaseOrderNo>
      <po:TransportOrder>
        <po:ConsignmentId>?</po:ConsignmentId>
        <!--Optional:-->
        <po:PackageId>?</po:PackageId>
        <!--Zero or more repetitions:-->
        <po:PackingListSet orderLineId="?">
          <!--Zero or more repetitions:-->
          <po:PackingListItem articleLineId="?">
            <po:ArticleQuantity>?</po:ArticleQuantity>
            <!--Optional:-->
            <po:ArticleNumber>?</po:ArticleNumber>
            <!--Optional:-->
            <po:ArticleVendorNumber>?</po:ArticleVendorNumber>
          </po:PackingListItem>
        </po:PackingListSet>
        <!--Zero or more repetitions:-->
        <po:PackingListAdditionalSet>
          <!--Zero or more repetitions:-->
          <po:PackingListAdditionalItem>
            <po:ArticleId>?</po:ArticleId>
            <po:ArticleQuantity>?</po:ArticleQuantity>
            <!--Optional:-->
            <po:Description>
              <po:Text>?</po:Text>
              <po:Usage>?</po:Usage>
            </po:Description>
            <!--Optional:-->
            <po:DateAndTimes subClass="?">?</po:DateAndTimes>
            <!--Optional:-->
            <po:ArticleMonetaryAmounts>
              <po:UnitPrice currencyIdentificationCode="?">?</po:UnitPrice>
            </po:ArticleMonetaryAmounts>
          </po:PackingListAdditionalItem>
        </po:PackingListAdditionalSet>
      </po:TransportOrder>
    </po:CreateTransportOrderRequest>
  </soapenv:Body>
</soapenv:Envelope>

Response examples

<SOAP-ENV:Envelope
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header/>
  <SOAP-ENV:Body>
    <CreateTransportOrderResponse
      xmlns="http://api.bring.com/po">
      <ResponseProperties>
        <SchemaVersion>1</SchemaVersion>
        <Locale>en</Locale>
        <DateAndTimes subClass="ResponseDate">2022-06-10T09:52:15.763+02:00</DateAndTimes>
      </ResponseProperties>
      <Status>OK</Status>
    </CreateTransportOrderResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
comments powered by Disqus