v1

latestOpenAPI 3.0.12026-07-26381328555.2 KB

CarrierCredentialSet

Get Carrier Credential Set

Returns a credential set based on a specific Carrier ID and Code

get/commerce/shipping/admin/carriers/credential-sets/{carrierId}/{code}

carrierIdstring required

The carrier ID.

codestring required

The carrier credential set code.

responseFieldsstring

limits which fields are returned in the response body

Success

carrierIdstring nullable

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

codestring nullable

A unique code identifying this credential set. The code is only guaranteed to be unique at the tenant and carrier level.

integrationIdstring nullable

Specifies the ID returned from an integration.

namestring nullable

A name (i.e., nickname) for this credential set.