commercetools-logistics - Pinkfish - AI Agents & Workflows for Getting Work Done

Server path: /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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "expand": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Related resources to expand inline"
    },
    "address": {
      "type": "object",
      "description": "The address value",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "key": {
          "type": "string",
          "description": "The key value"
        },
        "country": {
          "type": "string",
          "description": "The country value"
        },
        "title": {
          "type": "string",
          "description": "The title value"
        },
        "salutation": {
          "type": "string",
          "description": "The salutation value"
        },
        "firstName": {
          "type": "string",
          "description": "First Name"
        },
        "lastName": {
          "type": "string",
          "description": "Last Name"
        },
        "streetName": {
          "type": "string",
          "description": "Street Name"
        },
        "streetNumber": {
          "type": "string",
          "description": "Street Number"
        },
        "additionalStreetInfo": {
          "type": "string",
          "description": "Additional Street Info"
        },
        "postalCode": {
          "type": "string",
          "description": "Postal Code"
        },
        "city": {
          "type": "string",
          "description": "The city value"
        },
        "region": {
          "type": "string",
          "description": "The region value"
        },
        "state": {
          "type": "string",
          "description": "The state value"
        },
        "company": {
          "type": "string",
          "description": "The company value"
        },
        "department": {
          "type": "string",
          "description": "The department value"
        },
        "building": {
          "type": "string",
          "description": "The building value"
        },
        "apartment": {
          "type": "string",
          "description": "The apartment value"
        },
        "pOBox": {
          "type": "string",
          "description": "P O Box"
        },
        "phone": {
          "type": "string",
          "description": "The phone value"
        },
        "mobile": {
          "type": "string",
          "description": "The mobile value"
        },
        "email": {
          "type": "string",
          "description": "The email value"
        },
        "fax": {
          "type": "string",
          "description": "The fax value"
        },
        "additionalAddressInfo": {
          "type": "string",
          "description": "Additional Address Info"
        },
        "externalId": {
          "type": "string",
          "description": "External Id"
        }
      },
      "required": [
        "country"
      ]
    },
    "custom": {
      "type": "object",
      "description": "The custom value",
      "properties": {
        "type": {
          "description": "The type value"
        },
        "fields": {
          "type": "object",
          "description": "The fields value"
        }
      },
      "required": [
        "type"
      ]
    },
    "description": {
      "type": "object",
      "description": "The description value"
    },
    "geoLocation": {
      "type": "object",
      "description": "Geo Location",
      "properties": {
        "type": {
          "type": "string",
          "description": "The type value"
        }
      },
      "required": [
        "type"
      ]
    },
    "key": {
      "type": "string",
      "description": "The key value"
    },
    "name": {
      "type": "object",
      "description": "The name value"
    },
    "roles": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "InventorySupply",
          "ProductDistribution",
          "OrderExport",
          "OrderImport",
          "Primary"
        ]
      },
      "description": "The roles value"
    }
  },
  "required": [
    "PCID",
    "key"
  ]
}

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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "expand": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Related resources to expand inline"
    },
    "custom": {
      "type": "object",
      "description": "The custom value",
      "properties": {
        "type": {
          "description": "The type value"
        },
        "fields": {
          "type": "object",
          "description": "The fields value"
        }
      },
      "required": [
        "type"
      ]
    },
    "expectedDelivery": {
      "type": "string",
      "description": "Expected Delivery"
    },
    "key": {
      "type": "string",
      "description": "The key value"
    },
    "maxCartQuantity": {
      "type": "integer",
      "description": "Max Cart Quantity"
    },
    "minCartQuantity": {
      "type": "integer",
      "description": "Min Cart Quantity"
    },
    "quantityOnStock": {
      "type": "integer",
      "description": "Quantity On Stock"
    },
    "restockableInDays": {
      "type": "integer",
      "description": "Restockable In Days"
    },
    "sku": {
      "type": "string",
      "description": "The sku value"
    },
    "supplyChannel": {
      "description": "Supply Channel"
    }
  },
  "required": [
    "PCID",
    "quantityOnStock",
    "sku"
  ]
}

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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "expand": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Related resources to expand inline"
    },
    "active": {
      "type": "boolean",
      "description": "The active value"
    },
    "custom": {
      "type": "object",
      "description": "The custom value",
      "properties": {
        "type": {
          "description": "The type value"
        },
        "fields": {
          "type": "object",
          "description": "The fields value"
        }
      },
      "required": [
        "type"
      ]
    },
    "description": {
      "type": "string",
      "description": "The description value"
    },
    "isDefault": {
      "type": "boolean",
      "description": "Is Default"
    },
    "key": {
      "type": "string",
      "description": "The key value"
    },
    "localizedDescription": {
      "type": "object",
      "description": "Localized Description"
    },
    "localizedName": {
      "type": "object",
      "description": "Localized Name"
    },
    "name": {
      "type": "string",
      "description": "The name value"
    },
    "predicate": {
      "type": "string",
      "description": "The predicate value"
    },
    "taxCategory": {
      "description": "Tax Category"
    },
    "zoneRates": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "zone": {
            "description": "The zone value"
          },
          "shippingRates": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "price": {
                  "type": "object"
                },
                "freeAbove": {
                  "type": "object"
                },
                "tiers": {
                  "type": "array"
                }
              }
            },
            "description": "Shipping Rates"
          }
        },
        "required": [
          "shippingRates",
          "zone"
        ]
      },
      "description": "Zone Rates"
    }
  },
  "required": [
    "PCID",
    "isDefault",
    "name",
    "taxCategory",
    "zoneRates"
  ]
}

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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "expand": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Related resources to expand inline"
    },
    "description": {
      "type": "string",
      "description": "The description value"
    },
    "key": {
      "type": "string",
      "description": "The key value"
    },
    "name": {
      "type": "string",
      "description": "The name value"
    },
    "rates": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "The name value"
          },
          "amount": {
            "type": "number",
            "format": "double",
            "description": "The amount value"
          },
          "includedInPrice": {
            "type": "boolean",
            "description": "Included In Price"
          },
          "country": {
            "type": "string",
            "description": "The country value"
          },
          "state": {
            "type": "string",
            "description": "The state value"
          },
          "subRates": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string"
                },
                "amount": {
                  "type": "number"
                }
              }
            },
            "description": "Sub Rates"
          },
          "key": {
            "type": "string",
            "description": "The key value"
          }
        },
        "required": [
          "country",
          "includedInPrice",
          "name"
        ]
      },
      "description": "The rates value"
    }
  },
  "required": [
    "PCID",
    "name"
  ]
}

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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "expand": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Related resources to expand inline"
    },
    "description": {
      "type": "string",
      "description": "The description value"
    },
    "key": {
      "type": "string",
      "description": "The key value"
    },
    "locations": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "country": {
            "type": "string",
            "description": "The country value"
          },
          "state": {
            "type": "string",
            "description": "The state value"
          }
        },
        "required": [
          "country"
        ]
      },
      "description": "The locations value"
    },
    "name": {
      "type": "string",
      "description": "The name value"
    }
  },
  "required": [
    "PCID",
    "name"
  ]
}

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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "ID": {
      "type": "string",
      "description": "The id value"
    },
    "version": {
      "type": "integer",
      "description": "The version value"
    },
    "expand": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Related resources to expand inline"
    }
  },
  "required": [
    "PCID",
    "ID",
    "version"
  ]
}

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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "key": {
      "type": "string",
      "description": "The key value"
    },
    "version": {
      "type": "integer",
      "description": "The version value"
    },
    "expand": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Related resources to expand inline"
    }
  },
  "required": [
    "PCID",
    "key",
    "version"
  ]
}

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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "ID": {
      "type": "string",
      "description": "The id value"
    },
    "version": {
      "type": "integer",
      "description": "The version value"
    },
    "expand": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Related resources to expand inline"
    }
  },
  "required": [
    "PCID",
    "ID",
    "version"
  ]
}

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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "key": {
      "type": "string",
      "description": "The key value"
    },
    "version": {
      "type": "integer",
      "description": "The version value"
    },
    "expand": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Related resources to expand inline"
    }
  },
  "required": [
    "PCID",
    "key",
    "version"
  ]
}

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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "ID": {
      "type": "string",
      "description": "The id value"
    },
    "version": {
      "type": "integer",
      "description": "The version value"
    },
    "expand": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Related resources to expand inline"
    }
  },
  "required": [
    "PCID",
    "ID",
    "version"
  ]
}

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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "key": {
      "type": "string",
      "description": "The key value"
    },
    "version": {
      "type": "integer",
      "description": "The version value"
    },
    "expand": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Related resources to expand inline"
    }
  },
  "required": [
    "PCID",
    "key",
    "version"
  ]
}

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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "ID": {
      "type": "string",
      "description": "The id value"
    },
    "version": {
      "type": "integer",
      "description": "The version value"
    },
    "expand": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Related resources to expand inline"
    }
  },
  "required": [
    "PCID",
    "ID",
    "version"
  ]
}

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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "key": {
      "type": "string",
      "description": "The key value"
    },
    "version": {
      "type": "integer",
      "description": "The version value"
    },
    "expand": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Related resources to expand inline"
    }
  },
  "required": [
    "PCID",
    "key",
    "version"
  ]
}

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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "ID": {
      "type": "string",
      "description": "The id value"
    },
    "version": {
      "type": "integer",
      "description": "The version value"
    },
    "expand": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Related resources to expand inline"
    }
  },
  "required": [
    "PCID",
    "ID",
    "version"
  ]
}

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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "key": {
      "type": "string",
      "description": "The key value"
    },
    "version": {
      "type": "integer",
      "description": "The version value"
    },
    "expand": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Related resources to expand inline"
    }
  },
  "required": [
    "PCID",
    "key",
    "version"
  ]
}

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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "ID": {
      "type": "string",
      "description": "The id value"
    },
    "expand": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Related resources to expand inline"
    }
  },
  "required": [
    "PCID",
    "ID"
  ]
}

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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "key": {
      "type": "string",
      "description": "The key value"
    },
    "expand": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Related resources to expand inline"
    }
  },
  "required": [
    "PCID",
    "key"
  ]
}

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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "ID": {
      "type": "string",
      "description": "The id value"
    },
    "expand": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Related resources to expand inline"
    }
  },
  "required": [
    "PCID",
    "ID"
  ]
}

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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "key": {
      "type": "string",
      "description": "The key value"
    },
    "expand": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Related resources to expand inline"
    }
  },
  "required": [
    "PCID",
    "key"
  ]
}

