shipping
carrier

Retrieve a carrier

Changed on

Retrieves a single ShippingCarrier by its id. Obtain id values from the corresponding list endpoint. Use fields to return only the fields you need.

get/shipping/{connection_id}/carrier/{id}

Request

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

Path parameters

connection_idstring required

ID of the connection

idstring required

ID of the Carrier

Query parameters

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

rawobject

The raw data returned by the integration for this carrier

Changes

  • 39502239a975Revision changes
    • info

      added the enum value metadata to the property items/ of the query request parameter fields

    • info

      added the optional property to the response with the status