Sign in

v1

latestOpenAPI 3.0.12026-07-26381328555.2 KB
CarrierCredential

Get Carrier Credentials by ID

Retrieves carrier credentials for a specific Carrier ID

get/commerce/shipping/admin/carriers/credentials/{carrierId}

Path parameters

carrierIdstring required

The carrier ID.

Query parameters

siteIdinteger

The site ID, if any.

locationGroupCodestring

The location group code, if any.

locationCodestring

The location code, if any.

responseFieldsstring

limits which fields are returned in the response body

Response

Success

carrierIdstring nullable

The Carrier ID associated with this carrier credential. Usually the short name of a carrier (e.g., "FedEx").

locationCodestring nullable

The Location Code associated with this carrier credential, if any.

locationGroupCodestring nullable

The Location Group Code associated with this carrier credential, if any.

siteIdinteger nullable

The Site ID associated with this carrier credential, if any.