v1

latestOpenAPI 3.0.12026-07-26381328555.2 KB

CarrierCredentialSet

Create Carrier Credential Set

Creates a new carrier credential set. See <a href="/pages/shipping-carriers-api-overview">this guide</a> for details about the fields that are required for each carrier.

post/commerce/shipping/admin/carriers/credential-sets/{carrierId}

Path parameters

carrierIdstring required

The carrier ID.

Query parameters

responseFieldsstring

limits which fields are returned in the response body

Request body

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.

Response

Success