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 |
---|
Sample Header:
1 2 3 |
GET https://api.getquipt.com/v2/carriers Content-Type: application/json;charset=UTF-8 Accept: */* |
Sample Response (JSON):
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
{ "Result" : [ { "Id":"c8096b1a-1cb9-4fc9-90c3-1fa5131392b5", "Name":"FedEx SmartPost", "Code":"FDXSP", "TrackingUrlFormat":"http://www.fedex.com/Tracking?action=track&tracknumbers={0}" } ], "TransactionId" : null, "TransactionTime" : "2019-05-08T06:15:52.193656Z", "Success" : true, "Messages" : [] } |
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 |
Sample Header:
1 2 3 |
GET https://api.getquipt.com/v2/carriers/methods/FDX Content-Type: application/json;charset=UTF-8 Accept: */* |
Sample Response (JSON):
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 |
{ "Result" : [ { "Id" : "13dc9690-0347-47cd-8de6-07561477cbe6", "Carrier" : { "Id" : "18e61aba-069e-4788-8e62-6d54ad9ba43f", "Name" : "FedEx", "Code" : "FDX", "TrackingUrlFormat" : "http://www.fedex.com/Tracking?action=track&tracknumbers={0}" }, "Name": "2-Day", "Code": "FDX2D" } ], "TransactionId" : null, "TransactionTime" : "2019-05-08T06:15:52.193656Z", "Success" : true, "Messages" : [] } |
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[] |