commercetools_logistics_get_shipping_methods_by_id

Retrieves a ShippingMethod with the provided id. Parameters:

Parameter	Type	Required	Default	Description
`ID`	string	Yes	—	The id value
`expand`	string[]	No	—	Related resources to expand inline

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "ID": {
      "type": "string",
      "description": "The id value"
    },
    "expand": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Related resources to expand inline"
    }
  },
  "required": [
    "PCID",
    "ID"
  ]
}

commercetools_logistics_get_shipping_methods_by_key

Retrieves a ShippingMethod with the provided key. Parameters:

Parameter	Type	Required	Default	Description
`key`	string	Yes	—	The key value
`expand`	string[]	No	—	Related resources to expand inline

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "key": {
      "type": "string",
      "description": "The key value"
    },
    "expand": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Related resources to expand inline"
    }
  },
  "required": [
    "PCID",
    "key"
  ]
}

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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "ID": {
      "type": "string",
      "description": "The id value"
    },
    "expand": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Related resources to expand inline"
    }
  },
  "required": [
    "PCID",
    "ID"
  ]
}

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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "key": {
      "type": "string",
      "description": "The key value"
    },
    "expand": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Related resources to expand inline"
    }
  },
  "required": [
    "PCID",
    "key"
  ]
}

commercetools_logistics_get_zones_by_id

