--- title: "Get all orders" method: GET path: "/consumers/{consumer_id}/commerce/orders" tags: ["eCommerce", "Orders"] --- # Get all orders `GET /consumers/{consumer_id}/commerce/orders` Returns a list of all the orders ## Path parameters - `consumer_id` string, uuid, required ## Query parameters - `page` integer - `size` integer - `date_from` string, date, nullable - `date_to` string, date, nullable - `updated_after` string, date-time, nullable - `include_detailed_refunds` 'true' | 'false' - `include_product_categories` 'true' | 'false' - `include_customer_details` 'true' | 'false' ## Response `200` Successful Response - ChiftPageOrderItemOut - `items` OrderItemOut[], required - `id` string, required — Technical id in Chift - `source_ref` Ref, required - `id` string, nullable — Technical id in the target software - `model` string, nullable — Name of the model/entity in the target software - `order_number` string, nullable - `customer` OrderCustomerItemOut - `first_name` string, nullable - `last_name` string, nullable - `phone` string, nullable - `internal_notes` string, nullable - `email` string, nullable - `id` string, required — Technical id of the customer in Chift - `billing_address` CommerceAddressItemOut - `address_type` 'main' | 'delivery' | 'invoice', required - `company_name` string, nullable - `first_name` string, nullable - `last_name` string, nullable - `street` string, nullable - `number` string, nullable - `box` string, nullable - `city` string, nullable - `postal_code` string, nullable - `country` string, nullable — Format: ISO 3166-1 codes. - `phone` string, nullable - `email` string, nullable - `vat` string, nullable - `shipping_address` CommerceAddressItemOut - `address_type` 'main' | 'delivery' | 'invoice', required - `company_name` string, nullable - `first_name` string, nullable - `last_name` string, nullable - `street` string, nullable - `number` string, nullable - `box` string, nullable - `city` string, nullable - `postal_code` string, nullable - `country` string, nullable — Format: ISO 3166-1 codes. - `phone` string, nullable - `email` string, nullable - `vat` string, nullable - `created_on` string, date-time, nullable - `last_updated_on` string, date-time, nullable - `confirmed_on` string, date-time, nullable - `delivery_date` string, date-time, nullable - `cancelled_on` string, date-time, nullable - `status` 'cancelled_unpaid' | 'cancelled' | 'draft' | 'confirmed' | 'shipped' | 'refunded', required - `fulfillment` EcommerceFulfillmentObject - `fulfillment_type` 'FBA' | 'FBM', required - `shipping_from_address` AddressItemOut - `address_type` 'main' | 'delivery' | 'invoice', required - `name` string, nullable - `number` string, nullable - `box` string, nullable - `phone` string, nullable - `mobile` string, nullable - `email` string, nullable - `street` string, nullable - `city` string, nullable - `postal_code` string, nullable - `country` string, nullable — Format: ISO 3166-1 codes. - `discount_amount` number, required - `untaxed_amount_without_fees` number, required — Untaxed amount without fees (e.g. shipping) but with discout. Refunds and returns are not included. - `tax_amount_without_fees` number, required — Total taxes applied to the order without taxes linked to fees (e.g. shipping). - `total_without_fees` number, required — Total of the order without fees (e.g. shipping) but with discount. Refunds and returns are not included. - `current_untaxed_amount` number, required — Untaxed amount with discout and any kind of fee (e.g. shipping). After returns, removes and returns. - `current_tax_amount` number, required — Total taxes applied to the order. After returns, removes and returns. - `current_total` number, required — Current total of the order with discount. After returns, removes and returns. - `untaxed_amount` number, required — Untaxed amount with discout and any kind of fee (e.g. shipping). Refunds and returns are not included. - `tax_amount` number, required — Total taxes applied to the order. Refunds and returns are not included. - `total` number, required — Total of the order with discount. Refunds and returns are not included. - `refunded_amount` number, nullable - `currency` string, required — Indicates the currency of the order (e.g. EUR). - `note` string, nullable - `tags` string[], nullable - `lines` OrderLineItemOut[], required - `id` string, required — Technical id in Chift - `source_ref` Ref, required - `id` string, nullable — Technical id in the target software - `model` string, nullable — Name of the model/entity in the target software - `created_on` string, date-time, nullable - `variant` OrderLineProductVariantItem - `id` string, required — Technical id of the product variant in Chift - `sku` string, nullable - `name` string, required - `categories` CommerceProductCategoryItem[], nullable - `id` string, required — Technical id of the category in Chift - `name` string, required - `quantity` integer, required - `current_quantity` integer, required — Quantity without refunds and returns. - `unit_price` number, required — Unit price of the product without taxes. - `description` string, required - `tax_id` string, nullable — Technical id of the tax rate in Chift - `tax_rate` number, required — Indicates the tax rate used for the line (e.g. 21.0). - `untaxed_amount` number, required — Untaxed amount of the order line with discount. - `tax_amount` number, required — Total taxes applied to the order line. - `total` number, required — Total of the order line with discount. - `discounts` CommerceDiscountItem[], nullable - `name` string, required - `description` string, required - `amount` number, required - `gift_card` boolean, nullable - `is_gift` boolean, nullable - `other_fees` FeesItem[], nullable - `id` string, required — Technical id in Chift - `source_ref` Ref, required - `id` string, nullable — Technical id in the target software - `model` string, nullable — Name of the model/entity in the target software - `created_on` string, date-time, nullable - `type` 'shipping' | 'other', required - `removed` boolean, nullable — Indicates if the fee has been removed from the order - `tax_rate` number, required - `tax_id` string, nullable — Technical id of the tax rate in Chift - `discounts` CommerceDiscountItem[], nullable - `name` string, required - `description` string, required - `amount` number, required - `untaxed_amount` number, required - `tax_amount` number, required - `total` number, required - `payment_method_id` string, nullable — Technical id of the payment method in the eCommerce - `transactions` OrderTransactions[], nullable - `id` string, required — Technical id of the transaction in the eCommerce - `created_on` string, date-time, nullable - `payment_method_id` string, nullable — Technical id of the payment method in the eCommerce - `payment_method_name` string, nullable — Name of the payment method - `amount` number, required - `status` 'failed' | 'pending' | 'success', required - `payment_methods` OrderPaymentMethods[], nullable - `id` string, required — Technical id of the payment method in the eCommerce - `name` string, nullable — Name of the payment method - `detailed_refunds` OrderRefundItem[], nullable - `id` string, required — Technical id in Chift - `source_ref` Ref, required - `id` string, nullable — Technical id in the target software - `model` string, nullable — Name of the model/entity in the target software - `created_on` string, date-time, nullable - `total` number, required - `reason` string, nullable - `order_lines` RefundOrderLineItem[], nullable - `id` string, required — Technical id of the order line in Chift - `variant` OrderLineProductVariantItem - `id` string, required — Technical id of the product variant in Chift - `sku` string, nullable - `name` string, required - `categories` CommerceProductCategoryItem[], nullable - `id` string, required — Technical id of the category in Chift - `name` string, required - `quantity` integer, required - `untaxed_amount` number, required — Untaxed amount refunded (after discount). - `tax_amount` number, required — Total taxes refunded (after discount). - `total` number, required — Total refunded (after discount). - `other` number, nullable - `shipping_refunds` ShippingRefund[], nullable - `id` string, required — Technical id in Chift - `source_ref` Ref, required - `id` string, nullable — Technical id in the target software - `model` string, nullable — Name of the model/entity in the target software - `untaxed_amount` number, required — Untaxed amount refunded (after discount). - `tax_amount` number, required — Total taxes refunded (after discount). - `total` number, required — Total refunded (after discount). - `other_fees` RefundFeesItem[], nullable - `id` string, required — Technical id of the fee in Chift - `source_ref` Ref, required - `id` string, nullable — Technical id in the target software - `model` string, nullable — Name of the model/entity in the target software - `type` 'shipping' | 'other', required - `untaxed_amount` number, required - `tax_amount` number, required - `total` number, required - `transactions` OrderTransactions[], nullable - `id` string, required — Technical id of the transaction in the eCommerce - `created_on` string, date-time, nullable - `payment_method_id` string, nullable — Technical id of the payment method in the eCommerce - `payment_method_name` string, nullable — Name of the payment method - `amount` number, required - `status` 'failed' | 'pending' | 'success', required - `returns` OrderReturnItem[], nullable - `id` string, required — Technical id of the return in Chift - `source_ref` Ref, required - `id` string, nullable — Technical id in the target software - `model` string, nullable — Name of the model/entity in the target software - `created_on` string, date-time, nullable - `order_lines` ReturnOrderLineItem[], nullable - `id` string, required — Technical id of the order line in Chift - `variant` OrderLineProductVariantItem - `id` string, required — Technical id of the product variant in Chift - `sku` string, nullable - `name` string, required - `categories` CommerceProductCategoryItem[], nullable - `id` string, required — Technical id of the category in Chift - `name` string, required - `quantity` integer, required - `untaxed_amount` number, required — Untaxed amount refunded (after discount). - `tax_amount` number, required — Total taxes refunded (after discount). - `total` number, required — Total refunded (after discount). - `new_lines` ReturnOrderLineItem[], nullable - `id` string, required — Technical id of the order line in Chift - `variant` OrderLineProductVariantItem - `id` string, required — Technical id of the product variant in Chift - `sku` string, nullable - `name` string, required - `categories` CommerceProductCategoryItem[], nullable - `id` string, required — Technical id of the category in Chift - `name` string, required - `quantity` integer, required - `untaxed_amount` number, required — Untaxed amount refunded (after discount). - `tax_amount` number, required — Total taxes refunded (after discount). - `total` number, required — Total refunded (after discount). - `linked_fees` ReturnFeesItem[], nullable - `id` string, required — Technical id of the fee in Chift - `source_ref` Ref, required - `id` string, nullable — Technical id in the target software - `model` string, nullable — Name of the model/entity in the target software - `type` 'shipping' | 'other', required - `untaxed_amount` number, required - `tax_amount` number, required - `total` number, required - `total` integer, required - `page` integer, required - `size` integer, required ## Other responses - `400` — Bad Request - `422` — Validation Error --- [API](https://skmtc.net/chift/apis/chift-api.md) · [All operations](https://skmtc.net/chift/apis/chift-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/chift/chift-api/versions/b5f1214a482a/schema)