> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# commercetools-orders
> commercetools Orders - manage orders, carts, payments, and payment methods
**Server path:** `/commercetools-orders` | **Type:** Application | **PCID required:** Yes
## Tools
| Tool | Description |
| ------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [`commercetools_orders_create_carts`](#commercetools_orders_create_carts) | Creates a Cart in the Project. If the referenced ShippingMethod in the CartDraft has a predicate that does not match, or if the Shipping Method is not active, an InvalidOperation error is returned. Specific Error Codes: - DiscountCodeNonApplicable - InvalidItemShippingDetails - MatchingPriceNotFound - MissingTaxRateForCountry |
| [`commercetools_orders_create_carts_customer_id_customer_id_merge`](#commercetools_orders_create_carts_customer_id_customer_id_merge) | Merges items from an anonymous Cart into the most recently modified active Cart of a Customer. If no active Cart exists, the anonymous Cart becomes the Customer's active Cart. For more information about merge mode behaviors, merge rules, and tax recalculation, see Merge a Cart. |
| [`commercetools_orders_create_carts_replicate`](#commercetools_orders_create_carts_replicate) | Creates a new Cart by replicating an existing Cart or Order. The following applies to the new Cart: - It contains the same Customer information, Line Items and Custom Line Items, Custom Fields, Discount Codes, and other settings of the originating Cart or Order. - If a Line Item becomes invalid, it is removed from the new Cart. A common reason for this is removed Products or Prices. - Line items and Custom Line Items are reset to their initial state. - It contains no payments or delivery information. - It contains up-to-date Tax Rates, Prices, and Line Item product data. - The CartState is `Active`. - If using the `customerGroup` field (for a single Customer Group) and the referenced Customer switched to another Customer Group, the new Cart is automatically updated to reflect the new group and corresponding prices. - If using the `customerGroupAssignments` field (for multiple Customer Groups), the Cart no longer keeps a direct reference to a Customer Group. If a Customer’s group assignments change, the Cart and its Line Item prices are not updated automatically. Prices are only updated when the Cart is changed via a direct update action. Specific Error Codes: - MatchingPriceNotFound - MissingTaxRateForCountry |
| [`commercetools_orders_create_orders`](#commercetools_orders_create_orders) | Creates an Order from a Cart. The Cart must have a shipping address and an active Shipping Method set. The shipping address is used for tax calculation for a Cart with `Platform` TaxMode. Creating an Order produces the OrderCreated Message. If the Order is created from a Recurring Order schedule, the OrderCreatedFromRecurringOrder Message is generated. If a server-side problem occurs, indicated by a 500 Internal Server Error HTTP response, the Order creation may still successfully complete after the error is returned. If you receive this error, you should verify the status of the Order by querying a unique identifier supplied during the creation request, such as the Order number. Specific Error Codes: - OutOfStock - PriceChanged - DiscountCodeNonApplicable - ShippingMethodDoesNotMatchCart - InvalidItemShippingDetails - InvalidOperation - MatchingPriceNotFound - MissingTaxRateForCountry |
| [`commercetools_orders_create_orders_edits`](#commercetools_orders_create_orders_edits) | Creates an OrderEdit in the Project. You can either create multiple Order Edits for an Order and apply them sequentially to an Order, or create multiple Order Edits parallelly (as alternatives to each other) and apply one of them to the Order. You can only create an Order Edit if the InventoryMode of the Order and its LineItems is `None`. |
| [`commercetools_orders_create_orders_edits_apply_by_id`](#commercetools_orders_create_orders_edits_apply_by_id) | Applying an OrderEdit produces the OrderEditApplied Message. |
| [`commercetools_orders_create_orders_import`](#commercetools_orders_create_orders_import) | Creates an Order without needing to create a Cart first. Importing an Order produces the Order Imported Message. Specific Error Codes: - OutOfStock - CountryNotConfiguredInStore |
| [`commercetools_orders_create_orders_order_number_order_number`](#commercetools_orders_create_orders_order_number_order_number) | Updates an Order in the Project using one or more update actions. |
| [`commercetools_orders_create_orders_quotes`](#commercetools_orders_create_orders_quotes) | Creates an Order from a Quote. The referenced Quote must have the `Pending` state and must be valid (not past the `validTo` date); otherwise, an InvalidOperation error is returned. Produces the OrderCreated Message. Specific Error Codes: - CountryNotConfiguredInStore - InvalidItemShippingDetails - InvalidOperation - OutOfStock |
| [`commercetools_orders_create_orders_search`](#commercetools_orders_create_orders_search) | POST /orders/search |
| [`commercetools_orders_create_payment_methods`](#commercetools_orders_create_payment_methods) | Creates a PaymentMethod in the Project. This request generates the PaymentMethodCreated Message. |
| [`commercetools_orders_create_payments`](#commercetools_orders_create_payments) | Creates a Payment in the Project. Creating a Payment produces the PaymentCreated Message. |
| [`commercetools_orders_delete_by_id`](#commercetools_orders_delete_by_id) | Deletes an Order in the Project. Deleting an Order produces the OrderDeleted Message. |
| [`commercetools_orders_delete_carts_by_id`](#commercetools_orders_delete_carts_by_id) | Deletes a Cart in the Project. |
| [`commercetools_orders_delete_carts_by_key`](#commercetools_orders_delete_carts_by_key) | Deletes a Cart in the Project. |
| [`commercetools_orders_delete_edits_by_id`](#commercetools_orders_delete_edits_by_id) | Deletes an OrderEdit in the Project. |
| [`commercetools_orders_delete_edits_by_key`](#commercetools_orders_delete_edits_by_key) | Deletes an OrderEdit in the Project. |
| [`commercetools_orders_delete_order_number_order_number`](#commercetools_orders_delete_order_number_order_number) | Deletes an Order in the Project. Deleting an Order produces the OrderDeleted Message. |
| [`commercetools_orders_delete_payment_methods_by_id`](#commercetools_orders_delete_payment_methods_by_id) | Deletes a PaymentMethod in the Project. This request generates the PaymentMethodDeleted Message. |
| [`commercetools_orders_delete_payment_methods_by_key`](#commercetools_orders_delete_payment_methods_by_key) | Deletes a PaymentMethod in the Project. This request generates the PaymentMethodDeleted Message. |
| [`commercetools_orders_delete_payments_by_id`](#commercetools_orders_delete_payments_by_id) | Deletes a Payment in the Project. |
| [`commercetools_orders_delete_payments_by_key`](#commercetools_orders_delete_payments_by_key) | Deletes a Payment in the Project. |
| [`commercetools_orders_get_by_id`](#commercetools_orders_get_by_id) | Retrieves an Order with the provided `id`. |
| [`commercetools_orders_get_carts_by_id`](#commercetools_orders_get_carts_by_id) | Retrieves a Cart with the provided `id`. To ensure the Cart is up-to-date with current values (such as Prices and Discounts), use the Recalculate update action. |
| [`commercetools_orders_get_carts_by_key`](#commercetools_orders_get_carts_by_key) | Retrieves a Cart with the provided `key`. To ensure the Cart is up-to-date with current values (such as Prices and Discounts), use the Recalculate update action. |
| [`commercetools_orders_get_edits_by_id`](#commercetools_orders_get_edits_by_id) | Retrieves an OrderEdit with the provided `id`. |
| [`commercetools_orders_get_edits_by_key`](#commercetools_orders_get_edits_by_key) | Retrieves an OrderEdit with the provided `key`. |
| [`commercetools_orders_get_payment_methods_by_id`](#commercetools_orders_get_payment_methods_by_id) | Retrieves a PaymentMethod with the provided `id`. |
| [`commercetools_orders_get_payment_methods_by_key`](#commercetools_orders_get_payment_methods_by_key) | Retrieves a PaymentMethod with the provided `key`. |
| [`commercetools_orders_get_payments_by_id`](#commercetools_orders_get_payments_by_id) | Retrieves a Payment with the provided `id`. |
| [`commercetools_orders_get_payments_by_key`](#commercetools_orders_get_payments_by_key) | Retrieves a Payment with the provided `key`. |
| [`commercetools_orders_list_carts`](#commercetools_orders_list_carts) | Retrieves Carts in the Project. |
| [`commercetools_orders_list_carts_customer_id_customer_id`](#commercetools_orders_list_carts_customer_id_customer_id) | Retrieves the most recently modified active Cart of a Customer with CartOrigin `Customer`. If no active Cart exists, this method returns a ResourceNotFound error. To ensure the Cart is up-to-date with current values (such as Prices and Discounts), use the Recalculate update action. |
| [`commercetools_orders_list_orders`](#commercetools_orders_list_orders) | Retrieves Orders in the Project. |
| [`commercetools_orders_list_orders_edits`](#commercetools_orders_list_orders_edits) | Retrieves OrderEdits in the Project. |
| [`commercetools_orders_list_orders_order_number_order_number`](#commercetools_orders_list_orders_order_number_order_number) | Retrieves an Order with the provided `orderNumber`. |
| [`commercetools_orders_list_payment_methods`](#commercetools_orders_list_payment_methods) | Retrieves all PaymentMethods in the Project. |
| [`commercetools_orders_list_payments`](#commercetools_orders_list_payments) | Retrieves Payments in the Project. |
| [`commercetools_orders_update_carts_by_id`](#commercetools_orders_update_carts_by_id) | Updates a Cart in the Project using one or more update actions. |
| [`commercetools_orders_update_carts_by_key`](#commercetools_orders_update_carts_by_key) | Updates a Cart in the Project using one or more update actions. |
| [`commercetools_orders_update_orders_by_id`](#commercetools_orders_update_orders_by_id) | Updates an Order in the Project using one or more update actions. |
| [`commercetools_orders_update_orders_edits_by_id`](#commercetools_orders_update_orders_edits_by_id) | Updates an OrderEdit in the Project using one or more update actions. |
| [`commercetools_orders_update_orders_edits_by_key`](#commercetools_orders_update_orders_edits_by_key) | Updates an OrderEdit in the Project using one or more update actions. |
| [`commercetools_orders_update_payment_methods_by_id`](#commercetools_orders_update_payment_methods_by_id) | Updates a PaymentMethod in the Project using one or more update actions. |
| [`commercetools_orders_update_payment_methods_by_key`](#commercetools_orders_update_payment_methods_by_key) | Updates a PaymentMethod in the Project using one or more update actions. |
| [`commercetools_orders_update_payments_by_id`](#commercetools_orders_update_payments_by_id) | Updates a Payment in the Project using one or more update actions. |
| [`commercetools_orders_update_payments_by_key`](#commercetools_orders_update_payments_by_key) | Updates a Payment in the Project using one or more update actions. |
***
## commercetools\_orders\_create\_carts
Creates a Cart in the Project. If the referenced ShippingMethod in the CartDraft has a predicate that does not match, or if the Shipping Method is not active, an InvalidOperation error is returned. Specific Error Codes: - DiscountCodeNonApplicable - InvalidItemShippingDetails - MatchingPriceNotFound - MissingTaxRateForCountry
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------------------------- | --------- | -------- | ------- | ------------------------------------- |
| `expand` | string\[] | No | — | Related resources to expand inline |
| `anonymousId` | string | No | — | Anonymous Id |
| `billingAddress` | object | No | — | Billing Address |
| `businessUnit` | object | No | — | Business Unit |
| `country` | string | No | — | The country value |
| `currency` | string | Yes | — | The currency value |
| `custom` | object | No | — | The custom value |
| `customerEmail` | string | No | — | Customer Email |
| `customerGroup` | object | No | — | Customer Group |
| `customerId` | string | No | — | Customer Id |
| `customLineItems` | object\[] | No | — | Custom Line Items |
| `customShipping` | object\[] | No | — | Custom Shipping |
| `deleteDaysAfterLastModification` | integer | No | — | Delete Days After Last Modification |
| `discountCodes` | string\[] | No | — | Discount Codes |
| `externalTaxRateForShippingMethod` | object | No | — | External Tax Rate For Shipping Method |
| `inventoryMode` | string | No | — | Inventory Mode |
| `itemShippingAddresses` | object\[] | No | — | Item Shipping Addresses |
| `key` | string | No | — | The key value |
| `lineItems` | object\[] | No | — | Line Items |
| `locale` | string | No | — | Locale or language code |
| `origin` | string | No | — | The origin value |
| `priceRoundingMode` | string | No | — | Price Rounding Mode |
| `purchaseOrderNumber` | string | No | — | Purchase Order Number |
| `shipping` | object\[] | No | — | The shipping value |
| `shippingAddress` | object | No | — | Shipping Address |
| `shippingMethod` | object | No | — | Shipping Method |
| `shippingMode` | string | No | — | Shipping Mode |
| `shippingRateInput` | object | No | — | Shipping Rate Input |
| `store` | object | No | — | The store value |
| `taxCalculationMode` | string | No | — | Tax Calculation Mode |
| `taxMode` | string | No | — | Tax Mode |
| `taxRoundingMode` | string | No | — | Tax Rounding Mode |
```json theme={null}
{
"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"
},
"anonymousId": {
"type": "string",
"description": "Anonymous Id"
},
"billingAddress": {
"type": "object",
"description": "Billing Address",
"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"
]
},
"businessUnit": {
"description": "Business Unit"
},
"country": {
"type": "string",
"description": "The country value"
},
"currency": {
"type": "string",
"description": "The currency value"
},
"custom": {
"type": "object",
"description": "The custom value",
"properties": {
"type": {
"description": "The type value"
},
"fields": {
"type": "object",
"description": "The fields value"
}
},
"required": [
"type"
]
},
"customerEmail": {
"type": "string",
"description": "Customer Email"
},
"customerGroup": {
"description": "Customer Group"
},
"customerId": {
"type": "string",
"description": "Customer Id"
},
"customLineItems": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "object",
"description": "The name value"
},
"key": {
"type": "string",
"description": "The key value"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "The quantity value"
},
"money": {
"type": "object",
"description": "The money value"
},
"slug": {
"type": "string",
"description": "The slug value"
},
"taxCategory": {
"description": "Tax Category"
},
"externalTaxRate": {
"type": "object",
"description": "External Tax Rate"
},
"custom": {
"type": "object",
"description": "The custom value"
},
"shippingDetails": {
"type": "object",
"description": "Shipping Details"
},
"priceMode": {
"type": "string",
"enum": [
"Standard",
"External"
],
"description": "Price Mode"
},
"recurrenceInfo": {
"type": "object",
"description": "Recurrence Info"
}
},
"required": [
"money",
"name",
"slug"
]
},
"description": "Custom Line Items"
},
"customShipping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "The key value"
},
"shippingMethodName": {
"type": "string",
"description": "Shipping Method Name"
},
"shippingAddress": {
"type": "object",
"description": "Shipping Address"
},
"shippingRate": {
"type": "object",
"description": "Shipping Rate"
},
"shippingRateInput": {
"type": "object",
"description": "Shipping Rate Input"
},
"taxCategory": {
"description": "Tax Category"
},
"externalTaxRate": {
"type": "object",
"description": "External Tax Rate"
},
"deliveries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"items": {
"type": "array"
},
"parcels": {
"type": "array"
},
"address": {},
"custom": {
"type": "object"
}
}
},
"description": "The deliveries value"
},
"custom": {
"type": "object",
"description": "The custom value"
}
},
"required": [
"key",
"shippingMethodName",
"shippingRate"
]
},
"description": "Custom Shipping"
},
"deleteDaysAfterLastModification": {
"type": "integer",
"description": "Delete Days After Last Modification"
},
"discountCodes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Discount Codes"
},
"externalTaxRateForShippingMethod": {
"type": "object",
"description": "External Tax Rate For Shipping Method",
"properties": {
"name": {
"type": "string",
"description": "The name value"
},
"amount": {
"type": "number",
"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"
},
"description": "Sub Rates"
}
},
"required": [
"country",
"name"
]
},
"inventoryMode": {
"type": "string",
"description": "Inventory Mode",
"enum": [
"None",
"TrackOnly",
"ReserveOnOrder"
]
},
"itemShippingAddresses": {
"type": "array",
"items": {
"type": "object",
"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"
]
},
"description": "Item Shipping Addresses"
},
"key": {
"type": "string",
"description": "The key value"
},
"lineItems": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "The key value"
},
"productId": {
"type": "string",
"description": "Product Id"
},
"variantId": {
"type": "integer",
"format": "int64",
"description": "Variant Id"
},
"sku": {
"type": "string",
"description": "The sku value"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "The quantity value"
},
"addedAt": {
"type": "string",
"format": "datetime",
"description": "Added At"
},
"distributionChannel": {
"description": "Distribution Channel"
},
"supplyChannel": {
"description": "Supply Channel"
},
"externalPrice": {
"type": "object",
"description": "External Price"
},
"externalTotalPrice": {
"type": "object",
"description": "External Total Price"
},
"externalTaxRate": {
"type": "object",
"description": "External Tax Rate"
},
"perMethodExternalTaxRate": {
"type": "array",
"items": {
"type": "object",
"properties": {
"shippingMethodKey": {
"type": "string"
},
"taxRate": {
"type": "object"
}
}
},
"description": "Per Method External Tax Rate"
},
"inventoryMode": {
"type": "string",
"enum": [
"None",
"TrackOnly",
"ReserveOnOrder"
],
"description": "Inventory Mode"
},
"shippingDetails": {
"type": "object",
"description": "Shipping Details"
},
"custom": {
"type": "object",
"description": "The custom value"
},
"recurrenceInfo": {
"type": "object",
"description": "Recurrence Info"
}
}
},
"description": "Line Items"
},
"locale": {
"type": "string",
"description": "Locale or language code"
},
"origin": {
"type": "string",
"description": "The origin value",
"enum": [
"Customer",
"Merchant",
"Quote",
"RecurringOrder"
]
},
"priceRoundingMode": {
"type": "string",
"description": "Price Rounding Mode",
"enum": [
"HalfEven",
"HalfUp",
"HalfDown"
]
},
"purchaseOrderNumber": {
"type": "string",
"description": "Purchase Order Number"
},
"shipping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "The key value"
},
"shippingMethod": {
"description": "Shipping Method"
},
"shippingAddress": {
"type": "object",
"description": "Shipping Address"
},
"shippingRateInput": {
"type": "object",
"description": "Shipping Rate Input"
},
"externalTaxRate": {
"type": "object",
"description": "External Tax Rate"
},
"deliveries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"items": {
"type": "array"
},
"parcels": {
"type": "array"
},
"address": {},
"custom": {
"type": "object"
}
}
},
"description": "The deliveries value"
},
"custom": {
"type": "object",
"description": "The custom value"
}
},
"required": [
"key",
"shippingAddress"
]
},
"description": "The shipping value"
},
"shippingAddress": {
"type": "object",
"description": "Shipping Address",
"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"
]
},
"shippingMethod": {
"description": "Shipping Method"
},
"shippingMode": {
"type": "string",
"description": "Shipping Mode",
"enum": [
"Single",
"Multiple"
]
},
"shippingRateInput": {
"type": "object",
"description": "Shipping Rate Input",
"properties": {
"type": {
"type": "string",
"description": "The type value"
}
},
"required": [
"type"
]
},
"store": {
"description": "The store value"
},
"taxCalculationMode": {
"type": "string",
"description": "Tax Calculation Mode",
"enum": [
"LineItemLevel",
"UnitPriceLevel"
]
},
"taxMode": {
"type": "string",
"description": "Tax Mode",
"enum": [
"Platform",
"External",
"ExternalAmount",
"Disabled"
]
},
"taxRoundingMode": {
"type": "string",
"description": "Tax Rounding Mode",
"enum": [
"HalfEven",
"HalfUp",
"HalfDown"
]
}
},
"required": [
"PCID",
"currency"
]
}
```
***
## commercetools\_orders\_create\_carts\_customer\_id\_customer\_id\_merge
Merges items from an anonymous Cart into the most recently modified active Cart of a Customer. If no active Cart exists, the anonymous Cart becomes the Customer's active Cart. For more information about merge mode behaviors, merge rules, and tax recalculation, see Merge a Cart.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------- | ------- | -------- | ------- | ------------------- |
| `customerId` | string | Yes | — | Customer Id |
| `anonymousCart` | object | No | — | Anonymous Cart |
| `anonymousId` | string | No | — | Anonymous Id |
| `mergeMode` | string | No | — | Merge Mode |
| `updateProductData` | boolean | No | — | Update Product Data |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"customerId": {
"type": "string",
"description": "Customer Id"
},
"anonymousCart": {
"description": "Anonymous Cart"
},
"anonymousId": {
"type": "string",
"description": "Anonymous Id"
},
"mergeMode": {
"type": "string",
"description": "Merge Mode",
"enum": [
"MergeWithExistingCustomerCart",
"UseAsNewActiveCustomerCart"
]
},
"updateProductData": {
"type": "boolean",
"description": "Update Product Data"
}
},
"required": [
"PCID",
"customerId"
]
}
```
***
## commercetools\_orders\_create\_carts\_replicate
Creates a new Cart by replicating an existing Cart or Order. The following applies to the new Cart: - It contains the same Customer information, Line Items and Custom Line Items, Custom Fields, Discount Codes, and other settings of the originating Cart or Order. - If a Line Item becomes invalid, it is removed from the new Cart. A common reason for this is removed Products or Prices. - Line items and Custom Line Items are reset to their initial state. - It contains no payments or delivery information. - It contains up-to-date Tax Rates, Prices, and Line Item product data. - The CartState is `Active`. - If using the `customerGroup` field (for a single Customer Group) and the referenced Customer switched to another Customer Group, the new Cart is automatically updated to reflect the new group and corresponding prices. - If using the `customerGroupAssignments` field (for multiple Customer Groups), the Cart no longer keeps a direct reference to a Customer Group. If a Customer’s group assignments change, the Cart and its Line Item prices are not updated automatically. Prices are only updated when the Cart is changed via a direct update action. Specific Error Codes: - MatchingPriceNotFound - MissingTaxRateForCountry
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | ------------------- |
| `key` | string | No | — | The key value |
| `reference` | object | Yes | — | The reference value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"key": {
"type": "string",
"description": "The key value"
},
"reference": {
"description": "The reference value"
}
},
"required": [
"PCID",
"reference"
]
}
```
***
## commercetools\_orders\_create\_orders
Creates an Order from a Cart. The Cart must have a shipping address and an active Shipping Method set. The shipping address is used for tax calculation for a Cart with `Platform` TaxMode. Creating an Order produces the OrderCreated Message. If the Order is created from a Recurring Order schedule, the OrderCreatedFromRecurringOrder Message is generated. If a server-side problem occurs, indicated by a 500 Internal Server Error HTTP response, the Order creation may still successfully complete after the error is returned. If you receive this error, you should verify the status of the Order by querying a unique identifier supplied during the creation request, such as the Order number. Specific Error Codes: - OutOfStock - PriceChanged - DiscountCodeNonApplicable - ShippingMethodDoesNotMatchCart - InvalidItemShippingDetails - InvalidOperation - MatchingPriceNotFound - MissingTaxRateForCountry
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | --------- | -------- | ------- | ---------------------------------- |
| `expand` | string\[] | No | — | Related resources to expand inline |
| `cart` | object | No | — | The cart value |
| `custom` | object | No | — | The custom value |
| `id` | string | No | — | The id value |
| `orderNumber` | string | No | — | Order Number |
| `orderState` | string | No | — | Order State |
| `paymentState` | string | No | — | Payment State |
| `purchaseOrderNumber` | string | No | — | Purchase Order Number |
| `shipmentState` | string | No | — | Shipment State |
| `state` | object | No | — | The state value |
| `version` | integer | Yes | — | The version value |
```json theme={null}
{
"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"
},
"cart": {
"description": "The cart value"
},
"custom": {
"type": "object",
"description": "The custom value",
"properties": {
"type": {
"description": "The type value"
},
"fields": {
"type": "object",
"description": "The fields value"
}
},
"required": [
"type"
]
},
"id": {
"type": "string",
"description": "The id value"
},
"orderNumber": {
"type": "string",
"description": "Order Number"
},
"orderState": {
"type": "string",
"description": "Order State",
"enum": [
"Open",
"Confirmed",
"Complete",
"Cancelled"
]
},
"paymentState": {
"type": "string",
"description": "Payment State",
"enum": [
"BalanceDue",
"Failed",
"Pending",
"CreditOwed",
"Paid"
]
},
"purchaseOrderNumber": {
"type": "string",
"description": "Purchase Order Number"
},
"shipmentState": {
"type": "string",
"description": "Shipment State",
"enum": [
"Shipped",
"Delivered",
"Ready",
"Pending",
"Delayed",
"Partial",
"Backorder",
"Canceled"
]
},
"state": {
"description": "The state value"
},
"version": {
"type": "integer",
"description": "The version value"
}
},
"required": [
"PCID",
"version"
]
}
```
***
## commercetools\_orders\_create\_orders\_edits
Creates an OrderEdit in the Project. You can either create multiple Order Edits for an Order and apply them sequentially to an Order, or create multiple Order Edits parallelly (as alternatives to each other) and apply one of them to the Order. You can only create an Order Edit if the InventoryMode of the Order and its LineItems is `None`.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | --------- | -------- | ------- | ---------------------------------- |
| `expand` | string\[] | No | — | Related resources to expand inline |
| `comment` | string | No | — | The comment value |
| `custom` | object | No | — | The custom value |
| `dryRun` | boolean | No | — | Dry Run |
| `key` | string | No | — | The key value |
| `resource` | object | Yes | — | The resource value |
| `stagedActions` | object\[] | No | — | Staged Actions |
```json theme={null}
{
"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"
},
"comment": {
"type": "string",
"description": "The comment value"
},
"custom": {
"type": "object",
"description": "The custom value",
"properties": {
"type": {
"description": "The type value"
},
"fields": {
"type": "object",
"description": "The fields value"
}
},
"required": [
"type"
]
},
"dryRun": {
"type": "boolean",
"description": "Dry Run"
},
"key": {
"type": "string",
"description": "The key value"
},
"resource": {
"description": "The resource value"
},
"stagedActions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"action": {
"type": "string",
"description": "The action value"
}
},
"required": [
"action"
]
},
"description": "Staged Actions"
}
},
"required": [
"PCID",
"resource"
]
}
```
***
## commercetools\_orders\_create\_orders\_edits\_apply\_by\_id
Applying an OrderEdit produces the OrderEditApplied Message.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------- | -------- | ------- | ---------------- |
| `ID` | string | Yes | — | The id value |
| `editVersion` | integer | Yes | — | Edit Version |
| `resourceVersion` | integer | Yes | — | Resource Version |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ID": {
"type": "string",
"description": "The id value"
},
"editVersion": {
"type": "integer",
"description": "Edit Version"
},
"resourceVersion": {
"type": "integer",
"description": "Resource Version"
}
},
"required": [
"PCID",
"ID",
"editVersion",
"resourceVersion"
]
}
```
***
## commercetools\_orders\_create\_orders\_import
Creates an Order without needing to create a Cart first. Importing an Order produces the Order Imported Message. Specific Error Codes: - OutOfStock - CountryNotConfiguredInStore
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | --------- | -------- | ------- | ----------------------- |
| `billingAddress` | object | No | — | Billing Address |
| `businessUnit` | object | No | — | Business Unit |
| `completedAt` | string | No | — | Completed At |
| `country` | string | No | — | The country value |
| `custom` | object | No | — | The custom value |
| `customerEmail` | string | No | — | Customer Email |
| `customerGroup` | object | No | — | Customer Group |
| `customerId` | string | No | — | Customer Id |
| `customLineItems` | object\[] | No | — | Custom Line Items |
| `inventoryMode` | string | No | — | Inventory Mode |
| `itemShippingAddresses` | object\[] | No | — | Item Shipping Addresses |
| `lineItems` | object\[] | No | — | Line Items |
| `orderNumber` | string | No | — | Order Number |
| `orderState` | string | No | — | Order State |
| `origin` | string | No | — | The origin value |
| `paymentInfo` | object | No | — | Payment Info |
| `paymentState` | string | No | — | Payment State |
| `priceRoundingMode` | string | No | — | Price Rounding Mode |
| `purchaseOrderNumber` | string | No | — | Purchase Order Number |
| `shipmentState` | string | No | — | Shipment State |
| `shippingAddress` | object | No | — | Shipping Address |
| `shippingInfo` | object | No | — | Shipping Info |
| `state` | object | No | — | The state value |
| `store` | object | No | — | The store value |
| `taxCalculationMode` | string | No | — | Tax Calculation Mode |
| `taxedPrice` | object | No | — | Taxed Price |
| `taxRoundingMode` | string | No | — | Tax Rounding Mode |
| `totalPrice` | object | Yes | — | Total Price |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"billingAddress": {
"type": "object",
"description": "Billing Address",
"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"
]
},
"businessUnit": {
"description": "Business Unit"
},
"completedAt": {
"type": "string",
"description": "Completed At"
},
"country": {
"type": "string",
"description": "The country value"
},
"custom": {
"type": "object",
"description": "The custom value",
"properties": {
"type": {
"description": "The type value"
},
"fields": {
"type": "object",
"description": "The fields value"
}
},
"required": [
"type"
]
},
"customerEmail": {
"type": "string",
"description": "Customer Email"
},
"customerGroup": {
"description": "Customer Group"
},
"customerId": {
"type": "string",
"description": "Customer Id"
},
"customLineItems": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "object",
"description": "The name value"
},
"key": {
"type": "string",
"description": "The key value"
},
"slug": {
"type": "string",
"description": "The slug value"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "The quantity value"
},
"money": {
"type": "object",
"description": "The money value"
},
"taxRate": {
"type": "object",
"description": "Tax Rate"
},
"taxCategory": {
"description": "Tax Category"
},
"priceMode": {
"type": "string",
"enum": [
"Standard",
"External"
],
"description": "Price Mode"
},
"shippingDetails": {
"type": "object",
"description": "Shipping Details"
},
"state": {
"type": "array",
"items": {
"type": "object",
"properties": {
"quantity": {
"type": "integer"
},
"state": {}
}
},
"description": "The state value"
},
"custom": {
"type": "object",
"description": "The custom value"
}
},
"required": [
"money",
"name",
"quantity",
"slug"
]
},
"description": "Custom Line Items"
},
"inventoryMode": {
"type": "string",
"description": "Inventory Mode",
"enum": [
"None",
"TrackOnly",
"ReserveOnOrder"
]
},
"itemShippingAddresses": {
"type": "array",
"items": {
"type": "object",
"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"
]
},
"description": "Item Shipping Addresses"
},
"lineItems": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "object",
"description": "The name value"
},
"key": {
"type": "string",
"description": "The key value"
},
"variant": {
"type": "object",
"description": "The variant value"
},
"productId": {
"type": "string",
"description": "Product Id"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "The quantity value"
},
"price": {
"type": "object",
"description": "The price value"
},
"taxRate": {
"type": "object",
"description": "Tax Rate"
},
"distributionChannel": {
"description": "Distribution Channel"
},
"supplyChannel": {
"description": "Supply Channel"
},
"inventoryMode": {
"type": "string",
"enum": [
"None",
"TrackOnly",
"ReserveOnOrder"
],
"description": "Inventory Mode"
},
"shippingDetails": {
"type": "object",
"description": "Shipping Details"
},
"state": {
"type": "array",
"items": {
"type": "object",
"properties": {
"quantity": {
"type": "integer"
},
"state": {}
}
},
"description": "The state value"
},
"custom": {
"type": "object",
"description": "The custom value"
}
},
"required": [
"name",
"price",
"quantity",
"variant"
]
},
"description": "Line Items"
},
"orderNumber": {
"type": "string",
"description": "Order Number"
},
"orderState": {
"type": "string",
"description": "Order State",
"enum": [
"Open",
"Confirmed",
"Complete",
"Cancelled"
]
},
"origin": {
"type": "string",
"description": "The origin value",
"enum": [
"Customer",
"Merchant",
"Quote",
"RecurringOrder"
]
},
"paymentInfo": {
"type": "object",
"description": "Payment Info",
"properties": {
"payments": {
"type": "array",
"description": "The payments value"
}
},
"required": [
"payments"
]
},
"paymentState": {
"type": "string",
"description": "Payment State",
"enum": [
"BalanceDue",
"Failed",
"Pending",
"CreditOwed",
"Paid"
]
},
"priceRoundingMode": {
"type": "string",
"description": "Price Rounding Mode",
"enum": [
"HalfEven",
"HalfUp",
"HalfDown"
]
},
"purchaseOrderNumber": {
"type": "string",
"description": "Purchase Order Number"
},
"shipmentState": {
"type": "string",
"description": "Shipment State",
"enum": [
"Shipped",
"Delivered",
"Ready",
"Pending",
"Delayed",
"Partial",
"Backorder",
"Canceled"
]
},
"shippingAddress": {
"type": "object",
"description": "Shipping Address",
"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"
]
},
"shippingInfo": {
"type": "object",
"description": "Shipping Info",
"properties": {
"shippingMethodName": {
"type": "string",
"description": "Shipping Method Name"
},
"price": {
"type": "object",
"description": "The price value"
},
"shippingRate": {
"type": "object",
"description": "Shipping Rate"
},
"taxRate": {
"type": "object",
"description": "Tax Rate"
},
"taxCategory": {
"description": "Tax Category"
},
"shippingMethod": {
"description": "Shipping Method"
},
"deliveries": {
"type": "array",
"items": {
"type": "object"
},
"description": "The deliveries value"
},
"discountedPrice": {
"type": "object",
"description": "Discounted Price"
},
"shippingMethodState": {
"type": "string",
"description": "Shipping Method State",
"enum": [
"DoesNotMatchCart",
"MatchesCart"
]
}
},
"required": [
"price",
"shippingMethodName",
"shippingRate"
]
},
"state": {
"description": "The state value"
},
"store": {
"description": "The store value"
},
"taxCalculationMode": {
"type": "string",
"description": "Tax Calculation Mode",
"enum": [
"LineItemLevel",
"UnitPriceLevel"
]
},
"taxedPrice": {
"type": "object",
"description": "Taxed Price",
"properties": {
"totalNet": {
"type": "object",
"description": "Total Net"
},
"totalGross": {
"type": "object",
"description": "Total Gross"
},
"taxPortions": {
"type": "array",
"items": {
"type": "object"
},
"description": "Tax Portions"
},
"totalTax": {
"description": "Total Tax"
}
},
"required": [
"taxPortions",
"totalGross",
"totalNet"
]
},
"taxRoundingMode": {
"type": "string",
"description": "Tax Rounding Mode",
"enum": [
"HalfEven",
"HalfUp",
"HalfDown"
]
},
"totalPrice": {
"type": "object",
"description": "Total Price",
"properties": {
"centAmount": {
"type": "integer",
"description": "Cent Amount"
},
"currencyCode": {
"type": "string",
"description": "Currency Code"
}
},
"required": [
"centAmount",
"currencyCode"
]
}
},
"required": [
"PCID",
"totalPrice"
]
}
```
***
## commercetools\_orders\_create\_orders\_order\_number\_order\_number
Updates an Order in the Project using one or more update actions.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | --------- | -------- | ------- | ---------------------------------- |
| `orderNumber` | string | Yes | — | Order Number |
| `expand` | string\[] | No | — | Related resources to expand inline |
| `actions` | object\[] | Yes | — | The actions value |
| `version` | integer | Yes | — | The version value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"orderNumber": {
"type": "string",
"description": "Order Number"
},
"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",
"orderNumber",
"actions",
"version"
]
}
```
***
## commercetools\_orders\_create\_orders\_quotes
Creates an Order from a Quote. The referenced Quote must have the `Pending` state and must be valid (not past the `validTo` date); otherwise, an InvalidOperation error is returned. Produces the OrderCreated Message. Specific Error Codes: - CountryNotConfiguredInStore - InvalidItemShippingDetails - InvalidOperation - OutOfStock
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------------- | ------- | -------- | ------- | ----------------------- |
| `orderNumber` | string | No | — | Order Number |
| `orderState` | string | No | — | Order State |
| `paymentState` | string | No | — | Payment State |
| `quote` | object | Yes | — | The quote value |
| `quoteStateToAccepted` | boolean | No | — | Quote State To Accepted |
| `shipmentState` | string | No | — | Shipment State |
| `state` | object | No | — | The state value |
| `version` | integer | Yes | — | The version value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"orderNumber": {
"type": "string",
"description": "Order Number"
},
"orderState": {
"type": "string",
"description": "Order State",
"enum": [
"Open",
"Confirmed",
"Complete",
"Cancelled"
]
},
"paymentState": {
"type": "string",
"description": "Payment State",
"enum": [
"BalanceDue",
"Failed",
"Pending",
"CreditOwed",
"Paid"
]
},
"quote": {
"description": "The quote value"
},
"quoteStateToAccepted": {
"type": "boolean",
"description": "Quote State To Accepted"
},
"shipmentState": {
"type": "string",
"description": "Shipment State",
"enum": [
"Shipped",
"Delivered",
"Ready",
"Pending",
"Delayed",
"Partial",
"Backorder",
"Canceled"
]
},
"state": {
"description": "The state value"
},
"version": {
"type": "integer",
"description": "The version value"
}
},
"required": [
"PCID",
"quote",
"version"
]
}
```
***
## commercetools\_orders\_create\_orders\_search
POST /orders/search
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | --------- | -------- | ------- | ----------------------------------- |
| `limit` | integer | No | — | Maximum number of results to return |
| `offset` | integer | No | — | The offset value |
| `query` | object | Yes | — | Search query string |
| `sort` | object\[] | No | — | Sort order for results |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"limit": {
"type": "integer",
"description": "Maximum number of results to return"
},
"offset": {
"type": "integer",
"description": "The offset value"
},
"query": {
"type": "object",
"description": "Search query string"
},
"sort": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "The field value"
},
"language": {
"type": "string",
"description": "The language value"
},
"order": {
"type": "string",
"enum": [
"asc",
"desc"
],
"description": "The order value"
},
"mode": {
"type": "string",
"enum": [
"min",
"max",
"avg",
"sum"
],
"description": "The mode value"
},
"filter": {
"description": "The filter value"
}
},
"required": [
"field"
]
},
"description": "Sort order for results"
}
},
"required": [
"PCID",
"query"
]
}
```
***
## commercetools\_orders\_create\_payment\_methods
Creates a PaymentMethod in the Project. This request generates the PaymentMethodCreated Message.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | --------- | -------- | ------- | ---------------------------------- |
| `expand` | string\[] | No | — | Related resources to expand inline |
| `businessUnit` | object | No | — | Business Unit |
| `custom` | object | No | — | The custom value |
| `customer` | object | No | — | The customer value |
| `default` | boolean | No | — | The default value |
| `interfaceAccount` | string | No | — | Interface Account |
| `key` | string | No | — | The key value |
| `method` | string | No | — | The method value |
| `name` | object | No | — | The name value |
| `paymentInterface` | string | No | — | Payment Interface |
| `paymentMethodStatus` | string | No | — | Payment Method Status |
| `token` | object | No | — | The token value |
```json theme={null}
{
"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"
},
"businessUnit": {
"description": "Business Unit"
},
"custom": {
"type": "object",
"description": "The custom value",
"properties": {
"type": {
"description": "The type value"
},
"fields": {
"type": "object",
"description": "The fields value"
}
},
"required": [
"type"
]
},
"customer": {
"description": "The customer value"
},
"default": {
"type": "boolean",
"description": "The default value"
},
"interfaceAccount": {
"type": "string",
"description": "Interface Account"
},
"key": {
"type": "string",
"description": "The key value"
},
"method": {
"type": "string",
"description": "The method value"
},
"name": {
"type": "object",
"description": "The name value"
},
"paymentInterface": {
"type": "string",
"description": "Payment Interface"
},
"paymentMethodStatus": {
"type": "string",
"description": "Payment Method Status",
"enum": [
"Active",
"Inactive"
]
},
"token": {
"type": "object",
"description": "The token value",
"properties": {
"value": {
"type": "string",
"description": "The value value"
}
},
"required": [
"value"
]
}
},
"required": [
"PCID"
]
}
```
***
## commercetools\_orders\_create\_payments
Creates a Payment in the Project. Creating a Payment produces the PaymentCreated Message.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | --------- | -------- | ------- | ---------------------------------- |
| `expand` | string\[] | No | — | Related resources to expand inline |
| `amountAuthorized` | object | No | — | Amount Authorized |
| `amountPaid` | object | No | — | Amount Paid |
| `amountPlanned` | object | Yes | — | Amount Planned |
| `amountRefunded` | object | No | — | Amount Refunded |
| `anonymousId` | string | No | — | Anonymous Id |
| `authorizedUntil` | string | No | — | Authorized Until |
| `custom` | object | No | — | The custom value |
| `customer` | object | No | — | The customer value |
| `externalId` | string | No | — | External Id |
| `interfaceId` | string | No | — | Interface Id |
| `interfaceInteractions` | object\[] | No | — | Interface Interactions |
| `key` | string | No | — | The key value |
| `paymentMethodInfo` | object | No | — | Payment Method Info |
| `paymentStatus` | object | No | — | Payment Status |
| `transactions` | object\[] | No | — | The transactions value |
```json theme={null}
{
"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"
},
"amountAuthorized": {
"type": "object",
"description": "Amount Authorized",
"properties": {
"centAmount": {
"type": "integer",
"description": "Cent Amount"
},
"currencyCode": {
"type": "string",
"description": "Currency Code"
}
},
"required": [
"centAmount",
"currencyCode"
]
},
"amountPaid": {
"type": "object",
"description": "Amount Paid",
"properties": {
"centAmount": {
"type": "integer",
"description": "Cent Amount"
},
"currencyCode": {
"type": "string",
"description": "Currency Code"
}
},
"required": [
"centAmount",
"currencyCode"
]
},
"amountPlanned": {
"type": "object",
"description": "Amount Planned",
"properties": {
"centAmount": {
"type": "integer",
"description": "Cent Amount"
},
"currencyCode": {
"type": "string",
"description": "Currency Code"
}
},
"required": [
"centAmount",
"currencyCode"
]
},
"amountRefunded": {
"type": "object",
"description": "Amount Refunded",
"properties": {
"centAmount": {
"type": "integer",
"description": "Cent Amount"
},
"currencyCode": {
"type": "string",
"description": "Currency Code"
}
},
"required": [
"centAmount",
"currencyCode"
]
},
"anonymousId": {
"type": "string",
"description": "Anonymous Id"
},
"authorizedUntil": {
"type": "string",
"description": "Authorized Until"
},
"custom": {
"type": "object",
"description": "The custom value",
"properties": {
"type": {
"description": "The type value"
},
"fields": {
"type": "object",
"description": "The fields value"
}
},
"required": [
"type"
]
},
"customer": {
"description": "The customer value"
},
"externalId": {
"type": "string",
"description": "External Id"
},
"interfaceId": {
"type": "string",
"description": "Interface Id"
},
"interfaceInteractions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"description": "The type value"
},
"fields": {
"type": "object",
"description": "The fields value"
}
},
"required": [
"type"
]
},
"description": "Interface Interactions"
},
"key": {
"type": "string",
"description": "The key value"
},
"paymentMethodInfo": {
"type": "object",
"description": "Payment Method Info",
"properties": {
"paymentInterface": {
"type": "string",
"description": "Payment Interface"
},
"method": {
"type": "string",
"description": "The method value"
},
"name": {
"type": "object",
"description": "The name value"
},
"token": {
"type": "object",
"description": "The token value"
},
"interfaceAccount": {
"type": "string",
"description": "Interface Account"
},
"custom": {
"type": "object",
"description": "The custom value"
}
}
},
"paymentStatus": {
"type": "object",
"description": "Payment Status",
"properties": {
"interfaceCode": {
"type": "string",
"description": "Interface Code"
},
"interfaceText": {
"type": "string",
"description": "Interface Text"
},
"state": {
"description": "The state value"
}
}
},
"transactions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"type": "string",
"format": "datetime",
"description": "The timestamp value"
},
"type": {
"type": "string",
"enum": [
"Authorization",
"CancelAuthorization",
"Charge",
"Refund",
"Chargeback"
],
"description": "The type value"
},
"amount": {
"type": "object",
"description": "The amount value"
},
"interactionId": {
"type": "string",
"description": "Interaction Id"
},
"state": {
"type": "string",
"enum": [
"Initial",
"Pending",
"Success",
"Failure"
],
"description": "The state value"
},
"custom": {
"type": "object",
"description": "The custom value"
},
"interfaceId": {
"type": "string",
"description": "Interface Id"
}
},
"required": [
"amount",
"type"
]
},
"description": "The transactions value"
}
},
"required": [
"PCID",
"amountPlanned"
]
}
```
***
## commercetools\_orders\_delete\_by\_id
Deletes an Order in the Project. Deleting an Order produces the OrderDeleted Message.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | --------- | -------- | ------- | ---------------------------------- |
| `ID` | string | Yes | — | The id value |
| `dataErasure` | boolean | No | — | Data Erasure |
| `version` | integer | Yes | — | The version value |
| `expand` | string\[] | No | — | Related resources to expand inline |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ID": {
"type": "string",
"description": "The id value"
},
"dataErasure": {
"type": "boolean",
"description": "Data Erasure"
},
"version": {
"type": "integer",
"description": "The version value"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Related resources to expand inline"
}
},
"required": [
"PCID",
"ID",
"version"
]
}
```
***
## commercetools\_orders\_delete\_carts\_by\_id
Deletes a Cart in the Project.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | --------- | -------- | ------- | ---------------------------------- |
| `ID` | string | Yes | — | The id value |
| `dataErasure` | boolean | No | — | Data Erasure |
| `version` | integer | Yes | — | The version value |
| `expand` | string\[] | No | — | Related resources to expand inline |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ID": {
"type": "string",
"description": "The id value"
},
"dataErasure": {
"type": "boolean",
"description": "Data Erasure"
},
"version": {
"type": "integer",
"description": "The version value"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Related resources to expand inline"
}
},
"required": [
"PCID",
"ID",
"version"
]
}
```
***
## commercetools\_orders\_delete\_carts\_by\_key
Deletes a Cart in the Project.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | --------- | -------- | ------- | ---------------------------------- |
| `key` | string | Yes | — | The key value |
| `dataErasure` | boolean | No | — | Data Erasure |
| `version` | integer | Yes | — | The version value |
| `expand` | string\[] | No | — | Related resources to expand inline |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"key": {
"type": "string",
"description": "The key value"
},
"dataErasure": {
"type": "boolean",
"description": "Data Erasure"
},
"version": {
"type": "integer",
"description": "The version value"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Related resources to expand inline"
}
},
"required": [
"PCID",
"key",
"version"
]
}
```
***
## commercetools\_orders\_delete\_edits\_by\_id
Deletes an OrderEdit 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 |
```json theme={null}
{
"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\_orders\_delete\_edits\_by\_key
Deletes an OrderEdit 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 |
```json theme={null}
{
"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\_orders\_delete\_order\_number\_order\_number
Deletes an Order in the Project. Deleting an Order produces the OrderDeleted Message.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | --------- | -------- | ------- | ---------------------------------- |
| `orderNumber` | string | Yes | — | Order Number |
| `dataErasure` | boolean | No | — | Data Erasure |
| `version` | integer | Yes | — | The version value |
| `expand` | string\[] | No | — | Related resources to expand inline |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"orderNumber": {
"type": "string",
"description": "Order Number"
},
"dataErasure": {
"type": "boolean",
"description": "Data Erasure"
},
"version": {
"type": "integer",
"description": "The version value"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Related resources to expand inline"
}
},
"required": [
"PCID",
"orderNumber",
"version"
]
}
```
***
## commercetools\_orders\_delete\_payment\_methods\_by\_id
Deletes a PaymentMethod in the Project. This request generates the PaymentMethodDeleted 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 |
```json theme={null}
{
"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\_orders\_delete\_payment\_methods\_by\_key
Deletes a PaymentMethod in the Project. This request generates the PaymentMethodDeleted 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 |
```json theme={null}
{
"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\_orders\_delete\_payments\_by\_id
Deletes a Payment in the Project.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | --------- | -------- | ------- | ---------------------------------- |
| `ID` | string | Yes | — | The id value |
| `dataErasure` | boolean | No | — | Data Erasure |
| `version` | integer | Yes | — | The version value |
| `expand` | string\[] | No | — | Related resources to expand inline |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ID": {
"type": "string",
"description": "The id value"
},
"dataErasure": {
"type": "boolean",
"description": "Data Erasure"
},
"version": {
"type": "integer",
"description": "The version value"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Related resources to expand inline"
}
},
"required": [
"PCID",
"ID",
"version"
]
}
```
***
## commercetools\_orders\_delete\_payments\_by\_key
Deletes a Payment in the Project.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | --------- | -------- | ------- | ---------------------------------- |
| `key` | string | Yes | — | The key value |
| `dataErasure` | boolean | No | — | Data Erasure |
| `version` | integer | Yes | — | The version value |
| `expand` | string\[] | No | — | Related resources to expand inline |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"key": {
"type": "string",
"description": "The key value"
},
"dataErasure": {
"type": "boolean",
"description": "Data Erasure"
},
"version": {
"type": "integer",
"description": "The version value"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Related resources to expand inline"
}
},
"required": [
"PCID",
"key",
"version"
]
}
```
***
## commercetools\_orders\_get\_by\_id
Retrieves an Order with the provided `id`.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | --------- | -------- | ------- | ---------------------------------- |
| `ID` | string | Yes | — | The id value |
| `expand` | string\[] | No | — | Related resources to expand inline |
```json theme={null}
{
"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\_orders\_get\_carts\_by\_id
Retrieves a Cart with the provided `id`. To ensure the Cart is up-to-date with current values (such as Prices and Discounts), use the Recalculate update action.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | --------- | -------- | ------- | ---------------------------------- |
| `ID` | string | Yes | — | The id value |
| `expand` | string\[] | No | — | Related resources to expand inline |
```json theme={null}
{
"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\_orders\_get\_carts\_by\_key
Retrieves a Cart with the provided `key`. To ensure the Cart is up-to-date with current values (such as Prices and Discounts), use the Recalculate update action.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | --------- | -------- | ------- | ---------------------------------- |
| `key` | string | Yes | — | The key value |
| `expand` | string\[] | No | — | Related resources to expand inline |
```json theme={null}
{
"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\_orders\_get\_edits\_by\_id
Retrieves an OrderEdit with the provided `id`.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | --------- | -------- | ------- | ---------------------------------- |
| `ID` | string | Yes | — | The id value |
| `expand` | string\[] | No | — | Related resources to expand inline |
```json theme={null}
{
"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\_orders\_get\_edits\_by\_key
Retrieves an OrderEdit with the provided `key`.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | --------- | -------- | ------- | ---------------------------------- |
| `key` | string | Yes | — | The key value |
| `expand` | string\[] | No | — | Related resources to expand inline |
```json theme={null}
{
"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\_orders\_get\_payment\_methods\_by\_id
Retrieves a PaymentMethod with the provided `id`.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | --------- | -------- | ------- | ---------------------------------- |
| `ID` | string | Yes | — | The id value |
| `expand` | string\[] | No | — | Related resources to expand inline |
```json theme={null}
{
"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\_orders\_get\_payment\_methods\_by\_key
Retrieves a PaymentMethod with the provided `key`.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | --------- | -------- | ------- | ---------------------------------- |
| `key` | string | Yes | — | The key value |
| `expand` | string\[] | No | — | Related resources to expand inline |
```json theme={null}
{
"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\_orders\_get\_payments\_by\_id
Retrieves a Payment with the provided `id`.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | --------- | -------- | ------- | ---------------------------------- |
| `ID` | string | Yes | — | The id value |
| `expand` | string\[] | No | — | Related resources to expand inline |
```json theme={null}
{
"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\_orders\_get\_payments\_by\_key
Retrieves a Payment with the provided `key`.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | --------- | -------- | ------- | ---------------------------------- |
| `key` | string | Yes | — | The key value |
| `expand` | string\[] | No | — | Related resources to expand inline |
```json theme={null}
{
"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\_orders\_list\_carts
Retrieves Carts 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 |
```json theme={null}
{
"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\_orders\_list\_carts\_customer\_id\_customer\_id
Retrieves the most recently modified active Cart of a Customer with CartOrigin `Customer`. If no active Cart exists, this method returns a ResourceNotFound error. To ensure the Cart is up-to-date with current values (such as Prices and Discounts), use the Recalculate update action.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | --------- | -------- | ------- | ---------------------------------- |
| `customerId` | string | Yes | — | Customer Id |
| `expand` | string\[] | No | — | Related resources to expand inline |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"customerId": {
"type": "string",
"description": "Customer Id"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Related resources to expand inline"
}
},
"required": [
"PCID",
"customerId"
]
}
```
***
## commercetools\_orders\_list\_orders
Retrieves Orders 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 |
```json theme={null}
{
"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\_orders\_list\_orders\_edits
Retrieves OrderEdits 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 |
```json theme={null}
{
"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\_orders\_list\_orders\_order\_number\_order\_number
Retrieves an Order with the provided `orderNumber`.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | --------- | -------- | ------- | ---------------------------------- |
| `orderNumber` | string | Yes | — | Order Number |
| `expand` | string\[] | No | — | Related resources to expand inline |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"orderNumber": {
"type": "string",
"description": "Order Number"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Related resources to expand inline"
}
},
"required": [
"PCID",
"orderNumber"
]
}
```
***
## commercetools\_orders\_list\_payment\_methods
Retrieves all PaymentMethods 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 |
```json theme={null}
{
"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\_orders\_list\_payments
Retrieves Payments 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 |
```json theme={null}
{
"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\_orders\_update\_carts\_by\_id
Updates a Cart 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 |
```json theme={null}
{
"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\_orders\_update\_carts\_by\_key
Updates a Cart 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 |
```json theme={null}
{
"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\_orders\_update\_orders\_by\_id
Updates an Order 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 |
```json theme={null}
{
"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\_orders\_update\_orders\_edits\_by\_id
Updates an OrderEdit 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 |
| `dryRun` | boolean | No | — | Dry Run |
| `version` | integer | Yes | — | The version value |
```json theme={null}
{
"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"
},
"dryRun": {
"type": "boolean",
"description": "Dry Run"
},
"version": {
"type": "integer",
"description": "The version value"
}
},
"required": [
"PCID",
"ID",
"actions",
"version"
]
}
```
***
## commercetools\_orders\_update\_orders\_edits\_by\_key
Updates an OrderEdit 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 |
| `dryRun` | boolean | No | — | Dry Run |
| `version` | integer | Yes | — | The version value |
```json theme={null}
{
"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"
},
"dryRun": {
"type": "boolean",
"description": "Dry Run"
},
"version": {
"type": "integer",
"description": "The version value"
}
},
"required": [
"PCID",
"key",
"actions",
"version"
]
}
```
***
## commercetools\_orders\_update\_payment\_methods\_by\_id
Updates a PaymentMethod 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 |
```json theme={null}
{
"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\_orders\_update\_payment\_methods\_by\_key
Updates a PaymentMethod 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 |
```json theme={null}
{
"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\_orders\_update\_payments\_by\_id
Updates a Payment 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 |
```json theme={null}
{
"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\_orders\_update\_payments\_by\_key
Updates a Payment 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 |
```json theme={null}
{
"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"
]
}
```