Retrieves a Zone with the provided id. Parameters:

Parameter	Type	Required	Default	Description
`ID`	string	Yes	—	The id value
`expand`	string[]	No	—	Related resources to expand inline

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "ID": {
      "type": "string",
      "description": "The id value"
    },
    "expand": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Related resources to expand inline"
    }
  },
  "required": [
    "PCID",
    "ID"
  ]
}

commercetools_logistics_get_zones_by_key

Retrieves a Zone with the provided key. Parameters:

Parameter	Type	Required	Default	Description
`key`	string	Yes	—	The key value
`expand`	string[]	No	—	Related resources to expand inline

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "key": {
      "type": "string",
      "description": "The key value"
    },
    "expand": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Related resources to expand inline"
    }
  },
  "required": [
    "PCID",
    "key"
  ]
}

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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "expand": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Related resources to expand inline"
    },
    "sort": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Sort order for results"
    },
    "limit": {
      "type": "integer",
      "description": "Maximum number of results to return"
    },
    "offset": {
      "type": "integer",
      "description": "The offset value"
    },
    "withTotal": {
      "type": "boolean",
      "description": "With Total"
    },
    "where": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The where value"
    }
  },
  "required": [
    "PCID"
  ]
}

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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "expand": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Related resources to expand inline"
    },
    "sort": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Sort order for results"
    },
    "limit": {
      "type": "integer",
      "description": "Maximum number of results to return"
    },
    "offset": {
      "type": "integer",
      "description": "The offset value"
    },
    "withTotal": {
      "type": "boolean",
      "description": "With Total"
    },
    "where": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The where value"
    }
  },
  "required": [
    "PCID"
  ]
}

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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "expand": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Related resources to expand inline"
    },
    "sort": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Sort order for results"
    },
    "limit": {
      "type": "integer",
      "description": "Maximum number of results to return"
    },
    "offset": {
      "type": "integer",
      "description": "The offset value"
    },
    "withTotal": {
      "type": "boolean",
      "description": "With Total"
    },
    "where": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The where value"
    }
  },
  "required": [
    "PCID"
  ]
}

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. Parameters:

