/commercetools-logistics | Type: Application | PCID required: Yes
Tools
| Tool | Description |
|---|---|
commercetools_logistics_create_channels | POST /channels |
commercetools_logistics_create_inventory | Creates an InventoryEntry in the Project. If quantity limits are provided, existing Line Items that reference a Product Variant with an SKU that matches the Inventory Entry can be affected. For more information, see Quantity limits. Produces the InventoryEntryCreated Message. |
commercetools_logistics_create_shipping_methods | Creates a ShippingMethod in the Project. |
commercetools_logistics_create_tax_categories | POST /tax-categories |
commercetools_logistics_create_zones | Creates a Zone in the Project. |
commercetools_logistics_delete_channels_by_id | Returns a ReferenceExists error if other resources reference the Channel to be deleted. |
commercetools_logistics_delete_channels_by_key | Returns a ReferenceExists error if other resources reference the Channel to be deleted. |
commercetools_logistics_delete_inventory_by_id | Produces the InventoryEntryDeleted Message. |
commercetools_logistics_delete_inventory_by_key | Produces the InventoryEntryDeleted Message. |
commercetools_logistics_delete_shipping_methods_by_id | Deletes a ShippingMethod in the Project. |
commercetools_logistics_delete_shipping_methods_by_key | Deletes a ShippingMethod in the Project. |
commercetools_logistics_delete_tax_categories_by_id | DELETE /tax-categories/{ID} |
commercetools_logistics_delete_tax_categories_by_key | DELETE /tax-categories/key={key} |
commercetools_logistics_delete_zones_by_id | Deletes a Zone in the Project. |
commercetools_logistics_delete_zones_by_key | Deletes a Zone in the Project. |
commercetools_logistics_get_channels_by_id | GET /channels/{ID} |
commercetools_logistics_get_channels_by_key | GET /channels/key={key} |
commercetools_logistics_get_inventory_by_id | GET /inventory/{ID} |
commercetools_logistics_get_inventory_by_key | GET /inventory/key={key} |
commercetools_logistics_get_shipping_methods_by_id | Retrieves a ShippingMethod with the provided id. |
commercetools_logistics_get_shipping_methods_by_key | Retrieves a ShippingMethod with the provided key. |
commercetools_logistics_get_tax_categories_by_id | GET /tax-categories/{ID} |
commercetools_logistics_get_tax_categories_by_key | GET /tax-categories/key={key} |
commercetools_logistics_get_zones_by_id | Retrieves a Zone with the provided id. |
commercetools_logistics_get_zones_by_key | Retrieves a Zone with the provided key. |
commercetools_logistics_list_channels | GET /channels |
commercetools_logistics_list_inventory | GET /inventory |
commercetools_logistics_list_shipping_methods | Retrieves all ShippingMethods in the Project. |
commercetools_logistics_list_shipping_methods_matching_cart | Retrieves the active ShippingMethods that can ship to the shipping address of the provided Cart. Each ShippingMethod contains exactly one ShippingRate with the flag isMatching set to true. This ShippingRate is used when the ShippingMethod is added to the Cart. If a matching ShippingMethod has isDefault set to true, it is returned as the first item in the array. |
commercetools_logistics_list_shipping_methods_matching_cart_location | Retrieves the active ShippingMethods that can ship to the provided Location with a predicate that matches the provided Cart. Each ShippingMethod contains exactly one ShippingRate with the flag isMatching set to true. This ShippingRate is used when the ShippingMethod is added to the Cart. If a matching ShippingMethod has isDefault set to true, it is returned as the first item in the array. |
commercetools_logistics_list_shipping_methods_matching_location | Retrieves the active ShippingMethods that can ship to the provided Location. The following applies: - ShippingMethods that have a predicate defined are automatically disqualified. - If the currency parameter is provided, then the ShippingMethods must also have a rate defined in the specified currency. - Each ShippingMethod contains at least one ShippingRate with the flag isMatching set to true. - If the currency parameter is provided, exactly one ShippingRate will contain it. - If a matching ShippingMethod has isDefault set to true, it is returned as the first item in the array. |
commercetools_logistics_list_shipping_methods_matching_orderedit | Retrieves the active ShippingMethods that can ship to the provided Location for an OrderEdit. If a matching ShippingMethod has isDefault set to true, it is returned as the first item in the array. If the OrderEdit preview cannot be generated, an EditPreviewFailed error is returned. |
commercetools_logistics_list_tax_categories | GET /tax-categories |
commercetools_logistics_list_zones | Retrieves all Zones in the Project. |
commercetools_logistics_update_channels_by_id | POST /channels/{ID} |
commercetools_logistics_update_channels_by_key | POST /channels/key={key} |
commercetools_logistics_update_inventory_by_id | POST /inventory/{ID} |
commercetools_logistics_update_inventory_by_key | POST /inventory/key={key} |
commercetools_logistics_update_shipping_methods_by_id | Updates a ShippingMethod in the Project using one or more update actions. |
commercetools_logistics_update_shipping_methods_by_key | Updates a ShippingMethod in the Project using one or more update actions. |
commercetools_logistics_update_tax_categories_by_id | POST /tax-categories/{ID} |
commercetools_logistics_update_tax_categories_by_key | POST /tax-categories/key={key} |
commercetools_logistics_update_zones_by_id | POST /zones/{ID} |
commercetools_logistics_update_zones_by_key | Updates a Zone in the Project using one or more update actions. |
commercetools_logistics_create_channels
POST /channels Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expand | string[] | No | — | Related resources to expand inline |
address | object | No | — | The address value |
custom | object | No | — | The custom value |
description | object | No | — | The description value |
geoLocation | object | No | — | Geo Location |
key | string | Yes | — | The key value |
name | object | No | — | The name value |
roles | string[] | No | — | The roles value |
commercetools_logistics_create_inventory
Creates an InventoryEntry in the Project. If quantity limits are provided, existing Line Items that reference a Product Variant with an SKU that matches the Inventory Entry can be affected. For more information, see Quantity limits. Produces the InventoryEntryCreated Message. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expand | string[] | No | — | Related resources to expand inline |
custom | object | No | — | The custom value |
expectedDelivery | string | No | — | Expected Delivery |
key | string | No | — | The key value |
maxCartQuantity | integer | No | — | Max Cart Quantity |
minCartQuantity | integer | No | — | Min Cart Quantity |
quantityOnStock | integer | Yes | — | Quantity On Stock |
restockableInDays | integer | No | — | Restockable In Days |
sku | string | Yes | — | The sku value |
supplyChannel | object | No | — | Supply Channel |
commercetools_logistics_create_shipping_methods
Creates a ShippingMethod in the Project. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expand | string[] | No | — | Related resources to expand inline |
active | boolean | No | — | The active value |
custom | object | No | — | The custom value |
description | string | No | — | The description value |
isDefault | boolean | Yes | — | Is Default |
key | string | No | — | The key value |
localizedDescription | object | No | — | Localized Description |
localizedName | object | No | — | Localized Name |
name | string | Yes | — | The name value |
predicate | string | No | — | The predicate value |
taxCategory | object | Yes | — | Tax Category |
zoneRates | object[] | Yes | — | Zone Rates |
commercetools_logistics_create_tax_categories
POST /tax-categories Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expand | string[] | No | — | Related resources to expand inline |
description | string | No | — | The description value |
key | string | No | — | The key value |
name | string | Yes | — | The name value |
rates | object[] | No | — | The rates value |
commercetools_logistics_create_zones
Creates a Zone in the Project. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expand | string[] | No | — | Related resources to expand inline |
description | string | No | — | The description value |
key | string | No | — | The key value |
locations | object[] | No | — | The locations value |
name | string | Yes | — | The name value |
commercetools_logistics_delete_channels_by_id
Returns a ReferenceExists error if other resources reference the Channel to be deleted. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
version | integer | Yes | — | The version value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_logistics_delete_channels_by_key
Returns a ReferenceExists error if other resources reference the Channel to be deleted. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
version | integer | Yes | — | The version value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_logistics_delete_inventory_by_id
Produces the InventoryEntryDeleted Message. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
version | integer | Yes | — | The version value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_logistics_delete_inventory_by_key
Produces the InventoryEntryDeleted Message. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
version | integer | Yes | — | The version value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_logistics_delete_shipping_methods_by_id
Deletes a ShippingMethod in the Project. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
version | integer | Yes | — | The version value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_logistics_delete_shipping_methods_by_key
Deletes a ShippingMethod in the Project. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
version | integer | Yes | — | The version value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_logistics_delete_tax_categories_by_id
DELETE /tax-categories/{ID} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
version | integer | Yes | — | The version value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_logistics_delete_tax_categories_by_key
DELETE /tax-categories/key={key} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
version | integer | Yes | — | The version value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_logistics_delete_zones_by_id
Deletes a Zone in the Project. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
version | integer | Yes | — | The version value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_logistics_delete_zones_by_key
Deletes a Zone in the Project. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
version | integer | Yes | — | The version value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_logistics_get_channels_by_id
GET /channels/{ID} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_logistics_get_channels_by_key
GET /channels/key={key} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_logistics_get_inventory_by_id
GET /inventory/{ID} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_logistics_get_inventory_by_key
GET /inventory/key={key} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_logistics_get_shipping_methods_by_id
Retrieves a ShippingMethod with the providedid.
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_logistics_get_shipping_methods_by_key
Retrieves a ShippingMethod with the providedkey.
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_logistics_get_tax_categories_by_id
GET /tax-categories/{ID} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_logistics_get_tax_categories_by_key
GET /tax-categories/key={key} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_logistics_get_zones_by_id
Retrieves a Zone with the providedid.
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_logistics_get_zones_by_key
Retrieves a Zone with the providedkey.
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_logistics_list_channels
GET /channels Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expand | string[] | No | — | Related resources to expand inline |
sort | string[] | No | — | Sort order for results |
limit | integer | No | — | Maximum number of results to return |
offset | integer | No | — | The offset value |
withTotal | boolean | No | — | With Total |
where | string[] | No | — | The where value |
commercetools_logistics_list_inventory
GET /inventory Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expand | string[] | No | — | Related resources to expand inline |
sort | string[] | No | — | Sort order for results |
limit | integer | No | — | Maximum number of results to return |
offset | integer | No | — | The offset value |
withTotal | boolean | No | — | With Total |
where | string[] | No | — | The where value |
commercetools_logistics_list_shipping_methods
Retrieves all ShippingMethods in the Project. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expand | string[] | No | — | Related resources to expand inline |
sort | string[] | No | — | Sort order for results |
limit | integer | No | — | Maximum number of results to return |
offset | integer | No | — | The offset value |
withTotal | boolean | No | — | With Total |
where | string[] | No | — | The where value |
commercetools_logistics_list_shipping_methods_matching_cart
Retrieves the active ShippingMethods that can ship to the shipping address of the provided Cart. Each ShippingMethod contains exactly one ShippingRate with the flagisMatching set to true. This ShippingRate is used when the ShippingMethod is added to the Cart. If a matching ShippingMethod has isDefault set to true, it is returned as the first item in the array.
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cartId | string | Yes | — | Cart Id |
expand | string[] | No | — | Related resources to expand inline |
commercetools_logistics_list_shipping_methods_matching_cart_location
Retrieves the active ShippingMethods that can ship to the provided Location with apredicate that matches the provided Cart. Each ShippingMethod contains exactly one ShippingRate with the flag isMatching set to true. This ShippingRate is used when the ShippingMethod is added to the Cart. If a matching ShippingMethod has isDefault set to true, it is returned as the first item in the array.
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
country | string | Yes | — | The country value |
state | string | No | — | The state value |
cartId | string | Yes | — | Cart Id |
expand | string[] | No | — | Related resources to expand inline |
commercetools_logistics_list_shipping_methods_matching_location
Retrieves the active ShippingMethods that can ship to the provided Location. The following applies: - ShippingMethods that have apredicate defined are automatically disqualified. - If the currency parameter is provided, then the ShippingMethods must also have a rate defined in the specified currency. - Each ShippingMethod contains at least one ShippingRate with the flag isMatching set to true. - If the currency parameter is provided, exactly one ShippingRate will contain it. - If a matching ShippingMethod has isDefault set to true, it is returned as the first item in the array.
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
country | string | Yes | — | The country value |
state | string | No | — | The state value |
currency | string | No | — | The currency value |
expand | string[] | No | — | Related resources to expand inline |
sort | string[] | No | — | Sort order for results |
commercetools_logistics_list_shipping_methods_matching_orderedit
Retrieves the active ShippingMethods that can ship to the provided Location for an OrderEdit. If a matching ShippingMethod hasisDefault set to true, it is returned as the first item in the array. If the OrderEdit preview cannot be generated, an EditPreviewFailed error is returned.
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
orderEditId | string | Yes | — | Order Edit Id |
country | string | Yes | — | The country value |
state | string | No | — | The state value |
commercetools_logistics_list_tax_categories
GET /tax-categories Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expand | string[] | No | — | Related resources to expand inline |
sort | string[] | No | — | Sort order for results |
limit | integer | No | — | Maximum number of results to return |
offset | integer | No | — | The offset value |
withTotal | boolean | No | — | With Total |
where | string[] | No | — | The where value |
commercetools_logistics_list_zones
Retrieves all Zones in the Project. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expand | string[] | No | — | Related resources to expand inline |
sort | string[] | No | — | Sort order for results |
limit | integer | No | — | Maximum number of results to return |
offset | integer | No | — | The offset value |
withTotal | boolean | No | — | With Total |
where | string[] | No | — | The where value |
commercetools_logistics_update_channels_by_id
POST /channels/{ID} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
expand | string[] | No | — | Related resources to expand inline |
actions | object[] | Yes | — | The actions value |
version | integer | Yes | — | The version value |
commercetools_logistics_update_channels_by_key
POST /channels/key={key} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
expand | string[] | No | — | Related resources to expand inline |
actions | object[] | Yes | — | The actions value |
version | integer | Yes | — | The version value |
commercetools_logistics_update_inventory_by_id
POST /inventory/{ID} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
expand | string[] | No | — | Related resources to expand inline |
actions | object[] | Yes | — | The actions value |
version | integer | Yes | — | The version value |
commercetools_logistics_update_inventory_by_key
POST /inventory/key={key} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
expand | string[] | No | — | Related resources to expand inline |
actions | object[] | Yes | — | The actions value |
version | integer | Yes | — | The version value |
commercetools_logistics_update_shipping_methods_by_id
Updates a ShippingMethod in the Project using one or more update actions. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
expand | string[] | No | — | Related resources to expand inline |
actions | object[] | Yes | — | The actions value |
version | integer | Yes | — | The version value |
commercetools_logistics_update_shipping_methods_by_key
Updates a ShippingMethod in the Project using one or more update actions. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
expand | string[] | No | — | Related resources to expand inline |
actions | object[] | Yes | — | The actions value |
version | integer | Yes | — | The version value |
commercetools_logistics_update_tax_categories_by_id
POST /tax-categories/{ID} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
expand | string[] | No | — | Related resources to expand inline |
actions | object[] | Yes | — | The actions value |
version | integer | Yes | — | The version value |
commercetools_logistics_update_tax_categories_by_key
POST /tax-categories/key={key} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
expand | string[] | No | — | Related resources to expand inline |
actions | object[] | Yes | — | The actions value |
version | integer | Yes | — | The version value |
commercetools_logistics_update_zones_by_id
POST /zones/{ID} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
expand | string[] | No | — | Related resources to expand inline |
actions | object[] | Yes | — | The actions value |
version | integer | Yes | — | The version value |
commercetools_logistics_update_zones_by_key
Updates a Zone in the Project using one or more update actions. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
expand | string[] | No | — | Related resources to expand inline |
actions | object[] | Yes | — | The actions value |
version | integer | Yes | — | The version value |

