Navigate the available carriers and related methods they support. No authorization required for the endpoints listed below.
This endpoint allows the user to get our carrier list
Parameters:
Name | Description | Type | Required |
---|
Response Definitions:
Name | Description | Type |
---|---|---|
Result | The collection of carriers. | CarrierResult[] |
TransactionId | The transaction id for the request. | String |
TransactionTime | The time the transaction took place. | DateTime |
Success | Whether or not the transaction was successful | Boolean |
Messages | One or more messages may accompany the response. It is important to review the Severity of each message to determine the reason for failure. | Message[] |
This endpoint allows the user to retrieve the methods that belong to a carrier.
Parameters:
Name | Description | Type | Required |
---|---|---|---|
{carrierIdOrCode} | The carrier code or id retrieved from the /carriers endpoint. | Guid | Yes |
Response Definitions:
Name | Description | Type |
---|---|---|
Result | The collection of carrier methods. | CarrierMethodResult[] |
TransactionId | The transaction id for the request. | String |
TransactionTime | The time the transaction took place. | DateTime |
Success | Whether or not the transaction was successful | Boolean |
Messages | One or more messages may accompany the response. It is important to review the Severity of each message to determine the reason for failure. | Message[] |