Parameter	Type	Required	Default	Description
`cartId`	string	Yes	—	Cart Id
`expand`	string[]	No	—	Related resources to expand inline

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "cartId": {
      "type": "string",
      "description": "Cart Id"
    },
    "expand": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Related resources to expand inline"
    }
  },
  "required": [
    "PCID",
    "cartId"
  ]
}

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. 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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "country": {
      "type": "string",
      "description": "The country value"
    },
    "state": {
      "type": "string",
      "description": "The state value"
    },
    "cartId": {
      "type": "string",
      "description": "Cart Id"
    },
    "expand": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Related resources to expand inline"
    }
  },
  "required": [
    "PCID",
    "country",
    "cartId"
  ]
}

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. 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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "country": {
      "type": "string",
      "description": "The country value"
    },
    "state": {
      "type": "string",
      "description": "The state value"
    },
    "currency": {
      "type": "string",
      "description": "The currency value"
    },
    "expand": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Related resources to expand inline"
    },
    "sort": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Sort order for results"
    }
  },
  "required": [
    "PCID",
    "country"
  ]
}

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. Parameters:

Parameter	Type	Required	Default	Description
`orderEditId`	string	Yes	—	Order Edit Id
`country`	string	Yes	—	The country value
`state`	string	No	—	The state value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "orderEditId": {
      "type": "string",
      "description": "Order Edit Id"
    },
    "country": {
      "type": "string",
      "description": "The country value"
    },
    "state": {
      "type": "string",
      "description": "The state value"
    }
  },
  "required": [
    "PCID",
    "orderEditId",
    "country"
  ]
}

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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "expand": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Related resources to expand inline"
    },
    "sort": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Sort order for results"
    },
    "limit": {
      "type": "integer",
      "description": "Maximum number of results to return"
    },
    "offset": {
      "type": "integer",
      "description": "The offset value"
    },
    "withTotal": {
      "type": "boolean",
      "description": "With Total"
    },
    "where": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The where value"
    }
  },
  "required": [
    "PCID"
  ]
}

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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "expand": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Related resources to expand inline"
    },
    "sort": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Sort order for results"
    },
    "limit": {
      "type": "integer",
      "description": "Maximum number of results to return"
    },
    "offset": {
      "type": "integer",
      "description": "The offset value"
    },
    "withTotal": {
      "type": "boolean",
      "description": "With Total"
    },
    "where": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The where value"
    }
  },
  "required": [
    "PCID"
  ]
}

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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "ID": {
      "type": "string",
      "description": "The id value"
    },
    "expand": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Related resources to expand inline"
    },
    "actions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "action": {
            "type": "string",
            "description": "The action value"
          }
        },
        "required": [
          "action"
        ]
      },
      "description": "The actions value"
    },
    "version": {
      "type": "integer",
      "description": "The version value"
    }
  },
  "required": [
    "PCID",
    "ID",
    "actions",
    "version"
  ]
}

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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "key": {
      "type": "string",
      "description": "The key value"
    },
    "expand": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Related resources to expand inline"
    },
    "actions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "action": {
            "type": "string",
            "description": "The action value"
          }
        },
        "required": [
          "action"
        ]
      },
      "description": "The actions value"
    },
    "version": {
      "type": "integer",
      "description": "The version value"
    }
  },
  "required": [
    "PCID",
    "key",
    "actions",
    "version"
  ]
}

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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "ID": {
      "type": "string",
      "description": "The id value"
    },
    "expand": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Related resources to expand inline"
    },
    "actions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "action": {
            "type": "string",
            "description": "The action value"
          }
        },
        "required": [
          "action"
        ]
      },
      "description": "The actions value"
    },
    "version": {
      "type": "integer",
      "description": "The version value"
    }
  },
  "required": [
    "PCID",
    "ID",
    "actions",
    "version"
  ]
}

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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "key": {
      "type": "string",
      "description": "The key value"
    },
    "expand": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Related resources to expand inline"
    },
    "actions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "action": {
            "type": "string",
            "description": "The action value"
          }
        },
        "required": [
          "action"
        ]
      },
      "description": "The actions value"
    },
    "version": {
      "type": "integer",
      "description": "The version value"
    }
  },
  "required": [
    "PCID",
    "key",
    "actions",
    "version"
  ]
}

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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "ID": {
      "type": "string",
      "description": "The id value"
    },
    "expand": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Related resources to expand inline"
    },
    "actions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "action": {
            "type": "string",
            "description": "The action value"
          }
        },
        "required": [
          "action"
        ]
      },
      "description": "The actions value"
    },
    "version": {
      "type": "integer",
      "description": "The version value"
    }
  },
  "required": [
    "PCID",
    "ID",
    "actions",
    "version"
  ]
}

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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "key": {
      "type": "string",
      "description": "The key value"
    },
    "expand": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Related resources to expand inline"
    },
    "actions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "action": {
            "type": "string",
            "description": "The action value"
          }
        },
        "required": [
          "action"
        ]
      },
      "description": "The actions value"
    },
    "version": {
      "type": "integer",
      "description": "The version value"
    }
  },
  "required": [
    "PCID",
    "key",
    "actions",
    "version"
  ]
}

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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "ID": {
      "type": "string",
      "description": "The id value"
    },
    "expand": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Related resources to expand inline"
    },
    "actions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "action": {
            "type": "string",
            "description": "The action value"
          }
        },
        "required": [
          "action"
        ]
      },
      "description": "The actions value"
    },
    "version": {
      "type": "integer",
      "description": "The version value"
    }
  },
  "required": [
    "PCID",
    "ID",
    "actions",
    "version"
  ]
}

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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "key": {
      "type": "string",
      "description": "The key value"
    },
    "expand": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Related resources to expand inline"
    },
    "actions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "action": {
            "type": "string",
            "description": "The action value"
          }
        },
        "required": [
          "action"
        ]
      },
      "description": "The actions value"
    },
    "version": {
      "type": "integer",
      "description": "The version value"
    }
  },
  "required": [
    "PCID",
    "key",
    "actions",
    "version"
  ]
}

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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "ID": {
      "type": "string",
      "description": "The id value"
    },
    "expand": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Related resources to expand inline"
    },
    "actions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "action": {
            "type": "string",
            "description": "The action value"
          }
        },
        "required": [
          "action"
        ]
      },
      "description": "The actions value"
    },
    "version": {
      "type": "integer",
      "description": "The version value"
    }
  },
  "required": [
    "PCID",
    "ID",
    "actions",
    "version"
  ]
}

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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "key": {
      "type": "string",
      "description": "The key value"
    },
    "expand": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Related resources to expand inline"
    },
    "actions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "action": {
            "type": "string",
            "description": "The action value"
          }
        },
        "required": [
          "action"
        ]
      },
      "description": "The actions value"
    },
    "version": {
      "type": "integer",
      "description": "The version value"
    }
  },
  "required": [
    "PCID",
    "key",
    "actions",
    "version"
  ]
}

