Customs API
The Customs API is used to submit customs declarations electronically
Authentication
To integrate with 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. In addition to authentication, you need to be authorized.
Rate limiting
Clients exceeding a certain number of requests per second will be throttled, and the response will contain http status code 429. If you have a use case requiring rates above the limit, please contact developer-booking@bring.com for assistance.
Formats
REST JSON over HTTP
What can the Customs API help me with?
The Customs API can help users send customs declarations as structured data to Bring.
Endpoints
- Base URL
https://api.bring.com/customs/v1- OpenAPI document
- https://api.bring.com/customs/v1/openapi
| Usage | Method | Endpoint |
|---|---|---|
| Submit customs declaration for a shipment | POST |
/declarations
|
Submit customs declaration for a shipment
- POST
-
https://api.bring.com/customs/v1/declarations
Request
header parameters
-
X-Bring-Test-IndicatorRequired -
- Description
- Indicates whether this is a test message or a live one.
- Type
- boolean
Body schema
Media type: application/json
-
currencyCode - Currency code (ISO 4217) that applies to all amounts in the customs declarationstring
-
customerNumber - Customer number paying for the transportstring
- List of customs linesarray of objects
-
amount - The value of the goods. In base units.number
-
consignmentItemId - The customs consignment item idstring
-
countryCodeOrigin - The customs line's origin ISO 3166 country codestring
-
customsArticleNumber - The customs article number, or tariff codestring
- array of objects
-
certificateCode - Certificate code for the customs linestring
-
documentCode - Document code for the customs linestring
-
-
goodsDescription - A description of the goods declaredstring
-
grossWeight - Gross weight for the shipment. In base units (kgs).number
-
netWeight - Net weight for the shipment. In base units (kg).number
-
quantity - The quantity of the customs line if weight is not aptstring
-
salesOrder - A reference to the customer's sales orderstring
-
tradePreferenceCode - The trade preference code. Defaults to Jstring
- Enum
-
A -
B -
C -
G -
P -
J(default) -
N
-
-
declarationType - Indicates whether the declaration should be import, export, or both. Defaults to IMPORT_EXPORT.string
- Enum
-
IMPORT -
EXPORT -
IMPORT_EXPORT(default)
- Information about the importer or exporterobject
-
-
city - The party's namestring
-
countryCode - The party's ISO 3166 country codestring
-
id - The party's id. Usually a customer number.string
-
name - The party's namestring
-
postalCode - The party's postal codestring
-
vatId - The party's VAT numberstring
-
- Information about the importer or exporterobject
-
-
city - The party's namestring
-
countryCode - The party's ISO 3166 country codestring
-
id - The party's id. Usually a customer number.string
-
name - The party's namestring
-
postalCode - The party's postal codestring
-
vatId - The party's VAT numberstring
-
- List of invoice dataarray of objects
-
amount - The invoice's total amount. In base units.number
-
discount - The invoice's total discount. In base units.number
-
invoiceDate - The invoice datestring
-
invoiceNumber - The invoice numberstring
-
- Describes shipment data associated with the customs declarationobject
-
-
consignmentId - Customs consignment id for the shipment. Top level id.stringMax length: 35
-
freightCost - Cost of freight. In base units.number
-
insuranceCost - Cost of insurance. In base units.number
-
service - Service code declared. 0300 is the service code for bulk/routing label.string
- Enum
-
0300 -
0336
- Information about terms of deliveryobject
-
-
incotermsCode - The incoterms that applies for the customer's shipmentstring
- Enum
-
EXW -
FCA -
FAS -
FOB -
CFR -
CIF -
CPT -
CIP -
DPU -
DAP -
DDP
-
location - The location for the shipmentstring
-
-
Responses
200 Successfully submitted customs declaration for a shipment
Schema
Media type: application/json
-
error - A description of the error that occurredstring
-
processingId - A processing id for the requeststring
-
status - The outcome of the requeststring
- Enum
-
ACCEPTED -
FAILED
Request examples
{
"currencyCode": "SEK",
"customerNumber": "1234567890",
"customsDeclarations": [
{
"amount": 1500.5,
"consignmentItemId": "CS128104136NO",
"countryCodeOrigin": "SE",
"customsArticleNumber": "article number 1",
"documentReferences": "null,",
"goodsDescription": "description 1",
"grossWeight": 1,
"netWeight": 1,
"quantityOtherUnit": 2,
"salesOrder": null,
"tradePreferenceCode": "A"
},
{
"amount": 250.5,
"consignmentItemId": "CS128104137NO",
"countryCodeOrigin": "FI",
"customsArticleNumber": "article number 2",
"documentReferences": [
{
"certificateCode": "SE/HF/003245"
}
],
"goodsDescription": "description 2",
"grossWeight": 2,
"netWeight": 2,
"numberOfPieces": 3,
"salesOrder": {
"articleNumber": "GK153-1",
"orderNumber": "OPT5566"
}
}
],
"declarationType": "IMPORT_EXPORT",
"exporter": {
"addressLine1": "Exporter street 42",
"city": "Oslo",
"countryCode": "NO",
"id": null,
"name": "Ex Porter",
"postalCode": "1234",
"vatId": null
},
"importer": {
"addressLine1": "Importer street 42",
"city": "Stockholm",
"countryCode": "SE",
"id": "1234567891",
"name": "Im Porter",
"postalCode": "12000",
"vatId": null
},
"invoices": [
{
"amount": 100887.5,
"discount": 250.5,
"invoiceDate": "2025-11-13",
"invoiceNumber": "401528"
},
{
"amount": 100887.5,
"invoiceDate": "2025-11-14",
"invoiceNumber": "401529"
}
],
"shipment": {
"consignmentId": "012345678910",
"freightCost": 1000.5,
"insuranceCost": 5000.5,
"service": "0300",
"termsOfDelivery": {
"incotermsCode": "DDP",
"location": "Oslo"
}
}
}{
"currencyCode": "SEK",
"customerNumber": "1234567890",
"customsDeclarations": [
{
"amount": 1500.5,
"consignmentItemId": "CS128104136NO",
"countryCodeOrigin": "SE",
"customsArticleNumber": "article number 1",
"documentReferences": "null,",
"goodsDescription": "description 1",
"grossWeight": 1,
"netWeight": 1,
"quantityOtherUnit": 2,
"salesOrder": null,
"tradePreferenceCode": "A"
},
{
"amount": 250.5,
"consignmentItemId": "CS128104137NO",
"countryCodeOrigin": "FI",
"customsArticleNumber": "article number 2",
"documentReferences": [
{
"certificateCode": "SE/HF/003245"
}
],
"goodsDescription": "description 2",
"grossWeight": 2,
"netWeight": 2,
"numberOfPieces": 3,
"salesOrder": {
"articleNumber": "GK153-1",
"orderNumber": "OPT5566"
}
}
],
"declarationType": "IMPORT_EXPORT",
"exporter": {
"addressLine1": "Exporter street 42",
"city": "Oslo",
"countryCode": "NO",
"id": null,
"name": "Ex Porter",
"postalCode": "1234",
"vatId": null
},
"importer": {
"addressLine1": "Importer street 42",
"city": "Stockholm",
"countryCode": "SE",
"id": "1234567891",
"name": "Im Porter",
"postalCode": "12000",
"vatId": null
},
"invoices": [
{
"amount": 100887.5,
"discount": 250.5,
"invoiceDate": "2025-11-13",
"invoiceNumber": "401528"
},
{
"amount": 100887.5,
"invoiceDate": "2025-11-14",
"invoiceNumber": "401529"
}
],
"shipment": {
"consignmentId": "012345678910",
"freightCost": 1000.5,
"insuranceCost": 5000.5,
"service": "0336",
"termsOfDelivery": {
"incotermsCode": "DDP",
"location": "Oslo"
}
}
}Response examples
{
"error": null,
"processingId": "89257cb6-43be-4250-9a56-eb679b95ba8d",
"status": "ACCEPTED"
}