v1

latestOpenAPI 3.0.12026-07-26381328555.2 KB
CarrierConfiguration

Get carrier configuration information

Get Carrier Configuration (for this particular site)

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

Path parameters

carrierIdstring required

Query parameters

responseFieldsstring

limits which fields are returned in the response body

Response

Success

areCredentialsSetboolean

Indicates whether the credentials/passwords are set. <remarks>Credetials are updated only if this flag is set to true</remarks>

enabledboolean

Indicates that this CarrierConfiguration should be used at runtime

enabledForReturnsboolean

Indicates that this CarrierConfiguration should be the default for returns shipping

idstring nullable

Carrier Id (usually a shortname of a carrier, e.g. FedEx)

isDeliveryMethodboolean