An Order can be created from a Cart, usually after a checkout process has been completed.
Learn more about how to implement order creation as part of a custom checkout flow in our self-paced Implement a custom checkout module.
Representations
Representations are JSON objects submitted or received as payload to API requests or responses.
Order
idString | Unique identifier of the Order. |
versionInt | Current version of the Order. |
orderNumberString | User-defined identifier of the Order that is unique across a Project. |
purchaseOrderNumberString | User-defined identifier of a purchase Order. It is typically set by the Buyer and can be used with Quotes to track the purchase Order during the quote and order flow. |
customerIdString | id of the Customer that the Order belongs to. |
customerEmailString | Email address of the Customer that the Order belongs to. |
customerGroup | Reference to the Customer Group of the Customer that the Order belongs to.
Used for Line Item price selection. |
anonymousIdString | Anonymous session associated with the Order. |
businessUnit | |
store | Reference to a Store the Order belongs to. |
lineItemsArray of LineItem | Line Items that are part of the Order. |
customLineItemsArray of CustomLineItem | Custom Line Items that are part of the Order. |
totalPrice | Sum of the
totalPrice field of all LineItems and CustomLineItems, and if available, the price field of ShippingInfo.
If a discount applies on totalPrice, this field holds the discounted value. |
taxedPrice |
If a discount applies on totalPrice, this field holds the proportionally discounted value. |
taxedShippingPrice | Sum of the
taxedPrice field of ShippingInfo across all Shipping Methods.If a discount applies on totalPrice, this field holds the proportionally discounted value. |
discountOnTotalPrice | Discounts that apply on the total price of the Order. |
priceRoundingMode | Indicates how the total prices on LineItems and CustomLineItems are rounded when calculated. Default: HalfEven |
taxMode | Indicates how Tax Rates are set. Default:Platform |
taxRoundingMode | Indicates how monetary values are rounded when calculating taxes for Default: taxedPrice.HalfEven |
taxCalculationMode | Indicates how taxes are calculated when calculating taxes for Default: taxedPrice.LineItemLevel |
inventoryMode | Indicates how stock quantities are tracked for Line Items in the Order. Default:None |
billingAddress | Billing address associated with the Order. |
shippingAddress | Shipping address associated with the Order.
Determines eligible ShippingMethod rates and Tax Rates of Line Items. |
shippingMode | Indicates whether there can be one or multiple Shipping Methods. Default:Single |
shippingKeyString | |
shippingInfo | Shipping-related information for Single ShippingMode.
Automatically set when a Shipping Method is set. |
shippingRateInput | Input used to select a ShippingRatePriceTier.
The data type of this field depends on the
shippingRateInputType.type configured in the Project:
|
shippingCustomFields | Custom Fields of the Shipping Method for Single ShippingMode. |
shippingArray of Shipping | Shipping-related information for Multiple ShippingMode.
Updated automatically each time a new Shipping Method is added. |
itemShippingAddressesArray of Address | Additional shipping addresses of the Order as specified by LineItems using the shippingDetails field.
Eligible Shipping Methods or applicable Tax Rates are determined by the address in shippingAddress, and not itemShippingAddresses. |
discountCodesArray of DiscountCodeInfo | Discount Codes added to the Order.
An Order that has directDiscounts cannot have discountCodes. |
directDiscountsArray of DirectDiscount | Direct Discounts added to the Order.
An Order that has discountCodes cannot have directDiscounts. |
refusedGiftsArray of CartDiscountReference | |
paymentInfo | Payment information related to the Order. |
country | Used for Line Item price selection. Pattern: ^[A-Z]{2}$ |
locale | Languages of the Order.
Can only contain languages supported by the Project. |
origin | Indicates the origin of the Cart from which the Order was created. Default:Customer |
cart | Reference to the Cart for an Order created from Cart.
The referenced Cart will have the Ordered CartState. |
quote | Reference to the Quote for an Order created from Quote. |
recurringOrder | Reference to the RecurringOrder that generated this Order. |
orderState | Current status of the Order. |
shipmentState | Shipment status of the Order. |
paymentState | Payment status of the Order. |
state | State of the Order.
This reference can point to a State in a custom workflow. |
syncInfoArray of SyncInfo | Contains synchronization activity information of the Order (like export or import).
Can only be set with Update SyncInfo update action. |
returnInfoArray of ReturnInfo | Contains information regarding the returns associated with the Order. |
discountTypeCombination | Indicates if a combination of discount types can apply on an Order. |
completedAt | User-defined date and time (UTC) of the Order.
Present only on an Order created using Order Import. |
custom | Custom Fields of the Order. |
createdAt | Date and time (UTC) the Order was initially created. |
createdByBETA | IDs and references that created the Order. |
lastModifiedAt | Date and time (UTC) the Order was last updated. |
lastModifiedByBETA | IDs and references that last modified the Order. |
OrderFromCartDraft
You must provide a value for the
cart field. It is marked as optional only for backward compatibility reasons.When an Order is created from a Cart, inventory updates triggered by the Order are eventually consistent. Changes to
availableQuantity and quantityOnStock may take up to 10 seconds to be reflected. For detailed information about inventory consistency guarantees, see Inventory checks and consistency.versionInt | version of the Cart from which the Order is created. |
cart | ResourceIdentifier to the Cart from which the Order is created.
This field is required, but is marked as optional for backwards compatibility reasons. |
orderNumberString | User-defined identifier for the Order that is unique across a Project. Once set, the value cannot be changed. |
purchaseOrderNumberString | User-defined identifier for a purchase order. It is typically set by the Buyer or Merchant to track the purchase order during the quote and order flow.
If not provided, the purchaseOrderNumber from the referenced Cart is used. |
paymentState | Payment status for the Order. |
shipmentState | Shipment status for the Order. |
orderState | Current status for the Order. Default:Open |
state | State for the Order in a custom workflow. |
custom | Custom Fields for the Order.
The Custom Fields' type must match the Custom Fields' type in the referenced Cart.
|
OrderFromQuoteDraft
versionInt | version of the Quote from which the Order is created. |
quote | ResourceIdentifier to the Quote from which the Order is created.
|
quoteStateToAcceptedBoolean | Default: false |
orderNumberString | User-defined identifier for the Order that is unique across a Project. Once set, the value cannot be changed. |
paymentState | Payment status for the Order. |
shipmentState | Shipment status for the Order. |
orderState | Current status for the Order. Default:Open |
state | State of the Order in a custom workflow. |
OrderPagedQueryResponse
limitInt | Number of results requested. Default: 20Minimum: 0Maximum: 500 |
offsetInt | Number of elements skipped. Default: 0Maximum: 10000 |
countInt | Actual number of results returned. |
totalInt | Total number of results matching the query.
This number is an estimation that is not strongly consistent.
This field is returned by default.
For improved performance, calculating this field can be deactivated by using the query parameter withTotal=false.
When the results are filtered with a Query Predicate, total is subject to a limit. |
resultsArray of Order | Orders matching the query. |
OrderReference
idString | Unique identifier of the referenced Order. |
typeId | order |
obj | Contains the representation of the expanded Order. Only present in responses to requests with Reference Expansion for Orders. |
OrderState
Indicates the state of the Order.
OpenThe default state of a new Order.
ConfirmedIndicates that the Order is accepted and being processed.
CompleteIndicates that the Order is fulfilled.
CancelledIndicates that the Order is canceled.
ShipmentState
Indicates the shipment status of the Order.
ShippedIndicates that the Order is shipped.
DeliveredIndicates that the Order is delivered.
ReadyIndicates that the Order is ready to be shipped.
PendingIndicates that the shipment of the Order is pending.
DelayedIndicates that the shipment of the Order is delayed.
PartialIndicates that items in the Order are shipped in more than one shipment.
BackorderIndicates that items in the Order are not in stock and will be delivered once the items are restocked.
CanceledIndicates that the shipment of the Order is canceled.
PaymentState
Indicates the payment status for the Order.
BalanceDueIndicates that payment balance is due for the Order.
FailedIndicates that payment for the Order has failed.
PendingIndicates that payment for the Order is pending.
CreditOwedIndicates that payment for the Order is made on a credit basis.
PaidIndicates that the Order is paid for.
PaymentInfo
paymentsArray of PaymentReference | References to the Payments associated with the Order. |
SyncInfo
Contains synchronization activity information of the Order (like export or import).
externalIdString | Identifier of an external order instance, file, or other resource. |
channel | Connection to a synchronization destination. |
syncedAt | Date and time (UTC) the information was synced. |
Delivery
Contains information on how items are shipped to Customers, for example, a delivery note.
idString | Unique identifier of the Delivery. |
keyString | User-defined identifier of the Delivery. Unique among Deliveries in the Order. MinLength:2MaxLength: 256Pattern: ^[a-zA-Z0-9_-] |
itemsArray of DeliveryItem | Line Items or Custom Line Items that are delivered. |
parcelsArray of Parcel | Information regarding the appearance, content, and shipment of a Parcel. |
address | Address to which Parcels are delivered. |
custom | Custom Fields of the Delivery. |
createdAt | Date and time (UTC) the Delivery was created. |
DeliveryDraft
keyString | User-defined identifier of the Delivery. Must be unique among Deliveries in the Order. MinLength:2MaxLength: 256Pattern: ^[a-zA-Z0-9_-] |
itemsArray of DeliveryItem | Line Items or Custom Line Items to deliver.
It can also be specified individually for each Parcel. |
parcelsArray of ParcelDraft | Information regarding the appearance, content, and shipment of a parcel. |
address | Address to which the Parcels are delivered. |
custom | Custom Fields for the Delivery. |
DeliveryItem
idString | |
quantityInt | Quantity of Line Items or Custom Line Items delivered. |
Parcel
Information regarding the appearance, content, and shipment of a Parcel.
idString | Unique identifier of the Parcel. |
keyString | User-defined unique identifier of the Parcel. MinLength:2MaxLength: 256Pattern: ^[a-zA-Z0-9_-] |
measurements | Information about the dimensions of the Parcel. |
trackingData | Shipment tracking information of the Parcel. |
itemsArray of DeliveryItem | Line Items or Custom Line Items delivered in this Parcel. |
custom | Custom Fields of the Parcel. |
createdAt | Date and time (UTC) the Parcel was created. |
ParcelDraft
keyString | User-defined unique identifier of the Parcel. MinLength:2MaxLength: 256Pattern: ^[a-zA-Z0-9_-] |
measurements | Information about the dimensions for the Parcel. |
trackingData | Shipment tracking information for the Parcel. |
itemsArray of DeliveryItem | Line Items or Custom Line Items delivered in this Parcel. |
custom | Custom Fields for the Parcel. |
ParcelMeasurements
heightInMillimeterInt | Height of the Parcel. |
lengthInMillimeterInt | Length of the Parcel. |
widthInMillimeterInt | Width of the Parcel. |
weightInGramInt | Weight of the Parcel. |
TrackingData
Information that helps track a Parcel.
trackingIdString | Identifier to track the Parcel. |
carrierString | Name of the carrier that delivers the Parcel. |
providerString | Name of the provider that serves as facade to several carriers. |
providerTransactionString | Transaction identifier with the provider. |
isReturnBoolean |
false |
Returns
The following types contain representations of returns, including what items are being returned and their current payment and shipment states.
ReturnInfo
Stores information about returns connected to an Order.
itemsArray of ReturnItem | Information on the Line Items or Custom Line Items returned. |
returnTrackingIdString | User-defined identifier to track the return. |
returnDate | Date and time (UTC) the return is initiated. |
ReturnInfoDraft
itemsArray of ReturnItemDraft | Information on the Line Items or Custom Line Items returned. |
returnTrackingIdString | User-defined identifier for tracking the return. |
returnDate | Date and time (UTC) the return is initiated. |
ReturnItem
Information on the returned Line Items or Custom Line Items; see LineItemReturnItem or CustomLineItemReturnItem respectively.
LineItemReturnItem
idString | Unique identifier of the Return Item. |
keyString | User-defined identifier of the LineItemReturnItem. Must be unique among Return Items in the Order. MinLength:2MaxLength: 256Pattern: ^[a-zA-Z0-9_-] |
quantityInt | Quantity of Line Items returned. |
typeString | "LineItemReturnItem" |
commentString | User-defined description for the return. |
shipmentState | Shipment status of the Return Item. |
paymentState | Payment status of the Return Item:
|
lineItemIdString | id of the returned LineItem. |
custom | Custom Fields of the Return Item. |
createdAt | Date and time (UTC) the Return Item was initially created. |
lastModifiedAt | Date and time (UTC) the Return Item was last updated. |
CustomLineItemReturnItem
idString | Unique identifier of the Return Item. |
keyString | User-defined identifier of the CustomLineItemReturnItem. Must be unique among Return Items in the Order. MinLength:2MaxLength: 256Pattern: ^[a-zA-Z0-9_-] |
quantityInt | Quantity of Custom Line Items returned. |
typeString | "CustomLineItemReturnItem" |
commentString | User-defined description for the return. |
shipmentState | Shipment status of the Return Item. |
paymentState | Payment status of the Return Item:
|
customLineItemIdString | id of the returned CustomLineItem. |
custom | Custom Fields of the Return Item. |
createdAt | Date and time (UTC) the Return Item was initially created. |
lastModifiedAt | Date and time (UTC) the Return Item was last updated. |
ReturnItemDraft
keyString | User-defined identifier of the Return Item. Must be unique among Return Items in the Order. MinLength:2MaxLength: 256Pattern: ^[a-zA-Z0-9_-] |
quantityInt | Quantity of Line Items or Custom Line Items to return. |
lineItemIdString | id of the LineItem to return.Required if Line Items are returned, to create a LineItemReturnItem. |
customLineItemIdString | id of the CustomLineItem to return.Required if Custom Line Items are returned, to create a CustomLineItemReturnItem. |
commentString | User-defined description for the return. |
shipmentState | Shipment status of the item to be returned.
Can either be Advised or Returned only. |
custom | Custom Fields for the Return Item. |
ReturnShipmentState
AdvisedInitial state for Return Items that are non-refundable.
Return Items of this state will have theNonRefundableReturnPaymentState.ReturnedInitial state for Return Items that are refundable.
Return Items of this state will have theInitialReturnPaymentState.BackInStockA state indicating that the Return Items are restocked in inventory.
UnusableA state indicating that the Return Items are not in good condition and cannot be restocked.
Allowed state transitions:
ReturnPaymentState
NonRefundableInitial state for Return Items for which payment cannot be refunded.
Return Items have theAdvisedReturnShipmentState.InitialInitial state for Return Items for which payment can be refunded.
Return Items have theReturnedReturnShipmentState.RefundedThe payment for the Return Items is refunded.
NotRefundedThe payment for the Return Items is not refunded.
Allowed state transitions:
Get Order
Get Order by ID
GET
https://api.{region}.commercetools.com/{projectKey}/orders/{id}
Retrieves an Order with the provided
id.OAuth 2.0 Scopes:
view_orders:{projectKey}Path parameters:
regionString | Region in which the Project is hosted. |
projectKeyString | key of the Project. |
idString | id of the Order. |
Query parameters:
expand | The parameter can be passed multiple times. |
Response:
200as
application/jsoncurl --get https://api.{region}.commercetools.com/{projectKey}/orders/{id} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" {
"type": "Order",
"id": "92f5a867-bf19-47ab-982c-6720a03a3921",
"version": 1,
"createdAt": "2017-01-04T19:54:49.797Z",
"lastModifiedAt": "2017-01-04T19:54:49.797Z",
"totalPrice": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"orderState": "Open",
"syncInfo": [],
"returnInfo": [],
"refusedGifts": [],
"taxMode": "External",
"inventoryMode": "None",
"taxRoundingMode": "HalfEven",
"customerId": "7297c742-d8b0-484b-aadc-1d0ba6769dc9",
"businessUnit": {
"typeId": "business-unit",
"key": "ba-france-123"
},
"lineItems": [
{
"id": "7297c742-d8b0-484b-aadc-1d0ba1869dc9",
"productId": "c5c75935-595a-4cc3-a80e-24e9a9c55094",
"name": {
"en": "MyProduct"
},
"productType": {
"typeId": "product-type",
"id": "a5c7e173-9754-4f02-9b18-a600896ae0e1",
"version": 21
},
"productSlug": {
"de": "neues-produkt-slug-1234678",
"en": "new-product-slug-12345678"
},
"variant": {
"id": 1,
"sku": "some-sku-123",
"prices": [
{
"value": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"id": "6d36dc85-6131-495d-9f20-d00f411d4124"
}
],
"images": [],
"attributes": [
{
"name": "text",
"value": "attribute-value"
},
{
"name": "enum",
"value": {
"key": "test",
"label": "test"
}
}
],
"assets": []
},
"price": {
"id": "6d36dc85-6131-495d-9f20-d00f411d4124",
"value": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
}
},
"quantity": 1,
"discountedPricePerQuantity": [],
"taxRate": {
"name": "Bla",
"amount": 0.1,
"includedInPrice": false,
"country": "DE",
"subRates": []
},
"state": [
{
"quantity": 1,
"state": {
"typeId": "state",
"id": "7c2e2694-aefe-43d7-888e-6a99514caaca"
}
}
],
"priceMode": "Platform",
"lineItemMode": "Standard",
"totalPrice": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"taxedPrice": {
"totalNet": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"totalGross": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1100
},
"taxPortions": [
{
"rate": 0.1,
"amount": {
"type": "centPrecision",
"currencyCode": "EUR",
"centAmount": 634,
"fractionDigits": 2
},
"name": "Bla"
}
]
},
"perMethodTaxRate": [],
"taxedPricePortions": []
}
],
"customLineItems": [],
"discountCodes": [],
"origin": "Customer",
"shipping": [],
"shippingMode": "Single"
}Get Order by OrderNumber
GET
https://api.{region}.commercetools.com/{projectKey}/orders/order-number={orderNumber}
Retrieves an Order with the provided
orderNumber.OAuth 2.0 Scopes:
view_orders:{projectKey}Path parameters:
regionString | Region in which the Project is hosted. |
projectKeyString | key of the Project. |
orderNumberString | orderNumber of the Order. Should be provided in URL-encoded format. |
Query parameters:
expand | The parameter can be passed multiple times. |
Response:
200as
application/jsoncurl --get https://api.{region}.commercetools.com/{projectKey}/orders/order-number={orderNumber} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" {
"type": "Order",
"id": "92f5a867-bf19-47ab-982c-6720a03a3921",
"version": 1,
"createdAt": "2017-01-04T19:54:49.797Z",
"lastModifiedAt": "2017-01-04T19:54:49.797Z",
"totalPrice": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"orderState": "Open",
"syncInfo": [],
"returnInfo": [],
"refusedGifts": [],
"taxMode": "External",
"inventoryMode": "None",
"taxRoundingMode": "HalfEven",
"customerId": "7297c742-d8b0-484b-aadc-1d0ba6769dc9",
"businessUnit": {
"typeId": "business-unit",
"key": "ba-france-123"
},
"lineItems": [
{
"id": "7297c742-d8b0-484b-aadc-1d0ba1869dc9",
"productId": "c5c75935-595a-4cc3-a80e-24e9a9c55094",
"name": {
"en": "MyProduct"
},
"productType": {
"typeId": "product-type",
"id": "a5c7e173-9754-4f02-9b18-a600896ae0e1",
"version": 21
},
"productSlug": {
"de": "neues-produkt-slug-1234678",
"en": "new-product-slug-12345678"
},
"variant": {
"id": 1,
"sku": "some-sku-123",
"prices": [
{
"value": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"id": "6d36dc85-6131-495d-9f20-d00f411d4124"
}
],
"images": [],
"attributes": [
{
"name": "text",
"value": "attribute-value"
},
{
"name": "enum",
"value": {
"key": "test",
"label": "test"
}
}
],
"assets": []
},
"price": {
"id": "6d36dc85-6131-495d-9f20-d00f411d4124",
"value": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
}
},
"quantity": 1,
"discountedPricePerQuantity": [],
"taxRate": {
"name": "Bla",
"amount": 0.1,
"includedInPrice": false,
"country": "DE",
"subRates": []
},
"state": [
{
"quantity": 1,
"state": {
"typeId": "state",
"id": "7c2e2694-aefe-43d7-888e-6a99514caaca"
}
}
],
"priceMode": "Platform",
"lineItemMode": "Standard",
"totalPrice": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"taxedPrice": {
"totalNet": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"totalGross": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1100
},
"taxPortions": [
{
"rate": 0.1,
"amount": {
"type": "centPrecision",
"currencyCode": "EUR",
"centAmount": 634,
"fractionDigits": 2
},
"name": "Bla"
}
]
},
"perMethodTaxRate": [],
"taxedPricePortions": []
}
],
"customLineItems": [],
"discountCodes": [],
"origin": "Customer",
"shipping": [],
"shippingMode": "Single"
}Get Order in Store
Get Order in Store by ID
GET
https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/orders/{id}
Retrieves an Order with the provided
id in a Store.
If the Order exists in the Project but does not have a store specified, or the store field references a different Store, this method returns a ResourceNotFound error.OAuth 2.0 Scopes:
view_orders:{projectKey}view_orders:{projectKey}:{storeKey}Path parameters:
regionString | Region in which the Project is hosted. |
projectKeyString | key of the Project. |
storeKeyString | key of the Store. |
idString | id of the Order. |
Query parameters:
expand | The parameter can be passed multiple times. |
Response:
200as
application/jsoncurl --get https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/orders/{id} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" {
"type": "Order",
"id": "92f5a867-bf19-47ab-982c-6720a03a3921",
"version": 1,
"createdAt": "2017-01-04T19:54:49.797Z",
"lastModifiedAt": "2017-01-04T19:54:49.797Z",
"totalPrice": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"orderState": "Open",
"syncInfo": [],
"returnInfo": [],
"refusedGifts": [],
"taxMode": "External",
"inventoryMode": "None",
"taxRoundingMode": "HalfEven",
"customerId": "7297c742-d8b0-484b-aadc-1d0ba6769dc9",
"businessUnit": {
"typeId": "business-unit",
"key": "ba-france-123"
},
"lineItems": [
{
"id": "7297c742-d8b0-484b-aadc-1d0ba1869dc9",
"productId": "c5c75935-595a-4cc3-a80e-24e9a9c55094",
"name": {
"en": "MyProduct"
},
"productType": {
"typeId": "product-type",
"id": "a5c7e173-9754-4f02-9b18-a600896ae0e1",
"version": 21
},
"productSlug": {
"de": "neues-produkt-slug-1234678",
"en": "new-product-slug-12345678"
},
"variant": {
"id": 1,
"sku": "some-sku-123",
"prices": [
{
"value": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"id": "6d36dc85-6131-495d-9f20-d00f411d4124"
}
],
"images": [],
"attributes": [
{
"name": "text",
"value": "attribute-value"
},
{
"name": "enum",
"value": {
"key": "test",
"label": "test"
}
}
],
"assets": []
},
"price": {
"id": "6d36dc85-6131-495d-9f20-d00f411d4124",
"value": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
}
},
"quantity": 1,
"discountedPricePerQuantity": [],
"taxRate": {
"name": "Bla",
"amount": 0.1,
"includedInPrice": false,
"country": "DE",
"subRates": []
},
"state": [
{
"quantity": 1,
"state": {
"typeId": "state",
"id": "7c2e2694-aefe-43d7-888e-6a99514caaca"
}
}
],
"priceMode": "Platform",
"lineItemMode": "Standard",
"totalPrice": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"taxedPrice": {
"totalNet": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"totalGross": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1100
},
"taxPortions": [
{
"rate": 0.1,
"amount": {
"type": "centPrecision",
"currencyCode": "EUR",
"centAmount": 634,
"fractionDigits": 2
},
"name": "Bla"
}
]
},
"perMethodTaxRate": [],
"taxedPricePortions": []
}
],
"customLineItems": [],
"discountCodes": [],
"origin": "Customer",
"shipping": [],
"shippingMode": "Single"
}Get Order in Store by OrderNumber
GET
https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/orders/order-number={orderNumber}
Retrieves an Order with the provided
orderNumber in a Store.
If the Order exists in the Project but does not have a store specified, or the store field references a different Store, this method returns a ResourceNotFound error.OAuth 2.0 Scopes:
view_orders:{projectKey}view_orders:{projectKey}:{storeKey}Path parameters:
regionString | Region in which the Project is hosted. |
projectKeyString | key of the Project. |
storeKeyString | key of the Store. |
orderNumberString | orderNumber of the Order. Should be provided in URL-encoded format. |
Query parameters:
expand | The parameter can be passed multiple times. |
Response:
200as
application/jsoncurl --get https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/orders/order-number={orderNumber} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" {
"type": "Order",
"id": "92f5a867-bf19-47ab-982c-6720a03a3921",
"version": 1,
"createdAt": "2017-01-04T19:54:49.797Z",
"lastModifiedAt": "2017-01-04T19:54:49.797Z",
"totalPrice": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"orderState": "Open",
"syncInfo": [],
"returnInfo": [],
"refusedGifts": [],
"taxMode": "External",
"inventoryMode": "None",
"taxRoundingMode": "HalfEven",
"customerId": "7297c742-d8b0-484b-aadc-1d0ba6769dc9",
"businessUnit": {
"typeId": "business-unit",
"key": "ba-france-123"
},
"lineItems": [
{
"id": "7297c742-d8b0-484b-aadc-1d0ba1869dc9",
"productId": "c5c75935-595a-4cc3-a80e-24e9a9c55094",
"name": {
"en": "MyProduct"
},
"productType": {
"typeId": "product-type",
"id": "a5c7e173-9754-4f02-9b18-a600896ae0e1",
"version": 21
},
"productSlug": {
"de": "neues-produkt-slug-1234678",
"en": "new-product-slug-12345678"
},
"variant": {
"id": 1,
"sku": "some-sku-123",
"prices": [
{
"value": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"id": "6d36dc85-6131-495d-9f20-d00f411d4124"
}
],
"images": [],
"attributes": [
{
"name": "text",
"value": "attribute-value"
},
{
"name": "enum",
"value": {
"key": "test",
"label": "test"
}
}
],
"assets": []
},
"price": {
"id": "6d36dc85-6131-495d-9f20-d00f411d4124",
"value": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
}
},
"quantity": 1,
"discountedPricePerQuantity": [],
"taxRate": {
"name": "Bla",
"amount": 0.1,
"includedInPrice": false,
"country": "DE",
"subRates": []
},
"state": [
{
"quantity": 1,
"state": {
"typeId": "state",
"id": "7c2e2694-aefe-43d7-888e-6a99514caaca"
}
}
],
"priceMode": "Platform",
"lineItemMode": "Standard",
"totalPrice": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"taxedPrice": {
"totalNet": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"totalGross": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1100
},
"taxPortions": [
{
"rate": 0.1,
"amount": {
"type": "centPrecision",
"currencyCode": "EUR",
"centAmount": 634,
"fractionDigits": 2
},
"name": "Bla"
}
]
},
"perMethodTaxRate": [],
"taxedPricePortions": []
}
],
"customLineItems": [],
"discountCodes": [],
"origin": "Customer",
"shipping": [],
"shippingMode": "Single"
}Query Orders
To perform searches across a large number of Orders for back-office use cases, consider Order Search BETA instead.
GET
https://api.{region}.commercetools.com/{projectKey}/orders
Retrieves Orders in the Project.
OAuth 2.0 Scopes:
view_orders:{projectKey}Path parameters:
regionString | Region in which the Project is hosted. |
projectKeyString | key of the Project. |
Query parameters:
where | The parameter can be passed multiple times. |
sort | The parameter can be passed multiple times. |
expand | The parameter can be passed multiple times. |
limitInt | Number of results requested. Default: 20Minimum: 0Maximum: 500 |
offsetInt | Number of elements skipped. Default: 0Maximum: 10000 |
withTotalBoolean | Controls the calculation of the total number of query results. Set to false to improve query performance when the total is not needed.Default: true |
var.<varName>String | Predicate parameter values. The parameter can be passed multiple times. |
Response:
200as
application/jsoncurl --get https://api.{region}.commercetools.com/{projectKey}/orders -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" {
"limit": 20,
"offset": 0,
"count": 1,
"total": 1,
"results": [
{
"type": "Order",
"id": "92f5a867-bf19-47ab-982c-6720a03a3921",
"version": 1,
"createdAt": "2017-01-04T19:54:49.797Z",
"lastModifiedAt": "2017-01-04T19:54:49.797Z",
"totalPrice": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"orderState": "Open",
"syncInfo": [],
"returnInfo": [],
"refusedGifts": [],
"taxMode": "External",
"inventoryMode": "None",
"taxRoundingMode": "HalfEven",
"customerId": "7297c742-d8b0-484b-aadc-1d0ba6769dc9",
"businessUnit": {
"typeId": "business-unit",
"key": "ba-france-123"
},
"lineItems": [
{
"id": "7297c742-d8b0-484b-aadc-1d0ba1869dc9",
"productId": "c5c75935-595a-4cc3-a80e-24e9a9c55094",
"name": {
"en": "MyProduct"
},
"productType": {
"typeId": "product-type",
"id": "a5c7e173-9754-4f02-9b18-a600896ae0e1",
"version": 21
},
"productSlug": {
"de": "neues-produkt-slug-1234678",
"en": "new-product-slug-12345678"
},
"variant": {
"id": 1,
"sku": "some-sku-123",
"prices": [
{
"value": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"id": "6d36dc85-6131-495d-9f20-d00f411d4124"
}
],
"images": [],
"attributes": [
{
"name": "text",
"value": "attribute-value"
},
{
"name": "enum",
"value": {
"key": "test",
"label": "test"
}
}
],
"assets": []
},
"price": {
"id": "6d36dc85-6131-495d-9f20-d00f411d4124",
"value": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
}
},
"quantity": 1,
"discountedPricePerQuantity": [],
"taxRate": {
"name": "Bla",
"amount": 0.1,
"includedInPrice": false,
"country": "DE",
"subRates": []
},
"state": [
{
"quantity": 1,
"state": {
"typeId": "state",
"id": "7c2e2694-aefe-43d7-888e-6a99514caaca"
}
}
],
"priceMode": "Platform",
"lineItemMode": "Standard",
"totalPrice": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"taxedPrice": {
"totalNet": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"totalGross": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1100
},
"taxPortions": [
{
"rate": 0.1,
"amount": {
"type": "centPrecision",
"currencyCode": "EUR",
"centAmount": 634,
"fractionDigits": 2
},
"name": "Bla"
}
]
},
"perMethodTaxRate": [],
"taxedPricePortions": []
}
],
"customLineItems": [],
"discountCodes": [],
"origin": "Customer",
"shipping": [],
"shippingMode": "Single"
}
]
}Query Orders in Store
GET
https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/orders
Retrieves Orders in a Store.
OAuth 2.0 Scopes:
view_orders:{projectKey}view_orders:{projectKey}:{storeKey}Path parameters:
regionString | Region in which the Project is hosted. |
projectKeyString | key of the Project. |
storeKeyString | key of the Store. |
Query parameters:
where | The parameter can be passed multiple times. |
sort | The parameter can be passed multiple times. |
expand | The parameter can be passed multiple times. |
limitInt | Number of results requested. Default: 20Minimum: 0Maximum: 500 |
offsetInt | Number of elements skipped. Default: 0Maximum: 10000 |
withTotalBoolean | Controls the calculation of the total number of query results. Set to false to improve query performance when the total is not needed.Default: true |
var.<varName>String | Predicate parameter values. The parameter can be passed multiple times. |
Response:
200as
application/jsoncurl --get https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/orders -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" {
"limit": 20,
"offset": 0,
"count": 1,
"total": 1,
"results": [
{
"type": "Order",
"id": "92f5a867-bf19-47ab-982c-6720a03a3921",
"version": 1,
"createdAt": "2017-01-04T19:54:49.797Z",
"lastModifiedAt": "2017-01-04T19:54:49.797Z",
"totalPrice": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"orderState": "Open",
"syncInfo": [],
"returnInfo": [],
"refusedGifts": [],
"taxMode": "External",
"inventoryMode": "None",
"taxRoundingMode": "HalfEven",
"customerId": "7297c742-d8b0-484b-aadc-1d0ba6769dc9",
"businessUnit": {
"typeId": "business-unit",
"key": "ba-france-123"
},
"lineItems": [
{
"id": "7297c742-d8b0-484b-aadc-1d0ba1869dc9",
"productId": "c5c75935-595a-4cc3-a80e-24e9a9c55094",
"name": {
"en": "MyProduct"
},
"productType": {
"typeId": "product-type",
"id": "a5c7e173-9754-4f02-9b18-a600896ae0e1",
"version": 21
},
"productSlug": {
"de": "neues-produkt-slug-1234678",
"en": "new-product-slug-12345678"
},
"variant": {
"id": 1,
"sku": "some-sku-123",
"prices": [
{
"value": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"id": "6d36dc85-6131-495d-9f20-d00f411d4124"
}
],
"images": [],
"attributes": [
{
"name": "text",
"value": "attribute-value"
},
{
"name": "enum",
"value": {
"key": "test",
"label": "test"
}
}
],
"assets": []
},
"price": {
"id": "6d36dc85-6131-495d-9f20-d00f411d4124",
"value": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
}
},
"quantity": 1,
"discountedPricePerQuantity": [],
"taxRate": {
"name": "Bla",
"amount": 0.1,
"includedInPrice": false,
"country": "DE",
"subRates": []
},
"state": [
{
"quantity": 1,
"state": {
"typeId": "state",
"id": "7c2e2694-aefe-43d7-888e-6a99514caaca"
}
}
],
"priceMode": "Platform",
"lineItemMode": "Standard",
"totalPrice": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"taxedPrice": {
"totalNet": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"totalGross": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1100
},
"taxPortions": [
{
"rate": 0.1,
"amount": {
"type": "centPrecision",
"currencyCode": "EUR",
"centAmount": 634,
"fractionDigits": 2
},
"name": "Bla"
}
]
},
"perMethodTaxRate": [],
"taxedPricePortions": []
}
],
"customLineItems": [],
"discountCodes": [],
"origin": "Customer",
"shipping": [],
"shippingMode": "Single"
}
]
}Check if Order exists
Check if Order exists by ID
HEAD
https://api.{region}.commercetools.com/{projectKey}/orders/{id}
Checks if an Order exists with the provided
id. Returns a 200 status if the Order exists, or a 404 status otherwise.OAuth 2.0 Scopes:
view_orders:{projectKey}Path parameters:
regionString | Region in which the Project is hosted. |
projectKeyString | key of the Project. |
idString | id of the Order. |
Response:
200
curl --head https://api.{region}.commercetools.com/{projectKey}/orders/{id} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" Check if Order exists by OrderNumber
HEAD
https://api.{region}.commercetools.com/{projectKey}/orders/order-number={orderNumber}
Checks if an Order exists with the provided
orderNumber. Returns a 200 status if the Order exists, or a 404 status otherwise.OAuth 2.0 Scopes:
view_orders:{projectKey}Path parameters:
regionString | Region in which the Project is hosted. |
projectKeyString | key of the Project. |
orderNumberString | orderNumber of the Order. Should be provided in URL-encoded format. |
Response:
200
curl --head https://api.{region}.commercetools.com/{projectKey}/orders/order-number={orderNumber} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" Check if Order exists by Query Predicate
HEAD
https://api.{region}.commercetools.com/{projectKey}/orders
Checks if one or more Orders exist for the provided query predicate. Returns a
200 status if any Orders match the query predicate, or a 404 status otherwise.OAuth 2.0 Scopes:
view_orders:{projectKey}Path parameters:
regionString | Region in which the Project is hosted. |
projectKeyString | key of the Project. |
Query parameters:
where | The parameter can be passed multiple times. |
Response:
200
curl --head https://api.{region}.commercetools.com/{projectKey}/orders -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" Check if Order exists in Store
Check if Order exists in Store by ID
HEAD
https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/orders/{id}
Checks if an Order exists with the provided
id in a Store. Returns a 200 status if the Order exists, or a 404 status otherwise.OAuth 2.0 Scopes:
view_orders:{projectKey}view_orders:{projectKey}:{storeKey}Path parameters:
regionString | Region in which the Project is hosted. |
projectKeyString | key of the Project. |
storeKeyString | key of the Store. |
idString | id of the Order. |
Response:
200
curl --head https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/orders/{id} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" Check if Order exists in Store by OrderNumber
HEAD
https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/orders/order-number={orderNumber}
Checks if an Order exists with the provided
orderNumber in a Store. Returns a 200 status if the Order exists, or a 404 status otherwise.OAuth 2.0 Scopes:
view_orders:{projectKey}view_orders:{projectKey}:{storeKey}Path parameters:
regionString | Region in which the Project is hosted. |
projectKeyString | key of the Project. |
storeKeyString | key of the Store. |
orderNumberString | orderNumber of the Order. Should be provided in URL-encoded format. |
Response:
200
curl --head https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/orders/order-number={orderNumber} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" Check if Order exists in Store by Query Predicate
HEAD
https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/orders
Checks if one or more Orders exist for the provided query predicate in a Store. Returns a
200 status if any Orders match the query predicate, or a 404 status otherwise.OAuth 2.0 Scopes:
view_orders:{projectKey}view_orders:{projectKey}:{storeKey}Path parameters:
regionString | Region in which the Project is hosted. |
projectKeyString | key of the Project. |
storeKeyString | key of the Store. |
Query parameters:
where | The parameter can be passed multiple times. |
Response:
200
curl --head https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/orders -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" Create Order
Create Order from Cart
POST
https://api.{region}.commercetools.com/{projectKey}/orders
Creates an Order from a Cart.
The Cart must have a shipping address set, regardless of the TaxMode.
For a Cart with
Platform TaxMode, the shipping address is used for tax calculation.Creating an Order produces the OrderCreated Message. If the Order is created from a Recurring Order schedule, the OrderCreatedFromRecurringOrder Message is generated instead of the OrderCreated Message.
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 is returned in several cases, including the following:
- The referenced Shipping Method is not active.
- The referenced Shipping Method is scoped to a Store that differs from the Cart's Store.
- The referenced Shipping Method is scoped to a Store, but the Cart does not belong to a Store.
- MatchingPriceNotFound
- MissingTaxRateForCountry
OAuth 2.0 Scopes:
manage_orders:{projectKey}Path parameters:
regionString | Region in which the Project is hosted. |
projectKeyString | key of the Project. |
Query parameters:
expand | The parameter can be passed multiple times. |
Request Body:OrderFromCartDraftas
application/jsonResponse:
201as
application/jsoncurl https://api.{region}.commercetools.com/{projectKey}/orders -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-binary @- << DATA
{
"cart" : {
"id" : "7c2e2694-aefe-43d7-888e-6a99514caaca",
"typeId" : "cart"
},
"version" : 10
}
DATA{
"type": "Order",
"id": "92f5a867-bf19-47ab-982c-6720a03a3921",
"version": 1,
"createdAt": "2017-01-04T19:54:49.797Z",
"lastModifiedAt": "2017-01-04T19:54:49.797Z",
"totalPrice": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"orderState": "Open",
"syncInfo": [],
"returnInfo": [],
"refusedGifts": [],
"taxMode": "External",
"inventoryMode": "None",
"taxRoundingMode": "HalfEven",
"customerId": "7297c742-d8b0-484b-aadc-1d0ba6769dc9",
"businessUnit": {
"typeId": "business-unit",
"key": "ba-france-123"
},
"lineItems": [
{
"id": "7297c742-d8b0-484b-aadc-1d0ba1869dc9",
"productId": "c5c75935-595a-4cc3-a80e-24e9a9c55094",
"name": {
"en": "MyProduct"
},
"productType": {
"typeId": "product-type",
"id": "a5c7e173-9754-4f02-9b18-a600896ae0e1",
"version": 21
},
"productSlug": {
"de": "neues-produkt-slug-1234678",
"en": "new-product-slug-12345678"
},
"variant": {
"id": 1,
"sku": "some-sku-123",
"prices": [
{
"value": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"id": "6d36dc85-6131-495d-9f20-d00f411d4124"
}
],
"images": [],
"attributes": [
{
"name": "text",
"value": "attribute-value"
},
{
"name": "enum",
"value": {
"key": "test",
"label": "test"
}
}
],
"assets": []
},
"price": {
"id": "6d36dc85-6131-495d-9f20-d00f411d4124",
"value": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
}
},
"quantity": 1,
"discountedPricePerQuantity": [],
"taxRate": {
"name": "Bla",
"amount": 0.1,
"includedInPrice": false,
"country": "DE",
"subRates": []
},
"state": [
{
"quantity": 1,
"state": {
"typeId": "state",
"id": "7c2e2694-aefe-43d7-888e-6a99514caaca"
}
}
],
"priceMode": "Platform",
"lineItemMode": "Standard",
"totalPrice": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"taxedPrice": {
"totalNet": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"totalGross": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1100
},
"taxPortions": [
{
"rate": 0.1,
"amount": {
"type": "centPrecision",
"currencyCode": "EUR",
"centAmount": 634,
"fractionDigits": 2
},
"name": "Bla"
}
]
},
"perMethodTaxRate": [],
"taxedPricePortions": []
}
],
"customLineItems": [],
"discountCodes": [],
"origin": "Customer",
"shipping": [],
"shippingMode": "Single"
}Create Order from Quote
POST
https://api.{region}.commercetools.com/{projectKey}/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 is returned in several cases, including the following:
- OutOfStock
OAuth 2.0 Scopes:
manage_quotes:{projectKey}Path parameters:
regionString | Region in which the Project is hosted. |
projectKeyString | key of the Project. |
Request Body:OrderFromQuoteDraftas
application/jsonResponse:
201as
application/jsoncurl https://api.{region}.commercetools.com/{projectKey}/orders/quotes -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-binary @- << DATA
{
"quote" : {
"id" : "40d04a85-34d3-4769-a1b6-ecd00db2a587",
"typeId" : "quote"
},
"version" : 1
}
DATA{
"type": "Order",
"id": "92f5a867-bf19-47ab-982c-6720a03a3921",
"version": 1,
"createdAt": "2017-01-04T19:54:49.797Z",
"lastModifiedAt": "2017-01-04T19:54:49.797Z",
"totalPrice": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"orderState": "Open",
"syncInfo": [],
"returnInfo": [],
"refusedGifts": [],
"taxMode": "External",
"inventoryMode": "None",
"taxRoundingMode": "HalfEven",
"customerId": "7297c742-d8b0-484b-aadc-1d0ba6769dc9",
"businessUnit": {
"typeId": "business-unit",
"key": "ba-france-123"
},
"lineItems": [
{
"id": "7297c742-d8b0-484b-aadc-1d0ba1869dc9",
"productId": "c5c75935-595a-4cc3-a80e-24e9a9c55094",
"name": {
"en": "MyProduct"
},
"productType": {
"typeId": "product-type",
"id": "a5c7e173-9754-4f02-9b18-a600896ae0e1",
"version": 21
},
"productSlug": {
"de": "neues-produkt-slug-1234678",
"en": "new-product-slug-12345678"
},
"variant": {
"id": 1,
"sku": "some-sku-123",
"prices": [
{
"value": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"id": "6d36dc85-6131-495d-9f20-d00f411d4124"
}
],
"images": [],
"attributes": [
{
"name": "text",
"value": "attribute-value"
},
{
"name": "enum",
"value": {
"key": "test",
"label": "test"
}
}
],
"assets": []
},
"price": {
"id": "6d36dc85-6131-495d-9f20-d00f411d4124",
"value": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
}
},
"quantity": 1,
"discountedPricePerQuantity": [],
"taxRate": {
"name": "Bla",
"amount": 0.1,
"includedInPrice": false,
"country": "DE",
"subRates": []
},
"state": [
{
"quantity": 1,
"state": {
"typeId": "state",
"id": "7c2e2694-aefe-43d7-888e-6a99514caaca"
}
}
],
"priceMode": "Platform",
"lineItemMode": "Standard",
"totalPrice": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"taxedPrice": {
"totalNet": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"totalGross": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1100
},
"taxPortions": [
{
"rate": 0.1,
"amount": {
"type": "centPrecision",
"currencyCode": "EUR",
"centAmount": 634,
"fractionDigits": 2
},
"name": "Bla"
}
]
},
"perMethodTaxRate": [],
"taxedPricePortions": []
}
],
"customLineItems": [],
"discountCodes": [],
"origin": "Customer",
"shipping": [],
"shippingMode": "Single"
}Create Order by Import
To import an Order without having a Cart or Quote before, see Create Order by Import.
Create Order in Store
Create Order in Store from Cart
POST
https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/orders
Creates an Order from a Cart in a Store.
The Cart must have a shipping address set, regardless of the TaxMode.
For a Cart with
Platform TaxMode, the shipping address is used for tax calculation.Creating an Order produces the OrderCreated Message.
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:
OAuth 2.0 Scopes:
manage_orders:{projectKey}manage_orders:{projectKey}:{storeKey}Path parameters:
regionString | Region in which the Project is hosted. |
projectKeyString | key of the Project. |
storeKeyString | key of the Store. |
Query parameters:
expand | The parameter can be passed multiple times. |
Request Body:OrderFromCartDraftas
application/jsonResponse:
201as
application/jsoncurl https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/orders -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-binary @- << DATA
{
"cart" : {
"id" : "7c2e2694-aefe-43d7-888e-6a99514caaca",
"typeId" : "cart"
},
"version" : 10
}
DATA{
"type": "Order",
"id": "92f5a867-bf19-47ab-982c-6720a03a3921",
"version": 1,
"createdAt": "2017-01-04T19:54:49.797Z",
"lastModifiedAt": "2017-01-04T19:54:49.797Z",
"totalPrice": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"orderState": "Open",
"syncInfo": [],
"returnInfo": [],
"refusedGifts": [],
"taxMode": "External",
"inventoryMode": "None",
"taxRoundingMode": "HalfEven",
"customerId": "7297c742-d8b0-484b-aadc-1d0ba6769dc9",
"businessUnit": {
"typeId": "business-unit",
"key": "ba-france-123"
},
"lineItems": [
{
"id": "7297c742-d8b0-484b-aadc-1d0ba1869dc9",
"productId": "c5c75935-595a-4cc3-a80e-24e9a9c55094",
"name": {
"en": "MyProduct"
},
"productType": {
"typeId": "product-type",
"id": "a5c7e173-9754-4f02-9b18-a600896ae0e1",
"version": 21
},
"productSlug": {
"de": "neues-produkt-slug-1234678",
"en": "new-product-slug-12345678"
},
"variant": {
"id": 1,
"sku": "some-sku-123",
"prices": [
{
"value": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"id": "6d36dc85-6131-495d-9f20-d00f411d4124"
}
],
"images": [],
"attributes": [
{
"name": "text",
"value": "attribute-value"
},
{
"name": "enum",
"value": {
"key": "test",
"label": "test"
}
}
],
"assets": []
},
"price": {
"id": "6d36dc85-6131-495d-9f20-d00f411d4124",
"value": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
}
},
"quantity": 1,
"discountedPricePerQuantity": [],
"taxRate": {
"name": "Bla",
"amount": 0.1,
"includedInPrice": false,
"country": "DE",
"subRates": []
},
"state": [
{
"quantity": 1,
"state": {
"typeId": "state",
"id": "7c2e2694-aefe-43d7-888e-6a99514caaca"
}
}
],
"priceMode": "Platform",
"lineItemMode": "Standard",
"totalPrice": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"taxedPrice": {
"totalNet": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"totalGross": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1100
},
"taxPortions": [
{
"rate": 0.1,
"amount": {
"type": "centPrecision",
"currencyCode": "EUR",
"centAmount": 634,
"fractionDigits": 2
},
"name": "Bla"
}
]
},
"perMethodTaxRate": [],
"taxedPricePortions": []
}
],
"customLineItems": [],
"discountCodes": [],
"origin": "Customer",
"shipping": [],
"shippingMode": "Single"
}Create Order in Store from Quote
POST
https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/orders/quotes
Creates an Order from a Quote in a Store. 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:
OAuth 2.0 Scopes:
manage_quotes:{projectKey}manage_quotes:{projectKey}:{storeKey}Path parameters:
regionString | Region in which the Project is hosted. |
projectKeyString | key of the Project. |
storeKeyString | key of the Store. |
Request Body:OrderFromQuoteDraftas
application/jsonResponse:
201as
application/jsoncurl https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/orders/quotes -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-binary @- << DATA
{
"quote" : {
"id" : "40d04a85-34d3-4769-a1b6-ecd00db2a587",
"typeId" : "quote"
},
"version" : 1
}
DATA{
"type": "Order",
"id": "92f5a867-bf19-47ab-982c-6720a03a3921",
"version": 1,
"createdAt": "2017-01-04T19:54:49.797Z",
"lastModifiedAt": "2017-01-04T19:54:49.797Z",
"totalPrice": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"orderState": "Open",
"syncInfo": [],
"returnInfo": [],
"refusedGifts": [],
"taxMode": "External",
"inventoryMode": "None",
"taxRoundingMode": "HalfEven",
"customerId": "7297c742-d8b0-484b-aadc-1d0ba6769dc9",
"businessUnit": {
"typeId": "business-unit",
"key": "ba-france-123"
},
"lineItems": [
{
"id": "7297c742-d8b0-484b-aadc-1d0ba1869dc9",
"productId": "c5c75935-595a-4cc3-a80e-24e9a9c55094",
"name": {
"en": "MyProduct"
},
"productType": {
"typeId": "product-type",
"id": "a5c7e173-9754-4f02-9b18-a600896ae0e1",
"version": 21
},
"productSlug": {
"de": "neues-produkt-slug-1234678",
"en": "new-product-slug-12345678"
},
"variant": {
"id": 1,
"sku": "some-sku-123",
"prices": [
{
"value": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"id": "6d36dc85-6131-495d-9f20-d00f411d4124"
}
],
"images": [],
"attributes": [
{
"name": "text",
"value": "attribute-value"
},
{
"name": "enum",
"value": {
"key": "test",
"label": "test"
}
}
],
"assets": []
},
"price": {
"id": "6d36dc85-6131-495d-9f20-d00f411d4124",
"value": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
}
},
"quantity": 1,
"discountedPricePerQuantity": [],
"taxRate": {
"name": "Bla",
"amount": 0.1,
"includedInPrice": false,
"country": "DE",
"subRates": []
},
"state": [
{
"quantity": 1,
"state": {
"typeId": "state",
"id": "7c2e2694-aefe-43d7-888e-6a99514caaca"
}
}
],
"priceMode": "Platform",
"lineItemMode": "Standard",
"totalPrice": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"taxedPrice": {
"totalNet": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"totalGross": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1100
},
"taxPortions": [
{
"rate": 0.1,
"amount": {
"type": "centPrecision",
"currencyCode": "EUR",
"centAmount": 634,
"fractionDigits": 2
},
"name": "Bla"
}
]
},
"perMethodTaxRate": [],
"taxedPricePortions": []
}
],
"customLineItems": [],
"discountCodes": [],
"origin": "Customer",
"shipping": [],
"shippingMode": "Single"
}Update Order
Update Order by ID
POST
https://api.{region}.commercetools.com/{projectKey}/orders/{id}
Updates an Order in the Project using one or more update actions.
OAuth 2.0 Scopes:
manage_orders:{projectKey}Path parameters:
regionString | Region in which the Project is hosted. |
projectKeyString | key of the Project. |
idString | id of the Order. |
Query parameters:
expand | The parameter can be passed multiple times. |
Request Body:
application/jsonversionInt | Expected version of the Order on which the changes should be applied.
If the expected version does not match the actual version, a ConcurrentModification error will be returned. |
actionsArray of OrderUpdateAction | Update actions to be performed on the Order. |
Response:
200as
application/jsoncurl https://api.{region}.commercetools.com/{projectKey}/orders/{id} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-binary @- << DATA
{
"version" : 1,
"actions" : [ {
"action" : "changeOrderState",
"orderState" : "Complete"
} ]
}
DATA{
"type": "Order",
"id": "92f5a867-bf19-47ab-982c-6720a03a3921",
"version": 1,
"createdAt": "2017-01-04T19:54:49.797Z",
"lastModifiedAt": "2017-01-04T19:54:49.797Z",
"totalPrice": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"orderState": "Open",
"syncInfo": [],
"returnInfo": [],
"refusedGifts": [],
"taxMode": "External",
"inventoryMode": "None",
"taxRoundingMode": "HalfEven",
"customerId": "7297c742-d8b0-484b-aadc-1d0ba6769dc9",
"businessUnit": {
"typeId": "business-unit",
"key": "ba-france-123"
},
"lineItems": [
{
"id": "7297c742-d8b0-484b-aadc-1d0ba1869dc9",
"productId": "c5c75935-595a-4cc3-a80e-24e9a9c55094",
"name": {
"en": "MyProduct"
},
"productType": {
"typeId": "product-type",
"id": "a5c7e173-9754-4f02-9b18-a600896ae0e1",
"version": 21
},
"productSlug": {
"de": "neues-produkt-slug-1234678",
"en": "new-product-slug-12345678"
},
"variant": {
"id": 1,
"sku": "some-sku-123",
"prices": [
{
"value": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"id": "6d36dc85-6131-495d-9f20-d00f411d4124"
}
],
"images": [],
"attributes": [
{
"name": "text",
"value": "attribute-value"
},
{
"name": "enum",
"value": {
"key": "test",
"label": "test"
}
}
],
"assets": []
},
"price": {
"id": "6d36dc85-6131-495d-9f20-d00f411d4124",
"value": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
}
},
"quantity": 1,
"discountedPricePerQuantity": [],
"taxRate": {
"name": "Bla",
"amount": 0.1,
"includedInPrice": false,
"country": "DE",
"subRates": []
},
"state": [
{
"quantity": 1,
"state": {
"typeId": "state",
"id": "7c2e2694-aefe-43d7-888e-6a99514caaca"
}
}
],
"priceMode": "Platform",
"lineItemMode": "Standard",
"totalPrice": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"taxedPrice": {
"totalNet": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"totalGross": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1100
},
"taxPortions": [
{
"rate": 0.1,
"amount": {
"type": "centPrecision",
"currencyCode": "EUR",
"centAmount": 634,
"fractionDigits": 2
},
"name": "Bla"
}
]
},
"perMethodTaxRate": [],
"taxedPricePortions": []
}
],
"customLineItems": [],
"discountCodes": [],
"origin": "Customer",
"shipping": [],
"shippingMode": "Single"
}Update Order by OrderNumber
POST
https://api.{region}.commercetools.com/{projectKey}/orders/order-number={orderNumber}
Updates an Order in the Project using one or more update actions.
OAuth 2.0 Scopes:
manage_orders:{projectKey}Path parameters:
regionString | Region in which the Project is hosted. |
projectKeyString | key of the Project. |
orderNumberString | orderNumber of the Order. Should be provided in URL-encoded format. |
Query parameters:
expand | The parameter can be passed multiple times. |
Request Body:
application/jsonversionInt | Expected version of the Order on which the changes should be applied.
If the expected version does not match the actual version, a ConcurrentModification error will be returned. |
actionsArray of OrderUpdateAction | Update actions to be performed on the Order. |
Response:
200as
application/jsoncurl https://api.{region}.commercetools.com/{projectKey}/orders/order-number={orderNumber} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-binary @- << DATA
{
"version" : 1,
"actions" : [ {
"action" : "changeOrderState",
"orderState" : "Complete"
} ]
}
DATA{
"type": "Order",
"id": "92f5a867-bf19-47ab-982c-6720a03a3921",
"version": 1,
"createdAt": "2017-01-04T19:54:49.797Z",
"lastModifiedAt": "2017-01-04T19:54:49.797Z",
"totalPrice": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"orderState": "Open",
"syncInfo": [],
"returnInfo": [],
"refusedGifts": [],
"taxMode": "External",
"inventoryMode": "None",
"taxRoundingMode": "HalfEven",
"customerId": "7297c742-d8b0-484b-aadc-1d0ba6769dc9",
"businessUnit": {
"typeId": "business-unit",
"key": "ba-france-123"
},
"lineItems": [
{
"id": "7297c742-d8b0-484b-aadc-1d0ba1869dc9",
"productId": "c5c75935-595a-4cc3-a80e-24e9a9c55094",
"name": {
"en": "MyProduct"
},
"productType": {
"typeId": "product-type",
"id": "a5c7e173-9754-4f02-9b18-a600896ae0e1",
"version": 21
},
"productSlug": {
"de": "neues-produkt-slug-1234678",
"en": "new-product-slug-12345678"
},
"variant": {
"id": 1,
"sku": "some-sku-123",
"prices": [
{
"value": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"id": "6d36dc85-6131-495d-9f20-d00f411d4124"
}
],
"images": [],
"attributes": [
{
"name": "text",
"value": "attribute-value"
},
{
"name": "enum",
"value": {
"key": "test",
"label": "test"
}
}
],
"assets": []
},
"price": {
"id": "6d36dc85-6131-495d-9f20-d00f411d4124",
"value": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
}
},
"quantity": 1,
"discountedPricePerQuantity": [],
"taxRate": {
"name": "Bla",
"amount": 0.1,
"includedInPrice": false,
"country": "DE",
"subRates": []
},
"state": [
{
"quantity": 1,
"state": {
"typeId": "state",
"id": "7c2e2694-aefe-43d7-888e-6a99514caaca"
}
}
],
"priceMode": "Platform",
"lineItemMode": "Standard",
"totalPrice": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"taxedPrice": {
"totalNet": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"totalGross": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1100
},
"taxPortions": [
{
"rate": 0.1,
"amount": {
"type": "centPrecision",
"currencyCode": "EUR",
"centAmount": 634,
"fractionDigits": 2
},
"name": "Bla"
}
]
},
"perMethodTaxRate": [],
"taxedPricePortions": []
}
],
"customLineItems": [],
"discountCodes": [],
"origin": "Customer",
"shipping": [],
"shippingMode": "Single"
}Update Order in Store
Update Order in Store by ID
POST
https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/orders/{id}
Updates an Order in a Store using one or more update actions.
If the Order exists in the Project but does not have a
store specified, or the store field references a different Store, this method returns a ResourceNotFound error.OAuth 2.0 Scopes:
manage_orders:{projectKey}manage_orders:{projectKey}:{storeKey}Path parameters:
regionString | Region in which the Project is hosted. |
projectKeyString | key of the Project. |
storeKeyString | key of the Store. |
idString | id of the Order. |
Query parameters:
expand | The parameter can be passed multiple times. |
Request Body:
application/jsonversionInt | Expected version of the Order on which the changes should be applied.
If the expected version does not match the actual version, a ConcurrentModification error will be returned. |
actionsArray of OrderUpdateAction | Update actions to be performed on the Order. |
Response:
200as
application/jsoncurl https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/orders/{id} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-binary @- << DATA
{
"version" : 1,
"actions" : [ {
"action" : "changeOrderState",
"orderState" : "Complete"
} ]
}
DATA{
"type": "Order",
"id": "92f5a867-bf19-47ab-982c-6720a03a3921",
"version": 1,
"createdAt": "2017-01-04T19:54:49.797Z",
"lastModifiedAt": "2017-01-04T19:54:49.797Z",
"totalPrice": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"orderState": "Open",
"syncInfo": [],
"returnInfo": [],
"refusedGifts": [],
"taxMode": "External",
"inventoryMode": "None",
"taxRoundingMode": "HalfEven",
"customerId": "7297c742-d8b0-484b-aadc-1d0ba6769dc9",
"businessUnit": {
"typeId": "business-unit",
"key": "ba-france-123"
},
"lineItems": [
{
"id": "7297c742-d8b0-484b-aadc-1d0ba1869dc9",
"productId": "c5c75935-595a-4cc3-a80e-24e9a9c55094",
"name": {
"en": "MyProduct"
},
"productType": {
"typeId": "product-type",
"id": "a5c7e173-9754-4f02-9b18-a600896ae0e1",
"version": 21
},
"productSlug": {
"de": "neues-produkt-slug-1234678",
"en": "new-product-slug-12345678"
},
"variant": {
"id": 1,
"sku": "some-sku-123",
"prices": [
{
"value": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"id": "6d36dc85-6131-495d-9f20-d00f411d4124"
}
],
"images": [],
"attributes": [
{
"name": "text",
"value": "attribute-value"
},
{
"name": "enum",
"value": {
"key": "test",
"label": "test"
}
}
],
"assets": []
},
"price": {
"id": "6d36dc85-6131-495d-9f20-d00f411d4124",
"value": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
}
},
"quantity": 1,
"discountedPricePerQuantity": [],
"taxRate": {
"name": "Bla",
"amount": 0.1,
"includedInPrice": false,
"country": "DE",
"subRates": []
},
"state": [
{
"quantity": 1,
"state": {
"typeId": "state",
"id": "7c2e2694-aefe-43d7-888e-6a99514caaca"
}
}
],
"priceMode": "Platform",
"lineItemMode": "Standard",
"totalPrice": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"taxedPrice": {
"totalNet": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"totalGross": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1100
},
"taxPortions": [
{
"rate": 0.1,
"amount": {
"type": "centPrecision",
"currencyCode": "EUR",
"centAmount": 634,
"fractionDigits": 2
},
"name": "Bla"
}
]
},
"perMethodTaxRate": [],
"taxedPricePortions": []
}
],
"customLineItems": [],
"discountCodes": [],
"origin": "Customer",
"shipping": [],
"shippingMode": "Single"
}Update Order in Store by OrderNumber
POST
https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/orders/order-number={orderNumber}
Updates an Order in a Store using one or more update actions.
If the Order exists in the Project but does not have a
store specified, or the store field references a different Store, this method returns a ResourceNotFound error.OAuth 2.0 Scopes:
manage_orders:{projectKey}manage_orders:{projectKey}:{storeKey}Path parameters:
regionString | Region in which the Project is hosted. |
projectKeyString | key of the Project. |
storeKeyString | key of the Store. |
orderNumberString | orderNumber of the Order. Should be provided in URL-encoded format. |
Query parameters:
expand | The parameter can be passed multiple times. |
Request Body:
application/jsonversionInt | Expected version of the Order on which the changes should be applied.
If the expected version does not match the actual version, a ConcurrentModification error will be returned. |
actionsArray of OrderUpdateAction | Update actions to be performed on the Order. |
Response:
200as
application/jsoncurl https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/orders/order-number={orderNumber} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-binary @- << DATA
{
"version" : 1,
"actions" : [ {
"action" : "changeOrderState",
"orderState" : "Complete"
} ]
}
DATA{
"type": "Order",
"id": "92f5a867-bf19-47ab-982c-6720a03a3921",
"version": 1,
"createdAt": "2017-01-04T19:54:49.797Z",
"lastModifiedAt": "2017-01-04T19:54:49.797Z",
"totalPrice": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"orderState": "Open",
"syncInfo": [],
"returnInfo": [],
"refusedGifts": [],
"taxMode": "External",
"inventoryMode": "None",
"taxRoundingMode": "HalfEven",
"customerId": "7297c742-d8b0-484b-aadc-1d0ba6769dc9",
"businessUnit": {
"typeId": "business-unit",
"key": "ba-france-123"
},
"lineItems": [
{
"id": "7297c742-d8b0-484b-aadc-1d0ba1869dc9",
"productId": "c5c75935-595a-4cc3-a80e-24e9a9c55094",
"name": {
"en": "MyProduct"
},
"productType": {
"typeId": "product-type",
"id": "a5c7e173-9754-4f02-9b18-a600896ae0e1",
"version": 21
},
"productSlug": {
"de": "neues-produkt-slug-1234678",
"en": "new-product-slug-12345678"
},
"variant": {
"id": 1,
"sku": "some-sku-123",
"prices": [
{
"value": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"id": "6d36dc85-6131-495d-9f20-d00f411d4124"
}
],
"images": [],
"attributes": [
{
"name": "text",
"value": "attribute-value"
},
{
"name": "enum",
"value": {
"key": "test",
"label": "test"
}
}
],
"assets": []
},
"price": {
"id": "6d36dc85-6131-495d-9f20-d00f411d4124",
"value": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
}
},
"quantity": 1,
"discountedPricePerQuantity": [],
"taxRate": {
"name": "Bla",
"amount": 0.1,
"includedInPrice": false,
"country": "DE",
"subRates": []
},
"state": [
{
"quantity": 1,
"state": {
"typeId": "state",
"id": "7c2e2694-aefe-43d7-888e-6a99514caaca"
}
}
],
"priceMode": "Platform",
"lineItemMode": "Standard",
"totalPrice": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"taxedPrice": {
"totalNet": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"totalGross": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1100
},
"taxPortions": [
{
"rate": 0.1,
"amount": {
"type": "centPrecision",
"currencyCode": "EUR",
"centAmount": 634,
"fractionDigits": 2
},
"name": "Bla"
}
]
},
"perMethodTaxRate": [],
"taxedPricePortions": []
}
],
"customLineItems": [],
"discountCodes": [],
"origin": "Customer",
"shipping": [],
"shippingMode": "Single"
}Update actions
on Order-Set Order Number-Set Purchase Order Number-Set Business Unit -Set Customer ID-Set Customer Email-Add Payment-Remove Payment-Change PaymentState-Set Billing Address-Set Shipping Address-Add ItemShippingAddress-Remove ItemShippingAddress-Update ItemShippingAddress-Add Delivery-Remove Delivery-Change ShipmentState-Add ReturnInfo-Set ReturnInfo-Set ReturnShipmentState-Set ReturnPaymentState-Change OrderState-Transition State-Update SyncInfo-Set Locale-Set Store-Set Custom Type-Set CustomField
on LineItem-Set LineItem ShippingDetails-Set LineItem Custom Type-Set LineItem CustomField-Transition LineItem State-Import LineItem State
on Custom LineItem-Set CustomLineItem ShippingDetails-Transition CustomLineItem State-Import CustomLineItem State-Set CustomLineItem Custom Type-Set CustomLineItem CustomField
on Delivery-Set Delivery Address-Add Parcel to Delivery-Remove Parcel from Delivery-Set Delivery Items-Set Delivery Custom Type-Set Delivery CustomField
on Order
Set Order Number
actionString | "setOrderNumber" |
orderNumberString | Value to set. Must be unique across a Project. Once set, the value cannot be changed. |
{
"action": "setOrderNumber",
"orderNumber": "myOrderNumber"
}Set Purchase Order Number
Produces the PurchaseOrderNumberSet Message.
actionString | "setPurchaseOrderNumber" |
purchaseOrderNumberString | Value to set. If empty, any existing value is removed. |
{
"action": "setPurchaseOrderNumber",
"purchaseOrderNumber": "purchaseOrderNumberString"
}Set Business Unit B2B B2X
Updates the Business Unit on the Order. Setting the Order's
businessUnit does not recalculate prices or discounts on the Order.Produces the OrderBusinessUnitSet Message.
actionString | "setBusinessUnit" |
businessUnit | New Business Unit to assign to the Order. If empty, any existing value is removed. If the referenced Business Unit does not exist, a ReferencedResourceNotFound error is returned. |
{
"action": "setBusinessUnit",
"businessUnit": {
"key": "{{business-unit-key}}",
"typeId": "business-unit"
}
}Set Customer ID
Setting the Order's
customerId does not recalculate prices or discounts on the Order.
If the Customer belongs to a Customer Group, customerGroup on the Order is updated automatically.Produces the OrderCustomerSet Message.
actionString | "setCustomerId" |
customerIdString | id of an existing Customer.
If empty, any existing value is removed. |
{
"action": "setCustomerId",
"customerId": "{{customer-id}}"
}Set Customer Email
This action updates the
customerEmail on the Order, but it does not change the Customer email on the Cart the Order has been created from.Produces the Order Customer Email Set Message.
actionString | "setCustomerEmail" |
emailString | Value to set. If empty, any existing value is removed. |
{
"action": "setCustomerEmail",
"email": "email@example.com"
}Add Payment
Produces the Order Payment Added Message.
actionString | "addPayment" |
payment | Payment to add to the PaymentInfo.
Must not be assigned to another Order or active Cart already. |
{
"action": "addPayment",
"payment": {
"typeId": "payment",
"id": "{{payment-id}}"
}
}Remove Payment
Produces the Order Payment Removed Message.
actionString | "removePayment" |
payment | Payment to remove from the PaymentInfo. |
{
"action": "removePayment",
"payment": {
"typeId": "payment",
"id": "{{payment-id}}"
}
}Change PaymentState
Produces the Order Payment State Changed Message.
actionString | "changePaymentState" |
paymentState | New payment status of the Order. |
{
"action": "changePaymentState",
"paymentState": "Failed"
}Set Billing Address
This action updates the
billingAddress on the Order, but it does not change the billing address on the referenced Cart from which the Order is created.Produces the Order Billing Address Set Message.
actionString | "setBillingAddress" |
address | Value to set. If empty, any existing value is removed. |
{
"action": "setBillingAddress",
"address": {
"key": "exampleKey",
"title": "My Address",
"salutation": "Mr.",
"firstName": "Example",
"lastName": "Person",
"streetName": "Example Street",
"streetNumber": "4711",
"additionalStreetInfo": "Backhouse",
"postalCode": "80933",
"city": "Exemplary City",
"region": "Exemplary Region",
"state": "Exemplary State",
"country": "DE",
"company": "My Company Name",
"department": "Sales",
"building": "Hightower 1",
"apartment": "247",
"pOBox": "2471",
"phone": "+49 89 12345678",
"mobile": "+49 171 2345678",
"email": "email@example.com",
"fax": "+49 89 12345679",
"additionalAddressInfo": "no additional Info",
"externalId": "Information not needed"
}
}Set Shipping Address
This action updates the
shippingAddress on the Order, but it does not change the shipping address on the referenced Cart from which the Order is created.
Also, it does not recalculate the Cart as taxes may not fit to the shipping address anymore.Produces the Order Shipping Address Set Message.
actionString | "setShippingAddress" |
address | Value to set. If empty, any existing value is removed. |
{
"action": "setShippingAddress",
"address": {
"key": "exampleKey",
"title": "My Address",
"salutation": "Mr.",
"firstName": "Example",
"lastName": "Person",
"streetName": "Example Street",
"streetNumber": "4711",
"additionalStreetInfo": "Backhouse",
"postalCode": "80933",
"city": "Exemplary City",
"region": "Exemplary Region",
"state": "Exemplary State",
"country": "DE",
"company": "My Company Name",
"department": "Sales",
"building": "Hightower 1",
"apartment": "247",
"pOBox": "2471",
"phone": "+49 89 12345678",
"mobile": "+49 171 2345678",
"email": "email@example.com",
"fax": "+49 89 12345679",
"additionalAddressInfo": "no additional Info",
"externalId": "Information not needed"
}
}Add ItemShippingAddress
Adds an address to the
itemShippingAddresses of an Order. Use this action when shipping is defined per item. For example, when shipping items to multiple addresses or when using different Shipping Methods, even if all items share the same address.actionString | "addItemShippingAddress" |
address | Address to append to itemShippingAddresses.
The new Address must have a key that is unique across this Order. |
{
"action": "addItemShippingAddress",
"address": {
"key": "exampleKey",
"title": "My Address",
"salutation": "Mr.",
"firstName": "Example",
"lastName": "Person",
"streetName": "Example Street",
"streetNumber": "4711",
"additionalStreetInfo": "Backhouse",
"postalCode": "80933",
"city": "Exemplary City",
"region": "Exemplary Region",
"state": "Exemplary State",
"country": "DE",
"company": "My Company Name",
"department": "Sales",
"building": "Hightower 1",
"apartment": "247",
"pOBox": "2471",
"phone": "+49 89 12345678",
"mobile": "+49 171 2345678",
"email": "email@example.com",
"fax": "+49 89 12345679",
"additionalAddressInfo": "no additional Info",
"externalId": "Information not needed"
}
}Remove ItemShippingAddress
An address can only be removed if it is not referenced in any ItemShippingTarget of the Cart.
In such case, change the Line Item shipping address to a different
addressKey first using the Set LineItemShippingDetails update action, before you remove the obsolete address.actionString | "removeItemShippingAddress" |
addressKeyString | key of the Address to remove from itemShippingAddresses. |
{
"action": "removeItemShippingAddress",
"addressKey": "addressKey"
}Update ItemShippingAddress
Updates an address in
itemShippingAddresses by keeping the Address key.actionString | "updateItemShippingAddress" |
address | The new Address with the same key as the Address it will replace. |
{
"action": "updateItemShippingAddress",
"address": {
"key": "exampleKey",
"title": "My Address",
"salutation": "Mr.",
"firstName": "Example",
"lastName": "Person",
"streetName": "Example Street",
"streetNumber": "4711",
"additionalStreetInfo": "Backhouse",
"postalCode": "80933",
"city": "Exemplary City",
"region": "Exemplary Region",
"state": "Exemplary State",
"country": "DE",
"company": "My Company Name",
"department": "Sales",
"building": "Hightower 1",
"apartment": "247",
"pOBox": "2471",
"phone": "+49 89 12345678",
"mobile": "+49 171 2345678",
"email": "email@example.com",
"fax": "+49 89 12345679",
"additionalAddressInfo": "no additional Info",
"externalId": "Information not needed"
}
}Add Delivery
A Delivery can only be added to an Order if
its
shippingInfo (for shippingMode = Single), or its shipping (for shippingMode = Multiple) exists.Multiple Deliveries can be added to the same Order to represent split or partial shipments. However, the API doesn't validate that the cumulative quantities of Line Items or Custom Line Items across all Deliveries match or stay within the originally ordered quantities. For more information, see Multiple Deliveries on the Shipping and Delivery overview page.
Produces the Delivery Added Message.
actionString | "addDelivery" |
deliveryKeyString | key of an existing Delivery. |
shippingKeyString | |
itemsArray of DeliveryItem | Line Items or Custom Line Items to be included in the Delivery. |
address | Address the parcels should be delivered to. |
parcelsArray of ParcelDraft | Parcels of the Delivery. If provided, this update action produces the Parcel Added To Delivery Message. |
custom | Custom Fields for the Delivery. |
{
"action": "addDelivery",
"items": [
{
"id": "{{lineItemId}}",
"quantity": 1
}
],
"address": {
"key": "exampleKey",
"title": "My Address",
"salutation": "Mr.",
"firstName": "Example",
"lastName": "Person",
"streetName": "Example Street",
"streetNumber": "4711",
"additionalStreetInfo": "Backhouse",
"postalCode": "80933",
"city": "Exemplary City",
"region": "Exemplary Region",
"state": "Exemplary State",
"country": "DE",
"company": "My Company Name",
"department": "Sales",
"building": "Hightower 1",
"apartment": "247",
"pOBox": "2471",
"phone": "+49 89 12345678",
"mobile": "+49 171 2345678",
"email": "email@example.com",
"fax": "+49 89 12345679",
"additionalAddressInfo": "no additional Info",
"externalId": "Information not needed"
},
"parcels": [
{
"measurements": {
"heightInMillimeter": 11,
"widthInMillimeter": 11
},
"trackingData": {
"trackingId": "{{trackingId}}",
"carrier": "TNT",
"provider": "providerName",
"providerTransaction": "{{transactionId}}",
"isReturn": false
}
}
]
}Remove Delivery
Produces the DeliveryRemoved Message.
Change ShipmentState
Produces the Order Shipment State Changed Message.
actionString | "changeShipmentState" |
shipmentState | New shipment status of the Order. |
{
"action": "changeShipmentState",
"shipmentState": "Ready"
}Add ReturnInfo
Produces the Return Info Added Message.
actionString | "addReturnInfo" |
returnTrackingIdString | Value to set. |
itemsArray of ReturnItemDraft | Items to be returned. Must not be empty. MinItems:1 |
returnDate | Value to set. If not set, it defaults to the current date and time. |
{
"action": "addReturnInfo",
"items": [
{
"quantity": 1,
"lineItemId": "{{lineItemId}}",
"shipmentState": "Returned"
}
]
}Set ReturnInfo
Produces the Return Info Set Message.
actionString | "setReturnInfo" |
itemsArray of ReturnInfoDraft | Value to set. If empty, any existing value is removed. |
{
"action": "setReturnInfo",
"items": [
{
"items": [
{
"quantity": 1,
"lineItemId": "{{lineItemId}}",
"comment": "any comment",
"shipmentState": "Returned"
}
],
"returnTrackingId": "returnTrackingId-example",
"returnDate": "2021-04-30T09:21:15.003Z"
}
]
}Set ReturnShipmentState
Produces the Order Return Shipment State Changed Message.
actionString | "setReturnShipmentState" |
returnItemIdString | |
returnItemKeyString | |
shipmentState | New shipment state of the ReturnItem.
This update action can only transition Return Items from the Returned state to BackInStock or Unusable. The initial Advised and Returned states can only be set at creation time on ReturnItemDraft. |
{
"action": "setReturnShipmentState",
"returnItemId": "{{returnItemId}}",
"shipmentState": "BackInStock"
}Set ReturnPaymentState
actionString | "setReturnPaymentState" |
returnItemIdString | |
returnItemKeyString | |
paymentState | New Payment status of the ReturnItem. |
{
"action": "setReturnPaymentState",
"returnItemId": "{{returnItemId}}",
"paymentState": "NotRefunded"
}Change OrderState
Produces the Order State Changed Message.
actionString | "changeOrderState" |
orderState | New status of the Order. |
{
"action": "changeOrderState",
"orderState": "Open"
}Transition State
If the existing State has set
transitions, there must be a direct transition to the new State.
If transitions is not set, no validation is performed.This update action produces the Order State Transition Message.
actionString | "transitionState" |
state | Value to set. If there is no State yet, the new State must be an initial State. |
forceBoolean | Set to Default: true to turn off validation.false |
{
"action": "transitionState",
"state": {
"typeId": "state",
"id": "{{state-id}}"
}
}Update SyncInfo
actionString | "updateSyncInfo" |
externalIdString | Set this to identify an external order instance, file, or other resource. |
channel | The synchronization destination to set. Must not be empty.
The referenced Channel must have the Channel Role OrderExport or OrderImport.
Otherwise this update action returns an InvalidInput error. |
syncedAt | If not set, it defaults to the current date and time. |
{
"action": "updateSyncInfo",
"channel": {
"typeId": "channel",
"id": "{{channel-id}}"
}
}Set Locale
Set Store
Sets the Store the Order is assigned to.
It should be used to migrate Orders to a new Store.
No validations are performed (such as that the Customer is allowed to create Orders in the Store).
Produces the Order Store Set Message.
Returns a
400 error if store references the same Store the Order is currently assigned to, including if you try to remove the value when no Store is currently assigned.actionString | "setStore" |
store | Value to set. If empty, any existing value is removed. If store references the same Store the Order is currently assigned to or if you try to remove the value when no Store is currently assigned, a 400 error is returned. |
{
"action": "setStore",
"store": {
"key": "{{store-key}}",
"typeId": "store"
}
}Set Custom Type
actionString | "setCustomType" |
type | Defines the Type that extends the Order with Custom Fields.
If absent, any existing Type and Custom Fields are removed from the Order. |
fields | Object containing the Custom Fields fields for the Order.
Required if at least one Custom Field is defined as required in the fieldDefinitions of the referenced Type. |
{
"action": "setCustomType",
"type": {
"id": "{{type-id}}",
"typeId": "type"
},
"fields": {
"exampleStringField": "TextString"
}
}Set CustomField
actionString | "setCustomField" |
nameString | Name of the Custom Field. |
value | If value is absent or null, this field will be removed if it exists.
Removing a field that does not exist returns an InvalidOperation error.
If value is provided, it is set for the field defined by name. |
{
"action": "setCustomField",
"name": "exampleStringField",
"value": "TextString"
}on LineItem
Set LineItem ShippingDetails
actionString | "setLineItemShippingDetails" |
lineItemIdString | |
lineItemKeyString | |
shippingDetails | Value to set. If empty, the existing value is removed. |
{
"action": "setLineItemShippingDetails",
"lineItemId": "{{lineItemId}}",
"shippingDetails": {
"targets": [
{
"addressKey": "AddressKeyStringFromAddress",
"quantity": 2
}
]
}
}Set LineItem Custom Type
actionString | "setLineItemCustomType" |
lineItemIdString | |
lineItemKeyString | |
type | Defines the Type that extends the Line Item with Custom Fields.
If absent, any existing Type and Custom Fields are removed from the Line Item. |
fields | Object containing the Custom Fields fields for the Line Item.
Required if at least one Custom Field is defined as required in the fieldDefinitions of the referenced Type. |
{
"action": "setLineItemCustomType",
"lineItemId": "{{lineItemId}}",
"type": {
"id": "{{type-id}}",
"typeId": "type"
},
"fields": {
"exampleStringField": "TextString"
}
}Set LineItem CustomField
actionString | "setLineItemCustomField" |
lineItemIdString | |
lineItemKeyString | |
nameString | Name of the Custom Field. |
value | If value is absent or null, this field will be removed if it exists.
Removing a field that does not exist returns an InvalidOperation error.
If value is provided, it is set for the field defined by name. |
{
"action": "setLineItemCustomField",
"lineItemId": "{{lineItemId}}",
"name": "exampleStringField",
"value": "TextString"
}Transition LineItem State
Produces the Line Item State Transition Message.
actionString | "transitionLineItemState" |
lineItemIdString | |
lineItemKeyString | |
quantityInt | Quantity of Line Items that should transition State. |
fromState | State the Line Item should transition from. |
toState | State the Line Item should transition to. |
actualTransitionDate | Date and time (UTC) to perform the State transition. |
{
"action": "transitionLineItemState",
"lineItemId": "{{lineItemId}}",
"quantity": 3,
"fromState": {
"typeId": "state",
"id": "{{state-id}}"
},
"toState": {
"typeId": "state",
"id": "{{state-id}}"
}
}Import LineItem State
The import of States does not follow any predefined rules and should be only used if no transitions are defined.
The
quantity in the ItemStates must match the sum of all Line Items states' quantities.actionString | "importLineItemState" |
lineItemIdString | |
lineItemKeyString | |
stateArray of ItemState | New status of the Line Items. |
{
"action": "importLineItemState",
"lineItemId": "{{lineItemId}}",
"state": [
{
"quantity": 5,
"state": {
"typeId": "state",
"id": "{{state-id}}"
}
}
]
}on Custom LineItem
Set CustomLineItem ShippingDetails
actionString | "setCustomLineItemShippingDetails" |
customLineItemIdString | |
customLineItemKeyString | |
shippingDetails | Value to set. If empty, any existing value is removed. |
{
"action": "setCustomLineItemShippingDetails",
"customLineItemId": "{{customLineItemId}}",
"shippingDetails": {
"targets": [
{
"addressKey": "{{addressKey}}",
"quantity": 2
}
]
}
}Transition CustomLineItem State
Produces the Custom Line Item State Transition Message.
actionString | "transitionCustomLineItemState" |
customLineItemIdString | |
customLineItemKeyString | |
quantityInt | Quantity of Custom Line Items that should transition State. |
fromState | State the Custom Line Item should transition from. |
toState | State the Custom Line Item should transition to. |
actualTransitionDate | Date and time (UTC) to perform the State transition. |
{
"action": "transitionCustomLineItemState",
"customLineItemId": "{{customLineItemId}}",
"quantity": 6,
"fromState": {
"typeId": "state",
"id": "{{state-id}}"
},
"toState": {
"typeId": "state",
"id": "{{state-id}}"
}
}Import CustomLineItem State
The import of States does not follow any predefined rules and should be only used if no transitions are defined.
The
quantity in the ItemStates must match the sum of all Custom Line Item states' quantities.actionString | "importCustomLineItemState" |
customLineItemIdString | |
customLineItemKeyString | |
stateArray of ItemState | New status of the Custom Line Items. |
{
"action": "importCustomLineItemState",
"customLineItemId": "{{customLineItemId}}",
"state": [
{
"quantity": 6,
"state": {
"typeId": "state",
"id": "{{state-id}}"
}
}
]
}Set CustomLineItem Custom Type
actionString | "setCustomLineItemCustomType" |
customLineItemIdString | |
customLineItemKeyString | |
type | Defines the Type that extends the Custom Line Item with Custom Fields.
If absent, any existing Type and Custom Fields are removed from the Custom Line Item. |
fields | Object containing the Custom Fields fields for the Custom Line Item.
Required if at least one Custom Field is defined as required in the fieldDefinitions of the referenced Type. |
{
"action": "setCustomLineItemCustomType",
"customLineItemId": "{{customLineItemId}}",
"type": {
"id": "{{type-id}}",
"typeId": "type"
},
"fields": {
"exampleStringField": "TextString"
}
}Set CustomLineItem CustomField
actionString | "setCustomLineItemCustomField" |
customLineItemIdString | |
customLineItemKeyString | |
nameString | Name of the Custom Field. |
value | If value is absent or null, this field will be removed if it exists.
Removing a field that does not exist returns an InvalidOperation error.
If value is provided, it is set for the field defined by name. |
{
"action": "setCustomLineItemCustomField",
"customLineItemId": "{{customLineItemId}}",
"name": "exampleStringField",
"value": "TextString"
}on Billing Address
Set Billing Address Custom Type
actionString | "setBillingAddressCustomType" |
type | Defines the Type that extends the billingAddress with Custom Fields.
If absent, any existing Type and Custom Fields are removed from the billingAddress. |
fields | Object containing the Custom Fields fields for the
billingAddress.Required if at least one Custom Field is defined as required in the fieldDefinitions of the referenced Type. |
{
"action": "setBillingAddressCustomType",
"type": {
"id": "{{type-id}}",
"typeId": "type"
},
"fields": {
"exampleStringField": "TextString"
}
}Set Billing Address CustomField
actionString | "setBillingAddressCustomField" |
nameString | Name of the Custom Field. |
value | If value is absent or null, this field will be removed if it exists.
Removing a field that does not exist returns an InvalidOperation error.
If value is provided, it is set for the field defined by name. |
{
"action": "setBillingAddressCustomField",
"name": "exampleStringField",
"value": "TextString"
}on Shipping Address
Set Shipping Address Custom Type
actionString | "setShippingAddressCustomType" |
type | Defines the Type that extends the shippingAddress with Custom Fields.
If absent, any existing Type and Custom Fields are removed from the shippingAddress. |
fields | Object containing the Custom Fields fields for the
shippingAddress.Required if at least one Custom Field is defined as required in the fieldDefinitions of the referenced Type. |
{
"action": "setShippingAddressCustomType",
"type": {
"id": "{{type-id}}",
"typeId": "type"
},
"fields": {
"exampleStringField": "TextString"
}
}Set Shipping Address CustomField
actionString | "setShippingAddressCustomField" |
nameString | Name of the Custom Field. |
value | If value is absent or null, this field will be removed if it exists.
Removing a field that does not exist returns an InvalidOperation error.
If value is provided, it is set for the field defined by name. |
{
"action": "setShippingAddressCustomField",
"name": "exampleStringField",
"value": "TextString"
}on ItemShipping Address
Set ItemShipping Address Custom Type
actionString | "setItemShippingAddressCustomType" |
addressKeyString | |
type | Defines the Type that extends the itemShippingAddress with Custom Fields.
If absent, any existing Type and Custom Fields are removed from the itemShippingAddress. |
fields | Object containing the Custom Fields fields for the
itemShippingAddress.Required if at least one Custom Field is defined as required in the fieldDefinitions of the referenced Type. |
{
"action": "setItemShippingAddressCustomType",
"addressKey": "{{address-key}}",
"type": {
"id": "{{type-id}}",
"typeId": "type"
},
"fields": {
"exampleStringField": "TextString"
}
}Set ItemShipping Address CustomField
actionString | "setItemShippingAddressCustomField" |
addressKeyString | |
nameString | Name of the Custom Field. |
value | If value is absent or null, this field will be removed if it exists.
Removing a field that does not exist returns an InvalidOperation error.
If value is provided, it is set for the field defined by name. |
{
"action": "setItemShippingAddressCustomField",
"addressKey": "{{address-key}}",
"name": "exampleStringField",
"value": "TextString"
}on Shipping
Set Shipping Custom Type
This action sets, overwrites, or removes any existing Custom Type and Custom Fields for the Order's
shippingMethod or shipping.actionString | "setShippingCustomType" |
shippingKeyString | The shippingKey of the Shipping to customize. Used to specify which Shipping Method to customize
on a Order with Multiple ShippingMode.
Leave this empty to customize the one and only ShippingMethod on a Single ShippingMode Order. |
type | Defines the Type that extends the specified ShippingMethod with Custom Fields.
If absent, any existing Type and Custom Fields are removed from the ShippingMethod. |
fields | Object containing the Custom Fields fields for the
shippingMethod.Required if at least one Custom Field is defined as required in the fieldDefinitions of the referenced Type. |
{
"action": "setShippingCustomType",
"shippingKey": "shipping-key-express",
"type": {
"id": "{{type-id}}",
"typeId": "type"
},
"fields": {
"exampleStringField": "TextString"
}
}Set Shipping CustomField
actionString | "setShippingCustomField" |
shippingKeyString | The shippingKey of the Shipping to customize. Used to specify which Shipping Method to customize
on a Order with Multiple ShippingMode.
Leave this empty to customize the one and only ShippingMethod on a Single ShippingMode Order. |
nameString | Name of the Custom Field. |
value | If value is absent or null, this field will be removed if it exists.
Trying to remove a field that does not exist will fail with an InvalidOperation error.
If value is provided, it is set for the field defined by name. |
{
"action": "setShippingCustomField",
"shippingKey": "shipping-key-express",
"name": "exampleStringField",
"value": "TextString"
}on Delivery
Set Delivery Address
Produces the DeliveryAddressSet Message.
actionString | "setDeliveryAddress" |
deliveryIdString | id of an existing Delivery.Either deliveryId or deliveryKey must be provided. |
deliveryKeyString | key of an existing Delivery.Either deliveryId or deliveryKey must be provided. |
address | Value to set. If empty, any existing value is removed. |
{
"action": "setDeliveryAddress",
"deliveryId": "{{deliveryId}}",
"address": {
"key": "exampleKey",
"title": "My Address",
"salutation": "Mr.",
"firstName": "Example",
"lastName": "Person",
"streetName": "Example Street",
"streetNumber": "4711",
"additionalStreetInfo": "Backhouse",
"postalCode": "80933",
"city": "Exemplary City",
"region": "Exemplary Region",
"state": "Exemplary State",
"country": "DE",
"company": "My Company Name",
"department": "Sales",
"building": "Hightower 1",
"apartment": "247",
"pOBox": "2471",
"phone": "+49 89 12345678",
"mobile": "+49 171 2345678",
"email": "email@example.com",
"fax": "+49 89 12345679",
"additionalAddressInfo": "no additional Info",
"externalId": "Information not needed"
}
}Add Parcel to Delivery
To add a Parcel, at least one Delivery must exist.
Produces the Parcel Added To Delivery Message.
actionString | "addParcelToDelivery" |
deliveryIdString | id of an existing Delivery.Either deliveryId or deliveryKey must be provided. |
deliveryKeyString | key of an existing Delivery.Either deliveryId or deliveryKey must be provided. |
parcelKeyString | key of an existing Parcel. |
measurements | Value to set. |
trackingData | Value to set. |
itemsArray of DeliveryItem | Value to set. |
custom | Custom Fields for the Parcel. |
{
"action": "addParcelToDelivery",
"deliveryId": "{{deliveryId}}",
"measurements": {
"heightInMillimeter": 11,
"widthInMillimeter": 11
},
"trackingData": {
"trackingId": "{{trackingId}}",
"carrier": "TNT",
"provider": "providerName",
"providerTransaction": "{{transactionId}}",
"isReturn": false
},
"items": {
"id": "{{lineItemId}}",
"quantity": 2
}
}Remove Parcel from Delivery
Produces the ParcelRemovedFromDelivery Message.
Set Delivery Items
Produces the Delivery Items Updated Message.
actionString | "setDeliveryItems" |
deliveryIdString | id of an existing Delivery.Either deliveryId or deliveryKey must be provided. |
deliveryKeyString | key of an existing Delivery.Either deliveryId or deliveryKey must be provided. |
itemsArray of DeliveryItem | Value to set. If empty, any existing value is removed. |
{
"action": "setDeliveryItems",
"deliveryId": "{{deliveryId}}",
"items": [
{
"id": "{{itemId}}",
"quantity": 2
}
]
}Set Delivery Custom Type
actionString | "setDeliveryCustomType" |
deliveryIdString | id of an existing Delivery.Either deliveryId or deliveryKey must be provided. |
deliveryKeyString | key of an existing Delivery.Either deliveryId or deliveryKey must be provided. |
type | Defines the Type that extends the Delivery with Custom Fields.
If absent, any existing Type and Custom Fields are removed from the Delivery. |
fields | Object containing the Custom Fields fields for the Delivery.
Required if at least one Custom Field is defined as required in the fieldDefinitions of the referenced Type. |
{
"action": "setDeliveryCustomType",
"deliveryId": "exampleDeliveryID",
"type": {
"id": "{{type-id}}",
"typeId": "type"
},
"fields": {
"exampleStringField": "TextString"
}
}Set Delivery CustomField
actionString | "setDeliveryCustomField" |
deliveryIdString | id of an existing Delivery.Either deliveryId or deliveryKey must be provided. |
deliveryKeyString | key of an existing Delivery.Either deliveryId or deliveryKey must be provided. |
nameString | Name of the Custom Field. |
value | If value is absent or null, this field will be removed if it exists.
Removing a field that does not exist returns an InvalidOperation error.
If value is provided, it is set for the field defined by name. |
{
"action": "setDeliveryCustomField",
"deliveryId": "exampleDeliveryID",
"name": "exampleStringField",
"value": "TextString"
}on Parcel
Set Parcel Measurements
Produces the ParcelMeasurementsUpdated Message.
actionString | "setParcelMeasurements" |
parcelIdString | id of an existing Parcel.Either parcelId or parcelKey must be provided. |
parcelKeyString | key of an existing Parcel.Either parcelId or parcelKey must be provided. |
measurements | Value to set. If empty, any existing value is removed. |
{
"action": "setParcelMeasurements",
"parcelId": "{{parcelId}}",
"measurements": {
"heightInMillimeter": 11,
"lengthInMillimeter": 11
}
}Set Parcel Tracking Data
Produces the ParcelTrackingDataUpdated Message.
actionString | "setParcelTrackingData" |
parcelIdString | id of an existing Parcel.Either parcelId or parcelKey must be provided. |
parcelKeyString | key of an existing Parcel.Either parcelId or parcelKey must be provided. |
trackingData | Value to set. If empty, any existing value is removed. |
{
"action": "setParcelTrackingData",
"parcelId": "{{parcelId}}",
"trackingData": {
"trackingId": "{{trackingId}}",
"carrier": "TNT",
"provider": "providerName",
"providerTransaction": "{{transactionId}}",
"isReturn": false
}
}Set Parcel Items
Produces the ParcelItemsUpdated Message.
actionString | "setParcelItems" |
parcelIdString | id of an existing Parcel.Either parcelId or parcelKey must be provided. |
parcelKeyString | key of an existing Parcel.Either parcelId or parcelKey must be provided. |
itemsArray of DeliveryItem | Value to set. If empty, any existing value is removed. |
{
"action": "setParcelItems",
"parcelId": "{{parcelId}}",
"items": [
{
"id": "{{lineItemId}}",
"quantity": 2
}
]
}Set Parcel Custom Type
actionString | "setParcelCustomType" |
parcelIdString | id of an existing Parcel.Either parcelId or parcelKey must be provided. |
parcelKeyString | key of an existing Parcel.Either parcelId or parcelKey must be provided. |
type | Defines the Type that extends the Parcel with Custom Fields.
If absent, any existing Type and Custom Fields are removed from the Parcel. |
fields | Object containing the Custom Fields fields for the Parcel.
Required if at least one Custom Field is defined as required in the fieldDefinitions of the referenced Type. |
{
"action": "setParcelCustomType",
"parcelId": "exampleParcelID",
"type": {
"id": "{{type-id}}",
"typeId": "type"
},
"fields": {
"exampleStringField": "TextString"
}
}Set Parcel CustomField
actionString | "setParcelCustomField" |
parcelIdString | id of an existing Parcel.Either parcelId or parcelKey must be provided. |
parcelKeyString | key of an existing Parcel.Either parcelId or parcelKey must be provided. |
nameString | Name of the Custom Field. |
value | If value is absent or null, this field will be removed if it exists.
Removing a field that does not exist returns an InvalidOperation error.
If value is provided, it is set for the field defined by name. |
{
"action": "setParcelCustomField",
"parcelId": "exampleParcelID",
"name": "exampleStringField",
"value": "TextString"
}on Delivery Address
Set Delivery Address Custom Type
actionString | "setDeliveryAddressCustomType" |
deliveryIdString | id of an existing Delivery.Either deliveryId or deliveryKey must be provided. |
deliveryKeyString | key of an existing Delivery.Either deliveryId or deliveryKey must be provided. |
type | Defines the Type that extends the Delivery address with Custom Fields.
If absent, any existing Type and Custom Fields are removed from the Delivery address. |
fields | Required if at least one Custom Field is defined as required in the fieldDefinitions of the referenced Type. |
{
"action": "setDeliveryAddressCustomType",
"deliveryId": "{{delivery-id}}",
"type": {
"id": "{{type-id}}",
"typeId": "type"
},
"fields": {
"exampleStringField": "TextString"
}
}Set Delivery Address CustomField
actionString | "setDeliveryAddressCustomField" |
deliveryIdString | id of an existing Delivery.Either deliveryId or deliveryKey must be provided. |
deliveryKeyString | key of an existing Delivery.Either deliveryId or deliveryKey must be provided. |
nameString | Name of the Custom Field. |
value | If value is absent or null, this field will be removed if it exists.
Removing a field that does not exist returns an InvalidOperation error.
If value is provided, it is set for the field defined by name. |
{
"action": "setDeliveryAddressCustomField",
"deliveryId": "{{delivery-id}}",
"name": "exampleStringField",
"value": "TextString"
}on ReturnItem
Set ReturnItem Custom Type
actionString | "setReturnItemCustomType" |
returnItemIdString | |
returnItemKeyString | |
type | Defines the Type that extends the Return Item with Custom Fields.
If absent, any existing Type and Custom Fields are removed from the Return Item. |
fields | Object containing the Custom Fields fields for the Return Item.
Required if at least one Custom Field is defined as required in the fieldDefinitions of the referenced Type. |
{
"action": "setReturnItemCustomType",
"returnItemId": "exampleReturnItemID",
"type": {
"id": "{{type-id}}",
"typeId": "type"
},
"fields": {
"exampleStringField": "TextString"
}
}Set ReturnItem CustomField
actionString | "setReturnItemCustomField" |
returnItemIdString | |
returnItemKeyString | |
nameString | Name of the Custom Field. |
value | If value is absent or null, this field will be removed if it exists.
Removing a field that does not exist returns an InvalidOperation error.
If value is provided, it is set for the field defined by name. |
{
"action": "setReturnItemCustomField",
"returnItemId": "exampleReturnItemID",
"name": "exampleStringField",
"value": "TextString"
}Delete Order
Delete Order by ID
Although it is possible to delete Orders with the
manage_orders scope, we strongly recommend doing so only for test Orders. You are responsible for deciding which Orders, if any, can be deleted in your production Project.If a DiscountCode with a
maxApplications or maxApplicationsPerCustomer limit has been applied to the Order, the deleted Order is still counted towards that limit.DELETE
https://api.{region}.commercetools.com/{projectKey}/orders/{id}
Deletes an Order in the Project.
Deleting an Order produces the OrderDeleted Message.
OAuth 2.0 Scopes:
manage_orders:{projectKey}Path parameters:
regionString | Region in which the Project is hosted. |
projectKeyString | key of the Project. |
idString | id of the Order. |
Query parameters:
versionInt | Last seen version of the resource. |
expand | The parameter can be passed multiple times. |
dataErasureBoolean | To erase all related personal data in compliance with GDPR, set to true.Default: false |
Response:
200as
application/jsoncurl -X DELETE https://api.{region}.commercetools.com/{projectKey}/orders/{id}?version={version} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"{
"type": "Order",
"id": "92f5a867-bf19-47ab-982c-6720a03a3921",
"version": 1,
"createdAt": "2017-01-04T19:54:49.797Z",
"lastModifiedAt": "2017-01-04T19:54:49.797Z",
"totalPrice": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"orderState": "Open",
"syncInfo": [],
"returnInfo": [],
"refusedGifts": [],
"taxMode": "External",
"inventoryMode": "None",
"taxRoundingMode": "HalfEven",
"customerId": "7297c742-d8b0-484b-aadc-1d0ba6769dc9",
"businessUnit": {
"typeId": "business-unit",
"key": "ba-france-123"
},
"lineItems": [
{
"id": "7297c742-d8b0-484b-aadc-1d0ba1869dc9",
"productId": "c5c75935-595a-4cc3-a80e-24e9a9c55094",
"name": {
"en": "MyProduct"
},
"productType": {
"typeId": "product-type",
"id": "a5c7e173-9754-4f02-9b18-a600896ae0e1",
"version": 21
},
"productSlug": {
"de": "neues-produkt-slug-1234678",
"en": "new-product-slug-12345678"
},
"variant": {
"id": 1,
"sku": "some-sku-123",
"prices": [
{
"value": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"id": "6d36dc85-6131-495d-9f20-d00f411d4124"
}
],
"images": [],
"attributes": [
{
"name": "text",
"value": "attribute-value"
},
{
"name": "enum",
"value": {
"key": "test",
"label": "test"
}
}
],
"assets": []
},
"price": {
"id": "6d36dc85-6131-495d-9f20-d00f411d4124",
"value": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
}
},
"quantity": 1,
"discountedPricePerQuantity": [],
"taxRate": {
"name": "Bla",
"amount": 0.1,
"includedInPrice": false,
"country": "DE",
"subRates": []
},
"state": [
{
"quantity": 1,
"state": {
"typeId": "state",
"id": "7c2e2694-aefe-43d7-888e-6a99514caaca"
}
}
],
"priceMode": "Platform",
"lineItemMode": "Standard",
"totalPrice": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"taxedPrice": {
"totalNet": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"totalGross": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1100
},
"taxPortions": [
{
"rate": 0.1,
"amount": {
"type": "centPrecision",
"currencyCode": "EUR",
"centAmount": 634,
"fractionDigits": 2
},
"name": "Bla"
}
]
},
"perMethodTaxRate": [],
"taxedPricePortions": []
}
],
"customLineItems": [],
"discountCodes": [],
"origin": "Customer",
"shipping": [],
"shippingMode": "Single"
}Delete Order by OrderNumber
Although it is possible to delete Orders with the
manage_orders scope, we strongly recommend doing so only for test Orders. You are responsible for deciding which Orders, if any, can be deleted in your production Project.If a DiscountCode with a
maxApplications or maxApplicationsPerCustomer limit has been applied to the Order, the deleted Order is still counted towards that limit.DELETE
https://api.{region}.commercetools.com/{projectKey}/orders/order-number={orderNumber}
Deletes an Order in the Project.
Deleting an Order produces the OrderDeleted Message.
OAuth 2.0 Scopes:
manage_orders:{projectKey}Path parameters:
regionString | Region in which the Project is hosted. |
projectKeyString | key of the Project. |
orderNumberString | orderNumber of the Order. Should be provided in URL-encoded format. |
Query parameters:
versionInt | Last seen version of the resource. |
expand | The parameter can be passed multiple times. |
dataErasureBoolean | To erase all related personal data in compliance with GDPR, set to true.Default: false |
Response:
200as
application/jsoncurl -X DELETE https://api.{region}.commercetools.com/{projectKey}/orders/order-number={orderNumber}?version={version} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"{
"type": "Order",
"id": "92f5a867-bf19-47ab-982c-6720a03a3921",
"version": 1,
"createdAt": "2017-01-04T19:54:49.797Z",
"lastModifiedAt": "2017-01-04T19:54:49.797Z",
"totalPrice": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"orderState": "Open",
"syncInfo": [],
"returnInfo": [],
"refusedGifts": [],
"taxMode": "External",
"inventoryMode": "None",
"taxRoundingMode": "HalfEven",
"customerId": "7297c742-d8b0-484b-aadc-1d0ba6769dc9",
"businessUnit": {
"typeId": "business-unit",
"key": "ba-france-123"
},
"lineItems": [
{
"id": "7297c742-d8b0-484b-aadc-1d0ba1869dc9",
"productId": "c5c75935-595a-4cc3-a80e-24e9a9c55094",
"name": {
"en": "MyProduct"
},
"productType": {
"typeId": "product-type",
"id": "a5c7e173-9754-4f02-9b18-a600896ae0e1",
"version": 21
},
"productSlug": {
"de": "neues-produkt-slug-1234678",
"en": "new-product-slug-12345678"
},
"variant": {
"id": 1,
"sku": "some-sku-123",
"prices": [
{
"value": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"id": "6d36dc85-6131-495d-9f20-d00f411d4124"
}
],
"images": [],
"attributes": [
{
"name": "text",
"value": "attribute-value"
},
{
"name": "enum",
"value": {
"key": "test",
"label": "test"
}
}
],
"assets": []
},
"price": {
"id": "6d36dc85-6131-495d-9f20-d00f411d4124",
"value": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
}
},
"quantity": 1,
"discountedPricePerQuantity": [],
"taxRate": {
"name": "Bla",
"amount": 0.1,
"includedInPrice": false,
"country": "DE",
"subRates": []
},
"state": [
{
"quantity": 1,
"state": {
"typeId": "state",
"id": "7c2e2694-aefe-43d7-888e-6a99514caaca"
}
}
],
"priceMode": "Platform",
"lineItemMode": "Standard",
"totalPrice": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"taxedPrice": {
"totalNet": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"totalGross": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1100
},
"taxPortions": [
{
"rate": 0.1,
"amount": {
"type": "centPrecision",
"currencyCode": "EUR",
"centAmount": 634,
"fractionDigits": 2
},
"name": "Bla"
}
]
},
"perMethodTaxRate": [],
"taxedPricePortions": []
}
],
"customLineItems": [],
"discountCodes": [],
"origin": "Customer",
"shipping": [],
"shippingMode": "Single"
}Delete Order in Store
Delete Order in Store by ID
Although it is possible to delete Orders with the
manage_orders scope, we strongly recommend doing so only for test Orders. You are responsible for deciding which Orders, if any, can be deleted in your production Project.If a DiscountCode with a
maxApplications or maxApplicationsPerCustomer limit has been applied to the Order, the deleted Order is still counted towards that limit.DELETE
https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/orders/{id}
Deletes an Order in a Store.
If the Order exists in the Project but does not have a
store specified, or the store field references a different Store, this method returns a ResourceNotFound error.Deleting an Order produces the OrderDeleted Message.
OAuth 2.0 Scopes:
manage_orders:{projectKey}manage_orders:{projectKey}:{storeKey}Path parameters:
regionString | Region in which the Project is hosted. |
projectKeyString | key of the Project. |
storeKeyString | key of the Store. |
idString | id of the Order. |
Query parameters:
versionInt | Last seen version of the resource. |
expand | The parameter can be passed multiple times. |
dataErasureBoolean | To erase all related personal data in compliance with GDPR, set to true.Default: false |
Response:
200as
application/jsoncurl -X DELETE https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/orders/{id}?version={version} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"{
"type": "Order",
"id": "92f5a867-bf19-47ab-982c-6720a03a3921",
"version": 1,
"createdAt": "2017-01-04T19:54:49.797Z",
"lastModifiedAt": "2017-01-04T19:54:49.797Z",
"totalPrice": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"orderState": "Open",
"syncInfo": [],
"returnInfo": [],
"refusedGifts": [],
"taxMode": "External",
"inventoryMode": "None",
"taxRoundingMode": "HalfEven",
"customerId": "7297c742-d8b0-484b-aadc-1d0ba6769dc9",
"businessUnit": {
"typeId": "business-unit",
"key": "ba-france-123"
},
"lineItems": [
{
"id": "7297c742-d8b0-484b-aadc-1d0ba1869dc9",
"productId": "c5c75935-595a-4cc3-a80e-24e9a9c55094",
"name": {
"en": "MyProduct"
},
"productType": {
"typeId": "product-type",
"id": "a5c7e173-9754-4f02-9b18-a600896ae0e1",
"version": 21
},
"productSlug": {
"de": "neues-produkt-slug-1234678",
"en": "new-product-slug-12345678"
},
"variant": {
"id": 1,
"sku": "some-sku-123",
"prices": [
{
"value": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"id": "6d36dc85-6131-495d-9f20-d00f411d4124"
}
],
"images": [],
"attributes": [
{
"name": "text",
"value": "attribute-value"
},
{
"name": "enum",
"value": {
"key": "test",
"label": "test"
}
}
],
"assets": []
},
"price": {
"id": "6d36dc85-6131-495d-9f20-d00f411d4124",
"value": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
}
},
"quantity": 1,
"discountedPricePerQuantity": [],
"taxRate": {
"name": "Bla",
"amount": 0.1,
"includedInPrice": false,
"country": "DE",
"subRates": []
},
"state": [
{
"quantity": 1,
"state": {
"typeId": "state",
"id": "7c2e2694-aefe-43d7-888e-6a99514caaca"
}
}
],
"priceMode": "Platform",
"lineItemMode": "Standard",
"totalPrice": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"taxedPrice": {
"totalNet": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"totalGross": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1100
},
"taxPortions": [
{
"rate": 0.1,
"amount": {
"type": "centPrecision",
"currencyCode": "EUR",
"centAmount": 634,
"fractionDigits": 2
},
"name": "Bla"
}
]
},
"perMethodTaxRate": [],
"taxedPricePortions": []
}
],
"customLineItems": [],
"discountCodes": [],
"origin": "Customer",
"shipping": [],
"shippingMode": "Single"
}Delete Order in Store by OrderNumber
Although it is possible to delete Orders with the
manage_orders scope, we strongly recommend doing so only for test Orders. You are responsible for deciding which Orders, if any, can be deleted in your production Project.If a DiscountCode with a
maxApplications or maxApplicationsPerCustomer limit has been applied to the Order, the deleted Order is still counted towards that limit.DELETE
https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/orders/order-number={orderNumber}
Deletes an Order in a Store.
If the Order exists in the Project but does not have a
store specified, or the store field references a different Store, this method returns a ResourceNotFound error.Deleting an Order produces the OrderDeleted Message.
OAuth 2.0 Scopes:
manage_orders:{projectKey}manage_orders:{projectKey}:{storeKey}Path parameters:
regionString | Region in which the Project is hosted. |
projectKeyString | key of the Project. |
storeKeyString | key of the Store. |
orderNumberString | orderNumber of the Order. Should be provided in URL-encoded format. |
Query parameters:
versionInt | Last seen version of the resource. |
expand | The parameter can be passed multiple times. |
dataErasureBoolean | To erase all related personal data in compliance with GDPR, set to true.Default: false |
Response:
200as
application/jsoncurl -X DELETE https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/orders/order-number={orderNumber}?version={version} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"{
"type": "Order",
"id": "92f5a867-bf19-47ab-982c-6720a03a3921",
"version": 1,
"createdAt": "2017-01-04T19:54:49.797Z",
"lastModifiedAt": "2017-01-04T19:54:49.797Z",
"totalPrice": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"orderState": "Open",
"syncInfo": [],
"returnInfo": [],
"refusedGifts": [],
"taxMode": "External",
"inventoryMode": "None",
"taxRoundingMode": "HalfEven",
"customerId": "7297c742-d8b0-484b-aadc-1d0ba6769dc9",
"businessUnit": {
"typeId": "business-unit",
"key": "ba-france-123"
},
"lineItems": [
{
"id": "7297c742-d8b0-484b-aadc-1d0ba1869dc9",
"productId": "c5c75935-595a-4cc3-a80e-24e9a9c55094",
"name": {
"en": "MyProduct"
},
"productType": {
"typeId": "product-type",
"id": "a5c7e173-9754-4f02-9b18-a600896ae0e1",
"version": 21
},
"productSlug": {
"de": "neues-produkt-slug-1234678",
"en": "new-product-slug-12345678"
},
"variant": {
"id": 1,
"sku": "some-sku-123",
"prices": [
{
"value": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"id": "6d36dc85-6131-495d-9f20-d00f411d4124"
}
],
"images": [],
"attributes": [
{
"name": "text",
"value": "attribute-value"
},
{
"name": "enum",
"value": {
"key": "test",
"label": "test"
}
}
],
"assets": []
},
"price": {
"id": "6d36dc85-6131-495d-9f20-d00f411d4124",
"value": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
}
},
"quantity": 1,
"discountedPricePerQuantity": [],
"taxRate": {
"name": "Bla",
"amount": 0.1,
"includedInPrice": false,
"country": "DE",
"subRates": []
},
"state": [
{
"quantity": 1,
"state": {
"typeId": "state",
"id": "7c2e2694-aefe-43d7-888e-6a99514caaca"
}
}
],
"priceMode": "Platform",
"lineItemMode": "Standard",
"totalPrice": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"taxedPrice": {
"totalNet": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1000
},
"totalGross": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "EUR",
"centAmount": 1100
},
"taxPortions": [
{
"rate": 0.1,
"amount": {
"type": "centPrecision",
"currencyCode": "EUR",
"centAmount": 634,
"fractionDigits": 2
},
"name": "Bla"
}
]
},
"perMethodTaxRate": [],
"taxedPricePortions": []
}
],
"customLineItems": [],
"discountCodes": [],
"origin": "Customer",
"shipping": [],
"shippingMode": "Single"
}