Carrier Data Type

A shipping carrier configured on a shop (e.g. DHL, UPS, GLS). Carriers define available shipping services and organize rates into zones and destinations.

Available Since
1.3.0
Subtypes
CarrierExpanded
Properties
Name Type Description
id number Unique numeric identifier for the carrier.
name string The name of the shipping service as seen by merchants and their customers.
description string The description of the shipping service. For example: Includes tracking and insurance.
phoneRequired boolean Whether the customer must provide a phone number.
moduleProvider ShippingModuleProvider The shipping integration provider used to calculate rates and book shipments for this carrier.
customProvider string Identifier of a custom (non-standard) shipping provider, used when moduleProvider is not set.
premium boolean Whether this carrier offers a premium service level (e.g. express delivery or enhanced handling).
emdorsement string USPS endorsement instruction printed on the label to control undeliverable mail handling.
ddp boolean Whether this carrier delivers Delivered Duty Paid (DDP) — the sender covers import duties and taxes.
showTicketLogo boolean Whether the carrier's logo is printed on the packing slip or production ticket.
customApiUser string API username for direct carrier API integration when using a custom provider.
customApiKey string API key for direct carrier API integration when using a custom provider.
htmlTemplate string Custom HTML template used for carrier-specific label or notification content.
mainCarrier Carrier Parent carrier this carrier is derived from, when this is a sub-carrier or variant of another carrier.
perProduct boolean When true, shipping cost is calculated per ordered product rather than per order.
Used in
GET /accounts/{accountId}/shops/{shopId}/carriers/{carrierId} response
Carrier (JSON) 
{
  "carrier" : {
    "id" : 12345,
    "name" : "UPS",
    "description" : "Standard domestic shipping method",
    "phoneRequired" : true,
    "moduleProvider" : {
      "id" : 12345,
      "name" : "Standard",
      "provider" : "ups",
      "serviceType" : "standard",
      "moduleType" : {
        "id" : 12345,
        "name" : "SPOD"
      }
    },
    "customProvider" : "...",
    "premium" : true,
    "emdorsement" : "...",
    "ddp" : true,
    "showTicketLogo" : true,
    "customApiUser" : "...",
    "customApiKey" : "...",
    "htmlTemplate" : "...",
    "mainCarrier" : {
      "id" : 12345,
      "name" : "UPS",
      "description" : "Standard domestic shipping method",
      "phoneRequired" : true,
      "moduleProvider" : {
        "id" : 12345,
        "name" : "Standard",
        "provider" : "ups",
        "serviceType" : "standard",
        "moduleType" : { }
      },
      "customProvider" : "...",
      "premium" : true,
      "emdorsement" : "...",
      "ddp" : true,
      "showTicketLogo" : true,
      "customApiUser" : "...",
      "customApiKey" : "...",
      "htmlTemplate" : "...",
      "mainCarrier" : { },
      "perProduct" : true
    },
    "perProduct" : true
  }
}
Carrier Data Type

A shipping carrier configured on a shop (e.g. DHL, UPS, GLS). Carriers define available shipping services and organize rates into zones and destinations.

Available Since
1.3.0
Subtypes
CarrierExpanded
Properties
Name Type Description
customApiKey string API key for direct carrier API integration when using a custom provider.
customApiUser string API username for direct carrier API integration when using a custom provider.
customProvider string Identifier of a custom (non-standard) shipping provider, used when moduleProvider is not set.
ddp boolean Whether this carrier delivers Delivered Duty Paid (DDP) — the sender covers import duties and taxes.
description string The description of the shipping service. For example: Includes tracking and insurance.
emdorsement string USPS endorsement instruction printed on the label to control undeliverable mail handling.
htmlTemplate string Custom HTML template used for carrier-specific label or notification content.
id int Unique numeric identifier for the carrier.
mainCarrier Carrier Parent carrier this carrier is derived from, when this is a sub-carrier or variant of another carrier.
moduleProvider ShippingModuleProvider The shipping integration provider used to calculate rates and book shipments for this carrier.
name string The name of the shipping service as seen by merchants and their customers.
perProduct boolean When true, shipping cost is calculated per ordered product rather than per order.
phoneRequired boolean Whether the customer must provide a phone number.
premium boolean Whether this carrier offers a premium service level (e.g. express delivery or enhanced handling).
showTicketLogo boolean Whether the carrier's logo is printed on the packing slip or production ticket.
Used in
GET /accounts/{accountId}/shops/{shopId}/carriers/{carrierId} response
Carrier (XML) 
<carrier>
  <id>...</id>
  <name>UPS</name>
  <description>Standard domestic shipping method</description>
  <phoneRequired>true</phoneRequired>
  <moduleProvider>
    <id>...</id>
    <name>Standard</name>
    <provider>ups</provider>
    <serviceType>standard</serviceType>
    <moduleType>
      <id>...</id>
      <name>SPOD</name>
    </moduleType>
  </moduleProvider>
  <customProvider>...</customProvider>
  <premium>...</premium>
  <emdorsement>...</emdorsement>
  <ddp>...</ddp>
  <showTicketLogo>...</showTicketLogo>
  <customApiUser>...</customApiUser>
  <customApiKey>...</customApiKey>
  <htmlTemplate>...</htmlTemplate>
  <mainCarrier/>
  <perProduct>...</perProduct>
</carrier>