ShippingModule Data Type

A shipping integration configured on a shop. Shipping modules connect the platform to an external shipping provider (e.g. GLS, DPD) and calculate delivery rates for orders.

Available Since
1.3.0
Properties
Name Type Description
id number Unique numeric identifier for the shipping module.
version number Internal optimistic-locking version counter.
name string Display name of this shipping module as configured in the shop.
apiUser string API username used to authenticate with the shipping provider's API.
apiKey string API key used to authenticate with the shipping provider's API.
deleted boolean Whether this shipping module has been deleted.
moduleType ShippingModuleType The category or type of this shipping module.
Used in
GET /accounts/{accountId}/shippingModules/{moduleId} response
ShippingModule (JSON) 
{
  "shippingModule" : {
    "id" : 12345,
    "version" : 12345,
    "name" : "My DPD Integration",
    "apiUser" : "...",
    "apiKey" : "...",
    "deleted" : true,
    "moduleType" : {
      "id" : 12345,
      "name" : "SPOD"
    }
  }
}
ShippingModule Data Type

A shipping integration configured on a shop. Shipping modules connect the platform to an external shipping provider (e.g. GLS, DPD) and calculate delivery rates for orders.

Available Since
1.3.0
Properties
Name Type Description
apiKey string API key used to authenticate with the shipping provider's API.
apiUser string API username used to authenticate with the shipping provider's API.
deleted boolean Whether this shipping module has been deleted.
id int Unique numeric identifier for the shipping module.
moduleType ShippingModuleType The category or type of this shipping module.
name string Display name of this shipping module as configured in the shop.
version int Internal optimistic-locking version counter.
Used in
GET /accounts/{accountId}/shippingModules/{moduleId} response
ShippingModule (XML) 
<shippingModule>
  <id>...</id>
  <version>...</version>
  <name>My DPD Integration</name>
  <apiUser>...</apiUser>
  <apiKey>...</apiKey>
  <deleted>...</deleted>
  <moduleType>
    <id>...</id>
    <name>SPOD</name>
  </moduleType>
</shippingModule>