/shipping-carriers

Response attributes

Attributes that you will receive in response from the endpoint in JSON format, for example:
{"id": 1,"title": "Order"}.
Data will be wrapped in an items array with _links and _meta appended after it. See How to use get requests.
To use search with custom filters, see How to use search. Refer to field names in the Search field column.

Title

Type

Description

Search field

id

int

ID of the carrier

id

title

string

Title of the carrier

title

url

string

Website URL

url

is_deleted

bool

If the carrier is deleted

is_deleted

GET https://mystore.commercehq.com/api/v1/shipping-carriers
{
  "items": [
    {
      "id": 7,
      "title": "Canada Post",
      "url": "http://www.canadapost.ca/cpotools/apps/track/personal/findByTrackNumber?trackingNumber=",
      "is_deleted": false
    },
    {
      "id": 6,
      "title": "DHL Global",
      "url": "http://webtrack.dhlglobalmail.com/?trackingnumber=",
      "is_deleted": false
    },
    {
      "id": 5,
      "title": "DHL US",
      "url": "http://track.dhl-usa.com/TrackByNbr.asp?ShipmentNumber=",
      "is_deleted": false
    },
    {
      "id": 4,
      "title": "LaserShip",
      "url": "http://www.lasership.com/track/",
      "is_deleted": false
    },
    {
      "id": 3,
      "title": "FedEx",
      "url": "http://www.fedex.com/Tracking?action=track&tracknumbers=",
      "is_deleted": false
    },
    {
      "id": 2,
      "title": "UPS",
      "url": "http://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=",
      "is_deleted": false
    },
    {
      "id": 1,
      "title": "USPS",
      "url": "https://tools.usps.com/go/TrackConfirmAction_input?qtc_tLabels1=",
      "is_deleted": false
    }
  ],
  "_links": {
    "self": {
      "href": "http://dummy-api.com/api/v1/shipping-carriers?page=1"
    }
  },
  "_meta": {
    "totalCount": 7,
    "pageCount": 1,
    "currentPage": 1,
    "perPage": 20
  }
}