commercetools-discounts commercetools-orders

⌘I

​Tools

​commercetools_logistics_create_channels

​commercetools_logistics_create_inventory

​commercetools_logistics_create_shipping_methods

​commercetools_logistics_create_tax_categories

​commercetools_logistics_create_zones

​commercetools_logistics_delete_channels_by_id

​commercetools_logistics_delete_channels_by_key

​commercetools_logistics_delete_inventory_by_id

​commercetools_logistics_delete_inventory_by_key

​commercetools_logistics_delete_shipping_methods_by_id

​commercetools_logistics_delete_shipping_methods_by_key

​commercetools_logistics_delete_tax_categories_by_id

​commercetools_logistics_delete_tax_categories_by_key

​commercetools_logistics_delete_zones_by_id

​commercetools_logistics_delete_zones_by_key

​commercetools_logistics_get_channels_by_id

​commercetools_logistics_get_channels_by_key

​commercetools_logistics_get_inventory_by_id

​commercetools_logistics_get_inventory_by_key

​commercetools_logistics_get_shipping_methods_by_id

​commercetools_logistics_get_shipping_methods_by_key

​commercetools_logistics_get_tax_categories_by_id

​commercetools_logistics_get_tax_categories_by_key

​commercetools_logistics_get_zones_by_id

