International Bridge Blue
International Bridge Blue API allows developers to integrate shipping labels and fulfillment within their e-commerce businesses and online marketplaces. The API offers price comparison, label printing, manifest generation, transactions details and tracking features. The guideline below will help get you started. For additional help, please email us at…
74 subscribers
29 endpoints
The in-depth APIMemo review for this API hasn't been published yet —
the data below comes straight from the public marketplace listing.
International Bridge Blue endpoints
| Method | Endpoint | Description |
|---|---|---|
| label | ||
| PUT |
update /v1/labels/{tracking_number} |
Only certain mailpiece properties can be updated (e.g. postmark date, weight and dimensions). The properties that cannot change will remain the same as in the intial request… |
| GET |
index /v1/labels |
Parameter | Default | Description --------- | ------- | ----------- start_date | (conditional) | Start date. UTC format. Mutually exclusive with request_id and status. end_date |… |
| POST |
create /v1/labels |
Parameter | Default | Description --------- | ------- | ----------- request_id | (null/empty) | Request ID. Used by API developers to match requests and responses. Echoed back in… |
| GET |
reprint /v1/labels/{tracking_number} |
Not available for UPS. Parameter | Default | Description --------- | ------- | ----------- tracking_number | (required) | Tracking number. |
| DELETE |
delete /v1/labels/{tracking_number} |
Parameter | Default | Description --------- | ------- | ----------- tracking_number | (required) | Tracking number. |
| price | ||
| POST |
get /v1/price.json |
Parameter | Default | Description --------- | ------- | ----------- request_id | (null/empty) | Request ID. Used by API developers to match requests and responses. Echoed back in… |
| manifest | ||
| GET |
index2 /v1/manifests |
Parameter | Default | Description --------- | ------- | ----------- start_date | (conditional) | Start date. UTC format. Mutually exclusive with request_id and status. end_date |… |
| GET |
reprint1 /v1/manifests/{manifest_number} |
Parameter | Default | Description --------- | ------- | ----------- manifest_number | (required) | Manifest number. |
| POST |
create0 /v1/manifests.json |
Parameter | Default | Description --------- | ------- | ----------- request_id | (null/empty) | Request ID. Used by API developers to match requests and responses. Echoed back in… |
| address | ||
| GET |
getstreets /v1/address/streets |
Parameter | Default | Description --------- | ------- | ----------- zip5 | (required) | Zip 5. |
| POST |
validate /v1/address/validate |
Parameter | Default | Description --------- | ------- | ----------- company_name | (null/empty) | Company name. line1 | (required) | Address line 1. line2 | (null/empty) |… |
| GET |
getcity /v1/address/city |
Parameter | Default | Description --------- | ------- | ----------- zip5 | (required) | Zip 5. |
| GET |
getpossibleaddresses /v1/address/possible_addresses |
Parameter | Default | Description --------- | ------- | ----------- zip5 | (required) | Zip 5. primary | (required) | Primary street number. street_name | (null/empty) | Street… |
| POST |
resolvemultiple /v1/address/resolve_multiple |
Parameter | Default | Description --------- | ------- | ----------- line1 | (required) | Address line 1. line2 | (null/empty) | Address line 2. line3 | (null/empty) | Address… |
| user | ||
| GET |
auth /v1/authenticate |
|
| GET |
read /v1/users/{user_id} |
|
| PUT |
update2 /v1/users/{user_id} |
|
| payment_methods | ||
| DELETE |
delete1 /v1/payment_methods/{payment_method_id} |
Parameter | Default | Description --------- | ------- | ----------- payment_method_id | (required) | Payment method id. |
| GET |
index0 /v1/payment_methods |
Context: user Parameter | Default | Description --------- | ------- | ----------- page_size | 25 | Page size. page_number | 1 | Page number. |
| payment_transactions | ||
| POST |
buy /v1/payment_transactions/{payment_method_id}/buy |
Parameter | Default | Description --------- | ------- | ----------- payment_method_id | (required) | Payment method id. transaction_amount | (required) | Amount that will be… |
| GET |
index0 /v1/payment_transactions |
Parameter | Default | Description --------- | ------- | ----------- page_size | 25 | Page size. page_number | 1 | Page number. |
| tracking | ||
| GET |
track /v1/track/{tracking_number} |
Parameter | Default | Description --------- | ------- | ----------- tracking_number | (required) | Tracking number. |
| POST |
createevent /v1/track |
Parameter | Default | Description --------- | ------- | ----------- TBD | TBD | TBD |
| refunds | ||
| GET |
refunds /v1/refunds |
Parameter | Default | Description --------- | ------- | ----------- start_date | (required) | Start date of date range when refunded labels are created end_date | (required) |… |
| pickups | ||
| POST |
schedule_pickup /v1/pickups |
Schedules a package pickup and provides the user a confirmation number for the scheduled pickup. Your carrier will pick up your packages on the next USPS delivery day (Monday… |
| DELETE |
delete_pickup /v1/pickups/[id] |
|
| GET |
get_pickups /v1/pickups |
|
| GET |
get_pickup /v1/pickups/{pickup_id} |
|
| account_ledger | ||
| GET |
account_ledger /v1/account_ledger |
Parameter | Default | Description --------- | ------- | ----------- entry_type | (null/empty) | Could have one of the 4 possible values: "label_charge",… |
International Bridge Blue pricing
| Plan | Price | Rate limit | Quotas |
|---|---|---|---|
| BASIC | Free | — |
|
