Sign in
CarrierCredential

Create Carrier Credentials

Creates new carrier credentials. 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/credentials/{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 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.

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.

Changes

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