​commercetools_logistics_get_zones_by_key

​commercetools_logistics_list_channels

​commercetools_logistics_list_inventory

​commercetools_logistics_list_shipping_methods

​commercetools_logistics_list_shipping_methods_matching_cart

​commercetools_logistics_list_shipping_methods_matching_cart_location

​commercetools_logistics_list_shipping_methods_matching_location

​commercetools_logistics_list_shipping_methods_matching_orderedit

​commercetools_logistics_list_tax_categories

​commercetools_logistics_list_zones

​commercetools_logistics_update_channels_by_id

​commercetools_logistics_update_channels_by_key

​commercetools_logistics_update_inventory_by_id

​commercetools_logistics_update_inventory_by_key

​commercetools_logistics_update_shipping_methods_by_id

​commercetools_logistics_update_shipping_methods_by_key

​commercetools_logistics_update_tax_categories_by_id

​commercetools_logistics_update_tax_categories_by_key

​commercetools_logistics_update_zones_by_id

​commercetools_logistics_update_zones_by_key

Tools

commercetools_logistics_create_channels

commercetools_logistics_create_inventory

commercetools_logistics_create_shipping_methods

commercetools_logistics_create_tax_categories

commercetools_logistics_create_zones

commercetools_logistics_delete_channels_by_id

commercetools_logistics_delete_channels_by_key

commercetools_logistics_delete_inventory_by_id

commercetools_logistics_delete_inventory_by_key

commercetools_logistics_delete_shipping_methods_by_id

commercetools_logistics_delete_shipping_methods_by_key

commercetools_logistics_delete_tax_categories_by_id

commercetools_logistics_delete_tax_categories_by_key

commercetools_logistics_delete_zones_by_id

commercetools_logistics_delete_zones_by_key

commercetools_logistics_get_channels_by_id

commercetools_logistics_get_channels_by_key

commercetools_logistics_get_inventory_by_id

commercetools_logistics_get_inventory_by_key

commercetools_logistics_get_shipping_methods_by_id

commercetools_logistics_get_shipping_methods_by_key

commercetools_logistics_get_tax_categories_by_id

commercetools_logistics_get_tax_categories_by_key

commercetools_logistics_get_zones_by_id

commercetools_logistics_get_zones_by_key

commercetools_logistics_list_channels

commercetools_logistics_list_inventory

commercetools_logistics_list_shipping_methods

commercetools_logistics_list_shipping_methods_matching_cart

commercetools_logistics_list_shipping_methods_matching_cart_location

commercetools_logistics_list_shipping_methods_matching_location

commercetools_logistics_list_shipping_methods_matching_orderedit

commercetools_logistics_list_tax_categories

commercetools_logistics_list_zones

commercetools_logistics_update_channels_by_id

commercetools_logistics_update_channels_by_key

commercetools_logistics_update_inventory_by_id

commercetools_logistics_update_inventory_by_key

commercetools_logistics_update_shipping_methods_by_id

commercetools_logistics_update_shipping_methods_by_key

commercetools_logistics_update_tax_categories_by_id

commercetools_logistics_update_tax_categories_by_key

commercetools_logistics_update_zones_by_id

commercetools_logistics_update_zones_by_key