shipping
carrier

List all carriers

get/shipping/{connection_id}/carrier

Request

  • Base URL: http://api.unified.to
  • URL: http://api.unified.to/shipping/{connection_id}/carrier
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

Query parameters

limitnumber
offsetnumber
updated_gtestring date-time

Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

sort'name' | 'updated_at' | 'created_at'
order'asc' | 'desc'
querystring

Query string to search. eg. email address or name

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring

Unique identifier for this carrier object

created_atstring date-time

The date that this carrier object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

The last date that this carrier object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

namestring

The name of the carrier

codestring

Carrier code (e.g., "usps", "fedex", "ups")

is_activeboolean

Whether the carrier is currently active

logo_urlstring

Carrier logo URL

website_urlstring

Carrier website

rawunknown

Changes

No recorded changes to this operation across all 1 revision of this API.