Update Carriers

Sets the allowed capabilities—services, packages, and special services - for a subscription and carrier. By default, all carrier-provided capabilities are available. After this call, only the specified capabilities are permitted for Rate Shop and Create Shipment operations. Requests that use capabilities not in this allowlist are rejected with an error.
Note: Support for this capability in other Shipment APIs is under active development. It is targeted for next release.

SecuritybearerAuth

Request

path Parameters

carrier

required

string

Carrier name whose capabilities are to be allowlisted for this subscription.

Example: USPS

Request Body schema: application/json

originCountryCode required	string Two-letter ISO 3166-1 alpha-2 country code (shipment origin country) to which the allowlist applies.
required	object Carrier-specific capability codes to allow for the subscription and origin country.

Responses

200

Subscription capabilities have been updated successfully.

400

Invalid request.

401

The request could not be authorized.

500

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

put/api/v1/carriers/{carrier}

Request samples

application/json

{"originCountryCode": "US",
"capabilities": {"parcelTypes": ["LP"
],
"services": ["NDA"
],
"specialServices": ["INS"
]
}
}

Response samples

application/json

[{"errorCode": "validation_error",
"errorDescription": "Error while getting rates for carrier with carrierAccount eRMnRx4mzPP.",
"additionalCode": "string",
"additionalInfo": "string",
"additionalParameters": ["string"
]
}
]