Get Shipping Restrictions for Single Country

This API helps determine if the item has regulatory, legal, or carrier-based restrictions for a single destination country.
Use this API to determine which countries are available for listing, and/or perform screenings to determine shipping compliance for crossborder transactions. Responses include restrictions and prohibitions for CITES, Health, Limited Quantity, Hazmat & Dangerous Goods, ITAR and Medical related regulations.

SecuritybearerAuth
Request
header Parameters
X-PB-TransactionId
string

A unique Transaction ID provided by the partner, which is used to enable debugging and linking between the client's transaction and the system.Allowed characters limit is 36.

Content-Type
required
string

The media type of the request body.

Value: "application/json"
Request Body schema: application/json
exportCountryCode
required
string [ 2 .. 3 ] characters

The country from which the shipment is exported.

  • Must be a valid ISO 3166-1 alpha-2 or alpha-3 country code (e.g., US or USA).
destinationCountryCode
required
string [ 2 .. 3 ] characters

The country to which the shipment is destined.

  • Must be a valid ISO 3166-1 alpha-2 or alpha-3 country code (e.g., CA or CAN).
required
object

The item being evaluated for restriction.

Responses
200

The requested restrictions has been retrived successfully.

400

Invalid request.

401

The request could not be authorized.

500

The request could not be completed due to an internal error.

post/api/v1/crossborder-services/restriction
Request samples
application/json
{
  • "exportCountryCode": "US",
  • "destinationCountryCode": "CA",
  • "item": {
    }
}
Response samples
application/json
{
  • "exportCountryCode": "US",
  • "destinationCountryCode": "CA",
  • "item": {
    }
}