ShippingModuleProvider Data Type

The external shipping provider behind a shipping module (e.g. GLS, DPD, DHL). Identifies the provider and its supported connection type.

Available Since
1.3.0
Properties
Name Type Description
id number Unique numeric identifier for the ShippingModuleProvider.
name string The name for the ShippingModuleProvider.
provider string The name for the Provider.
serviceType string The name for the service type.
moduleType ShippingModuleType The shipping module type that this provider belongs to.
letter string Short code identifying the provider on the production shipping ticket, at most 3 characters. Required. A shop can override it per provider on the production side.
useLastLabel boolean Whether the provider reuses the label of the previous shipment instead of requesting a new one. Omitted on a write, the stored value is kept.
packageLength number Default package length declared to the shipping provider. The unit is the one that provider expects, so it differs between providers. All three dimensions have to be set for any of them to be used; a value of zero or less counts as not set, and the shipping module falls back to its own default.
packageWidth number Default package width declared to the shipping provider, in that provider unit. See packageLength.
packageHeight number Default package height declared to the shipping provider, in that provider unit. See packageLength.
defaultCountryOfOrigin string Country of origin declared for customs when the shipment does not state one.
ShippingModuleProvider (JSON)
{
  "shippingModuleProvider" : {
    "id" : 12345,
    "name" : "Standard",
    "provider" : "ups",
    "serviceType" : "standard",
    "moduleType" : {
      "id" : 12345,
      "name" : "SPOD"
    },
    "letter" : "UPS",
    "useLastLabel" : true,
    "packageLength" : 12345,
    "packageWidth" : 12345,
    "packageHeight" : 12345,
    "defaultCountryOfOrigin" : "CZ"
  }
}
ShippingModuleProvider Data Type

The external shipping provider behind a shipping module (e.g. GLS, DPD, DHL). Identifies the provider and its supported connection type.

Available Since
1.3.0
Properties
Name Type Description
defaultCountryOfOrigin string Country of origin declared for customs when the shipment does not state one.
id int Unique numeric identifier for the ShippingModuleProvider.
letter string Short code identifying the provider on the production shipping ticket, at most 3 characters. Required. A shop can override it per provider on the production side.
moduleType ShippingModuleType The shipping module type that this provider belongs to.
name string The name for the ShippingModuleProvider.
packageHeight int Default package height declared to the shipping provider, in that provider unit. See packageLength.
packageLength int Default package length declared to the shipping provider. The unit is the one that provider expects, so it differs between providers. All three dimensions have to be set for any of them to be used; a value of zero or less counts as not set, and the shipping module falls back to its own default.
packageWidth int Default package width declared to the shipping provider, in that provider unit. See packageLength.
provider string The name for the Provider.
serviceType string The name for the service type.
useLastLabel boolean Whether the provider reuses the label of the previous shipment instead of requesting a new one. Omitted on a write, the stored value is kept.
ShippingModuleProvider (XML)
<shippingModuleProvider>
  <id>...</id>
  <name>Standard</name>
  <provider>ups</provider>
  <serviceType>standard</serviceType>
  <moduleType>
    <id>...</id>
    <name>SPOD</name>
  </moduleType>
  <letter>UPS</letter>
  <useLastLabel>...</useLastLabel>
  <packageLength>...</packageLength>
  <packageWidth>...</packageWidth>
  <packageHeight>...</packageHeight>
  <defaultCountryOfOrigin>CZ</defaultCountryOfOrigin>
</shippingModuleProvider>