openapi: 3.1.0 info: title: Commerce Layer addresses orders API version: 7.10.1 contact: name: API Support url: https://commercelayer.io email: support@commercelayer.io description: Headless Commerce for Global Brands. servers: - url: https://{your_organization_slug}.commercelayer.io/api description: API - url: https://core.commercelayer.io/users/sign_in description: Sign in - url: https://docs.commercelayer.io/api description: API reference security: - bearerAuth: [] tags: - name: orders description: resource type paths: /adyen_payments/{adyenPaymentId}/order: get: operationId: GET/adyenPaymentId/order summary: Retrieve the order associated to the adyen payment description: Retrieve the order associated to the adyen payment tags: - orders parameters: - name: adyenPaymentId in: path schema: type: string required: true description: The resource's id responses: '200': description: The order associated to the adyen payment /authorizations/{authorizationId}/order: get: operationId: GET/authorizationId/order summary: Retrieve the order associated to the authorization description: Retrieve the order associated to the authorization tags: - orders parameters: - name: authorizationId in: path schema: type: string required: true description: The resource's id responses: '200': description: The order associated to the authorization /axerve_payments/{axervePaymentId}/order: get: operationId: GET/axervePaymentId/order summary: Retrieve the order associated to the axerve payment description: Retrieve the order associated to the axerve payment tags: - orders parameters: - name: axervePaymentId in: path schema: type: string required: true description: The resource's id responses: '200': description: The order associated to the axerve payment /braintree_payments/{braintreePaymentId}/order: get: operationId: GET/braintreePaymentId/order summary: Retrieve the order associated to the braintree payment description: Retrieve the order associated to the braintree payment tags: - orders parameters: - name: braintreePaymentId in: path schema: type: string required: true description: The resource's id responses: '200': description: The order associated to the braintree payment /captures/{captureId}/order: get: operationId: GET/captureId/order summary: Retrieve the order associated to the capture description: Retrieve the order associated to the capture tags: - orders parameters: - name: captureId in: path schema: type: string required: true description: The resource's id responses: '200': description: The order associated to the capture /checkout_com_payments/{checkoutComPaymentId}/order: get: operationId: GET/checkoutComPaymentId/order summary: Retrieve the order associated to the checkout.com payment description: Retrieve the order associated to the checkout.com payment tags: - orders parameters: - name: checkoutComPaymentId in: path schema: type: string required: true description: The resource's id responses: '200': description: The order associated to the checkout.com payment /customers/{customerId}/orders: get: operationId: GET/customerId/orders summary: Retrieve the orders associated to the customer description: Retrieve the orders associated to the customer tags: - orders parameters: - name: customerId in: path schema: type: string required: true description: The resource's id responses: '200': description: The orders associated to the customer /discount_engine_items/{discountEngineItemId}/order: get: operationId: GET/discountEngineItemId/order summary: Retrieve the order associated to the discount engine item description: Retrieve the order associated to the discount engine item tags: - orders parameters: - name: discountEngineItemId in: path schema: type: string required: true description: The resource's id responses: '200': description: The order associated to the discount engine item /external_payments/{externalPaymentId}/order: get: operationId: GET/externalPaymentId/order summary: Retrieve the order associated to the external payment description: Retrieve the order associated to the external payment tags: - orders parameters: - name: externalPaymentId in: path schema: type: string required: true description: The resource's id responses: '200': description: The order associated to the external payment /klarna_payments/{klarnaPaymentId}/order: get: operationId: GET/klarnaPaymentId/order summary: Retrieve the order associated to the klarna payment description: Retrieve the order associated to the klarna payment tags: - orders parameters: - name: klarnaPaymentId in: path schema: type: string required: true description: The resource's id responses: '200': description: The order associated to the klarna payment /line_items/{lineItemId}/order: get: operationId: GET/lineItemId/order summary: Retrieve the order associated to the line item description: Retrieve the order associated to the line item tags: - orders parameters: - name: lineItemId in: path schema: type: string required: true description: The resource's id responses: '200': description: The order associated to the line item /order_copies/{orderCopyId}/source_order: get: operationId: GET/orderCopyId/source_order summary: Retrieve the source order associated to the order copy description: Retrieve the source order associated to the order copy tags: - orders parameters: - name: orderCopyId in: path schema: type: string required: true description: The resource's id responses: '200': description: The source_order associated to the order copy /order_copies/{orderCopyId}/target_order: get: operationId: GET/orderCopyId/target_order summary: Retrieve the target order associated to the order copy description: Retrieve the target order associated to the order copy tags: - orders parameters: - name: orderCopyId in: path schema: type: string required: true description: The resource's id responses: '200': description: The target_order associated to the order copy /order_factories/{orderFactoryId}/source_order: get: operationId: GET/orderFactoryId/source_order summary: Retrieve the source order associated to the order factory description: Retrieve the source order associated to the order factory tags: - orders parameters: - name: orderFactoryId in: path schema: type: string required: true description: The resource's id responses: '200': description: The source_order associated to the order factory /order_factories/{orderFactoryId}/target_order: get: operationId: GET/orderFactoryId/target_order summary: Retrieve the target order associated to the order factory description: Retrieve the target order associated to the order factory tags: - orders parameters: - name: orderFactoryId in: path schema: type: string required: true description: The resource's id responses: '200': description: The target_order associated to the order factory /order_subscriptions/{orderSubscriptionId}/source_order: get: operationId: GET/orderSubscriptionId/source_order summary: Retrieve the source order associated to the order subscription description: Retrieve the source order associated to the order subscription tags: - orders parameters: - name: orderSubscriptionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The source_order associated to the order subscription /order_subscriptions/{orderSubscriptionId}/orders: get: operationId: GET/orderSubscriptionId/orders summary: Retrieve the orders associated to the order subscription description: Retrieve the orders associated to the order subscription tags: - orders parameters: - name: orderSubscriptionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The orders associated to the order subscription /orders: get: operationId: GET/orders summary: List all orders description: List all orders tags: - orders responses: '200': description: A list of order objects content: application/vnd.api+json: schema: $ref: '#/components/schemas/orderResponseList' post: operationId: POST/orders summary: Create an order description: Create an order tags: - orders requestBody: required: true content: application/vnd.api+json: schema: $ref: '#/components/schemas/orderCreate' responses: '201': description: The created order object content: application/vnd.api+json: schema: $ref: '#/components/schemas/orderResponse' /orders/{orderId}: get: operationId: GET/orders/orderId summary: Retrieve an order description: Retrieve an order tags: - orders parameters: - name: orderId in: path schema: type: string required: true description: The resource's id responses: '200': description: The order object content: application/vnd.api+json: schema: $ref: '#/components/schemas/orderResponse' patch: operationId: PATCH/orders/orderId summary: Update an order description: Update an order tags: - orders parameters: - name: orderId in: path schema: type: string required: true description: The resource's id requestBody: required: true content: application/vnd.api+json: schema: $ref: '#/components/schemas/orderUpdate' responses: '200': description: The updated order object content: application/vnd.api+json: schema: $ref: '#/components/schemas/orderResponse' delete: operationId: DELETE/orders/orderId summary: Delete an order description: Delete an order tags: - orders parameters: - name: orderId in: path schema: type: string required: true description: The resource's id responses: '204': description: No content /payment_options/{paymentOptionId}/order: get: operationId: GET/paymentOptionId/order summary: Retrieve the order associated to the payment option description: Retrieve the order associated to the payment option tags: - orders parameters: - name: paymentOptionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The order associated to the payment option /paypal_payments/{paypalPaymentId}/order: get: operationId: GET/paypalPaymentId/order summary: Retrieve the order associated to the paypal payment description: Retrieve the order associated to the paypal payment tags: - orders parameters: - name: paypalPaymentId in: path schema: type: string required: true description: The resource's id responses: '200': description: The order associated to the paypal payment /recurring_order_copies/{recurringOrderCopyId}/source_order: get: operationId: GET/recurringOrderCopyId/source_order summary: Retrieve the source order associated to the recurring order copy description: Retrieve the source order associated to the recurring order copy tags: - orders parameters: - name: recurringOrderCopyId in: path schema: type: string required: true description: The resource's id responses: '200': description: The source_order associated to the recurring order copy /recurring_order_copies/{recurringOrderCopyId}/target_order: get: operationId: GET/recurringOrderCopyId/target_order summary: Retrieve the target order associated to the recurring order copy description: Retrieve the target order associated to the recurring order copy tags: - orders parameters: - name: recurringOrderCopyId in: path schema: type: string required: true description: The resource's id responses: '200': description: The target_order associated to the recurring order copy /refunds/{refundId}/order: get: operationId: GET/refundId/order summary: Retrieve the order associated to the refund description: Retrieve the order associated to the refund tags: - orders parameters: - name: refundId in: path schema: type: string required: true description: The resource's id responses: '200': description: The order associated to the refund /returns/{returnId}/order: get: operationId: GET/returnId/order summary: Retrieve the order associated to the return description: Retrieve the order associated to the return tags: - orders parameters: - name: returnId in: path schema: type: string required: true description: The resource's id responses: '200': description: The order associated to the return /satispay_payments/{satispayPaymentId}/order: get: operationId: GET/satispayPaymentId/order summary: Retrieve the order associated to the satispay payment description: Retrieve the order associated to the satispay payment tags: - orders parameters: - name: satispayPaymentId in: path schema: type: string required: true description: The resource's id responses: '200': description: The order associated to the satispay payment /shipments/{shipmentId}/order: get: operationId: GET/shipmentId/order summary: Retrieve the order associated to the shipment description: Retrieve the order associated to the shipment tags: - orders parameters: - name: shipmentId in: path schema: type: string required: true description: The resource's id responses: '200': description: The order associated to the shipment /stock_reservations/{stockReservationId}/order: get: operationId: GET/stockReservationId/order summary: Retrieve the order associated to the stock reservation description: Retrieve the order associated to the stock reservation tags: - orders parameters: - name: stockReservationId in: path schema: type: string required: true description: The resource's id responses: '200': description: The order associated to the stock reservation /stores/{storeId}/orders: get: operationId: GET/storeId/orders summary: Retrieve the orders associated to the store description: Retrieve the orders associated to the store tags: - orders parameters: - name: storeId in: path schema: type: string required: true description: The resource's id responses: '200': description: The orders associated to the store /stripe_payments/{stripePaymentId}/order: get: operationId: GET/stripePaymentId/order summary: Retrieve the order associated to the stripe payment description: Retrieve the order associated to the stripe payment tags: - orders parameters: - name: stripePaymentId in: path schema: type: string required: true description: The resource's id responses: '200': description: The order associated to the stripe payment /transactions/{transactionId}/order: get: operationId: GET/transactionId/order summary: Retrieve the order associated to the transaction description: Retrieve the order associated to the transaction tags: - orders parameters: - name: transactionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The order associated to the transaction /voids/{voidId}/order: get: operationId: GET/voidId/order summary: Retrieve the order associated to the void description: Retrieve the order associated to the void tags: - orders parameters: - name: voidId in: path schema: type: string required: true description: The resource's id responses: '200': description: The order associated to the void /wire_transfers/{wireTransferId}/order: get: operationId: GET/wireTransferId/order summary: Retrieve the order associated to the wire transfer description: Retrieve the order associated to the wire transfer tags: - orders parameters: - name: wireTransferId in: path schema: type: string required: true description: The resource's id responses: '200': description: The order associated to the wire transfer /orders/breakdown: post: operationId: POST/orders/breakdown summary: Query breakdown on orders description: "Breakdowns are aggregations that summarize your data as metrics (based on specific operators) or statistics, computed on field values. When performing a breakdown query on the Metrics API endpoint you get in the response the value of the computation (based on the selected operator) on the selected field, aggregated by another field.\r\n\r\n### Nesting breakdowns\r\nBreakdowns can be nested recursively one into the other, up to one level (see example). The valid values allowed for the by key of the nested breakdown are strictly dependent on the value you specified in the by key of the parent breakdown. Hence, they are different for each resource you’re doing statistics on (see orders, returns, and carts for the related lists).You cannot group the nested breakdown by the same field by which you’re already grouping the parent breakdown.\r\n\r\nSingle breakdown request\r\n\r\n`{\r\n\t\"breakdown\": {\r\n\t \"by\": \"market.name\",\r\n\t \"field\": \"order.id\",\r\n\t \"operator\": \"value_count\",\r\n\t \"condition\": {\r\n\t \"gte_lte\": [ 10000, 100000 ]\r\n\t },\r\n\t \"sort\": \"desc\",\r\n\t \"limit\": 2\r\n\t}\r\n}`\r\n \r\n \r\n Nested breakdown request\r\n \r\n` {\r\n \"breakdown\": {\r\n \"by\": \"market.name\",\r\n \"field\": \"order.id\",\r\n \"operator\": \"value_count\",\r\n \"condition\": {\r\n \"gte_lte\": [ 10000, 100000 ] \r\n },\r\n \"sort\": \"desc\",\r\n \"limit\": 3,\r\n \"breakdown\": {\r\n \"by\": \"order.currency_code\",\r\n \"field\": \"order.total_amount_with_taxes\",\r\n \"operator\": \"sum\"\r\n \"sort\": \"desc\",\r\n \"limit\": 2\r\n }\r\n }\r\n }`" tags: - orders requestBody: required: true content: application/vnd.api+json: schema: $ref: '#/components/schemas/orders_breakdown_request' responses: '200': description: The breakdown result from orders content: application/vnd.api+json: schema: type: object properties: data: oneOf: - type: object properties: billing_address.business: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: billing_address.city: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: billing_address.country_code: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: billing_address.geocoded: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: billing_address.localized: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: billing_address.state_code: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: billing_address.zip_code: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: customer.id: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: customer.email: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: customer.group_name: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: customer.reference: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: customer.reference_origin: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: line_items.code: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: line_items.id: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: line_items.item_id: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: line_items.item_type: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: line_items.name: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: line_items.options.id: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: line_items.options.name: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: market.id: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: market.name: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: market.number: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: organization.id: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: organization.name: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: organization.slug: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: order.customer_type: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: order.country_code: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: order.coupon_code: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: order.currency_code: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: order.freight_taxable: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: order.fulfillment_status: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: order.gift_card_code: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: order.guest: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: order.language_code: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: order.mode: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: order.payment_status: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: order.reference: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: order.reference_origin: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: order.status: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: order.tax_included: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: order.placed_day_of_week: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: order.link_id: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: order.user_id: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: order.store_id: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: order.affiliate_code: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: payment_method.id: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: payment_method.source_type: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: payment_method.name: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: payment_method.moto: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: payment_method.issuer: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: payment_method.issuer_type: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: payment_method.card_type: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: shipping_address.business: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: shipping_address.city: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: shipping_address.country_code: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: shipping_address.geocoded: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: shipping_address.localized: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: shipping_address.state_code: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: shipping_address.zip_code: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: shipments.status: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: shipments.reference: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: shipments.reference_origin: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: shipments.items: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: shipments.stock_location.name: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: shipments.stock_location.reference: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: shipments.stock_location.reference_origin: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: shipments.shipping_method.id: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: shipments.shipping_method.name: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: shipments.shipping_method.reference: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: shipments.shipping_method.reference_origin: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: shipments.shipping_method.currency_code: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: shipments.shipping_category.name: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: shipments.shipping_category.reference: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: shipments.shipping_category.reference_origin: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: shipments.tags.id: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: shipments.tags.name: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: tags.id: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: tags.name: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: resource_errors.code: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: resource_errors.name: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: resource_errors.id: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 - type: object properties: resource_errors.message: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 meta: type: object properties: type: type: string description: Action name trace_id: type: string description: Request ID mode: type: string description: Filter mode organization_id: type: string description: Organization ID from request market_ids: type: array items: type: string description: Markets IDs from the organization payload: type: object properties: filter: $ref: '#/components/schemas/orders_filter' breakdown: $ref: '#/components/schemas/orders_breakdown_request/properties/breakdown' /orders/date_breakdown: post: operationId: POST/orders/date_breakdown summary: Query date_breakdown on orders description: "Date breakdowns summarizes metrics data grouped by time intervals on a defined time range. They also support support breakdowns over the main date breakdown query and also supports all breakdown queries capabilities through the \"breakdown\" key, this also includes the possibility of nesting the breakdown over the main breakdown. \r\n\r\n\r\nSingle date breakdown request (no breakdown)\r\n\r\n`{\r\n\t\"date_breakdown\": {\r\n \"by\": \"shipments.cancelled_at\",\r\n \"field\": \"order.id\",\r\n \"interval\": \"month\",\r\n \"operator\": \"value_count\"\r\n }\r\n}`\r\n \r\n \r\nSingle date breakdown request with one breakdown\r\n \r\n` \r\n{\r\n\t\"date_breakdown\": {\r\n \"by\": \"shipments.cancelled_at\",\r\n \"field\": \"order.id\",\r\n \"interval\": \"month\",\r\n \"operator\": \"value_count\",\r\n \"breakdown\": {\r\n \"by\": \"order.currency_code\",\r\n \"field\": \"order.total_amount_with_taxes\",\r\n \"operator\": \"sum\",\r\n \"sort\": \"desc\",\r\n \"limit\": 5\r\n }\r\n }\r\n }`\r\n \r\n \r\nSingle date breakdown request with breakdown with a nested breakdown\r\n\r\n` \r\n{\r\n\"date_breakdown\": {\r\n \"by\": \"order.placed_at\",\r\n \"field\": \"order.total_amount_with_taxes\",\r\n \"operator\": \"stats\",\r\n \"interval\": \"month\",\r\n \"breakdown\": {\r\n \"by\": \"order.country_code\",\r\n \"field\": \"line_items.total_amount\",\r\n \"operator\": \"sum\",\r\n \"sort\": \"desc\",\r\n \"limit\": 20,\r\n \"breakdown\": {\r\n \"by\": \"order.currency_code\",\r\n \"field\": \"line_items.total_amount\",\r\n \"operator\": \"sum\",\r\n \"sort\": \"desc\",\r\n \"limit\": 21\r\n }\r\n }\r\n }\r\n }`\r\n " tags: - orders requestBody: required: true content: application/vnd.api+json: schema: $ref: '#/components/schemas/orders_date_breakdown_request' responses: '200': description: The date_breakdown result from orders content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: date: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 additionalProperties: type: array items: type: object properties: label: type: string value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 meta: type: object properties: type: type: string description: Action name trace_id: type: string description: Request ID mode: type: string description: Filter mode organization_id: type: string description: Organization ID from request market_ids: type: array items: type: string description: Markets IDs from the organization payload: type: object properties: filter: $ref: '#/components/schemas/orders_filter' date_breakdown: $ref: '#/components/schemas/orders_date_breakdown_request/properties/date_breakdown' /orders/stats: post: operationId: POST/orders/stats summary: Query stats on orders description: "Stats are aggregations that summarize your data within an operator (depending of the field, some of them could not be available), such as: value_count, cardinality, avg, min, max, sum or stats (which returns avg, min, max, sum) computed on the field specificed. When performing a stats query on the Metrics API endpoint you get in the response the value of the computation (based on the selected operator) on the selected field.\r\n\r\nStats request\r\n\r\n`{\r\n\t \"stats\": {\r\n \"field\": \"order.total_amount_cents\",\r\n \"operator\": \"stats\"\r\n }\r\n}`" tags: - orders requestBody: required: true content: application/vnd.api+json: schema: $ref: '#/components/schemas/orders_stats_request' responses: '200': description: The stats result from orders content: application/vnd.api+json: schema: type: object properties: data: type: object properties: customer.id: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 customer.email: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 customer.group_name: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 customer.reference: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 customer.reference_origin: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 line_items.code: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 line_items.discount: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 line_items.id: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 line_items.item_id: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 line_items.options_amount: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 line_items.quantity: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 line_items.tax_amount: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 line_items.tax_rate: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 line_items.total_amount: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 line_items.unit_amount: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 line_items.options.id: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 line_items.options.quantity: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 line_items.options.total_amount: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 line_items.options.unit_amount: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 market.id: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 market.number: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 order.adjustment_amount: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 order.adjustment_tax_amount: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 order.adjustment_taxable_amount: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 order.discount_amount: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 order.duty_amount: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 order.gift_card_code: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 order.gift_card_amount: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 order.id: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 order.line_item_options_count: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 order.number: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 order.payment_method_amount: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 order.payment_method_tax_amount: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 order.payment_method_taxable_amount: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 order.reference: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 order.reference_origin: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 order.shipments_count: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 order.shipping_amount: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 order.shipping_taxable_amount: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 order.skus_count: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 order.subtotal_amount: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 order.subtotal_tax_amount: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 order.subtotal_taxable_amount: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 order.total_amount: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 order.total_amount_with_taxes: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 order.total_tax_amount: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 order.total_taxable_amount: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 order.seconds_in_draft: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 order.seconds_in_approved: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 order.seconds_in_placed: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 order.refunds_total_amount_with_taxes: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 order.total_amount_with_taxes_net_of_refunds: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 refunds.id: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 refunds.amount: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 refunds.number: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 shipments.id: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 shipments.number: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 shipments.items_count: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 shipments.cost_amount: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 shipments.reference: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 shipments.reference_origin: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 shipments.seconds_in_picking: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 shipments.seconds_in_ready_to_ship: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 shipments.seconds_in_shipped: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 shipments.fulfillment_time: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 shipments.stock_location.id: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 shipments.stock_location.reference: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 shipments.stock_location.reference_origin: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 shipments.shipping_method.id: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 shipments.shipping_method.reference: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 shipments.shipping_method.reference_origin: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 shipments.shipping_category.id: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 shipments.shipping_category.reference: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 shipments.shipping_category.reference_origin: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 resource_errors.code: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 resource_errors.id: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 resource_errors.message: type: object properties: value: oneOf: - type: number example: 8 - type: string - type: object properties: count: type: number example: 8 min: type: number example: 8 max: type: number example: 8 avg: type: number example: 8 sum: type: number example: 8 meta: type: object properties: type: type: string description: Action name trace_id: type: string description: Request ID mode: type: string description: Filter mode organization_id: type: string description: Organization ID from request market_ids: type: array items: type: string description: Markets IDs from the organization payload: type: object properties: filter: $ref: '#/components/schemas/orders_filter' stats: $ref: '#/components/schemas/orders_stats_request/properties/stats' /orders/search: post: operationId: POST/orders/search summary: Query search on orders description: Get search results from orders tags: - orders requestBody: required: true content: application/vnd.api+json: schema: $ref: '#/components/schemas/orders_search_request' responses: '200': description: The search result from orders content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: date_from: type: string description: The lower limit of the date and time range used to filter the collected orders (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard). format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' date_to: type: string description: The upper limit of the date and time range used to filter the collected orders (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard). format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' date_field: type: string description: The date field (e.g. `created_at`, `updated_at`, etc.) where to apply the date and time range filter. enum: - current_date - approved_at - cancelled_at - created_at - placed_at - archived_at - updated_at - fulfillment_updated_at - payment_updated_at default: current_date discounted: type: boolean description: Indicates a discount has been applied to the order. refunded: type: boolean description: Indicates if the order has been partially or totally refunded. gift_card: type: boolean description: Indicates if a gift card has been (or is set to be) used to pay — in total or in part - for the order. coupon: type: boolean description: Indicates if a coupon code has been (or is set to be) used to pay — in total or in part — for the order. customer_types: type: string description: The type of the associated customer. One of `new` or `returning`. returned: type: boolean description: Indicates if a return is associated with the order. options: type: boolean description: Indicates if at least one line item of the order has at least an option. adjustment_amount: type: number description: The sum of all the adjustments applied to the order (float). example: 121 adjustment_tax_amount: type: number description: The taxes applied to the order's adjustments (float). example: 121 adjustment_taxable_amount: type: number description: The order's adjustment taxable amount (float). example: 121 approved_at: type: string description: The date and time at which the order was approved (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard). format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' archived_at: type: string description: The date and time at which the order was archived (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard). format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' archived: type: boolean description: Indicates if the order has been archived. cancelled_at: type: string description: The date and time at which the order was cancelled (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard). format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' country_codes: type: string description: The international 2-letter country code (as defined by the [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) standard), automatically inherited from the order's shipping address. coupon_codes: type: string description: The coupon code to be used to pay — in total or in part — for the order. If valid, it triggers a promotion adding a discount line item to the order. created_at: type: string description: The date and time at which the order was created (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard). format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' currency_codes: type: string description: The international 3-letter currency code (as defined by the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) standard), automatically inherited from the order's market. discount_amount: type: number description: The sum of all the discounts applied to the order (float). example: 121 duty_amount: type: number description: The duty amount that is calculated by external services (float). example: 121 freight_taxable: type: boolean description: Indicates if taxes are applied to shipping costs. fulfillment_statuses: type: string description: The order's fulfillment status. One of `unfulfilled` (default), `in_progress`, or `fulfilled`. fulfillment_updated_at: type: string description: The date and time at which the order's fulfillment status was last updated (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard). format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' gift_card_codes: type: string description: The gift card code (at least the first 8 characters) to be used to pay — in total or in part — for the order. If valid, it uses the associated gift card balance. gift_card_amount: type: number description: The sum of all the gift cards applied to the order (float). example: 121 guest: type: boolean description: Indicates if the order has been placed as guest (by a non-logged in customer). ids: type: string description: The ID of the order. language_codes: type: string description: The preferred language code (as defined by the [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) standard) to be used when communicating with the customer when checking out the order. line_item_options_count: type: integer description: The total number of line item options associated with the order's line items. example: 8 mode: type: string description: The order's environment (can be one of `test` or `live`). enum: - live - test numbers: type: integer description: The numeric unique identifier for the order. example: 8 payment_method_amount: type: number description: The costs of the payment method associated with the order (float). example: 121 payment_method_tax_amount: type: number description: The taxes applied to the order's payment method costs (float). example: 121 payment_method_taxable_amount: type: number description: The order's payment method taxable amount (float). example: 121 payment_statuses: type: string description: The order's payment status. One of `unpaid` (default), `authorized`, `partially_authorized`, `paid`, `partially_paid`, `voided`, `partially_voided`, `refunded`, `partially_refunded` or `free`. payment_updated_at: type: string description: The date and time at which the order's payment status was last updated (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard). format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' placed_at: type: string description: The date and time at which the order was placed (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard). format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' references: type: string description: Any external identifier that might be useful to link the order resource to other systems through the Commerce Layer core API. reference_origins: type: string description: Any identifier of the 3rd-party system that defines the reference code. shipments_count: type: integer description: The total number of shipments associated with the order. example: 8 shipping_amount: type: number description: The sum of all the shipping costs of the order (float). example: 121 shipping_taxable_amount: type: number description: The order's shipping taxable amount (float). example: 121 skus_count: type: integer description: The total number of SKUs in the order's line items. example: 8 statuses: type: string description: The order status. One of `placed`, `approved`, or `cancelled`. subtotal_amount: type: number description: The sum of all the SKU line items total amounts (float). example: 121 subtotal_tax_amount: type: number description: The taxes applied to the order's subtotal (float). example: 121 subtotal_taxable_amount: type: number description: The order's subtotal taxable amount (float). example: 121 tax_included: type: boolean description: Indicates if taxes are included in the order amounts (automatically inherited from the order's price list). total_amount: type: number description: The order's total amount (float). example: 121 total_amount_with_taxes: type: number description: The order's total amount, taxes included (float). example: 121 total_tax_amount: type: number description: The sum of all the taxes applied to the order (float). example: 121 total_taxable_amount: type: number description: The order's total taxable amount (float). example: 121 updated_at: type: string description: The date and time at which the order was last updated (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard). format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' current_date: type: string description: The date and time of the order's latest status change, regardless of the order's status (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard). format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' seconds_in_draft: type: integer description: The difference in seconds between `placed_at` and `created_at` (`null` if the order hasn't been placed yet). example: 8 seconds_in_approved: type: integer description: The difference in seconds between `cancelled_at` and `approved_at` (`null` if the order hasn't been approved yet or no further status change happened after approval — e.g. the order has been regularly fulfilled). example: 8 seconds_in_placed: type: integer description: The difference in seconds between `approved_at` and `placed_at` if the order has been approved or between `cancelled_at` and `placed_at` if the order has been cancelled before approval (`null` if the order hasn't been placed yet or no further status change happened after placement). example: 8 placed_day_of_week: type: integer description: The day of week when the order was placed, expressed as an integer (`0` through `6`, from Sunday to Saturday — e.g. `1` is Monday). example: 8 refunds_total_amount_with_taxes: type: integer description: Total amount of refunds (including taxes) associated with the order. example: 8 total_amount_with_taxes_net_of_refunds: type: number description: The total amount of the order minus the total amount of refunds. example: 121 aggregated_details: type: string description: Searchable field containing all orders data. link_ids: type: string description: The link ID used during the checkout. user_ids: type: string description: The user ID used to generate the link. store_ids: type: string description: The store ID used during the checkout. affiliate_codes: type: string description: The affiliate code used during the checkout. billing_address: type: object properties: business: type: boolean description: Indicates if the address is a business or a personal one. city: type: string description: The city specified in the address. country_code: type: string description: The international 2-letter country code (as defined by the [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) standard) specified in the address. geocoded: type: boolean description: Indicates if the address has been successfully geocoded. localized: type: boolean description: Indicates if the latitude and longitude of the address are present, either geocoded or manually updated. state_code: type: string description: The state, province or region code specified in the address. zip_code: type: string description: The ZIP or postal code specified in the address. company: type: string description: The company specified in the address. first_name: type: string description: The first name specified in the address. last_name: type: string description: The last name specified in the address. customer: type: object properties: id: type: string description: The ID of the customer. email: type: string description: The email address of the customer. group_name: type: string description: The name of the customer group the customer belongs to (if any). reference: type: string description: Any external identifier that might be useful to link the customer resource to other systems through the Commerce Layer core API. reference_origin: type: string description: Any identifier of the 3rd-party system that defines the reference code. line_items: type: object properties: code: type: string description: The code of the associated SKU or bundle. discount: type: number description: The discount applied to the line item (float). example: 121 id: type: string description: The ID of the line item. item_id: type: string description: The ID of the associated item. item_type: type: string description: The type of the associated item. One of `sku`, `bundle`, `shipment`, `payment_method`, `adjustment`, `gift_card`, or a valid promotion type (e.g. `percentage_discount_promotion`, `free_shipping_promotion`, etc.). name: type: string description: The name of the line item. When missing, it gets populated with the name of the associated item (if present). options_amount: type: number description: The amount of the line item option (float). example: 121 quantity: type: integer description: The line item's quantity. example: 8 tax_amount: type: number description: The collected tax amount for the line item (float). Otherwise calculated as the line item's `(total_amount - discount) * tax_rate` (float). example: 121 tax_rate: type: number description: The tax rate for the line item (if calculated). example: 121 total_amount: type: number description: The total amount of the line item (float). Calculated as the line item's `unit_amount * quantity` + plus the associated line item options amount. example: 121 unit_amount: type: number description: The unit amount of the line item (float). example: 121 updated_at: type: string description: The date and time at which the line item was last updated (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard). format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' line_items.options: type: object properties: id: type: string description: The ID of the line item option. name: type: string description: The name of the line item option. When missing, it gets populated with the name of the associated SKU option. quantity: type: integer description: The line item option's quantity. example: 8 total_amount: type: number description: The total amount of the line item option (float). Calculated as the line item option's `unit_amount * quantity`. example: 121 unit_amount: type: number description: The unit amount of the line item option (float). example: 121 market: type: object properties: id: type: string description: The ID of the market. name: type: string description: The name of the market. number: type: integer description: The numeric unique identifier for the market. example: 8 organization: type: object properties: id: type: string description: The ID of the organization. name: type: string description: The name of the organization. slug: type: string description: The name of the organization, parsed and converted into a URL-friendly slug. payment_method: type: object properties: id: type: string description: The ID of the payment method. source_type: type: string description: The payment source type. One of `AdyenPayment`, `BraintreePayment`, `CheckoutComPayment`, `CreditCard`, `ExternalPayment`, `KlarnaPayment`, `PaypalPayment`, `StripePayment`, or `WireTransfer`. name: type: string description: The payment source type, titleized. moto: type: boolean description: Indicates if the payment has been marked as MOTO (must be supported by the payment gateway). issuer: type: string description: The payment method's issuer (if present and provided by the payment gateway). issuer_type: type: string description: The type of issuer (if present and provided by the payment gateway). card_type: type: string description: The type of card used to pay for the order (if present and provided by the payment gateway). refunds: type: object properties: id: type: string description: The ID of the refund. amount: type: number description: The refunded amount (float). example: 121 number: type: string description: The transaction number associated with the refund (auto-generated). shipping_address: type: object properties: business: type: boolean description: Indicates if the address is a business or a personal one. city: type: string description: The city specified in the address. country_code: type: string description: The international 2-letter country code (as defined by the [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) standard) specified in the address. geocoded: type: boolean description: Indicates if the address has been successfully geocoded. localized: type: boolean description: Indicates if the latitude and longitude of the address are present, either geocoded or manually updated. state_code: type: string description: The state, province or region code specified in the address. zip_code: type: string description: The ZIP or postal code specified in the address. shipments: type: object properties: id: type: string description: The shipment ID. number: type: string description: The shipment number. items_count: type: integer description: The shipment items count. example: 8 cost_amount: type: integer description: The shipment cost amount. example: 8 status: type: string description: The shipment status. cancelled_at: type: string description: The date and time at which the shipment status was cancelled (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard). format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' delivered_at: type: string description: The date and time at which the shipment was delivered (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard). format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' on_hold_at: type: string description: The date and time at which the shipment status was put on hold (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard). format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' picking_at: type: string description: The date and time at which the shipment was picked (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard). format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' packing_at: type: string description: The date and time at which the shipment was packed (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard). format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' ready_to_ship_at: type: string description: The date and time at which the shipment was ready to ship (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard). format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' shipped_at: type: string description: The date and time at which the shipment was shipped (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard). format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' created_at: type: string description: The date and time at which the shipment was created (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard). format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' updated_at: type: string description: The date and time at which the shipment was updated (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard). format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' reference: type: string description: Any external identifier that might be useful to link the shipment resource to other systems through the Commerce Layer core API. reference_origin: type: string description: Any identifier of the 3rd-party system that defines the reference code. seconds_in_picking: type: integer description: The difference in seconds between `picking_at` and `packing_at` (`null` if the order hasn't been picked yet). example: 8 seconds_in_ready_to_ship: type: integer description: The difference in seconds between `ready_to_ship_at` and `shipped_at` (`null` if the order hasn't been shipped yet). example: 8 seconds_in_shipped: type: integer description: The difference in seconds between `delivered_at` and `shipped_at` (`null` if the order hasn't been delivered yet). example: 8 fulfillment_time: type: integer description: The difference in seconds between `delivered_at` and `picking_at` or `shipped_at` and `picking_at`. example: 8 items: type: string description: Array of the shipment items information. shipments.stock_location: type: object properties: id: type: string description: The shipment stock location ID. name: type: string description: The shipment stock location name. reference: type: string description: Any external identifier that might be useful to link the stock location reference resource to other systems through the Commerce Layer core API. reference_origin: type: string description: Any identifier of the 3rd-party system that defines the reference code. shipments.shipping_method: type: object properties: id: type: string description: The shipment shipping method ID. name: type: string description: The shipment shipping method name. reference: type: string description: Any external identifier that might be useful to link the shipping method reference resource to other systems through the Commerce Layer core API. reference_origin: type: string description: Any identifier of the 3rd-party system that defines the reference code. currency_code: type: string description: The international 3-letter currency code (as defined by the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) standard), automatically inherited from the order's market. shipments.shipping_category: type: object properties: id: type: string description: The shipment shipping category ID. name: type: string description: The shipment shipping category name. reference: type: string description: Any external identifier that might be useful to link the shipping method reference resource to other systems through the Commerce Layer core API. reference_origin: type: string description: Any identifier of the 3rd-party system that defines the reference code. shipments.tags: type: object properties: id: type: string description: The tag ID. name: type: string description: The tag name. tags: type: object properties: id: type: string description: The tag ID. name: type: string description: The tag name. resource_errors: type: object properties: code: type: string description: The resource errors code. name: type: string description: The name of the resource error. id: type: string description: The ID of the resource error. message: type: string description: The resource error message. created_at: type: string description: The date and time at which the resource error was created (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard). format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' updated_at: type: string description: The date and time at which the resource error was updated (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard). format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' meta: type: object properties: type: type: string description: Action name trace_id: type: string description: Request ID mode: type: string description: Filter mode organization_id: type: string description: Organization ID from request market_ids: type: array items: type: string description: Markets IDs from the organization payload: type: object properties: filter: $ref: '#/components/schemas/orders_filter' search: $ref: '#/components/schemas/orders_search_request/properties/search' pagination: type: object properties: record_count: type: integer example: 8 cursor: type: string example: LS0tCi0gJzIwMjEtMTEtMD /orders/export: post: operationId: POST/orders/export summary: Query export on orders description: Get export results from orders tags: - orders requestBody: required: true content: application/vnd.api+json: schema: $ref: '#/components/schemas/orders_export_request' responses: '200': description: The export result from orders content: text/csv: schema: type: string format: binary description: CSV file with exported records (text/csv) components: schemas: orders_search_request: type: object properties: filter: $ref: '#/components/schemas/orders_filter' search: type: object required: - fields properties: sort: type: string description: Result sorting enum: - asc - desc limit: type: integer description: Results limit default: 50 maximum: 100 sort_by: $ref: '#/components/schemas/orders_search_fields' fields: type: array items: $ref: '#/components/schemas/orders_search_fields' meta: type: object properties: payload: type: boolean description: Set to true if you want to receive how the payload has been made satispayPayment: type: object properties: data: type: object required: - type - attributes properties: type: type: string description: The resource's type enum: - satispay_payments attributes: type: object properties: payment_id: type: string description: The payment unique identifier. example: xxxx-yyyy-zzzz nullable: true flow: type: string description: The Satispay payment flow, inspect gateway API details for more information. example: MATCH_CODE nullable: true status: type: string description: The Satispay payment status. example: PENDING nullable: true redirect_url: type: string description: The url to redirect the customer after the payment flow is completed. example: http://commercelayer.dev/satispay/redirect nullable: true payment_url: type: string description: Redirect url to the payment page. example: https://online.satispay.com/pay/xxxx-yyyy-zzzz?redirect_url={redirect_url} nullable: true payment_response: type: object description: The Satispay payment response, used to fetch internal data. example: foo: bar nullable: true payment_instrument: type: object description: Information about the payment instrument used in the transaction. example: issuer: cl bank card_type: visa nullable: true created_at: type: string description: Time at which the resource was created. example: '2018-01-01T12:00:00.000Z' nullable: false updated_at: type: string description: Time at which the resource was last updated. example: '2018-01-01T12:00:00.000Z' nullable: false reference: type: string description: A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever. example: ANY-EXTERNAL-REFEFERNCE nullable: true reference_origin: type: string description: Any identifier of the third party system that defines the reference code. example: ANY-EXTERNAL-REFEFERNCE-ORIGIN nullable: true metadata: type: object description: Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format. example: foo: bar nullable: true relationships: type: object properties: order: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - orders id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN payment_gateway: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - payment_gateways id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN event_stores: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - event_stores id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN orders_export_request: type: object properties: filter: $ref: '#/components/schemas/orders_filter' search: type: object required: - fields properties: sort: type: string description: Result sorting enum: - asc - desc default: desc sort_by: $ref: '#/components/schemas/orders_export_fields' fields: type: array items: $ref: '#/components/schemas/orders_export_fields' description: Fields to export (order/return and single-level references only, no line_items). tags.name and tags.id return joined values. meta: type: object properties: payload: type: boolean description: Set to true if you want to receive how the payload has been made wireTransfer: type: object properties: data: type: object required: - type - attributes properties: type: type: string description: The resource's type enum: - wire_transfers attributes: type: object properties: payment_instrument: type: object description: Information about the payment instrument used in the transaction. example: issuer: cl bank card_type: visa nullable: true created_at: type: string description: Time at which the resource was created. example: '2018-01-01T12:00:00.000Z' nullable: false updated_at: type: string description: Time at which the resource was last updated. example: '2018-01-01T12:00:00.000Z' nullable: false reference: type: string description: A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever. example: ANY-EXTERNAL-REFEFERNCE nullable: true reference_origin: type: string description: Any identifier of the third party system that defines the reference code. example: ANY-EXTERNAL-REFEFERNCE-ORIGIN nullable: true metadata: type: object description: Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format. example: foo: bar nullable: true relationships: type: object properties: order: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - orders id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN event_stores: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - event_stores id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN orders_search_fields: type: string enum: - billing_address.business - billing_address.city - billing_address.country_code - billing_address.geocoded - billing_address.localized - billing_address.state_code - billing_address.zip_code - billing_address.company - billing_address.first_name - billing_address.last_name - customer.id - customer.email - customer.group_name - customer.reference - customer.reference_origin - line_items.code - line_items.discount - line_items.id - line_items.item_id - line_items.item_type - line_items.name - line_items.options_amount - line_items.quantity - line_items.tax_amount - line_items.tax_rate - line_items.total_amount - line_items.unit_amount - line_items.updated_at - line_items.options.id - line_items.options.name - line_items.options.quantity - line_items.options.total_amount - line_items.options.unit_amount - market.id - market.name - market.number - organization.id - organization.name - organization.slug - order.discounted - order.refunded - order.gift_card - order.coupon - order.customer_type - order.returned - order.options - order.adjustment_amount - order.adjustment_tax_amount - order.adjustment_taxable_amount - order.approved_at - order.archived_at - order.archived - order.cancelled_at - order.country_code - order.coupon_code - order.created_at - order.currency_code - order.discount_amount - order.duty_amount - order.freight_taxable - order.fulfillment_status - order.fulfillment_updated_at - order.gift_card_code - order.gift_card_amount - order.guest - order.id - order.language_code - order.line_item_options_count - order.mode - order.number - order.payment_method_amount - order.payment_method_tax_amount - order.payment_method_taxable_amount - order.payment_status - order.payment_updated_at - order.placed_at - order.reference - order.reference_origin - order.shipments_count - order.shipping_amount - order.shipping_taxable_amount - order.skus_count - order.status - order.subtotal_amount - order.subtotal_tax_amount - order.subtotal_taxable_amount - order.tax_included - order.total_amount - order.total_amount_with_taxes - order.total_tax_amount - order.total_taxable_amount - order.updated_at - order.current_date - order.seconds_in_draft - order.seconds_in_approved - order.seconds_in_placed - order.placed_day_of_week - order.refunds_total_amount_with_taxes - order.total_amount_with_taxes_net_of_refunds - order.aggregated_details - order.link_id - order.user_id - order.store_id - order.affiliate_code - payment_method.id - payment_method.source_type - payment_method.name - payment_method.moto - payment_method.issuer - payment_method.issuer_type - payment_method.card_type - refunds.id - refunds.amount - refunds.number - shipping_address.business - shipping_address.city - shipping_address.country_code - shipping_address.geocoded - shipping_address.localized - shipping_address.state_code - shipping_address.zip_code - shipments.id - shipments.number - shipments.items_count - shipments.cost_amount - shipments.status - shipments.cancelled_at - shipments.delivered_at - shipments.on_hold_at - shipments.picking_at - shipments.packing_at - shipments.ready_to_ship_at - shipments.shipped_at - shipments.created_at - shipments.updated_at - shipments.reference - shipments.reference_origin - shipments.seconds_in_picking - shipments.seconds_in_ready_to_ship - shipments.seconds_in_shipped - shipments.fulfillment_time - shipments.items - shipments.stock_location.id - shipments.stock_location.name - shipments.stock_location.reference - shipments.stock_location.reference_origin - shipments.shipping_method.id - shipments.shipping_method.name - shipments.shipping_method.reference - shipments.shipping_method.reference_origin - shipments.shipping_method.currency_code - shipments.shipping_category.id - shipments.shipping_category.name - shipments.shipping_category.reference - shipments.shipping_category.reference_origin - shipments.tags.id - shipments.tags.name - tags.id - tags.name - resource_errors.code - resource_errors.name - resource_errors.id - resource_errors.message - resource_errors.created_at - resource_errors.updated_at order: properties: data: properties: attributes: type: object properties: number: type: string description: The order identifier. Can be specified if unique within the organization (for enterprise plans only), default to numeric ID otherwise. Cannot be passed by sales channels. example: '1234' nullable: true affiliate_code: type: string description: The affiliate code, if any, to track commissions using any third party services. example: xxxx-yyyy-zzzz nullable: true autorefresh: type: boolean description: Save this attribute as 'false' if you want prevent the order to be refreshed automatically at each change (much faster). example: true nullable: true place_async: type: boolean description: Save this attribute as 'true' if you want perform the place asynchronously. Payment errors, if any, will be collected afterwards. example: true nullable: true status: type: string description: The order status. One of 'draft' (default), 'pending', 'editing', 'placing', 'placed', 'approved', or 'cancelled'. example: draft nullable: false enum: - draft - pending - editing - placing - placed - approved - cancelled payment_status: type: string description: The order payment status. One of 'unpaid' (default), 'authorized', 'partially_authorized', 'paid', 'partially_paid', 'voided', 'partially_voided', 'refunded', 'partially_refunded', or 'free'. example: unpaid nullable: false enum: - unpaid - authorized - partially_authorized - paid - partially_paid - voided - partially_voided - refunded - partially_refunded - free fulfillment_status: type: string description: The order fulfillment status. One of 'unfulfilled' (default), 'in_progress', 'fulfilled', or 'not_required'. example: unfulfilled nullable: false enum: - unfulfilled - in_progress - fulfilled - not_required guest: type: boolean description: Indicates if the order has been placed as guest. example: true nullable: true editable: type: boolean description: Indicates if the order can be edited. example: true nullable: true customer_email: type: string description: The email address of the associated customer. When creating or updating an order, this is a shortcut to find or create the associated customer by email. example: john@example.com nullable: true customer_type: type: string description: The type of the associated customer. One of 'new', or 'returning'. example: returning nullable: true enum: - new - returning language_code: type: string description: The preferred language code (ISO 639-1) to be used when communicating with the customer. This can be useful when sending the order to 3rd party marketing tools and CRMs. If the language is supported, the hosted checkout will be localized accordingly. example: it nullable: true currency_code: type: string description: The international 3-letter currency code as defined by the ISO 4217 standard, automatically inherited from the order's market. example: EUR nullable: true tax_included: type: boolean description: Indicates if taxes are included in the order amounts, automatically inherited from the order's price list. example: true nullable: true tax_rate: type: number description: The tax rate for this order (if calculated). example: 0.22 nullable: true freight_taxable: type: boolean description: Indicates if taxes are applied to shipping costs. example: true nullable: true payment_method_taxable: type: boolean description: Indicates if taxes are applied to payment methods costs. example: true nullable: true adjustment_taxable: type: boolean description: Indicates if taxes are applied to positive adjustments. example: true nullable: true gift_card_taxable: type: boolean description: Indicates if taxes are applied to purchased gift cards. example: false nullable: true requires_billing_info: type: boolean description: Indicates if the billing address associated to this order requires billing info to be present. example: false nullable: true country_code: type: string description: The international 2-letter country code as defined by the ISO 3166-1 standard, automatically inherited from the order's shipping or billing addresses. example: IT nullable: true shipping_country_code_lock: type: string description: The country code that you want the shipping address to be locked to. This can be useful to make sure the shipping address belongs to a given shipping country, e.g. the one selected in a country selector page. Not relevant if order contains only digital products. example: IT nullable: true coupon_code: type: string description: The coupon code to be used for the order. If valid, it triggers a promotion adding a discount line item to the order. example: SUMMERDISCOUNT nullable: true gift_card_code: type: string description: The gift card code (at least the first 8 characters) to be used for the order. If valid, it uses the gift card balance to pay for the order. example: cc92c23e-967e-48b2-a323-59add603301f nullable: true subtotal_amount_cents: type: integer description: The sum of all the SKU line items total amounts, in cents. example: 5000 nullable: true subtotal_amount_float: type: number description: The sum of all the SKU line items total amounts, float. example: 50.0 nullable: true formatted_subtotal_amount: type: string description: The sum of all the SKU line items total amounts, formatted. example: €50,00 nullable: true shipping_amount_cents: type: integer description: The sum of all the shipping costs, in cents. example: 1200 nullable: true shipping_amount_float: type: number description: The sum of all the shipping costs, float. example: 12.0 nullable: true formatted_shipping_amount: type: string description: The sum of all the shipping costs, formatted. example: €12,00 nullable: true payment_method_amount_cents: type: integer description: The payment method costs, in cents. example: 0 nullable: true payment_method_amount_float: type: number description: The payment method costs, float. example: 0.0 nullable: true formatted_payment_method_amount: type: string description: The payment method costs, formatted. example: €0,00 nullable: true discount_amount_cents: type: integer description: The sum of all the discounts applied to the order, in cents (negative amount). example: -500 nullable: true discount_amount_float: type: number description: The sum of all the discounts applied to the order, float. example: -5.0 nullable: true formatted_discount_amount: type: string description: The sum of all the discounts applied to the order, formatted. example: -€5,00 nullable: true adjustment_amount_cents: type: integer description: The sum of all the adjustments applied to the order, in cents. example: 1500 nullable: true adjustment_amount_float: type: number description: The sum of all the adjustments applied to the order, float. example: 15.0 nullable: true formatted_adjustment_amount: type: string description: The sum of all the adjustments applied to the order, formatted. example: €15,00 nullable: true gift_card_amount_cents: type: integer description: The sum of all the gift_cards applied to the order, in cents. example: 1500 nullable: true gift_card_amount_float: type: number description: The sum of all the gift_cards applied to the order, float. example: 15.0 nullable: true formatted_gift_card_amount: type: string description: The sum of all the gift_cards applied to the order, formatted. example: €15,00 nullable: true total_tax_amount_cents: type: integer description: The sum of all the taxes applied to the order, in cents. example: 1028 nullable: true total_tax_amount_float: type: number description: The sum of all the taxes applied to the order, float. example: 10.28 nullable: true formatted_total_tax_amount: type: string description: The sum of all the taxes applied to the order, formatted. example: €10,28 nullable: true subtotal_tax_amount_cents: type: integer description: The taxes applied to the order's subtotal, in cents. example: 902 nullable: true subtotal_tax_amount_float: type: number description: The taxes applied to the order's subtotal, float. example: 9.02 nullable: true formatted_subtotal_tax_amount: type: string description: The taxes applied to the order's subtotal, formatted. example: €9,02 nullable: true shipping_tax_amount_cents: type: integer description: The taxes applied to the order's shipping costs, in cents. example: 216 nullable: true shipping_tax_amount_float: type: number description: The taxes applied to the order's shipping costs, float. example: 2.16 nullable: true formatted_shipping_tax_amount: type: string description: The taxes applied to the order's shipping costs, formatted. example: €2,16 nullable: true payment_method_tax_amount_cents: type: integer description: The taxes applied to the order's payment method costs, in cents. example: 0 nullable: true payment_method_tax_amount_float: type: number description: The taxes applied to the order's payment method costs, float. example: 0.0 nullable: true formatted_payment_method_tax_amount: type: string description: The taxes applied to the order's payment method costs, formatted. example: €0,00 nullable: true adjustment_tax_amount_cents: type: integer description: The taxes applied to the order adjustments, in cents. example: 900 nullable: true adjustment_tax_amount_float: type: number description: The taxes applied to the order adjustments, float. example: 9.0 nullable: true formatted_adjustment_tax_amount: type: string description: The taxes applied to the order adjustments, formatted. example: €9,00 nullable: true total_amount_cents: type: integer description: The order's total amount, in cents. example: 5700 nullable: true total_amount_float: type: number description: The order's total amount, float. example: 57.0 nullable: true formatted_total_amount: type: string description: The order's total amount, formatted. example: €57,00 nullable: true total_taxable_amount_cents: type: integer description: The order's total taxable amount, in cents (without discounts). example: 4672 nullable: true total_taxable_amount_float: type: number description: The order's total taxable amount, float. example: 46.72 nullable: true formatted_total_taxable_amount: type: string description: The order's total taxable amount, formatted. example: €46,72 nullable: true subtotal_taxable_amount_cents: type: integer description: The order's subtotal taxable amount, in cents (equal to subtotal_amount_cents when prices don't include taxes). example: 4098 nullable: true subtotal_taxable_amount_float: type: number description: The order's subtotal taxable amount, float. example: 40.98 nullable: true formatted_subtotal_taxable_amount: type: string description: The order's subtotal taxable amount, formatted. example: €40,98 nullable: true shipping_taxable_amount_cents: type: integer description: The order's shipping taxable amount, in cents (equal to shipping_amount_cents when prices don't include taxes). example: 984 nullable: true shipping_taxable_amount_float: type: number description: The order's shipping taxable amount, float. example: 9.84 nullable: true formatted_shipping_taxable_amount: type: string description: The order's shipping taxable amount, formatted. example: €9,84 nullable: true payment_method_taxable_amount_cents: type: integer description: The order's payment method taxable amount, in cents (equal to payment_method_amount_cents when prices don't include taxes). example: 0 nullable: true payment_method_taxable_amount_float: type: number description: The order's payment method taxable amount, float. example: 0.0 nullable: true formatted_payment_method_taxable_amount: type: string description: The order's payment method taxable amount, formatted. example: €0,00 nullable: true adjustment_taxable_amount_cents: type: integer description: The order's adjustment taxable amount, in cents (equal to discount_adjustment_cents when prices don't include taxes). example: 120 nullable: true adjustment_taxable_amount_float: type: number description: The order's adjustment taxable amount, float. example: 1.2 nullable: true formatted_adjustment_taxable_amount: type: string description: The order's adjustment taxable amount, formatted. example: €1,20 nullable: true total_amount_with_taxes_cents: type: integer description: The order's total amount (when prices include taxes) or the order's total + taxes amount (when prices don't include taxes, e.g. US Markets or B2B). example: 5700 nullable: true total_amount_with_taxes_float: type: number description: The order's total amount with taxes, float. example: 57.0 nullable: true formatted_total_amount_with_taxes: type: string description: The order's total amount with taxes, formatted. example: €57,00 nullable: true fees_amount_cents: type: integer description: The fees amount that is applied by Commerce Layer, in cents. example: 0 nullable: true fees_amount_float: type: number description: The fees amount that is applied by Commerce Layer, float. example: 0.0 nullable: true formatted_fees_amount: type: string description: The fees amount that is applied by Commerce Layer, formatted. example: €0,00 nullable: true duty_amount_cents: type: integer description: The duty amount that is calculated by external services, in cents. example: 0 nullable: true duty_amount_float: type: number description: The duty amount that is calculated by external services, float. example: 0.0 nullable: true formatted_duty_amount: type: string description: The duty amount that is calculated by external services, formatted. example: €0,00 nullable: true place_total_amount_cents: type: integer description: The total amount at place time, in cents, which is used internally for editing. example: 0 nullable: true place_total_amount_float: type: number description: The total amount at place time, float. example: 0.0 nullable: true formatted_place_total_amount: type: string description: The total amount at place time, formatted. example: €0,00 nullable: true skus_count: type: integer description: The total number of SKUs in the order's line items. This can be useful to display a preview of the customer shopping cart content. example: 2 nullable: true line_item_options_count: type: integer description: The total number of line item options. This can be useful to display a preview of the customer shopping cart content. example: 1 nullable: true shipments_count: type: integer description: The total number of shipments. This can be useful to manage the shipping method(s) selection during checkout. example: 1 nullable: true tax_calculations_count: type: integer description: The total number of tax calculations. This can be useful to monitor external tax service usage. example: 1 nullable: true validations_count: type: integer description: The total number of external validation performed. This can be useful to monitor if external validation has been triggered. example: 1 nullable: true errors_count: type: integer description: The total number of resource errors. example: 1 nullable: true payment_source_details: type: object description: An object that contains the shareable details of the order's payment source. example: foo: bar nullable: true token: type: string description: A unique token that can be shared more securely instead of the order's id. example: 1c0994cc4e996e8c6ee56a2198f66f3c nullable: true cart_url: type: string description: The cart url on your site. If present, it will be used on our hosted checkout application. example: https://yourdomain.com/cart nullable: true return_url: type: string description: The return url on your site. If present, it will be used on our hosted checkout application. example: https://yourdomain.com/ nullable: true terms_url: type: string description: The terms and conditions url on your site. If present, it will be used on our hosted checkout application. example: https://yourdomain.com/terms nullable: true privacy_url: type: string description: The privacy policy url on your site. If present, it will be used on our hosted checkout application. example: https://yourdomain.com/privacy nullable: true checkout_url: type: string description: The checkout url that was automatically generated for the order. Send the customers to this url to let them checkout the order securely on our hosted checkout application. example: https://yourdomain.commercelayer.io/checkout/1c0994cc4e996e8c6ee56a2198f66f3c nullable: true placed_at: type: string description: Time at which the order was placed. example: '2018-01-01T12:00:00.000Z' nullable: true approved_at: type: string description: Time at which the order was approved. example: '2018-01-01T12:00:00.000Z' nullable: true cancelled_at: type: string description: Time at which the order was cancelled. example: '2018-01-01T12:00:00.000Z' nullable: true payment_updated_at: type: string description: Time at which the order's payment status was last updated. example: '2018-01-01T12:00:00.000Z' nullable: true fulfillment_updated_at: type: string description: Time at which the order's fulfillment status was last updated. example: '2018-01-01T12:00:00.000Z' nullable: true refreshed_at: type: string description: Last time at which the order was refreshed. example: '2018-01-01T12:00:00.000Z' nullable: true archived_at: type: string description: Time at which the resource has been archived. example: '2018-01-01T12:00:00.000Z' nullable: true subscription_created_at: type: string description: Time at which the order has been marked to create a subscription from its recurring line items. example: '2018-01-01T12:00:00.000Z' nullable: true expires_at: type: string description: The expiration date/time of this order. Cannot be passed by sales channels. example: '2018-01-02T12:00:00.000Z' nullable: true expiration_info: type: object description: The information related to the order expiration, in case expires_at is not null. Cannot be passed by sales channels. example: summary_message: Your tickets are reserved for the remaining time. expired_message: Your session has expired. Please start your checkout again. redirect_url: https://yourshop.com/ nullable: true circuit_state: type: string description: The circuit breaker state, by default it is 'closed'. It can become 'open' once the number of consecutive failures overlaps the specified threshold, in such case no further calls to the failing callback are made. example: closed nullable: true circuit_failure_count: type: integer description: The number of consecutive failures recorded by the circuit breaker associated to this resource, will be reset on first successful call to callback. example: 5 nullable: true created_at: type: string description: Time at which the resource was created. example: '2018-01-01T12:00:00.000Z' nullable: false updated_at: type: string description: Time at which the resource was last updated. example: '2018-01-01T12:00:00.000Z' nullable: false reference: type: string description: A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever. example: ANY-EXTERNAL-REFEFERNCE nullable: true reference_origin: type: string description: Any identifier of the third party system that defines the reference code. example: ANY-EXTERNAL-REFEFERNCE-ORIGIN nullable: true metadata: type: object description: Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format. example: foo: bar nullable: true paypalPayment: type: object properties: data: type: object required: - type - attributes properties: type: type: string description: The resource's type enum: - paypal_payments attributes: type: object properties: return_url: type: string description: The URL where the payer is redirected after they approve the payment. example: https://yourdomain.com/thankyou nullable: false cancel_url: type: string description: The URL where the payer is redirected after they cancel the payment. example: https://yourdomain.com/checkout/payment nullable: false note_to_payer: type: string description: A free-form field that you can use to send a note to the payer on PayPal. example: Thank you for shopping with us! nullable: true paypal_payer_id: type: string description: The id of the payer that PayPal passes in the return_url. example: ABCDEFGHG123456 nullable: true name: type: string description: The PayPal payer id (if present). example: ABCDEFGHG123456 nullable: true paypal_id: type: string description: The id of the PayPal payment object. example: '1234567890' nullable: true status: type: string description: The PayPal payment status. One of 'created', or 'approved'. example: created nullable: true enum: - created - approved approval_url: type: string description: The URL the customer should be redirected to approve the payment. example: https://www.paypal.com/cgi-bin/webscr?cmd=_express-checkout&token=EC-1234567890ABCDEFGHG nullable: true mismatched_amounts: type: boolean description: Indicates if the order current amount differs form the one of the created payment intent. example: false nullable: true payment_instrument: type: object description: Information about the payment instrument used in the transaction. example: issuer: cl bank card_type: visa nullable: true created_at: type: string description: Time at which the resource was created. example: '2018-01-01T12:00:00.000Z' nullable: false updated_at: type: string description: Time at which the resource was last updated. example: '2018-01-01T12:00:00.000Z' nullable: false reference: type: string description: A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever. example: ANY-EXTERNAL-REFEFERNCE nullable: true reference_origin: type: string description: Any identifier of the third party system that defines the reference code. example: ANY-EXTERNAL-REFEFERNCE-ORIGIN nullable: true metadata: type: object description: Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format. example: foo: bar nullable: true relationships: type: object properties: order: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - orders id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN payment_gateway: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - payment_gateways id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN event_stores: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - event_stores id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN orders_date_breakdown_request: type: object properties: filter: $ref: '#/components/schemas/orders_filter' date_breakdown: type: object description: Check available [fields](#/components/schemas/orders_date_breakdown_request/properties/date_breakdown/properties/field/description) required: - by - field - operator properties: by: type: string description: Field to base your date breakdown query enum: - order.approved_at - order.archived_at - order.cancelled_at - order.created_at - order.fulfillment_updated_at - order.payment_updated_at - order.placed_at - order.updated_at - order.current_date - shipments.cancelled_at - shipments.delivered_at - shipments.on_hold_at - shipments.picking_at - shipments.packing_at - shipments.ready_to_ship_at - shipments.shipped_at - shipments.created_at - shipments.updated_at - resource_errors.created_at - resource_errors.updated_at field: type: string description: "These are the valid values you can specify for the field key of the date_breakdown query and the related valid operators, based on that key:\n\n\n \n| Value | Operators |\n| --- | --------- |\n|**`customer.id`** |

`cardinality`

`value_count`

|\n|**`customer.email`** |

`cardinality`

`value_count`

|\n|**`customer.group_name`** |

`cardinality`

`value_count`

|\n|**`customer.reference`** |

`cardinality`

`value_count`

|\n|**`customer.reference_origin`** |

`cardinality`

`value_count`

|\n|**`line_items.code`** |

`cardinality`

`value_count`

|\n|**`line_items.discount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`line_items.id`** |

`cardinality`

`value_count`

|\n|**`line_items.item_id`** |

`cardinality`

`value_count`

|\n|**`line_items.options_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`line_items.quantity`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`line_items.tax_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`line_items.tax_rate`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`line_items.total_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`line_items.unit_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`line_items.options.id`** |

`cardinality`

`value_count`

|\n|**`line_items.options.quantity`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`line_items.options.total_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`line_items.options.unit_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`market.id`** |

`cardinality`

|\n|**`market.number`** |

`cardinality`

`value_count`

|\n|**`order.adjustment_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.adjustment_tax_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.adjustment_taxable_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.discount_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.duty_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.gift_card_code`** |

`value_count`

|\n|**`order.gift_card_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.id`** |

`cardinality`

`value_count`

|\n|**`order.line_item_options_count`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.number`** |

`value_count`

|\n|**`order.payment_method_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.payment_method_tax_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.payment_method_taxable_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.reference`** |

`cardinality`

`value_count`

|\n|**`order.reference_origin`** |

`cardinality`

`value_count`

|\n|**`order.shipments_count`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.shipping_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.shipping_taxable_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.skus_count`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.subtotal_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.subtotal_tax_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.subtotal_taxable_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.total_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.total_amount_with_taxes`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.total_tax_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.total_taxable_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.seconds_in_draft`** |

`avg`

`max`

`min`

`stats`

`percentiles`

|\n|**`order.seconds_in_approved`** |

`avg`

`max`

`min`

`stats`

`percentiles`

|\n|**`order.seconds_in_placed`** |

`avg`

`max`

`min`

`stats`

`percentiles`

|\n|**`order.refunds_total_amount_with_taxes`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.total_amount_with_taxes_net_of_refunds`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`refunds.id`** |

`value_count`

|\n|**`refunds.amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`refunds.number`** |

`value_count`

|\n|**`shipments.id`** |

`cardinality`

`value_count`

|\n|**`shipments.number`** |

`cardinality`

`value_count`

|\n|**`shipments.items_count`** |

`avg`

`max`

`min`

`stats`

`percentiles`

|\n|**`shipments.cost_amount`** |

`avg`

`max`

`min`

`stats`

`percentiles`

|\n|**`shipments.reference`** |

`cardinality`

`value_count`

|\n|**`shipments.reference_origin`** |

`cardinality`

`value_count`

|\n|**`shipments.seconds_in_picking`** |

`avg`

`max`

`min`

`stats`

`percentiles`

|\n|**`shipments.seconds_in_ready_to_ship`** |

`avg`

`max`

`min`

`stats`

`percentiles`

|\n|**`shipments.seconds_in_shipped`** |

`avg`

`max`

`min`

`stats`

`percentiles`

|\n|**`shipments.fulfillment_time`** |

`avg`

`max`

`min`

`stats`

`percentiles`

|\n|**`shipments.stock_location.id`** |

`cardinality`

`value_count`

|\n|**`shipments.stock_location.reference`** |

`cardinality`

`value_count`

|\n|**`shipments.stock_location.reference_origin`** |

`cardinality`

`value_count`

|\n|**`shipments.shipping_method.id`** |

`cardinality`

`value_count`

|\n|**`shipments.shipping_method.reference`** |

`cardinality`

`value_count`

|\n|**`shipments.shipping_method.reference_origin`** |

`cardinality`

`value_count`

|\n|**`shipments.shipping_category.id`** |

`cardinality`

`value_count`

|\n|**`shipments.shipping_category.reference`** |

`cardinality`

`value_count`

|\n|**`shipments.shipping_category.reference_origin`** |

`cardinality`

`value_count`

|\n|**`resource_errors.code`** |

`cardinality`

`value_count`

|\n|**`resource_errors.id`** |

`cardinality`

`value_count`

|\n|**`resource_errors.message`** |

`cardinality`

`value_count`

|\n" enum: - customer.id - customer.email - customer.group_name - customer.reference - customer.reference_origin - line_items.code - line_items.discount - line_items.id - line_items.item_id - line_items.options_amount - line_items.quantity - line_items.tax_amount - line_items.tax_rate - line_items.total_amount - line_items.unit_amount - line_items.options.id - line_items.options.quantity - line_items.options.total_amount - line_items.options.unit_amount - market.id - market.number - order.adjustment_amount - order.adjustment_tax_amount - order.adjustment_taxable_amount - order.discount_amount - order.duty_amount - order.gift_card_code - order.gift_card_amount - order.id - order.line_item_options_count - order.number - order.payment_method_amount - order.payment_method_tax_amount - order.payment_method_taxable_amount - order.reference - order.reference_origin - order.shipments_count - order.shipping_amount - order.shipping_taxable_amount - order.skus_count - order.subtotal_amount - order.subtotal_tax_amount - order.subtotal_taxable_amount - order.total_amount - order.total_amount_with_taxes - order.total_tax_amount - order.total_taxable_amount - order.seconds_in_draft - order.seconds_in_approved - order.seconds_in_placed - order.refunds_total_amount_with_taxes - order.total_amount_with_taxes_net_of_refunds - refunds.id - refunds.amount - refunds.number - shipments.id - shipments.number - shipments.items_count - shipments.cost_amount - shipments.reference - shipments.reference_origin - shipments.seconds_in_picking - shipments.seconds_in_ready_to_ship - shipments.seconds_in_shipped - shipments.fulfillment_time - shipments.stock_location.id - shipments.stock_location.reference - shipments.stock_location.reference_origin - shipments.shipping_method.id - shipments.shipping_method.reference - shipments.shipping_method.reference_origin - shipments.shipping_category.id - shipments.shipping_category.reference - shipments.shipping_category.reference_origin - resource_errors.code - resource_errors.id - resource_errors.message operator: type: string description: Operator to apply enum: - cardinality - value_count - avg - max - min - sum - stats - percentiles interval: type: string description: Interval to base the date breakdown enum: - day - hour - month - week - year breakdown: type: object description: Check available [fields](#/components/schemas/orders_breakdown_request/properties/breakdown/properties/field/description) required: - by - field - operator properties: by: type: string description: "Field to base your breakdown query.\n\nForbidden nesting\n\n These are the valid values you can specify for the by key of the breakdown query and the related forbidden values for the by key of the nested breakdown, based on the by key of the parent breakdown (i.e. for each row of the table below the full list of the valid values for the by key of the nested breakdown is given by all the values in the \"Value\" column except the values in the row's \"Forbidden nesting\" cell):\n\n\n \n| Value | Forbidden nesting |\n| --- | ------ |\n|**`billing_address.business`** |

`billing_address.geocoded`

`billing_address.localized`

`customer.*`

`shipping_address.*`

`line_items.item_type`

`order.freight_taxable`

`order.fulfillment_status`

`order.payment_status`

`order.status`

|\n|**`billing_address.city`** |

`billing_address.country_code`

`billing_address.state_code`

`customer.*`

`shipping_address.*`

`line_items.item_type`

|\n|**`billing_address.country_code`** |

`customer.*`

`shipping_address.*`

`line_items.item_type`

|\n|**`billing_address.geocoded`** |

`billing_address.*`

`customer.*`

`shipping_address.*`

`line_items.item_type`

|\n|**`billing_address.localized`** |

`billing_address.*`

`customer.*`

`shipping_address.*`

`line_items.item_type`

|\n|**`billing_address.state_code`** |

`billing_address.country_code`

`customer.*`

`shipping_address.*`

`line_items.item_type`

|\n|**`billing_address.zip_code`** |

`billing_address.country_code`

`billing_address.city`

`billing_address.geocoded`

`billing_address.localized`

`customer.*`

`shipping_address.*`

`line_items.item_type`

|\n|**`customer.id`** | |\n|**`customer.email`** | |\n|**`customer.group_name`** | |\n|**`customer.reference`** | |\n|**`customer.reference_origin`** | |\n|**`line_items.code`** | |\n|**`line_items.id`** | |\n|**`line_items.item_id`** | |\n|**`line_items.item_type`** | |\n|**`line_items.name`** | |\n|**`line_items.options.id`** |

`line_items.*`

`shipments.*`

|\n|**`line_items.options.name`** |

`line_items.*`

`shipments.*`

|\n|**`market.id`** |

`billing_address.geocoded`

`billing_address.localized`

`shipping_address.geocoded`

`shipping_address.localized`

`line_items.item_type`

|\n|**`market.name`** | |\n|**`market.number`** | |\n|**`order.customer_type`** | |\n|**`order.country_code`** | |\n|**`order.coupon_code`** | |\n|**`order.currency_code`** | |\n|**`order.freight_taxable`** | |\n|**`order.fulfillment_status`** | |\n|**`order.gift_card_code`** | |\n|**`order.guest`** | |\n|**`order.language_code`** | |\n|**`order.payment_status`** | |\n|**`order.reference`** | |\n|**`order.reference_origin`** | |\n|**`order.status`** | |\n|**`order.tax_included`** | |\n|**`order.placed_day_of_week`** | |\n|**`order.link_id`** | |\n|**`order.user_id`** | |\n|**`order.store_id`** | |\n|**`order.affiliate_code`** | |\n|**`payment_method.id`** | |\n|**`payment_method.source_type`** | |\n|**`payment_method.name`** | |\n|**`payment_method.moto`** | |\n|**`payment_method.issuer`** | |\n|**`payment_method.issuer_type`** | |\n|**`payment_method.card_type`** | |\n|**`shipping_address.business`** |

`shipping_address.geocoded`

`shipping_address.localized`

`customer.*`

`billing_address.*`

`line_items.item_type`

`order.freight_taxable`

`order.fulfillment_status`

`order.payment_status`

`order.status`

|\n|**`shipping_address.city`** |

`shipping_address.country_code`

`shipping_address.state_code`

`customer.*`

`billing_address.*`

`line_items.item_type`

|\n|**`shipping_address.country_code`** |

`customer.*`

`billing_address.*`

`line_items.item_type`

|\n|**`shipping_address.geocoded`** |

`billing_address.*`

`customer.*`

`shipping_address.*`

`line_items.item_type`

|\n|**`shipping_address.localized`** |

`billing_address.*`

`customer.*`

`shipping_address.*`

`line_items.item_type`

|\n|**`shipping_address.state_code`** |

`shipping_address.country_code`

`customer.*`

`billing_address.*`

`line_items.item_type`

|\n|**`shipping_address.zip_code`** |

`shipping_address.country_code`

`shipping_address.city`

`shipping_address.geocoded`

`shipping_address.localized`

`customer.*`

`billing_address.*`

`line_items.item_type`

|\n|**`shipments.status`** | |\n|**`shipments.reference`** | |\n|**`shipments.reference_origin`** | |\n|**`shipments.items`** | |\n|**`shipments.stock_location.name`** | |\n|**`shipments.stock_location.reference`** | |\n|**`shipments.stock_location.reference_origin`** | |\n|**`shipments.shipping_method.id`** | |\n|**`shipments.shipping_method.name`** | |\n|**`shipments.shipping_method.reference`** | |\n|**`shipments.shipping_method.reference_origin`** | |\n|**`shipments.shipping_method.currency_code`** | |\n|**`shipments.shipping_category.name`** | |\n|**`shipments.shipping_category.reference`** | |\n|**`shipments.shipping_category.reference_origin`** | |\n|**`shipments.tags.id`** | |\n|**`shipments.tags.name`** | |\n|**`tags.id`** | |\n|**`tags.name`** | |\n|**`resource_errors.code`** | |\n|**`resource_errors.name`** | |\n|**`resource_errors.id`** | |\n|**`resource_errors.message`** | |\n" enum: - billing_address.business - billing_address.city - billing_address.country_code - billing_address.geocoded - billing_address.localized - billing_address.state_code - billing_address.zip_code - customer.id - customer.email - customer.group_name - customer.reference - customer.reference_origin - line_items.code - line_items.id - line_items.item_id - line_items.item_type - line_items.name - line_items.options.id - line_items.options.name - market.id - market.name - market.number - organization.id - organization.name - organization.slug - order.customer_type - order.country_code - order.coupon_code - order.currency_code - order.freight_taxable - order.fulfillment_status - order.gift_card_code - order.guest - order.language_code - order.mode - order.payment_status - order.reference - order.reference_origin - order.status - order.tax_included - order.placed_day_of_week - order.link_id - order.user_id - order.store_id - order.affiliate_code - payment_method.id - payment_method.source_type - payment_method.name - payment_method.moto - payment_method.issuer - payment_method.issuer_type - payment_method.card_type - shipping_address.business - shipping_address.city - shipping_address.country_code - shipping_address.geocoded - shipping_address.localized - shipping_address.state_code - shipping_address.zip_code - shipments.status - shipments.reference - shipments.reference_origin - shipments.items - shipments.stock_location.name - shipments.stock_location.reference - shipments.stock_location.reference_origin - shipments.shipping_method.id - shipments.shipping_method.name - shipments.shipping_method.reference - shipments.shipping_method.reference_origin - shipments.shipping_method.currency_code - shipments.shipping_category.name - shipments.shipping_category.reference - shipments.shipping_category.reference_origin - shipments.tags.id - shipments.tags.name - tags.id - tags.name - resource_errors.code - resource_errors.name - resource_errors.id - resource_errors.message field: type: string description: "These are the valid values you can specify for the field key of the breakdown query and the related valid operators, based on that key:\n\n\n \n| Value | Operators |\n| --- | --------- |\n|**`customer.id`** |

`cardinality`

`value_count`

|\n|**`customer.email`** |

`cardinality`

`value_count`

|\n|**`customer.group_name`** |

`cardinality`

`value_count`

|\n|**`customer.reference`** |

`cardinality`

`value_count`

|\n|**`customer.reference_origin`** |

`cardinality`

`value_count`

|\n|**`line_items.code`** |

`cardinality`

`value_count`

|\n|**`line_items.discount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`line_items.id`** |

`cardinality`

`value_count`

|\n|**`line_items.item_id`** |

`cardinality`

`value_count`

|\n|**`line_items.options_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`line_items.quantity`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`line_items.tax_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`line_items.tax_rate`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`line_items.total_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`line_items.unit_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`line_items.options.id`** |

`cardinality`

`value_count`

|\n|**`line_items.options.quantity`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`line_items.options.total_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`line_items.options.unit_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`market.id`** |

`cardinality`

|\n|**`market.number`** |

`cardinality`

`value_count`

|\n|**`order.adjustment_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.adjustment_tax_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.adjustment_taxable_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.discount_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.duty_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.gift_card_code`** |

`value_count`

|\n|**`order.gift_card_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.id`** |

`cardinality`

`value_count`

|\n|**`order.line_item_options_count`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.number`** |

`value_count`

|\n|**`order.payment_method_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.payment_method_tax_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.payment_method_taxable_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.reference`** |

`cardinality`

`value_count`

|\n|**`order.reference_origin`** |

`cardinality`

`value_count`

|\n|**`order.shipments_count`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.shipping_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.shipping_taxable_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.skus_count`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.subtotal_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.subtotal_tax_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.subtotal_taxable_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.total_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.total_amount_with_taxes`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.total_tax_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.total_taxable_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.seconds_in_draft`** |

`avg`

`max`

`min`

`stats`

`percentiles`

|\n|**`order.seconds_in_approved`** |

`avg`

`max`

`min`

`stats`

`percentiles`

|\n|**`order.seconds_in_placed`** |

`avg`

`max`

`min`

`stats`

`percentiles`

|\n|**`order.refunds_total_amount_with_taxes`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.total_amount_with_taxes_net_of_refunds`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`refunds.id`** |

`value_count`

|\n|**`refunds.amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`refunds.number`** |

`value_count`

|\n|**`shipments.id`** |

`cardinality`

`value_count`

|\n|**`shipments.number`** |

`cardinality`

`value_count`

|\n|**`shipments.items_count`** |

`avg`

`max`

`min`

`stats`

`percentiles`

|\n|**`shipments.cost_amount`** |

`avg`

`max`

`min`

`stats`

`percentiles`

|\n|**`shipments.reference`** |

`cardinality`

`value_count`

|\n|**`shipments.reference_origin`** |

`cardinality`

`value_count`

|\n|**`shipments.seconds_in_picking`** |

`avg`

`max`

`min`

`stats`

`percentiles`

|\n|**`shipments.seconds_in_ready_to_ship`** |

`avg`

`max`

`min`

`stats`

`percentiles`

|\n|**`shipments.seconds_in_shipped`** |

`avg`

`max`

`min`

`stats`

`percentiles`

|\n|**`shipments.fulfillment_time`** |

`avg`

`max`

`min`

`stats`

`percentiles`

|\n|**`shipments.stock_location.id`** |

`cardinality`

`value_count`

|\n|**`shipments.stock_location.reference`** |

`cardinality`

`value_count`

|\n|**`shipments.stock_location.reference_origin`** |

`cardinality`

`value_count`

|\n|**`shipments.shipping_method.id`** |

`cardinality`

`value_count`

|\n|**`shipments.shipping_method.reference`** |

`cardinality`

`value_count`

|\n|**`shipments.shipping_method.reference_origin`** |

`cardinality`

`value_count`

|\n|**`shipments.shipping_category.id`** |

`cardinality`

`value_count`

|\n|**`shipments.shipping_category.reference`** |

`cardinality`

`value_count`

|\n|**`shipments.shipping_category.reference_origin`** |

`cardinality`

`value_count`

|\n|**`resource_errors.code`** |

`cardinality`

`value_count`

|\n|**`resource_errors.id`** |

`cardinality`

`value_count`

|\n|**`resource_errors.message`** |

`cardinality`

`value_count`

|\n" enum: - customer.id - customer.email - customer.group_name - customer.reference - customer.reference_origin - line_items.code - line_items.discount - line_items.id - line_items.item_id - line_items.options_amount - line_items.quantity - line_items.tax_amount - line_items.tax_rate - line_items.total_amount - line_items.unit_amount - line_items.options.id - line_items.options.quantity - line_items.options.total_amount - line_items.options.unit_amount - market.id - market.number - order.adjustment_amount - order.adjustment_tax_amount - order.adjustment_taxable_amount - order.discount_amount - order.duty_amount - order.gift_card_code - order.gift_card_amount - order.id - order.line_item_options_count - order.number - order.payment_method_amount - order.payment_method_tax_amount - order.payment_method_taxable_amount - order.reference - order.reference_origin - order.shipments_count - order.shipping_amount - order.shipping_taxable_amount - order.skus_count - order.subtotal_amount - order.subtotal_tax_amount - order.subtotal_taxable_amount - order.total_amount - order.total_amount_with_taxes - order.total_tax_amount - order.total_taxable_amount - order.seconds_in_draft - order.seconds_in_approved - order.seconds_in_placed - order.refunds_total_amount_with_taxes - order.total_amount_with_taxes_net_of_refunds - refunds.id - refunds.amount - refunds.number - shipments.id - shipments.number - shipments.items_count - shipments.cost_amount - shipments.reference - shipments.reference_origin - shipments.seconds_in_picking - shipments.seconds_in_ready_to_ship - shipments.seconds_in_shipped - shipments.fulfillment_time - shipments.stock_location.id - shipments.stock_location.reference - shipments.stock_location.reference_origin - shipments.shipping_method.id - shipments.shipping_method.reference - shipments.shipping_method.reference_origin - shipments.shipping_category.id - shipments.shipping_category.reference - shipments.shipping_category.reference_origin - resource_errors.code - resource_errors.id - resource_errors.message operator: type: string description: Operator to apply enum: - cardinality - value_count - avg - max - min - sum - stats - percentiles sort: type: string description: Result sorting enum: - asc - desc limit: type: integer description: Results limit default: 10 maximum: 100 condition: description: Condition to filter the data over the breakdown result, value of the operator must be a Number or Array of numbers if operator is a range oneOf: - type: object properties: eq: type: number - type: object properties: ne: type: number - type: object properties: gt: type: number - type: object properties: gte: type: number - type: object properties: lt: type: number - type: object properties: lte: type: number - type: object properties: gt_lt: type: array items: type: number - type: object properties: gte_lte: type: array items: type: number - type: object properties: gte_lt: type: array items: type: number - type: object properties: gt_lte: type: array items: type: number additionalProperties: false breakdown: type: object properties: by: type: string description: "Field to base your breakdown query.\n\nForbidden nesting\n\n These are the valid values you can specify for the by key of the breakdown query and the related forbidden values for the by key of the nested breakdown, based on the by key of the parent breakdown (i.e. for each row of the table below the full list of the valid values for the by key of the nested breakdown is given by all the values in the \"Value\" column except the values in the row's \"Forbidden nesting\" cell):\n\n\n \n| Value | Forbidden nesting |\n| --- | ------ |\n|**`billing_address.business`** |

`billing_address.geocoded`

`billing_address.localized`

`customer.*`

`shipping_address.*`

`line_items.item_type`

`order.freight_taxable`

`order.fulfillment_status`

`order.payment_status`

`order.status`

|\n|**`billing_address.city`** |

`billing_address.country_code`

`billing_address.state_code`

`customer.*`

`shipping_address.*`

`line_items.item_type`

|\n|**`billing_address.country_code`** |

`customer.*`

`shipping_address.*`

`line_items.item_type`

|\n|**`billing_address.geocoded`** |

`billing_address.*`

`customer.*`

`shipping_address.*`

`line_items.item_type`

|\n|**`billing_address.localized`** |

`billing_address.*`

`customer.*`

`shipping_address.*`

`line_items.item_type`

|\n|**`billing_address.state_code`** |

`billing_address.country_code`

`customer.*`

`shipping_address.*`

`line_items.item_type`

|\n|**`billing_address.zip_code`** |

`billing_address.country_code`

`billing_address.city`

`billing_address.geocoded`

`billing_address.localized`

`customer.*`

`shipping_address.*`

`line_items.item_type`

|\n|**`customer.id`** | |\n|**`customer.email`** | |\n|**`customer.group_name`** | |\n|**`customer.reference`** | |\n|**`customer.reference_origin`** | |\n|**`line_items.code`** | |\n|**`line_items.id`** | |\n|**`line_items.item_id`** | |\n|**`line_items.item_type`** | |\n|**`line_items.name`** | |\n|**`line_items.options.id`** |

`line_items.*`

`shipments.*`

|\n|**`line_items.options.name`** |

`line_items.*`

`shipments.*`

|\n|**`market.id`** |

`billing_address.geocoded`

`billing_address.localized`

`shipping_address.geocoded`

`shipping_address.localized`

`line_items.item_type`

|\n|**`market.name`** | |\n|**`market.number`** | |\n|**`order.customer_type`** | |\n|**`order.country_code`** | |\n|**`order.coupon_code`** | |\n|**`order.currency_code`** | |\n|**`order.freight_taxable`** | |\n|**`order.fulfillment_status`** | |\n|**`order.gift_card_code`** | |\n|**`order.guest`** | |\n|**`order.language_code`** | |\n|**`order.payment_status`** | |\n|**`order.reference`** | |\n|**`order.reference_origin`** | |\n|**`order.status`** | |\n|**`order.tax_included`** | |\n|**`order.placed_day_of_week`** | |\n|**`order.link_id`** | |\n|**`order.user_id`** | |\n|**`order.store_id`** | |\n|**`order.affiliate_code`** | |\n|**`payment_method.id`** | |\n|**`payment_method.source_type`** | |\n|**`payment_method.name`** | |\n|**`payment_method.moto`** | |\n|**`payment_method.issuer`** | |\n|**`payment_method.issuer_type`** | |\n|**`payment_method.card_type`** | |\n|**`shipping_address.business`** |

`shipping_address.geocoded`

`shipping_address.localized`

`customer.*`

`billing_address.*`

`line_items.item_type`

`order.freight_taxable`

`order.fulfillment_status`

`order.payment_status`

`order.status`

|\n|**`shipping_address.city`** |

`shipping_address.country_code`

`shipping_address.state_code`

`customer.*`

`billing_address.*`

`line_items.item_type`

|\n|**`shipping_address.country_code`** |

`customer.*`

`billing_address.*`

`line_items.item_type`

|\n|**`shipping_address.geocoded`** |

`billing_address.*`

`customer.*`

`shipping_address.*`

`line_items.item_type`

|\n|**`shipping_address.localized`** |

`billing_address.*`

`customer.*`

`shipping_address.*`

`line_items.item_type`

|\n|**`shipping_address.state_code`** |

`shipping_address.country_code`

`customer.*`

`billing_address.*`

`line_items.item_type`

|\n|**`shipping_address.zip_code`** |

`shipping_address.country_code`

`shipping_address.city`

`shipping_address.geocoded`

`shipping_address.localized`

`customer.*`

`billing_address.*`

`line_items.item_type`

|\n|**`shipments.status`** | |\n|**`shipments.reference`** | |\n|**`shipments.reference_origin`** | |\n|**`shipments.items`** | |\n|**`shipments.stock_location.name`** | |\n|**`shipments.stock_location.reference`** | |\n|**`shipments.stock_location.reference_origin`** | |\n|**`shipments.shipping_method.id`** | |\n|**`shipments.shipping_method.name`** | |\n|**`shipments.shipping_method.reference`** | |\n|**`shipments.shipping_method.reference_origin`** | |\n|**`shipments.shipping_method.currency_code`** | |\n|**`shipments.shipping_category.name`** | |\n|**`shipments.shipping_category.reference`** | |\n|**`shipments.shipping_category.reference_origin`** | |\n|**`shipments.tags.id`** | |\n|**`shipments.tags.name`** | |\n|**`tags.id`** | |\n|**`tags.name`** | |\n|**`resource_errors.code`** | |\n|**`resource_errors.name`** | |\n|**`resource_errors.id`** | |\n|**`resource_errors.message`** | |\n" enum: - billing_address.business - billing_address.city - billing_address.country_code - billing_address.geocoded - billing_address.localized - billing_address.state_code - billing_address.zip_code - customer.id - customer.email - customer.group_name - customer.reference - customer.reference_origin - line_items.code - line_items.id - line_items.item_id - line_items.item_type - line_items.name - line_items.options.id - line_items.options.name - market.id - market.name - market.number - organization.id - organization.name - organization.slug - order.customer_type - order.country_code - order.coupon_code - order.currency_code - order.freight_taxable - order.fulfillment_status - order.gift_card_code - order.guest - order.language_code - order.mode - order.payment_status - order.reference - order.reference_origin - order.status - order.tax_included - order.placed_day_of_week - order.link_id - order.user_id - order.store_id - order.affiliate_code - payment_method.id - payment_method.source_type - payment_method.name - payment_method.moto - payment_method.issuer - payment_method.issuer_type - payment_method.card_type - shipping_address.business - shipping_address.city - shipping_address.country_code - shipping_address.geocoded - shipping_address.localized - shipping_address.state_code - shipping_address.zip_code - shipments.status - shipments.reference - shipments.reference_origin - shipments.items - shipments.stock_location.name - shipments.stock_location.reference - shipments.stock_location.reference_origin - shipments.shipping_method.id - shipments.shipping_method.name - shipments.shipping_method.reference - shipments.shipping_method.reference_origin - shipments.shipping_method.currency_code - shipments.shipping_category.name - shipments.shipping_category.reference - shipments.shipping_category.reference_origin - shipments.tags.id - shipments.tags.name - tags.id - tags.name - resource_errors.code - resource_errors.name - resource_errors.id - resource_errors.message field: type: string description: "These are the valid values you can specify for the field key of the breakdown query and the related valid operators, based on that key:\n\n\n \n| Value | Operators |\n| --- | --------- |\n|**`customer.id`** |

`cardinality`

`value_count`

|\n|**`customer.email`** |

`cardinality`

`value_count`

|\n|**`customer.group_name`** |

`cardinality`

`value_count`

|\n|**`customer.reference`** |

`cardinality`

`value_count`

|\n|**`customer.reference_origin`** |

`cardinality`

`value_count`

|\n|**`line_items.code`** |

`cardinality`

`value_count`

|\n|**`line_items.discount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`line_items.id`** |

`cardinality`

`value_count`

|\n|**`line_items.item_id`** |

`cardinality`

`value_count`

|\n|**`line_items.options_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`line_items.quantity`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`line_items.tax_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`line_items.tax_rate`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`line_items.total_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`line_items.unit_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`line_items.options.id`** |

`cardinality`

`value_count`

|\n|**`line_items.options.quantity`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`line_items.options.total_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`line_items.options.unit_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`market.id`** |

`cardinality`

|\n|**`market.number`** |

`cardinality`

`value_count`

|\n|**`order.adjustment_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.adjustment_tax_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.adjustment_taxable_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.discount_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.duty_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.gift_card_code`** |

`value_count`

|\n|**`order.gift_card_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.id`** |

`cardinality`

`value_count`

|\n|**`order.line_item_options_count`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.number`** |

`value_count`

|\n|**`order.payment_method_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.payment_method_tax_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.payment_method_taxable_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.reference`** |

`cardinality`

`value_count`

|\n|**`order.reference_origin`** |

`cardinality`

`value_count`

|\n|**`order.shipments_count`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.shipping_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.shipping_taxable_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.skus_count`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.subtotal_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.subtotal_tax_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.subtotal_taxable_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.total_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.total_amount_with_taxes`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.total_tax_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.total_taxable_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.seconds_in_draft`** |

`avg`

`max`

`min`

`stats`

`percentiles`

|\n|**`order.seconds_in_approved`** |

`avg`

`max`

`min`

`stats`

`percentiles`

|\n|**`order.seconds_in_placed`** |

`avg`

`max`

`min`

`stats`

`percentiles`

|\n|**`order.refunds_total_amount_with_taxes`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.total_amount_with_taxes_net_of_refunds`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`refunds.id`** |

`value_count`

|\n|**`refunds.amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`refunds.number`** |

`value_count`

|\n|**`shipments.id`** |

`cardinality`

`value_count`

|\n|**`shipments.number`** |

`cardinality`

`value_count`

|\n|**`shipments.items_count`** |

`avg`

`max`

`min`

`stats`

`percentiles`

|\n|**`shipments.cost_amount`** |

`avg`

`max`

`min`

`stats`

`percentiles`

|\n|**`shipments.reference`** |

`cardinality`

`value_count`

|\n|**`shipments.reference_origin`** |

`cardinality`

`value_count`

|\n|**`shipments.seconds_in_picking`** |

`avg`

`max`

`min`

`stats`

`percentiles`

|\n|**`shipments.seconds_in_ready_to_ship`** |

`avg`

`max`

`min`

`stats`

`percentiles`

|\n|**`shipments.seconds_in_shipped`** |

`avg`

`max`

`min`

`stats`

`percentiles`

|\n|**`shipments.fulfillment_time`** |

`avg`

`max`

`min`

`stats`

`percentiles`

|\n|**`shipments.stock_location.id`** |

`cardinality`

`value_count`

|\n|**`shipments.stock_location.reference`** |

`cardinality`

`value_count`

|\n|**`shipments.stock_location.reference_origin`** |

`cardinality`

`value_count`

|\n|**`shipments.shipping_method.id`** |

`cardinality`

`value_count`

|\n|**`shipments.shipping_method.reference`** |

`cardinality`

`value_count`

|\n|**`shipments.shipping_method.reference_origin`** |

`cardinality`

`value_count`

|\n|**`shipments.shipping_category.id`** |

`cardinality`

`value_count`

|\n|**`shipments.shipping_category.reference`** |

`cardinality`

`value_count`

|\n|**`shipments.shipping_category.reference_origin`** |

`cardinality`

`value_count`

|\n|**`resource_errors.code`** |

`cardinality`

`value_count`

|\n|**`resource_errors.id`** |

`cardinality`

`value_count`

|\n|**`resource_errors.message`** |

`cardinality`

`value_count`

|\n" enum: - customer.id - customer.email - customer.group_name - customer.reference - customer.reference_origin - line_items.code - line_items.discount - line_items.id - line_items.item_id - line_items.options_amount - line_items.quantity - line_items.tax_amount - line_items.tax_rate - line_items.total_amount - line_items.unit_amount - line_items.options.id - line_items.options.quantity - line_items.options.total_amount - line_items.options.unit_amount - market.id - market.number - order.adjustment_amount - order.adjustment_tax_amount - order.adjustment_taxable_amount - order.discount_amount - order.duty_amount - order.gift_card_code - order.gift_card_amount - order.id - order.line_item_options_count - order.number - order.payment_method_amount - order.payment_method_tax_amount - order.payment_method_taxable_amount - order.reference - order.reference_origin - order.shipments_count - order.shipping_amount - order.shipping_taxable_amount - order.skus_count - order.subtotal_amount - order.subtotal_tax_amount - order.subtotal_taxable_amount - order.total_amount - order.total_amount_with_taxes - order.total_tax_amount - order.total_taxable_amount - order.seconds_in_draft - order.seconds_in_approved - order.seconds_in_placed - order.refunds_total_amount_with_taxes - order.total_amount_with_taxes_net_of_refunds - refunds.id - refunds.amount - refunds.number - shipments.id - shipments.number - shipments.items_count - shipments.cost_amount - shipments.reference - shipments.reference_origin - shipments.seconds_in_picking - shipments.seconds_in_ready_to_ship - shipments.seconds_in_shipped - shipments.fulfillment_time - shipments.stock_location.id - shipments.stock_location.reference - shipments.stock_location.reference_origin - shipments.shipping_method.id - shipments.shipping_method.reference - shipments.shipping_method.reference_origin - shipments.shipping_category.id - shipments.shipping_category.reference - shipments.shipping_category.reference_origin - resource_errors.code - resource_errors.id - resource_errors.message operator: type: string description: Operator to apply enum: - cardinality - value_count - avg - max - min - sum - stats - percentiles sort: type: string description: Result sorting enum: - asc - desc limit: type: integer description: Results limit default: 10 maximum: 100 condition: description: Condition to filter the data over the breakdown result, value of the operator must be a Number or Array of numbers if operator is a range oneOf: - type: object properties: eq: type: number - type: object properties: ne: type: number - type: object properties: gt: type: number - type: object properties: gte: type: number - type: object properties: lt: type: number - type: object properties: lte: type: number - type: object properties: gt_lt: type: array items: type: number - type: object properties: gte_lte: type: array items: type: number - type: object properties: gte_lt: type: array items: type: number - type: object properties: gt_lte: type: array items: type: number additionalProperties: false required: - by - field - operator meta: type: object properties: payload: type: boolean description: Set to true if you want to receive how the payload has been made orderResponse: type: object properties: data: type: object properties: id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN type: type: string description: The resource's type enum: - orders links: type: object properties: self: type: string description: URL attributes: $ref: '#/components/schemas/order/properties/data/properties/attributes' relationships: type: object properties: market: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - market id: type: string description: The resource ID customer: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - customer id: type: string description: The resource ID shipping_address: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - shipping_address id: type: string description: The resource ID billing_address: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - billing_address id: type: string description: The resource ID store: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - store id: type: string description: The resource ID default_shipping_method: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - default_shipping_method id: type: string description: The resource ID default_payment_method: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - default_payment_method id: type: string description: The resource ID available_payment_methods: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - available_payment_methods id: type: string description: The resource ID available_customer_payment_sources: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - available_customer_payment_sources id: type: string description: The resource ID available_free_skus: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - available_free_skus id: type: string description: The resource ID available_free_bundles: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - available_free_bundles id: type: string description: The resource ID payment_method: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - payment_method id: type: string description: The resource ID payment_source: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - payment_source id: type: string description: The resource ID discount_engine_item: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - discount_engine_item id: type: string description: The resource ID line_items: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - line_items id: type: string description: The resource ID line_item_options: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - line_item_options id: type: string description: The resource ID stock_reservations: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - stock_reservations id: type: string description: The resource ID stock_line_items: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - stock_line_items id: type: string description: The resource ID stock_transfers: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - stock_transfers id: type: string description: The resource ID shipments: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - shipments id: type: string description: The resource ID payment_options: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - payment_options id: type: string description: The resource ID transactions: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - transactions id: type: string description: The resource ID authorizations: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - authorizations id: type: string description: The resource ID captures: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - captures id: type: string description: The resource ID voids: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - voids id: type: string description: The resource ID refunds: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - refunds id: type: string description: The resource ID returns: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - returns id: type: string description: The resource ID order_subscription: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - order_subscription id: type: string description: The resource ID order_subscriptions: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - order_subscriptions id: type: string description: The resource ID order_factories: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - order_factories id: type: string description: The resource ID order_copies: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - order_copies id: type: string description: The resource ID recurring_order_copies: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - recurring_order_copies id: type: string description: The resource ID attachments: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - attachments id: type: string description: The resource ID notifications: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - notifications id: type: string description: The resource ID links: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - links id: type: string description: The resource ID resource_errors: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - resource_errors id: type: string description: The resource ID events: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - events id: type: string description: The resource ID tags: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - tags id: type: string description: The resource ID event_stores: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - event_stores id: type: string description: The resource ID orders_filter: type: object properties: billing_address: type: object properties: business: type: boolean description: Indicates if the address is a business or a personal one. cities: description: The city specified in the address. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of cities - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of cities country_codes: description: The international 2-letter country code (as defined by the [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) standard) specified in the address. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of country_codes - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of country_codes geocoded: type: boolean description: Indicates if the address has been successfully geocoded. localized: type: boolean description: Indicates if the latitude and longitude of the address are present, either geocoded or manually updated. state_codes: description: The state, province or region code specified in the address. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of state_codes - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of state_codes zip_codes: description: The ZIP or postal code specified in the address. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of zip_codes - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of zip_codes companies: description: The company specified in the address. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of companies - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of companies first_names: description: The first name specified in the address. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of first_names - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of first_names last_names: description: The last name specified in the address. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of last_names - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of last_names customer: type: object properties: ids: description: The ID of the customer. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of ids - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of ids emails: description: The email address of the customer. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of emails - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of emails group_names: description: The name of the customer group the customer belongs to (if any). oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of group_names - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of group_names references: description: Any external identifier that might be useful to link the customer resource to other systems through the Commerce Layer core API. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of references - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of references reference_origins: description: Any identifier of the 3rd-party system that defines the reference code. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of reference_origins - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of reference_origins line_items: type: object properties: codes: description: The code of the associated SKU or bundle. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of codes - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of codes discount: description: The discount applied to the line item (float). oneOf: - type: object properties: eq: description: Equals to discount type: number - type: object properties: ne: description: Not equal discount type: number - type: object properties: gt: type: number description: Greater than discount - type: object properties: gte: type: number description: Greater than equal discount - type: object properties: lt: type: number description: Less than discount - type: object properties: lte: type: number description: Less than equal discount - type: object properties: gt_lt: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than, less than discount - type: object properties: gte_lte: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than equal, less than equal discount - type: object properties: gte_lt: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than equal, less than discount - type: object properties: gt_lte: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than, less than equal discount ids: description: The ID of the line item. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of ids - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of ids item_ids: description: The ID of the associated item. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of item_ids - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of item_ids types: description: The type of the associated item. One of `sku`, `bundle`, `shipment`, `payment_method`, `adjustment`, `gift_card`, or a valid promotion type (e.g. `percentage_discount_promotion`, `free_shipping_promotion`, etc.). oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of types - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of types names: description: The name of the line item. When missing, it gets populated with the name of the associated item (if present). oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of names - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of names options_amount: description: The amount of the line item option (float). oneOf: - type: object properties: eq: description: Equals to options_amount type: number - type: object properties: ne: description: Not equal options_amount type: number - type: object properties: gt: type: number description: Greater than options_amount - type: object properties: gte: type: number description: Greater than equal options_amount - type: object properties: lt: type: number description: Less than options_amount - type: object properties: lte: type: number description: Less than equal options_amount - type: object properties: gt_lt: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than, less than options_amount - type: object properties: gte_lte: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than equal, less than equal options_amount - type: object properties: gte_lt: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than equal, less than options_amount - type: object properties: gt_lte: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than, less than equal options_amount quantity: description: The line item's quantity. oneOf: - type: object properties: eq: description: Equals to quantity type: integer - type: object properties: ne: description: Not equal quantity type: integer - type: object properties: gt: type: integer description: Greater than quantity - type: object properties: gte: type: integer description: Greater than equal quantity - type: object properties: lt: type: integer description: Less than quantity - type: object properties: lte: type: integer description: Less than equal quantity - type: object properties: gt_lt: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than, less than quantity - type: object properties: gte_lte: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than equal, less than equal quantity - type: object properties: gte_lt: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than equal, less than quantity - type: object properties: gt_lte: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than, less than equal quantity tax_amount: description: The collected tax amount for the line item (float). Otherwise calculated as the line item's `(total_amount - discount) * tax_rate` (float). oneOf: - type: object properties: eq: description: Equals to tax_amount type: number - type: object properties: ne: description: Not equal tax_amount type: number - type: object properties: gt: type: number description: Greater than tax_amount - type: object properties: gte: type: number description: Greater than equal tax_amount - type: object properties: lt: type: number description: Less than tax_amount - type: object properties: lte: type: number description: Less than equal tax_amount - type: object properties: gt_lt: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than, less than tax_amount - type: object properties: gte_lte: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than equal, less than equal tax_amount - type: object properties: gte_lt: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than equal, less than tax_amount - type: object properties: gt_lte: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than, less than equal tax_amount tax_rate: description: The tax rate for the line item (if calculated). oneOf: - type: object properties: eq: description: Equals to tax_rate type: number - type: object properties: ne: description: Not equal tax_rate type: number - type: object properties: gt: type: number description: Greater than tax_rate - type: object properties: gte: type: number description: Greater than equal tax_rate - type: object properties: lt: type: number description: Less than tax_rate - type: object properties: lte: type: number description: Less than equal tax_rate - type: object properties: gt_lt: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than, less than tax_rate - type: object properties: gte_lte: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than equal, less than equal tax_rate - type: object properties: gte_lt: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than equal, less than tax_rate - type: object properties: gt_lte: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than, less than equal tax_rate total_amount: description: The total amount of the line item (float). Calculated as the line item's `unit_amount * quantity` + plus the associated line item options amount. oneOf: - type: object properties: eq: description: Equals to total_amount type: number - type: object properties: ne: description: Not equal total_amount type: number - type: object properties: gt: type: number description: Greater than total_amount - type: object properties: gte: type: number description: Greater than equal total_amount - type: object properties: lt: type: number description: Less than total_amount - type: object properties: lte: type: number description: Less than equal total_amount - type: object properties: gt_lt: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than, less than total_amount - type: object properties: gte_lte: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than equal, less than equal total_amount - type: object properties: gte_lt: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than equal, less than total_amount - type: object properties: gt_lte: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than, less than equal total_amount unit_amount: description: The unit amount of the line item (float). oneOf: - type: object properties: eq: description: Equals to unit_amount type: number - type: object properties: ne: description: Not equal unit_amount type: number - type: object properties: gt: type: number description: Greater than unit_amount - type: object properties: gte: type: number description: Greater than equal unit_amount - type: object properties: lt: type: number description: Less than unit_amount - type: object properties: lte: type: number description: Less than equal unit_amount - type: object properties: gt_lt: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than, less than unit_amount - type: object properties: gte_lte: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than equal, less than equal unit_amount - type: object properties: gte_lt: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than equal, less than unit_amount - type: object properties: gt_lte: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than, less than equal unit_amount updated_at: description: The date and time at which the line item was last updated (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard). oneOf: - type: object properties: eq: description: Equals to updated_at type: string - type: object properties: ne: description: Not equal updated_at type: string - type: object properties: gt: type: string description: Greater than updated_at - type: object properties: gte: type: string description: Greater than equal updated_at - type: object properties: lt: type: string description: Less than updated_at - type: object properties: lte: type: string description: Less than equal updated_at - type: object properties: gt_lt: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than, less than updated_at - type: object properties: gte_lte: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than equal, less than equal updated_at - type: object properties: gte_lt: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than equal, less than updated_at - type: object properties: gt_lte: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than, less than equal updated_at line_items.options: type: object properties: ids: description: The ID of the line item option. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of ids - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of ids names: description: The name of the line item option. When missing, it gets populated with the name of the associated SKU option. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of names - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of names quantity: description: The line item option's quantity. oneOf: - type: object properties: eq: description: Equals to quantity type: integer - type: object properties: ne: description: Not equal quantity type: integer - type: object properties: gt: type: integer description: Greater than quantity - type: object properties: gte: type: integer description: Greater than equal quantity - type: object properties: lt: type: integer description: Less than quantity - type: object properties: lte: type: integer description: Less than equal quantity - type: object properties: gt_lt: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than, less than quantity - type: object properties: gte_lte: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than equal, less than equal quantity - type: object properties: gte_lt: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than equal, less than quantity - type: object properties: gt_lte: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than, less than equal quantity total_amount: description: The total amount of the line item option (float). Calculated as the line item option's `unit_amount * quantity`. oneOf: - type: object properties: eq: description: Equals to total_amount type: number - type: object properties: ne: description: Not equal total_amount type: number - type: object properties: gt: type: number description: Greater than total_amount - type: object properties: gte: type: number description: Greater than equal total_amount - type: object properties: lt: type: number description: Less than total_amount - type: object properties: lte: type: number description: Less than equal total_amount - type: object properties: gt_lt: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than, less than total_amount - type: object properties: gte_lte: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than equal, less than equal total_amount - type: object properties: gte_lt: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than equal, less than total_amount - type: object properties: gt_lte: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than, less than equal total_amount unit_amount: description: The unit amount of the line item option (float). oneOf: - type: object properties: eq: description: Equals to unit_amount type: number - type: object properties: ne: description: Not equal unit_amount type: number - type: object properties: gt: type: number description: Greater than unit_amount - type: object properties: gte: type: number description: Greater than equal unit_amount - type: object properties: lt: type: number description: Less than unit_amount - type: object properties: lte: type: number description: Less than equal unit_amount - type: object properties: gt_lt: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than, less than unit_amount - type: object properties: gte_lte: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than equal, less than equal unit_amount - type: object properties: gte_lt: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than equal, less than unit_amount - type: object properties: gt_lte: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than, less than equal unit_amount market: type: object properties: ids: description: The ID of the market. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of ids - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of ids names: description: The name of the market. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of names - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of names numbers: description: The numeric unique identifier for the market. oneOf: - type: object properties: in: type: array minItems: 1 items: type: integer example: 8 description: To include, array of numbers - type: object properties: not_in: type: array minItems: 1 items: type: integer example: 8 description: To exclude, array of numbers organization: type: object properties: ids: description: The ID of the organization. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of ids - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of ids names: description: The name of the organization. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of names - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of names slugs: description: The name of the organization, parsed and converted into a URL-friendly slug. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of slugs - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of slugs order: type: object properties: date_from: type: string description: The lower limit of the date and time range used to filter the collected orders (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard). format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' date_to: type: string description: The upper limit of the date and time range used to filter the collected orders (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard). format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' date_field: type: string description: The date field (e.g. `created_at`, `updated_at`, etc.) where to apply the date and time range filter. enum: - current_date - approved_at - cancelled_at - created_at - placed_at - archived_at - updated_at - fulfillment_updated_at - payment_updated_at default: current_date discounted: type: boolean description: Indicates a discount has been applied to the order. refunded: type: boolean description: Indicates if the order has been partially or totally refunded. gift_card: type: boolean description: Indicates if a gift card has been (or is set to be) used to pay — in total or in part - for the order. coupon: type: boolean description: Indicates if a coupon code has been (or is set to be) used to pay — in total or in part — for the order. customer_types: description: The type of the associated customer. One of `new` or `returning`. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of customer_types - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of customer_types returned: type: boolean description: Indicates if a return is associated with the order. options: type: boolean description: Indicates if at least one line item of the order has at least an option. adjustment_amount: description: The sum of all the adjustments applied to the order (float). oneOf: - type: object properties: eq: description: Equals to adjustment_amount type: number - type: object properties: ne: description: Not equal adjustment_amount type: number - type: object properties: gt: type: number description: Greater than adjustment_amount - type: object properties: gte: type: number description: Greater than equal adjustment_amount - type: object properties: lt: type: number description: Less than adjustment_amount - type: object properties: lte: type: number description: Less than equal adjustment_amount - type: object properties: gt_lt: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than, less than adjustment_amount - type: object properties: gte_lte: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than equal, less than equal adjustment_amount - type: object properties: gte_lt: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than equal, less than adjustment_amount - type: object properties: gt_lte: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than, less than equal adjustment_amount adjustment_tax_amount: description: The taxes applied to the order's adjustments (float). oneOf: - type: object properties: eq: description: Equals to adjustment_tax_amount type: number - type: object properties: ne: description: Not equal adjustment_tax_amount type: number - type: object properties: gt: type: number description: Greater than adjustment_tax_amount - type: object properties: gte: type: number description: Greater than equal adjustment_tax_amount - type: object properties: lt: type: number description: Less than adjustment_tax_amount - type: object properties: lte: type: number description: Less than equal adjustment_tax_amount - type: object properties: gt_lt: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than, less than adjustment_tax_amount - type: object properties: gte_lte: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than equal, less than equal adjustment_tax_amount - type: object properties: gte_lt: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than equal, less than adjustment_tax_amount - type: object properties: gt_lte: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than, less than equal adjustment_tax_amount adjustment_taxable_amount: description: The order's adjustment taxable amount (float). oneOf: - type: object properties: eq: description: Equals to adjustment_taxable_amount type: number - type: object properties: ne: description: Not equal adjustment_taxable_amount type: number - type: object properties: gt: type: number description: Greater than adjustment_taxable_amount - type: object properties: gte: type: number description: Greater than equal adjustment_taxable_amount - type: object properties: lt: type: number description: Less than adjustment_taxable_amount - type: object properties: lte: type: number description: Less than equal adjustment_taxable_amount - type: object properties: gt_lt: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than, less than adjustment_taxable_amount - type: object properties: gte_lte: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than equal, less than equal adjustment_taxable_amount - type: object properties: gte_lt: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than equal, less than adjustment_taxable_amount - type: object properties: gt_lte: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than, less than equal adjustment_taxable_amount approved_at: description: The date and time at which the order was approved (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard). oneOf: - type: object properties: eq: description: Equals to approved_at type: string - type: object properties: ne: description: Not equal approved_at type: string - type: object properties: gt: type: string description: Greater than approved_at - type: object properties: gte: type: string description: Greater than equal approved_at - type: object properties: lt: type: string description: Less than approved_at - type: object properties: lte: type: string description: Less than equal approved_at - type: object properties: gt_lt: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than, less than approved_at - type: object properties: gte_lte: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than equal, less than equal approved_at - type: object properties: gte_lt: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than equal, less than approved_at - type: object properties: gt_lte: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than, less than equal approved_at archived_at: description: The date and time at which the order was archived (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard). oneOf: - type: object properties: eq: description: Equals to archived_at type: string - type: object properties: ne: description: Not equal archived_at type: string - type: object properties: gt: type: string description: Greater than archived_at - type: object properties: gte: type: string description: Greater than equal archived_at - type: object properties: lt: type: string description: Less than archived_at - type: object properties: lte: type: string description: Less than equal archived_at - type: object properties: gt_lt: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than, less than archived_at - type: object properties: gte_lte: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than equal, less than equal archived_at - type: object properties: gte_lt: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than equal, less than archived_at - type: object properties: gt_lte: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than, less than equal archived_at archived: type: boolean description: Indicates if the order has been archived. cancelled_at: description: The date and time at which the order was cancelled (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard). oneOf: - type: object properties: eq: description: Equals to cancelled_at type: string - type: object properties: ne: description: Not equal cancelled_at type: string - type: object properties: gt: type: string description: Greater than cancelled_at - type: object properties: gte: type: string description: Greater than equal cancelled_at - type: object properties: lt: type: string description: Less than cancelled_at - type: object properties: lte: type: string description: Less than equal cancelled_at - type: object properties: gt_lt: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than, less than cancelled_at - type: object properties: gte_lte: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than equal, less than equal cancelled_at - type: object properties: gte_lt: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than equal, less than cancelled_at - type: object properties: gt_lte: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than, less than equal cancelled_at country_codes: description: The international 2-letter country code (as defined by the [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) standard), automatically inherited from the order's shipping address. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of country_codes - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of country_codes coupon_codes: description: The coupon code to be used to pay — in total or in part — for the order. If valid, it triggers a promotion adding a discount line item to the order. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of coupon_codes - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of coupon_codes created_at: description: The date and time at which the order was created (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard). oneOf: - type: object properties: eq: description: Equals to created_at type: string - type: object properties: ne: description: Not equal created_at type: string - type: object properties: gt: type: string description: Greater than created_at - type: object properties: gte: type: string description: Greater than equal created_at - type: object properties: lt: type: string description: Less than created_at - type: object properties: lte: type: string description: Less than equal created_at - type: object properties: gt_lt: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than, less than created_at - type: object properties: gte_lte: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than equal, less than equal created_at - type: object properties: gte_lt: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than equal, less than created_at - type: object properties: gt_lte: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than, less than equal created_at currency_codes: description: The international 3-letter currency code (as defined by the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) standard), automatically inherited from the order's market. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of currency_codes - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of currency_codes discount_amount: description: The sum of all the discounts applied to the order (float). oneOf: - type: object properties: eq: description: Equals to discount_amount type: number - type: object properties: ne: description: Not equal discount_amount type: number - type: object properties: gt: type: number description: Greater than discount_amount - type: object properties: gte: type: number description: Greater than equal discount_amount - type: object properties: lt: type: number description: Less than discount_amount - type: object properties: lte: type: number description: Less than equal discount_amount - type: object properties: gt_lt: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than, less than discount_amount - type: object properties: gte_lte: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than equal, less than equal discount_amount - type: object properties: gte_lt: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than equal, less than discount_amount - type: object properties: gt_lte: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than, less than equal discount_amount duty_amount: description: The duty amount that is calculated by external services (float). oneOf: - type: object properties: eq: description: Equals to duty_amount type: number - type: object properties: ne: description: Not equal duty_amount type: number - type: object properties: gt: type: number description: Greater than duty_amount - type: object properties: gte: type: number description: Greater than equal duty_amount - type: object properties: lt: type: number description: Less than duty_amount - type: object properties: lte: type: number description: Less than equal duty_amount - type: object properties: gt_lt: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than, less than duty_amount - type: object properties: gte_lte: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than equal, less than equal duty_amount - type: object properties: gte_lt: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than equal, less than duty_amount - type: object properties: gt_lte: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than, less than equal duty_amount freight_taxable: type: boolean description: Indicates if taxes are applied to shipping costs. fulfillment_statuses: description: The order's fulfillment status. One of `unfulfilled` (default), `in_progress`, or `fulfilled`. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of fulfillment_statuses - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of fulfillment_statuses fulfillment_updated_at: description: The date and time at which the order's fulfillment status was last updated (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard). oneOf: - type: object properties: eq: description: Equals to fulfillment_updated_at type: string - type: object properties: ne: description: Not equal fulfillment_updated_at type: string - type: object properties: gt: type: string description: Greater than fulfillment_updated_at - type: object properties: gte: type: string description: Greater than equal fulfillment_updated_at - type: object properties: lt: type: string description: Less than fulfillment_updated_at - type: object properties: lte: type: string description: Less than equal fulfillment_updated_at - type: object properties: gt_lt: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than, less than fulfillment_updated_at - type: object properties: gte_lte: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than equal, less than equal fulfillment_updated_at - type: object properties: gte_lt: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than equal, less than fulfillment_updated_at - type: object properties: gt_lte: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than, less than equal fulfillment_updated_at gift_card_codes: description: The gift card code (at least the first 8 characters) to be used to pay — in total or in part — for the order. If valid, it uses the associated gift card balance. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of gift_card_codes - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of gift_card_codes gift_card_amount: description: The sum of all the gift cards applied to the order (float). oneOf: - type: object properties: eq: description: Equals to gift_card_amount type: number - type: object properties: ne: description: Not equal gift_card_amount type: number - type: object properties: gt: type: number description: Greater than gift_card_amount - type: object properties: gte: type: number description: Greater than equal gift_card_amount - type: object properties: lt: type: number description: Less than gift_card_amount - type: object properties: lte: type: number description: Less than equal gift_card_amount - type: object properties: gt_lt: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than, less than gift_card_amount - type: object properties: gte_lte: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than equal, less than equal gift_card_amount - type: object properties: gte_lt: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than equal, less than gift_card_amount - type: object properties: gt_lte: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than, less than equal gift_card_amount guest: type: boolean description: Indicates if the order has been placed as guest (by a non-logged in customer). ids: description: The ID of the order. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of ids - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of ids language_codes: description: The preferred language code (as defined by the [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) standard) to be used when communicating with the customer when checking out the order. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of language_codes - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of language_codes line_item_options_count: description: The total number of line item options associated with the order's line items. oneOf: - type: object properties: eq: description: Equals to line_item_options_count type: integer - type: object properties: ne: description: Not equal line_item_options_count type: integer - type: object properties: gt: type: integer description: Greater than line_item_options_count - type: object properties: gte: type: integer description: Greater than equal line_item_options_count - type: object properties: lt: type: integer description: Less than line_item_options_count - type: object properties: lte: type: integer description: Less than equal line_item_options_count - type: object properties: gt_lt: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than, less than line_item_options_count - type: object properties: gte_lte: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than equal, less than equal line_item_options_count - type: object properties: gte_lt: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than equal, less than line_item_options_count - type: object properties: gt_lte: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than, less than equal line_item_options_count mode: type: string description: The order's environment (can be one of `test` or `live`). enum: - live - test numbers: description: The numeric unique identifier for the order. oneOf: - type: object properties: in: type: array minItems: 1 items: type: integer example: 8 description: To include, array of numbers - type: object properties: not_in: type: array minItems: 1 items: type: integer example: 8 description: To exclude, array of numbers payment_method_amount: description: The costs of the payment method associated with the order (float). oneOf: - type: object properties: eq: description: Equals to payment_method_amount type: number - type: object properties: ne: description: Not equal payment_method_amount type: number - type: object properties: gt: type: number description: Greater than payment_method_amount - type: object properties: gte: type: number description: Greater than equal payment_method_amount - type: object properties: lt: type: number description: Less than payment_method_amount - type: object properties: lte: type: number description: Less than equal payment_method_amount - type: object properties: gt_lt: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than, less than payment_method_amount - type: object properties: gte_lte: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than equal, less than equal payment_method_amount - type: object properties: gte_lt: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than equal, less than payment_method_amount - type: object properties: gt_lte: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than, less than equal payment_method_amount payment_method_tax_amount: description: The taxes applied to the order's payment method costs (float). oneOf: - type: object properties: eq: description: Equals to payment_method_tax_amount type: number - type: object properties: ne: description: Not equal payment_method_tax_amount type: number - type: object properties: gt: type: number description: Greater than payment_method_tax_amount - type: object properties: gte: type: number description: Greater than equal payment_method_tax_amount - type: object properties: lt: type: number description: Less than payment_method_tax_amount - type: object properties: lte: type: number description: Less than equal payment_method_tax_amount - type: object properties: gt_lt: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than, less than payment_method_tax_amount - type: object properties: gte_lte: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than equal, less than equal payment_method_tax_amount - type: object properties: gte_lt: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than equal, less than payment_method_tax_amount - type: object properties: gt_lte: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than, less than equal payment_method_tax_amount payment_method_taxable_amount: description: The order's payment method taxable amount (float). oneOf: - type: object properties: eq: description: Equals to payment_method_taxable_amount type: number - type: object properties: ne: description: Not equal payment_method_taxable_amount type: number - type: object properties: gt: type: number description: Greater than payment_method_taxable_amount - type: object properties: gte: type: number description: Greater than equal payment_method_taxable_amount - type: object properties: lt: type: number description: Less than payment_method_taxable_amount - type: object properties: lte: type: number description: Less than equal payment_method_taxable_amount - type: object properties: gt_lt: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than, less than payment_method_taxable_amount - type: object properties: gte_lte: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than equal, less than equal payment_method_taxable_amount - type: object properties: gte_lt: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than equal, less than payment_method_taxable_amount - type: object properties: gt_lte: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than, less than equal payment_method_taxable_amount payment_statuses: description: The order's payment status. One of `unpaid` (default), `authorized`, `partially_authorized`, `paid`, `partially_paid`, `voided`, `partially_voided`, `refunded`, `partially_refunded` or `free`. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of payment_statuses - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of payment_statuses payment_updated_at: description: The date and time at which the order's payment status was last updated (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard). oneOf: - type: object properties: eq: description: Equals to payment_updated_at type: string - type: object properties: ne: description: Not equal payment_updated_at type: string - type: object properties: gt: type: string description: Greater than payment_updated_at - type: object properties: gte: type: string description: Greater than equal payment_updated_at - type: object properties: lt: type: string description: Less than payment_updated_at - type: object properties: lte: type: string description: Less than equal payment_updated_at - type: object properties: gt_lt: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than, less than payment_updated_at - type: object properties: gte_lte: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than equal, less than equal payment_updated_at - type: object properties: gte_lt: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than equal, less than payment_updated_at - type: object properties: gt_lte: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than, less than equal payment_updated_at placed_at: description: The date and time at which the order was placed (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard). oneOf: - type: object properties: eq: description: Equals to placed_at type: string - type: object properties: ne: description: Not equal placed_at type: string - type: object properties: gt: type: string description: Greater than placed_at - type: object properties: gte: type: string description: Greater than equal placed_at - type: object properties: lt: type: string description: Less than placed_at - type: object properties: lte: type: string description: Less than equal placed_at - type: object properties: gt_lt: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than, less than placed_at - type: object properties: gte_lte: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than equal, less than equal placed_at - type: object properties: gte_lt: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than equal, less than placed_at - type: object properties: gt_lte: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than, less than equal placed_at references: description: Any external identifier that might be useful to link the order resource to other systems through the Commerce Layer core API. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of references - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of references reference_origins: description: Any identifier of the 3rd-party system that defines the reference code. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of reference_origins - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of reference_origins shipments_count: description: The total number of shipments associated with the order. oneOf: - type: object properties: eq: description: Equals to shipments_count type: integer - type: object properties: ne: description: Not equal shipments_count type: integer - type: object properties: gt: type: integer description: Greater than shipments_count - type: object properties: gte: type: integer description: Greater than equal shipments_count - type: object properties: lt: type: integer description: Less than shipments_count - type: object properties: lte: type: integer description: Less than equal shipments_count - type: object properties: gt_lt: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than, less than shipments_count - type: object properties: gte_lte: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than equal, less than equal shipments_count - type: object properties: gte_lt: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than equal, less than shipments_count - type: object properties: gt_lte: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than, less than equal shipments_count shipping_amount: description: The sum of all the shipping costs of the order (float). oneOf: - type: object properties: eq: description: Equals to shipping_amount type: number - type: object properties: ne: description: Not equal shipping_amount type: number - type: object properties: gt: type: number description: Greater than shipping_amount - type: object properties: gte: type: number description: Greater than equal shipping_amount - type: object properties: lt: type: number description: Less than shipping_amount - type: object properties: lte: type: number description: Less than equal shipping_amount - type: object properties: gt_lt: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than, less than shipping_amount - type: object properties: gte_lte: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than equal, less than equal shipping_amount - type: object properties: gte_lt: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than equal, less than shipping_amount - type: object properties: gt_lte: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than, less than equal shipping_amount shipping_taxable_amount: description: The order's shipping taxable amount (float). oneOf: - type: object properties: eq: description: Equals to shipping_taxable_amount type: number - type: object properties: ne: description: Not equal shipping_taxable_amount type: number - type: object properties: gt: type: number description: Greater than shipping_taxable_amount - type: object properties: gte: type: number description: Greater than equal shipping_taxable_amount - type: object properties: lt: type: number description: Less than shipping_taxable_amount - type: object properties: lte: type: number description: Less than equal shipping_taxable_amount - type: object properties: gt_lt: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than, less than shipping_taxable_amount - type: object properties: gte_lte: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than equal, less than equal shipping_taxable_amount - type: object properties: gte_lt: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than equal, less than shipping_taxable_amount - type: object properties: gt_lte: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than, less than equal shipping_taxable_amount skus_count: description: The total number of SKUs in the order's line items. oneOf: - type: object properties: eq: description: Equals to skus_count type: integer - type: object properties: ne: description: Not equal skus_count type: integer - type: object properties: gt: type: integer description: Greater than skus_count - type: object properties: gte: type: integer description: Greater than equal skus_count - type: object properties: lt: type: integer description: Less than skus_count - type: object properties: lte: type: integer description: Less than equal skus_count - type: object properties: gt_lt: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than, less than skus_count - type: object properties: gte_lte: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than equal, less than equal skus_count - type: object properties: gte_lt: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than equal, less than skus_count - type: object properties: gt_lte: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than, less than equal skus_count statuses: description: The order status. One of `placed`, `approved`, or `cancelled`. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of statuses - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of statuses subtotal_amount: description: The sum of all the SKU line items total amounts (float). oneOf: - type: object properties: eq: description: Equals to subtotal_amount type: number - type: object properties: ne: description: Not equal subtotal_amount type: number - type: object properties: gt: type: number description: Greater than subtotal_amount - type: object properties: gte: type: number description: Greater than equal subtotal_amount - type: object properties: lt: type: number description: Less than subtotal_amount - type: object properties: lte: type: number description: Less than equal subtotal_amount - type: object properties: gt_lt: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than, less than subtotal_amount - type: object properties: gte_lte: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than equal, less than equal subtotal_amount - type: object properties: gte_lt: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than equal, less than subtotal_amount - type: object properties: gt_lte: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than, less than equal subtotal_amount subtotal_tax_amount: description: The taxes applied to the order's subtotal (float). oneOf: - type: object properties: eq: description: Equals to subtotal_tax_amount type: number - type: object properties: ne: description: Not equal subtotal_tax_amount type: number - type: object properties: gt: type: number description: Greater than subtotal_tax_amount - type: object properties: gte: type: number description: Greater than equal subtotal_tax_amount - type: object properties: lt: type: number description: Less than subtotal_tax_amount - type: object properties: lte: type: number description: Less than equal subtotal_tax_amount - type: object properties: gt_lt: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than, less than subtotal_tax_amount - type: object properties: gte_lte: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than equal, less than equal subtotal_tax_amount - type: object properties: gte_lt: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than equal, less than subtotal_tax_amount - type: object properties: gt_lte: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than, less than equal subtotal_tax_amount subtotal_taxable_amount: description: The order's subtotal taxable amount (float). oneOf: - type: object properties: eq: description: Equals to subtotal_taxable_amount type: number - type: object properties: ne: description: Not equal subtotal_taxable_amount type: number - type: object properties: gt: type: number description: Greater than subtotal_taxable_amount - type: object properties: gte: type: number description: Greater than equal subtotal_taxable_amount - type: object properties: lt: type: number description: Less than subtotal_taxable_amount - type: object properties: lte: type: number description: Less than equal subtotal_taxable_amount - type: object properties: gt_lt: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than, less than subtotal_taxable_amount - type: object properties: gte_lte: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than equal, less than equal subtotal_taxable_amount - type: object properties: gte_lt: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than equal, less than subtotal_taxable_amount - type: object properties: gt_lte: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than, less than equal subtotal_taxable_amount tax_included: type: boolean description: Indicates if taxes are included in the order amounts (automatically inherited from the order's price list). total_amount: description: The order's total amount (float). oneOf: - type: object properties: eq: description: Equals to total_amount type: number - type: object properties: ne: description: Not equal total_amount type: number - type: object properties: gt: type: number description: Greater than total_amount - type: object properties: gte: type: number description: Greater than equal total_amount - type: object properties: lt: type: number description: Less than total_amount - type: object properties: lte: type: number description: Less than equal total_amount - type: object properties: gt_lt: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than, less than total_amount - type: object properties: gte_lte: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than equal, less than equal total_amount - type: object properties: gte_lt: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than equal, less than total_amount - type: object properties: gt_lte: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than, less than equal total_amount total_amount_with_taxes: description: The order's total amount, taxes included (float). oneOf: - type: object properties: eq: description: Equals to total_amount_with_taxes type: number - type: object properties: ne: description: Not equal total_amount_with_taxes type: number - type: object properties: gt: type: number description: Greater than total_amount_with_taxes - type: object properties: gte: type: number description: Greater than equal total_amount_with_taxes - type: object properties: lt: type: number description: Less than total_amount_with_taxes - type: object properties: lte: type: number description: Less than equal total_amount_with_taxes - type: object properties: gt_lt: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than, less than total_amount_with_taxes - type: object properties: gte_lte: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than equal, less than equal total_amount_with_taxes - type: object properties: gte_lt: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than equal, less than total_amount_with_taxes - type: object properties: gt_lte: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than, less than equal total_amount_with_taxes total_tax_amount: description: The sum of all the taxes applied to the order (float). oneOf: - type: object properties: eq: description: Equals to total_tax_amount type: number - type: object properties: ne: description: Not equal total_tax_amount type: number - type: object properties: gt: type: number description: Greater than total_tax_amount - type: object properties: gte: type: number description: Greater than equal total_tax_amount - type: object properties: lt: type: number description: Less than total_tax_amount - type: object properties: lte: type: number description: Less than equal total_tax_amount - type: object properties: gt_lt: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than, less than total_tax_amount - type: object properties: gte_lte: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than equal, less than equal total_tax_amount - type: object properties: gte_lt: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than equal, less than total_tax_amount - type: object properties: gt_lte: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than, less than equal total_tax_amount total_taxable_amount: description: The order's total taxable amount (float). oneOf: - type: object properties: eq: description: Equals to total_taxable_amount type: number - type: object properties: ne: description: Not equal total_taxable_amount type: number - type: object properties: gt: type: number description: Greater than total_taxable_amount - type: object properties: gte: type: number description: Greater than equal total_taxable_amount - type: object properties: lt: type: number description: Less than total_taxable_amount - type: object properties: lte: type: number description: Less than equal total_taxable_amount - type: object properties: gt_lt: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than, less than total_taxable_amount - type: object properties: gte_lte: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than equal, less than equal total_taxable_amount - type: object properties: gte_lt: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than equal, less than total_taxable_amount - type: object properties: gt_lte: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than, less than equal total_taxable_amount updated_at: description: The date and time at which the order was last updated (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard). oneOf: - type: object properties: eq: description: Equals to updated_at type: string - type: object properties: ne: description: Not equal updated_at type: string - type: object properties: gt: type: string description: Greater than updated_at - type: object properties: gte: type: string description: Greater than equal updated_at - type: object properties: lt: type: string description: Less than updated_at - type: object properties: lte: type: string description: Less than equal updated_at - type: object properties: gt_lt: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than, less than updated_at - type: object properties: gte_lte: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than equal, less than equal updated_at - type: object properties: gte_lt: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than equal, less than updated_at - type: object properties: gt_lte: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than, less than equal updated_at current_date: description: The date and time of the order's latest status change, regardless of the order's status (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard). oneOf: - type: object properties: eq: description: Equals to current_date type: string - type: object properties: ne: description: Not equal current_date type: string - type: object properties: gt: type: string description: Greater than current_date - type: object properties: gte: type: string description: Greater than equal current_date - type: object properties: lt: type: string description: Less than current_date - type: object properties: lte: type: string description: Less than equal current_date - type: object properties: gt_lt: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than, less than current_date - type: object properties: gte_lte: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than equal, less than equal current_date - type: object properties: gte_lt: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than equal, less than current_date - type: object properties: gt_lte: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than, less than equal current_date seconds_in_draft: description: The difference in seconds between `placed_at` and `created_at` (`null` if the order hasn't been placed yet). oneOf: - type: object properties: eq: description: Equals to seconds_in_draft type: integer - type: object properties: ne: description: Not equal seconds_in_draft type: integer - type: object properties: gt: type: integer description: Greater than seconds_in_draft - type: object properties: gte: type: integer description: Greater than equal seconds_in_draft - type: object properties: lt: type: integer description: Less than seconds_in_draft - type: object properties: lte: type: integer description: Less than equal seconds_in_draft - type: object properties: gt_lt: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than, less than seconds_in_draft - type: object properties: gte_lte: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than equal, less than equal seconds_in_draft - type: object properties: gte_lt: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than equal, less than seconds_in_draft - type: object properties: gt_lte: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than, less than equal seconds_in_draft seconds_in_approved: description: The difference in seconds between `cancelled_at` and `approved_at` (`null` if the order hasn't been approved yet or no further status change happened after approval — e.g. the order has been regularly fulfilled). oneOf: - type: object properties: eq: description: Equals to seconds_in_approved type: integer - type: object properties: ne: description: Not equal seconds_in_approved type: integer - type: object properties: gt: type: integer description: Greater than seconds_in_approved - type: object properties: gte: type: integer description: Greater than equal seconds_in_approved - type: object properties: lt: type: integer description: Less than seconds_in_approved - type: object properties: lte: type: integer description: Less than equal seconds_in_approved - type: object properties: gt_lt: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than, less than seconds_in_approved - type: object properties: gte_lte: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than equal, less than equal seconds_in_approved - type: object properties: gte_lt: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than equal, less than seconds_in_approved - type: object properties: gt_lte: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than, less than equal seconds_in_approved seconds_in_placed: description: The difference in seconds between `approved_at` and `placed_at` if the order has been approved or between `cancelled_at` and `placed_at` if the order has been cancelled before approval (`null` if the order hasn't been placed yet or no further status change happened after placement). oneOf: - type: object properties: eq: description: Equals to seconds_in_placed type: integer - type: object properties: ne: description: Not equal seconds_in_placed type: integer - type: object properties: gt: type: integer description: Greater than seconds_in_placed - type: object properties: gte: type: integer description: Greater than equal seconds_in_placed - type: object properties: lt: type: integer description: Less than seconds_in_placed - type: object properties: lte: type: integer description: Less than equal seconds_in_placed - type: object properties: gt_lt: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than, less than seconds_in_placed - type: object properties: gte_lte: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than equal, less than equal seconds_in_placed - type: object properties: gte_lt: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than equal, less than seconds_in_placed - type: object properties: gt_lte: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than, less than equal seconds_in_placed placed_day_of_week: description: The day of week when the order was placed, expressed as an integer (`0` through `6`, from Sunday to Saturday — e.g. `1` is Monday). oneOf: - type: object properties: eq: description: Equals to placed_day_of_week type: integer - type: object properties: ne: description: Not equal placed_day_of_week type: integer - type: object properties: gt: type: integer description: Greater than placed_day_of_week - type: object properties: gte: type: integer description: Greater than equal placed_day_of_week - type: object properties: lt: type: integer description: Less than placed_day_of_week - type: object properties: lte: type: integer description: Less than equal placed_day_of_week - type: object properties: gt_lt: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than, less than placed_day_of_week - type: object properties: gte_lte: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than equal, less than equal placed_day_of_week - type: object properties: gte_lt: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than equal, less than placed_day_of_week - type: object properties: gt_lte: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than, less than equal placed_day_of_week refunds_total_amount_with_taxes: description: Total amount of refunds (including taxes) associated with the order. oneOf: - type: object properties: eq: description: Equals to refunds_total_amount_with_taxes type: integer - type: object properties: ne: description: Not equal refunds_total_amount_with_taxes type: integer - type: object properties: gt: type: integer description: Greater than refunds_total_amount_with_taxes - type: object properties: gte: type: integer description: Greater than equal refunds_total_amount_with_taxes - type: object properties: lt: type: integer description: Less than refunds_total_amount_with_taxes - type: object properties: lte: type: integer description: Less than equal refunds_total_amount_with_taxes - type: object properties: gt_lt: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than, less than refunds_total_amount_with_taxes - type: object properties: gte_lte: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than equal, less than equal refunds_total_amount_with_taxes - type: object properties: gte_lt: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than equal, less than refunds_total_amount_with_taxes - type: object properties: gt_lte: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than, less than equal refunds_total_amount_with_taxes total_amount_with_taxes_net_of_refunds: description: The total amount of the order minus the total amount of refunds. oneOf: - type: object properties: eq: description: Equals to total_amount_with_taxes_net_of_refunds type: number - type: object properties: ne: description: Not equal total_amount_with_taxes_net_of_refunds type: number - type: object properties: gt: type: number description: Greater than total_amount_with_taxes_net_of_refunds - type: object properties: gte: type: number description: Greater than equal total_amount_with_taxes_net_of_refunds - type: object properties: lt: type: number description: Less than total_amount_with_taxes_net_of_refunds - type: object properties: lte: type: number description: Less than equal total_amount_with_taxes_net_of_refunds - type: object properties: gt_lt: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than, less than total_amount_with_taxes_net_of_refunds - type: object properties: gte_lte: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than equal, less than equal total_amount_with_taxes_net_of_refunds - type: object properties: gte_lt: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than equal, less than total_amount_with_taxes_net_of_refunds - type: object properties: gt_lte: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than, less than equal total_amount_with_taxes_net_of_refunds aggregated_details: description: Searchable field containing all orders data. type: object properties: query: type: string description: Returns documents based on a provided query string aggregated_details link_ids: description: The link ID used during the checkout. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of link_ids - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of link_ids user_ids: description: The user ID used to generate the link. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of user_ids - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of user_ids store_ids: description: The store ID used during the checkout. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of store_ids - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of store_ids affiliate_codes: description: The affiliate code used during the checkout. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of affiliate_codes - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of affiliate_codes payment_method: type: object properties: ids: description: The ID of the payment method. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of ids - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of ids source_types: description: The payment source type. One of `AdyenPayment`, `BraintreePayment`, `CheckoutComPayment`, `CreditCard`, `ExternalPayment`, `KlarnaPayment`, `PaypalPayment`, `StripePayment`, or `WireTransfer`. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of source_types - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of source_types names: description: The payment source type, titleized. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of names - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of names moto: type: boolean description: Indicates if the payment has been marked as MOTO (must be supported by the payment gateway). issuer: description: The payment method's issuer (if present and provided by the payment gateway). oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of issuer - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of issuer issuer_type: description: The type of issuer (if present and provided by the payment gateway). oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of issuer_type - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of issuer_type card_type: description: The type of card used to pay for the order (if present and provided by the payment gateway). oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of card_type - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of card_type refunds: type: object properties: ids: description: The ID of the refund. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of ids - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of ids amount: description: The refunded amount (float). oneOf: - type: object properties: eq: description: Equals to amount type: number - type: object properties: ne: description: Not equal amount type: number - type: object properties: gt: type: number description: Greater than amount - type: object properties: gte: type: number description: Greater than equal amount - type: object properties: lt: type: number description: Less than amount - type: object properties: lte: type: number description: Less than equal amount - type: object properties: gt_lt: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than, less than amount - type: object properties: gte_lte: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than equal, less than equal amount - type: object properties: gte_lt: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than equal, less than amount - type: object properties: gt_lte: type: array items: type: number example: 121 minItems: 2 maxItems: 2 description: Greater than, less than equal amount numbers: description: The transaction number associated with the refund (auto-generated). oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of numbers - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of numbers shipping_address: type: object properties: business: type: boolean description: Indicates if the address is a business or a personal one. cities: description: The city specified in the address. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of cities - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of cities country_codes: description: The international 2-letter country code (as defined by the [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) standard) specified in the address. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of country_codes - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of country_codes geocoded: type: boolean description: Indicates if the address has been successfully geocoded. localized: type: boolean description: Indicates if the latitude and longitude of the address are present, either geocoded or manually updated. state_codes: description: The state, province or region code specified in the address. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of state_codes - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of state_codes zip_codes: description: The ZIP or postal code specified in the address. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of zip_codes - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of zip_codes shipments: type: object properties: ids: description: The shipment ID. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of ids - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of ids numbers: description: The shipment number. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of numbers - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of numbers items_count: description: The shipment items count. oneOf: - type: object properties: eq: description: Equals to items_count type: integer - type: object properties: ne: description: Not equal items_count type: integer - type: object properties: gt: type: integer description: Greater than items_count - type: object properties: gte: type: integer description: Greater than equal items_count - type: object properties: lt: type: integer description: Less than items_count - type: object properties: lte: type: integer description: Less than equal items_count - type: object properties: gt_lt: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than, less than items_count - type: object properties: gte_lte: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than equal, less than equal items_count - type: object properties: gte_lt: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than equal, less than items_count - type: object properties: gt_lte: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than, less than equal items_count cost_amount: description: The shipment cost amount. oneOf: - type: object properties: eq: description: Equals to cost_amount type: integer - type: object properties: ne: description: Not equal cost_amount type: integer - type: object properties: gt: type: integer description: Greater than cost_amount - type: object properties: gte: type: integer description: Greater than equal cost_amount - type: object properties: lt: type: integer description: Less than cost_amount - type: object properties: lte: type: integer description: Less than equal cost_amount - type: object properties: gt_lt: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than, less than cost_amount - type: object properties: gte_lte: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than equal, less than equal cost_amount - type: object properties: gte_lt: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than equal, less than cost_amount - type: object properties: gt_lte: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than, less than equal cost_amount statuses: description: The shipment status. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of statuses - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of statuses cancelled_at: description: The date and time at which the shipment status was cancelled (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard). oneOf: - type: object properties: eq: description: Equals to cancelled_at type: string - type: object properties: ne: description: Not equal cancelled_at type: string - type: object properties: gt: type: string description: Greater than cancelled_at - type: object properties: gte: type: string description: Greater than equal cancelled_at - type: object properties: lt: type: string description: Less than cancelled_at - type: object properties: lte: type: string description: Less than equal cancelled_at - type: object properties: gt_lt: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than, less than cancelled_at - type: object properties: gte_lte: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than equal, less than equal cancelled_at - type: object properties: gte_lt: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than equal, less than cancelled_at - type: object properties: gt_lte: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than, less than equal cancelled_at delivered_at: description: The date and time at which the shipment was delivered (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard). oneOf: - type: object properties: eq: description: Equals to delivered_at type: string - type: object properties: ne: description: Not equal delivered_at type: string - type: object properties: gt: type: string description: Greater than delivered_at - type: object properties: gte: type: string description: Greater than equal delivered_at - type: object properties: lt: type: string description: Less than delivered_at - type: object properties: lte: type: string description: Less than equal delivered_at - type: object properties: gt_lt: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than, less than delivered_at - type: object properties: gte_lte: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than equal, less than equal delivered_at - type: object properties: gte_lt: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than equal, less than delivered_at - type: object properties: gt_lte: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than, less than equal delivered_at on_hold_at: description: The date and time at which the shipment status was put on hold (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard). oneOf: - type: object properties: eq: description: Equals to on_hold_at type: string - type: object properties: ne: description: Not equal on_hold_at type: string - type: object properties: gt: type: string description: Greater than on_hold_at - type: object properties: gte: type: string description: Greater than equal on_hold_at - type: object properties: lt: type: string description: Less than on_hold_at - type: object properties: lte: type: string description: Less than equal on_hold_at - type: object properties: gt_lt: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than, less than on_hold_at - type: object properties: gte_lte: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than equal, less than equal on_hold_at - type: object properties: gte_lt: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than equal, less than on_hold_at - type: object properties: gt_lte: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than, less than equal on_hold_at picking_at: description: The date and time at which the shipment was picked (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard). oneOf: - type: object properties: eq: description: Equals to picking_at type: string - type: object properties: ne: description: Not equal picking_at type: string - type: object properties: gt: type: string description: Greater than picking_at - type: object properties: gte: type: string description: Greater than equal picking_at - type: object properties: lt: type: string description: Less than picking_at - type: object properties: lte: type: string description: Less than equal picking_at - type: object properties: gt_lt: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than, less than picking_at - type: object properties: gte_lte: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than equal, less than equal picking_at - type: object properties: gte_lt: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than equal, less than picking_at - type: object properties: gt_lte: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than, less than equal picking_at packing_at: description: The date and time at which the shipment was packed (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard). oneOf: - type: object properties: eq: description: Equals to packing_at type: string - type: object properties: ne: description: Not equal packing_at type: string - type: object properties: gt: type: string description: Greater than packing_at - type: object properties: gte: type: string description: Greater than equal packing_at - type: object properties: lt: type: string description: Less than packing_at - type: object properties: lte: type: string description: Less than equal packing_at - type: object properties: gt_lt: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than, less than packing_at - type: object properties: gte_lte: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than equal, less than equal packing_at - type: object properties: gte_lt: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than equal, less than packing_at - type: object properties: gt_lte: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than, less than equal packing_at ready_to_ship_at: description: The date and time at which the shipment was ready to ship (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard). oneOf: - type: object properties: eq: description: Equals to ready_to_ship_at type: string - type: object properties: ne: description: Not equal ready_to_ship_at type: string - type: object properties: gt: type: string description: Greater than ready_to_ship_at - type: object properties: gte: type: string description: Greater than equal ready_to_ship_at - type: object properties: lt: type: string description: Less than ready_to_ship_at - type: object properties: lte: type: string description: Less than equal ready_to_ship_at - type: object properties: gt_lt: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than, less than ready_to_ship_at - type: object properties: gte_lte: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than equal, less than equal ready_to_ship_at - type: object properties: gte_lt: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than equal, less than ready_to_ship_at - type: object properties: gt_lte: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than, less than equal ready_to_ship_at shipped_at: description: The date and time at which the shipment was shipped (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard). oneOf: - type: object properties: eq: description: Equals to shipped_at type: string - type: object properties: ne: description: Not equal shipped_at type: string - type: object properties: gt: type: string description: Greater than shipped_at - type: object properties: gte: type: string description: Greater than equal shipped_at - type: object properties: lt: type: string description: Less than shipped_at - type: object properties: lte: type: string description: Less than equal shipped_at - type: object properties: gt_lt: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than, less than shipped_at - type: object properties: gte_lte: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than equal, less than equal shipped_at - type: object properties: gte_lt: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than equal, less than shipped_at - type: object properties: gt_lte: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than, less than equal shipped_at created_at: description: The date and time at which the shipment was created (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard). oneOf: - type: object properties: eq: description: Equals to created_at type: string - type: object properties: ne: description: Not equal created_at type: string - type: object properties: gt: type: string description: Greater than created_at - type: object properties: gte: type: string description: Greater than equal created_at - type: object properties: lt: type: string description: Less than created_at - type: object properties: lte: type: string description: Less than equal created_at - type: object properties: gt_lt: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than, less than created_at - type: object properties: gte_lte: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than equal, less than equal created_at - type: object properties: gte_lt: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than equal, less than created_at - type: object properties: gt_lte: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than, less than equal created_at updated_at: description: The date and time at which the shipment was updated (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard). oneOf: - type: object properties: eq: description: Equals to updated_at type: string - type: object properties: ne: description: Not equal updated_at type: string - type: object properties: gt: type: string description: Greater than updated_at - type: object properties: gte: type: string description: Greater than equal updated_at - type: object properties: lt: type: string description: Less than updated_at - type: object properties: lte: type: string description: Less than equal updated_at - type: object properties: gt_lt: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than, less than updated_at - type: object properties: gte_lte: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than equal, less than equal updated_at - type: object properties: gte_lt: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than equal, less than updated_at - type: object properties: gt_lte: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than, less than equal updated_at references: description: Any external identifier that might be useful to link the shipment resource to other systems through the Commerce Layer core API. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of references - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of references reference_origins: description: Any identifier of the 3rd-party system that defines the reference code. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of reference_origins - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of reference_origins seconds_in_picking: description: The difference in seconds between `picking_at` and `packing_at` (`null` if the order hasn't been picked yet). oneOf: - type: object properties: eq: description: Equals to seconds_in_picking type: integer - type: object properties: ne: description: Not equal seconds_in_picking type: integer - type: object properties: gt: type: integer description: Greater than seconds_in_picking - type: object properties: gte: type: integer description: Greater than equal seconds_in_picking - type: object properties: lt: type: integer description: Less than seconds_in_picking - type: object properties: lte: type: integer description: Less than equal seconds_in_picking - type: object properties: gt_lt: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than, less than seconds_in_picking - type: object properties: gte_lte: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than equal, less than equal seconds_in_picking - type: object properties: gte_lt: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than equal, less than seconds_in_picking - type: object properties: gt_lte: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than, less than equal seconds_in_picking seconds_in_ready_to_ship: description: The difference in seconds between `ready_to_ship_at` and `shipped_at` (`null` if the order hasn't been shipped yet). oneOf: - type: object properties: eq: description: Equals to seconds_in_ready_to_ship type: integer - type: object properties: ne: description: Not equal seconds_in_ready_to_ship type: integer - type: object properties: gt: type: integer description: Greater than seconds_in_ready_to_ship - type: object properties: gte: type: integer description: Greater than equal seconds_in_ready_to_ship - type: object properties: lt: type: integer description: Less than seconds_in_ready_to_ship - type: object properties: lte: type: integer description: Less than equal seconds_in_ready_to_ship - type: object properties: gt_lt: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than, less than seconds_in_ready_to_ship - type: object properties: gte_lte: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than equal, less than equal seconds_in_ready_to_ship - type: object properties: gte_lt: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than equal, less than seconds_in_ready_to_ship - type: object properties: gt_lte: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than, less than equal seconds_in_ready_to_ship seconds_in_shipped: description: The difference in seconds between `delivered_at` and `shipped_at` (`null` if the order hasn't been delivered yet). oneOf: - type: object properties: eq: description: Equals to seconds_in_shipped type: integer - type: object properties: ne: description: Not equal seconds_in_shipped type: integer - type: object properties: gt: type: integer description: Greater than seconds_in_shipped - type: object properties: gte: type: integer description: Greater than equal seconds_in_shipped - type: object properties: lt: type: integer description: Less than seconds_in_shipped - type: object properties: lte: type: integer description: Less than equal seconds_in_shipped - type: object properties: gt_lt: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than, less than seconds_in_shipped - type: object properties: gte_lte: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than equal, less than equal seconds_in_shipped - type: object properties: gte_lt: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than equal, less than seconds_in_shipped - type: object properties: gt_lte: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than, less than equal seconds_in_shipped fulfillment_time: description: The difference in seconds between `delivered_at` and `picking_at` or `shipped_at` and `picking_at`. oneOf: - type: object properties: eq: description: Equals to fulfillment_time type: integer - type: object properties: ne: description: Not equal fulfillment_time type: integer - type: object properties: gt: type: integer description: Greater than fulfillment_time - type: object properties: gte: type: integer description: Greater than equal fulfillment_time - type: object properties: lt: type: integer description: Less than fulfillment_time - type: object properties: lte: type: integer description: Less than equal fulfillment_time - type: object properties: gt_lt: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than, less than fulfillment_time - type: object properties: gte_lte: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than equal, less than equal fulfillment_time - type: object properties: gte_lt: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than equal, less than fulfillment_time - type: object properties: gt_lte: type: array items: type: integer example: 8 minItems: 2 maxItems: 2 description: Greater than, less than equal fulfillment_time items: description: Array of the shipment items information. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of items - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of items shipments.stock_location: type: object properties: ids: description: The shipment stock location ID. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of ids - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of ids names: description: The shipment stock location name. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of names - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of names references: description: Any external identifier that might be useful to link the stock location reference resource to other systems through the Commerce Layer core API. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of references - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of references reference_origins: description: Any identifier of the 3rd-party system that defines the reference code. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of reference_origins - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of reference_origins shipments.shipping_method: type: object properties: ids: description: The shipment shipping method ID. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of ids - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of ids names: description: The shipment shipping method name. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of names - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of names references: description: Any external identifier that might be useful to link the shipping method reference resource to other systems through the Commerce Layer core API. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of references - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of references reference_origins: description: Any identifier of the 3rd-party system that defines the reference code. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of reference_origins - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of reference_origins currency_codes: description: The international 3-letter currency code (as defined by the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) standard), automatically inherited from the order's market. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of currency_codes - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of currency_codes shipments.shipping_category: type: object properties: ids: description: The shipment shipping category ID. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of ids - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of ids names: description: The shipment shipping category name. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of names - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of names references: description: Any external identifier that might be useful to link the shipping method reference resource to other systems through the Commerce Layer core API. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of references - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of references reference_origins: description: Any identifier of the 3rd-party system that defines the reference code. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of reference_origins - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of reference_origins shipments.tags: type: object properties: ids: description: The tag ID. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of ids - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of ids names: description: The tag name. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of names - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of names tags: type: object properties: ids: description: The tag ID. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of ids - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of ids names: description: The tag name. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of names - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of names resource_errors: type: object properties: codes: description: The resource errors code. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of codes - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of codes names: description: The name of the resource error. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of names - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of names ids: description: The ID of the resource error. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of ids - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of ids messages: description: The resource error message. oneOf: - type: object properties: in: type: array minItems: 1 items: type: string description: To include, array of messages - type: object properties: not_in: type: array minItems: 1 items: type: string description: To exclude, array of messages created_at: description: The date and time at which the resource error was created (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard). oneOf: - type: object properties: eq: description: Equals to created_at type: string - type: object properties: ne: description: Not equal created_at type: string - type: object properties: gt: type: string description: Greater than created_at - type: object properties: gte: type: string description: Greater than equal created_at - type: object properties: lt: type: string description: Less than created_at - type: object properties: lte: type: string description: Less than equal created_at - type: object properties: gt_lt: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than, less than created_at - type: object properties: gte_lte: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than equal, less than equal created_at - type: object properties: gte_lt: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than equal, less than created_at - type: object properties: gt_lte: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than, less than equal created_at updated_at: description: The date and time at which the resource error was updated (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard). oneOf: - type: object properties: eq: description: Equals to updated_at type: string - type: object properties: ne: description: Not equal updated_at type: string - type: object properties: gt: type: string description: Greater than updated_at - type: object properties: gte: type: string description: Greater than equal updated_at - type: object properties: lt: type: string description: Less than updated_at - type: object properties: lte: type: string description: Less than equal updated_at - type: object properties: gt_lt: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than, less than updated_at - type: object properties: gte_lte: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than equal, less than equal updated_at - type: object properties: gte_lt: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than equal, less than updated_at - type: object properties: gt_lte: type: array items: type: string format: '%Y-%m-%dT%H:%M:%SZ' example: '2022-07-06T21:41:03Z' minItems: 2 maxItems: 2 description: Greater than, less than equal updated_at checkoutComPayment: type: object properties: data: type: object required: - type - attributes properties: type: type: string description: The resource's type enum: - checkout_com_payments attributes: type: object properties: public_key: type: string description: The Checkout.com publishable API key. example: pk_test_xxxx-yyyy-zzzz nullable: true token: type: string description: The Checkout.com payment or digital wallet token. example: tok_4gzeau5o2uqubbk6fufs3m7p54 nullable: false payment_session: type: object description: The session object which initializes payment. example: id: ps_xxxx_yyyy_zzzz payment_session_secret: pss_xxxx_yyy_zzzz payment_session_token: xxxxx_yyyyy_zzzzz _links: self: href: https://api.sandbox.checkout.com/payment-sessions/ps_xxxx_yyyy_zzzz nullable: false success_url: type: string description: The URL to redirect your customer upon 3DS succeeded authentication. example: http://commercelayer.dev/checkout_com/success nullable: false failure_url: type: string description: The URL to redirect your customer upon 3DS failed authentication. example: http://commercelayer.dev/checkout_com/failure nullable: false source_id: type: string description: The payment source identifier that can be used for subsequent payments. example: src_nwd3m4in3hkuddfpjsaevunhdy nullable: true customer_token: type: string description: The customer's unique identifier. This can be passed as a source when making a payment. example: cus_udst2tfldj6upmye2reztkmm4i nullable: true redirect_uri: type: string description: The URI that the customer should be redirected to in order to complete the payment. example: https://api.checkout.com/3ds/pay_mbabizu24mvu3mela5njyhpit4 nullable: true payment_response: type: object description: The Checkout.com payment response, used to fetch internal data. example: foo: bar nullable: true mismatched_amounts: type: boolean description: Indicates if the order current amount differs form the one of the associated authorization. example: false nullable: true payment_instrument: type: object description: Information about the payment instrument used in the transaction. example: issuer: cl bank card_type: visa nullable: true created_at: type: string description: Time at which the resource was created. example: '2018-01-01T12:00:00.000Z' nullable: false updated_at: type: string description: Time at which the resource was last updated. example: '2018-01-01T12:00:00.000Z' nullable: false reference: type: string description: A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever. example: ANY-EXTERNAL-REFEFERNCE nullable: true reference_origin: type: string description: Any identifier of the third party system that defines the reference code. example: ANY-EXTERNAL-REFEFERNCE-ORIGIN nullable: true metadata: type: object description: Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format. example: foo: bar nullable: true relationships: type: object properties: order: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - orders id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN payment_gateway: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - payment_gateways id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN event_stores: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - event_stores id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN adyenPayment: type: object properties: data: type: object required: - type - attributes properties: type: type: string description: The resource's type enum: - adyen_payments attributes: type: object properties: public_key: type: string description: The public key linked to your API credential. example: xxxx-yyyy-zzzz nullable: true payment_methods: type: object description: The merchant available payment methods for the assoiated order (i.e. country and amount). Required by the Adyen JS SDK. example: foo: bar nullable: false payment_request_data: type: object description: The Adyen payment request data, collected by client. example: foo: bar nullable: true payment_request_details: type: object description: The Adyen additional details request data, collected by client. example: foo: bar nullable: true payment_response: type: object description: The Adyen payment response, used by client (includes 'resultCode' and 'action'). example: foo: bar nullable: true mismatched_amounts: type: boolean description: Indicates if the order current amount differs form the one of the associated authorization. example: false nullable: true balance: type: integer description: The balance remaining on a shopper's gift card, must be computed by using its related trigger attribute. example: 1000 nullable: true expires_at: type: string description: The expiration date/time of this Adyen payment (valid for partial payments only). example: '2018-01-02T12:00:00.000Z' nullable: true payment_instrument: type: object description: Information about the payment instrument used in the transaction. example: issuer: cl bank card_type: visa nullable: true created_at: type: string description: Time at which the resource was created. example: '2018-01-01T12:00:00.000Z' nullable: false updated_at: type: string description: Time at which the resource was last updated. example: '2018-01-01T12:00:00.000Z' nullable: false reference: type: string description: A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever. example: ANY-EXTERNAL-REFEFERNCE nullable: true reference_origin: type: string description: Any identifier of the third party system that defines the reference code. example: ANY-EXTERNAL-REFEFERNCE-ORIGIN nullable: true metadata: type: object description: Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format. example: foo: bar nullable: true relationships: type: object properties: order: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - orders id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN payment_gateway: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - payment_gateways id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN event_stores: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - event_stores id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN orderResponseList: type: object properties: data: type: array items: $ref: '#/components/schemas/orderResponse/properties/data' stripePayment: type: object properties: data: type: object required: - type - attributes properties: type: type: string description: The resource's type enum: - stripe_payments attributes: type: object properties: stripe_id: type: string description: The Stripe payment intent ID. Required to identify a payment session on stripe. example: pi_1234XXX nullable: true client_secret: type: string description: The Stripe payment intent client secret. Required to create a charge through Stripe.js. example: pi_1234XXX_secret_5678YYY nullable: true connected_account: type: string description: The account (if any) for which the funds of the PaymentIntent are intended. example: acct_xxxx-yyyy-zzzz nullable: true charge_id: type: string description: The Stripe charge ID. Identifies money movement upon the payment intent confirmation. example: ch_1234XXX nullable: true publishable_key: type: string description: The Stripe publishable API key. example: pk_live_xxxx-yyyy-zzzz nullable: true on_behalf_of: type: string description: The Stripe account ID that these funds are intended for. example: xxxx-yyyy-zzzz nullable: true transfer_group: type: string description: A string that identifies the resulting payment as part of a group. example: xxxx-yyyy-zzzz nullable: true options: type: object description: 'Stripe payment options: ''customer'', ''payment_method'', ''return_url'', etc. Check Stripe payment intent API for more details.' example: customer: cus_xxx payment_method: pm_xxx nullable: true payment_method: type: object description: Stripe 'payment_method', set by webhook. example: id: pm_xxx nullable: true mismatched_amounts: type: boolean description: Indicates if the order current amount differs form the one of the created payment intent. example: false nullable: true return_url: type: string description: The URL to return to when a redirect payment is completed. example: https://yourdomain.com/thankyou nullable: true receipt_email: type: string description: The email address to send the receipt to. example: john@example.com nullable: true payment_instrument: type: object description: Information about the payment instrument used in the transaction. example: issuer: cl bank card_type: visa nullable: true created_at: type: string description: Time at which the resource was created. example: '2018-01-01T12:00:00.000Z' nullable: false updated_at: type: string description: Time at which the resource was last updated. example: '2018-01-01T12:00:00.000Z' nullable: false reference: type: string description: A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever. example: ANY-EXTERNAL-REFEFERNCE nullable: true reference_origin: type: string description: Any identifier of the third party system that defines the reference code. example: ANY-EXTERNAL-REFEFERNCE-ORIGIN nullable: true metadata: type: object description: Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format. example: foo: bar nullable: true relationships: type: object properties: order: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - orders id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN payment_gateway: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - payment_gateways id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN event_stores: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - event_stores id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN klarnaPayment: type: object properties: data: type: object required: - type - attributes properties: type: type: string description: The resource's type enum: - klarna_payments attributes: type: object properties: session_id: type: string description: The identifier of the payment session. example: xxxx-yyyy-zzzz nullable: true client_token: type: string description: The public token linked to your API credential. Available upon session creation. example: xxxx-yyyy-zzzz nullable: true payment_methods: type: array description: The merchant available payment methods for the assoiated order. Available upon session creation. example: - foo: bar nullable: false items: type: object auth_token: type: string description: The token returned by a successful client authorization, mandatory to place the order. example: xxxx-yyyy-zzzz nullable: true mismatched_amounts: type: boolean description: Indicates if the order current amount differs form the one of the created payment intent. example: false nullable: true payment_instrument: type: object description: Information about the payment instrument used in the transaction. example: issuer: cl bank card_type: visa nullable: true created_at: type: string description: Time at which the resource was created. example: '2018-01-01T12:00:00.000Z' nullable: false updated_at: type: string description: Time at which the resource was last updated. example: '2018-01-01T12:00:00.000Z' nullable: false reference: type: string description: A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever. example: ANY-EXTERNAL-REFEFERNCE nullable: true reference_origin: type: string description: Any identifier of the third party system that defines the reference code. example: ANY-EXTERNAL-REFEFERNCE-ORIGIN nullable: true metadata: type: object description: Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format. example: foo: bar nullable: true relationships: type: object properties: order: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - orders id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN payment_gateway: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - payment_gateways id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN event_stores: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - event_stores id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN externalPayment: type: object properties: data: type: object required: - type - attributes properties: type: type: string description: The resource's type enum: - external_payments attributes: type: object properties: payment_source_token: type: string description: The payment source token, as generated by the external gateway SDK. Credit Card numbers are rejected. example: xxxx.yyyy.zzzz nullable: false options: type: object description: External payment options. example: foo: bar nullable: true payment_instrument: type: object description: Information about the payment instrument used in the transaction. example: issuer: cl bank card_type: visa nullable: true created_at: type: string description: Time at which the resource was created. example: '2018-01-01T12:00:00.000Z' nullable: false updated_at: type: string description: Time at which the resource was last updated. example: '2018-01-01T12:00:00.000Z' nullable: false reference: type: string description: A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever. example: ANY-EXTERNAL-REFEFERNCE nullable: true reference_origin: type: string description: Any identifier of the third party system that defines the reference code. example: ANY-EXTERNAL-REFEFERNCE-ORIGIN nullable: true metadata: type: object description: Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format. example: foo: bar nullable: true relationships: type: object properties: order: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - orders id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN payment_gateway: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - payment_gateways id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN wallet: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - customer_payment_sources id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN event_stores: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - event_stores id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN orders_stats_request: type: object properties: filter: $ref: '#/components/schemas/orders_filter' stats: type: object description: Check available [fields](#/components/schemas/orders_stats_request/properties/stats/properties/field/description) required: - field properties: field: type: string description: "These are the valid values you can specify for the field key of the stats query and the related valid operators, based on that key:\n\n\n \n| Value | Operators |\n| --- | --------- |\n|**`customer.id`** |

`cardinality`

`value_count`

|\n|**`customer.email`** |

`cardinality`

`value_count`

|\n|**`customer.group_name`** |

`cardinality`

`value_count`

|\n|**`customer.reference`** |

`cardinality`

`value_count`

|\n|**`customer.reference_origin`** |

`cardinality`

`value_count`

|\n|**`line_items.code`** |

`cardinality`

`value_count`

|\n|**`line_items.discount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`line_items.id`** |

`cardinality`

`value_count`

|\n|**`line_items.item_id`** |

`cardinality`

`value_count`

|\n|**`line_items.options_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`line_items.quantity`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`line_items.tax_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`line_items.tax_rate`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`line_items.total_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`line_items.unit_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`line_items.options.id`** |

`cardinality`

`value_count`

|\n|**`line_items.options.quantity`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`line_items.options.total_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`line_items.options.unit_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`market.id`** |

`cardinality`

|\n|**`market.number`** |

`cardinality`

`value_count`

|\n|**`order.adjustment_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.adjustment_tax_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.adjustment_taxable_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.discount_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.duty_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.gift_card_code`** |

`value_count`

|\n|**`order.gift_card_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.id`** |

`cardinality`

`value_count`

|\n|**`order.line_item_options_count`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.number`** |

`value_count`

|\n|**`order.payment_method_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.payment_method_tax_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.payment_method_taxable_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.reference`** |

`cardinality`

`value_count`

|\n|**`order.reference_origin`** |

`cardinality`

`value_count`

|\n|**`order.shipments_count`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.shipping_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.shipping_taxable_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.skus_count`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.subtotal_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.subtotal_tax_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.subtotal_taxable_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.total_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.total_amount_with_taxes`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.total_tax_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.total_taxable_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.seconds_in_draft`** |

`avg`

`max`

`min`

`stats`

`percentiles`

|\n|**`order.seconds_in_approved`** |

`avg`

`max`

`min`

`stats`

`percentiles`

|\n|**`order.seconds_in_placed`** |

`avg`

`max`

`min`

`stats`

`percentiles`

|\n|**`order.refunds_total_amount_with_taxes`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.total_amount_with_taxes_net_of_refunds`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`refunds.id`** |

`value_count`

|\n|**`refunds.amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`refunds.number`** |

`value_count`

|\n|**`shipments.id`** |

`cardinality`

`value_count`

|\n|**`shipments.number`** |

`cardinality`

`value_count`

|\n|**`shipments.items_count`** |

`avg`

`max`

`min`

`stats`

`percentiles`

|\n|**`shipments.cost_amount`** |

`avg`

`max`

`min`

`stats`

`percentiles`

|\n|**`shipments.reference`** |

`cardinality`

`value_count`

|\n|**`shipments.reference_origin`** |

`cardinality`

`value_count`

|\n|**`shipments.seconds_in_picking`** |

`avg`

`max`

`min`

`stats`

`percentiles`

|\n|**`shipments.seconds_in_ready_to_ship`** |

`avg`

`max`

`min`

`stats`

`percentiles`

|\n|**`shipments.seconds_in_shipped`** |

`avg`

`max`

`min`

`stats`

`percentiles`

|\n|**`shipments.fulfillment_time`** |

`avg`

`max`

`min`

`stats`

`percentiles`

|\n|**`shipments.stock_location.id`** |

`cardinality`

`value_count`

|\n|**`shipments.stock_location.reference`** |

`cardinality`

`value_count`

|\n|**`shipments.stock_location.reference_origin`** |

`cardinality`

`value_count`

|\n|**`shipments.shipping_method.id`** |

`cardinality`

`value_count`

|\n|**`shipments.shipping_method.reference`** |

`cardinality`

`value_count`

|\n|**`shipments.shipping_method.reference_origin`** |

`cardinality`

`value_count`

|\n|**`shipments.shipping_category.id`** |

`cardinality`

`value_count`

|\n|**`shipments.shipping_category.reference`** |

`cardinality`

`value_count`

|\n|**`shipments.shipping_category.reference_origin`** |

`cardinality`

`value_count`

|\n|**`resource_errors.code`** |

`cardinality`

`value_count`

|\n|**`resource_errors.id`** |

`cardinality`

`value_count`

|\n|**`resource_errors.message`** |

`cardinality`

`value_count`

|\n" enum: - customer.id - customer.email - customer.group_name - customer.reference - customer.reference_origin - line_items.code - line_items.discount - line_items.id - line_items.item_id - line_items.options_amount - line_items.quantity - line_items.tax_amount - line_items.tax_rate - line_items.total_amount - line_items.unit_amount - line_items.options.id - line_items.options.quantity - line_items.options.total_amount - line_items.options.unit_amount - market.id - market.number - order.adjustment_amount - order.adjustment_tax_amount - order.adjustment_taxable_amount - order.discount_amount - order.duty_amount - order.gift_card_code - order.gift_card_amount - order.id - order.line_item_options_count - order.number - order.payment_method_amount - order.payment_method_tax_amount - order.payment_method_taxable_amount - order.reference - order.reference_origin - order.shipments_count - order.shipping_amount - order.shipping_taxable_amount - order.skus_count - order.subtotal_amount - order.subtotal_tax_amount - order.subtotal_taxable_amount - order.total_amount - order.total_amount_with_taxes - order.total_tax_amount - order.total_taxable_amount - order.seconds_in_draft - order.seconds_in_approved - order.seconds_in_placed - order.refunds_total_amount_with_taxes - order.total_amount_with_taxes_net_of_refunds - refunds.id - refunds.amount - refunds.number - shipments.id - shipments.number - shipments.items_count - shipments.cost_amount - shipments.reference - shipments.reference_origin - shipments.seconds_in_picking - shipments.seconds_in_ready_to_ship - shipments.seconds_in_shipped - shipments.fulfillment_time - shipments.stock_location.id - shipments.stock_location.reference - shipments.stock_location.reference_origin - shipments.shipping_method.id - shipments.shipping_method.reference - shipments.shipping_method.reference_origin - shipments.shipping_category.id - shipments.shipping_category.reference - shipments.shipping_category.reference_origin - resource_errors.code - resource_errors.id - resource_errors.message operator: type: string description: Operator to apply enum: - cardinality - value_count - avg - max - min - sum - stats - percentiles meta: type: object properties: payload: type: boolean description: Set to true if you want to receive how the payload has been made axervePayment: type: object properties: data: type: object required: - type - attributes properties: type: type: string description: The resource's type enum: - axerve_payments attributes: type: object properties: login: type: string description: The merchant login code. example: xxxx-yyyy-zzzz nullable: false return_url: type: string description: The URL where the payer is redirected after they approve the payment. example: https://yourdomain.com/thankyou nullable: false payment_request_data: type: object description: The Axerve payment request data, collected by client. example: foo: bar nullable: true client_ip: type: string description: The IP adress of the client creating the payment. example: 213.45.120.5 nullable: true buyer_details: type: object description: The details of the buyer creating the payment. example: cardHolder: email: george.harrison@gmail.com shippingAddress: firstName: George nullable: true request_token: type: boolean description: Requires the creation of a token to represent this payment, mandatory to use customer's wallet and order subscriptions. example: true nullable: true mismatched_amounts: type: boolean description: Indicates if the order current amount differs form the one of the associated authorization. example: false nullable: true payment_instrument: type: object description: Information about the payment instrument used in the transaction. example: issuer: cl bank card_type: visa nullable: true created_at: type: string description: Time at which the resource was created. example: '2018-01-01T12:00:00.000Z' nullable: false updated_at: type: string description: Time at which the resource was last updated. example: '2018-01-01T12:00:00.000Z' nullable: false reference: type: string description: A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever. example: ANY-EXTERNAL-REFEFERNCE nullable: true reference_origin: type: string description: Any identifier of the third party system that defines the reference code. example: ANY-EXTERNAL-REFEFERNCE-ORIGIN nullable: true metadata: type: object description: Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format. example: foo: bar nullable: true relationships: type: object properties: order: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - orders id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN payment_gateway: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - payment_gateways id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN event_stores: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - event_stores id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN orderCreate: required: - data type: object properties: data: type: object required: - type - attributes properties: type: type: string description: The resource's type enum: - orders attributes: type: object properties: number: type: string description: The order identifier. Can be specified if unique within the organization (for enterprise plans only), default to numeric ID otherwise. Cannot be passed by sales channels. example: '1234' affiliate_code: type: string description: The affiliate code, if any, to track commissions using any third party services. example: xxxx-yyyy-zzzz autorefresh: type: boolean description: Save this attribute as 'false' if you want prevent the order to be refreshed automatically at each change (much faster). example: true place_async: type: boolean description: Save this attribute as 'true' if you want perform the place asynchronously. Payment errors, if any, will be collected afterwards. example: true guest: type: boolean description: Indicates if the order has been placed as guest. example: true customer_email: type: string description: The email address of the associated customer. When creating or updating an order, this is a shortcut to find or create the associated customer by email. example: john@example.com customer_password: type: string description: The password of the associated customer. When creating or updating an order, this is a shortcut to sign up the associated customer. example: secret language_code: type: string description: The preferred language code (ISO 639-1) to be used when communicating with the customer. This can be useful when sending the order to 3rd party marketing tools and CRMs. If the language is supported, the hosted checkout will be localized accordingly. example: it freight_taxable: type: boolean description: Indicates if taxes are applied to shipping costs. example: true payment_method_taxable: type: boolean description: Indicates if taxes are applied to payment methods costs. example: true adjustment_taxable: type: boolean description: Indicates if taxes are applied to positive adjustments. example: true gift_card_taxable: type: boolean description: Indicates if taxes are applied to purchased gift cards. example: false shipping_country_code_lock: type: string description: The country code that you want the shipping address to be locked to. This can be useful to make sure the shipping address belongs to a given shipping country, e.g. the one selected in a country selector page. Not relevant if order contains only digital products. example: IT coupon_code: type: string description: The coupon code to be used for the order. If valid, it triggers a promotion adding a discount line item to the order. example: SUMMERDISCOUNT gift_card_code: type: string description: The gift card code (at least the first 8 characters) to be used for the order. If valid, it uses the gift card balance to pay for the order. example: cc92c23e-967e-48b2-a323-59add603301f cart_url: type: string description: The cart url on your site. If present, it will be used on our hosted checkout application. example: https://yourdomain.com/cart return_url: type: string description: The return url on your site. If present, it will be used on our hosted checkout application. example: https://yourdomain.com/ terms_url: type: string description: The terms and conditions url on your site. If present, it will be used on our hosted checkout application. example: https://yourdomain.com/terms privacy_url: type: string description: The privacy policy url on your site. If present, it will be used on our hosted checkout application. example: https://yourdomain.com/privacy expires_at: type: string description: The expiration date/time of this order. Cannot be passed by sales channels. example: '2018-01-02T12:00:00.000Z' expiration_info: type: object description: The information related to the order expiration, in case expires_at is not null. Cannot be passed by sales channels. example: summary_message: Your tickets are reserved for the remaining time. expired_message: Your session has expired. Please start your checkout again. redirect_url: https://yourshop.com/ reference: type: string description: A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever. example: ANY-EXTERNAL-REFEFERNCE reference_origin: type: string description: Any identifier of the third party system that defines the reference code. example: ANY-EXTERNAL-REFEFERNCE-ORIGIN metadata: type: object description: Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format. example: foo: bar relationships: type: object properties: market: required: - data type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - markets id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN customer: required: - data type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - customers id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN shipping_address: required: - data type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - addresses id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN billing_address: required: - data type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - addresses id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN store: required: - data type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - stores id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN payment_method: required: - data type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - payment_methods id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN payment_source: required: - data type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - adyen_payments - axerve_payments - braintree_payments - checkout_com_payments - external_payments - klarna_payments - paypal_payments - satispay_payments - stripe_payments - wire_transfers id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN oneOf: - $ref: '#/components/schemas/adyenPayment' - $ref: '#/components/schemas/axervePayment' - $ref: '#/components/schemas/braintreePayment' - $ref: '#/components/schemas/checkoutComPayment' - $ref: '#/components/schemas/externalPayment' - $ref: '#/components/schemas/klarnaPayment' - $ref: '#/components/schemas/paypalPayment' - $ref: '#/components/schemas/satispayPayment' - $ref: '#/components/schemas/stripePayment' - $ref: '#/components/schemas/wireTransfer' tags: required: - data type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - tags id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN orders_export_fields: type: string enum: - billing_address.business - billing_address.city - billing_address.country_code - billing_address.geocoded - billing_address.localized - billing_address.state_code - billing_address.zip_code - billing_address.company - billing_address.first_name - billing_address.last_name - customer.id - customer.email - customer.group_name - customer.reference - customer.reference_origin - market.id - market.name - market.number - organization.id - organization.name - organization.slug - order.discounted - order.refunded - order.gift_card - order.coupon - order.customer_type - order.returned - order.options - order.adjustment_amount - order.adjustment_tax_amount - order.adjustment_taxable_amount - order.approved_at - order.archived_at - order.archived - order.cancelled_at - order.country_code - order.coupon_code - order.created_at - order.currency_code - order.discount_amount - order.duty_amount - order.freight_taxable - order.fulfillment_status - order.fulfillment_updated_at - order.gift_card_code - order.gift_card_amount - order.guest - order.id - order.language_code - order.line_item_options_count - order.mode - order.number - order.payment_method_amount - order.payment_method_tax_amount - order.payment_method_taxable_amount - order.payment_status - order.payment_updated_at - order.placed_at - order.reference - order.reference_origin - order.shipments_count - order.shipping_amount - order.shipping_taxable_amount - order.skus_count - order.status - order.subtotal_amount - order.subtotal_tax_amount - order.subtotal_taxable_amount - order.tax_included - order.total_amount - order.total_amount_with_taxes - order.total_tax_amount - order.total_taxable_amount - order.updated_at - order.current_date - order.seconds_in_draft - order.seconds_in_approved - order.seconds_in_placed - order.placed_day_of_week - order.refunds_total_amount_with_taxes - order.total_amount_with_taxes_net_of_refunds - order.aggregated_details - order.link_id - order.user_id - order.store_id - order.affiliate_code - payment_method.id - payment_method.source_type - payment_method.name - payment_method.moto - payment_method.issuer - payment_method.issuer_type - payment_method.card_type - shipping_address.business - shipping_address.city - shipping_address.country_code - shipping_address.geocoded - shipping_address.localized - shipping_address.state_code - shipping_address.zip_code - tags.id - tags.name orders_breakdown_request: type: object properties: filter: $ref: '#/components/schemas/orders_filter' breakdown: type: object description: Check available [fields](#/components/schemas/orders_breakdown_request/properties/breakdown/properties/field/description) required: - by - field - operator properties: by: type: string description: "Field to base your breakdown query.\n\nForbidden nesting\n\n These are the valid values you can specify for the by key of the breakdown query and the related forbidden values for the by key of the nested breakdown, based on the by key of the parent breakdown (i.e. for each row of the table below the full list of the valid values for the by key of the nested breakdown is given by all the values in the \"Value\" column except the values in the row's \"Forbidden nesting\" cell):\n\n\n \n| Value | Forbidden nesting |\n| --- | ------ |\n|**`billing_address.business`** |

`billing_address.geocoded`

`billing_address.localized`

`customer.*`

`shipping_address.*`

`line_items.item_type`

`order.freight_taxable`

`order.fulfillment_status`

`order.payment_status`

`order.status`

|\n|**`billing_address.city`** |

`billing_address.country_code`

`billing_address.state_code`

`customer.*`

`shipping_address.*`

`line_items.item_type`

|\n|**`billing_address.country_code`** |

`customer.*`

`shipping_address.*`

`line_items.item_type`

|\n|**`billing_address.geocoded`** |

`billing_address.*`

`customer.*`

`shipping_address.*`

`line_items.item_type`

|\n|**`billing_address.localized`** |

`billing_address.*`

`customer.*`

`shipping_address.*`

`line_items.item_type`

|\n|**`billing_address.state_code`** |

`billing_address.country_code`

`customer.*`

`shipping_address.*`

`line_items.item_type`

|\n|**`billing_address.zip_code`** |

`billing_address.country_code`

`billing_address.city`

`billing_address.geocoded`

`billing_address.localized`

`customer.*`

`shipping_address.*`

`line_items.item_type`

|\n|**`customer.id`** | |\n|**`customer.email`** | |\n|**`customer.group_name`** | |\n|**`customer.reference`** | |\n|**`customer.reference_origin`** | |\n|**`line_items.code`** | |\n|**`line_items.id`** | |\n|**`line_items.item_id`** | |\n|**`line_items.item_type`** | |\n|**`line_items.name`** | |\n|**`line_items.options.id`** |

`line_items.*`

`shipments.*`

|\n|**`line_items.options.name`** |

`line_items.*`

`shipments.*`

|\n|**`market.id`** |

`billing_address.geocoded`

`billing_address.localized`

`shipping_address.geocoded`

`shipping_address.localized`

`line_items.item_type`

|\n|**`market.name`** | |\n|**`market.number`** | |\n|**`order.customer_type`** | |\n|**`order.country_code`** | |\n|**`order.coupon_code`** | |\n|**`order.currency_code`** | |\n|**`order.freight_taxable`** | |\n|**`order.fulfillment_status`** | |\n|**`order.gift_card_code`** | |\n|**`order.guest`** | |\n|**`order.language_code`** | |\n|**`order.payment_status`** | |\n|**`order.reference`** | |\n|**`order.reference_origin`** | |\n|**`order.status`** | |\n|**`order.tax_included`** | |\n|**`order.placed_day_of_week`** | |\n|**`order.link_id`** | |\n|**`order.user_id`** | |\n|**`order.store_id`** | |\n|**`order.affiliate_code`** | |\n|**`payment_method.id`** | |\n|**`payment_method.source_type`** | |\n|**`payment_method.name`** | |\n|**`payment_method.moto`** | |\n|**`payment_method.issuer`** | |\n|**`payment_method.issuer_type`** | |\n|**`payment_method.card_type`** | |\n|**`shipping_address.business`** |

`shipping_address.geocoded`

`shipping_address.localized`

`customer.*`

`billing_address.*`

`line_items.item_type`

`order.freight_taxable`

`order.fulfillment_status`

`order.payment_status`

`order.status`

|\n|**`shipping_address.city`** |

`shipping_address.country_code`

`shipping_address.state_code`

`customer.*`

`billing_address.*`

`line_items.item_type`

|\n|**`shipping_address.country_code`** |

`customer.*`

`billing_address.*`

`line_items.item_type`

|\n|**`shipping_address.geocoded`** |

`billing_address.*`

`customer.*`

`shipping_address.*`

`line_items.item_type`

|\n|**`shipping_address.localized`** |

`billing_address.*`

`customer.*`

`shipping_address.*`

`line_items.item_type`

|\n|**`shipping_address.state_code`** |

`shipping_address.country_code`

`customer.*`

`billing_address.*`

`line_items.item_type`

|\n|**`shipping_address.zip_code`** |

`shipping_address.country_code`

`shipping_address.city`

`shipping_address.geocoded`

`shipping_address.localized`

`customer.*`

`billing_address.*`

`line_items.item_type`

|\n|**`shipments.status`** | |\n|**`shipments.reference`** | |\n|**`shipments.reference_origin`** | |\n|**`shipments.items`** | |\n|**`shipments.stock_location.name`** | |\n|**`shipments.stock_location.reference`** | |\n|**`shipments.stock_location.reference_origin`** | |\n|**`shipments.shipping_method.id`** | |\n|**`shipments.shipping_method.name`** | |\n|**`shipments.shipping_method.reference`** | |\n|**`shipments.shipping_method.reference_origin`** | |\n|**`shipments.shipping_method.currency_code`** | |\n|**`shipments.shipping_category.name`** | |\n|**`shipments.shipping_category.reference`** | |\n|**`shipments.shipping_category.reference_origin`** | |\n|**`shipments.tags.id`** | |\n|**`shipments.tags.name`** | |\n|**`tags.id`** | |\n|**`tags.name`** | |\n|**`resource_errors.code`** | |\n|**`resource_errors.name`** | |\n|**`resource_errors.id`** | |\n|**`resource_errors.message`** | |\n" enum: - billing_address.business - billing_address.city - billing_address.country_code - billing_address.geocoded - billing_address.localized - billing_address.state_code - billing_address.zip_code - customer.id - customer.email - customer.group_name - customer.reference - customer.reference_origin - line_items.code - line_items.id - line_items.item_id - line_items.item_type - line_items.name - line_items.options.id - line_items.options.name - market.id - market.name - market.number - organization.id - organization.name - organization.slug - order.customer_type - order.country_code - order.coupon_code - order.currency_code - order.freight_taxable - order.fulfillment_status - order.gift_card_code - order.guest - order.language_code - order.mode - order.payment_status - order.reference - order.reference_origin - order.status - order.tax_included - order.placed_day_of_week - order.link_id - order.user_id - order.store_id - order.affiliate_code - payment_method.id - payment_method.source_type - payment_method.name - payment_method.moto - payment_method.issuer - payment_method.issuer_type - payment_method.card_type - shipping_address.business - shipping_address.city - shipping_address.country_code - shipping_address.geocoded - shipping_address.localized - shipping_address.state_code - shipping_address.zip_code - shipments.status - shipments.reference - shipments.reference_origin - shipments.items - shipments.stock_location.name - shipments.stock_location.reference - shipments.stock_location.reference_origin - shipments.shipping_method.id - shipments.shipping_method.name - shipments.shipping_method.reference - shipments.shipping_method.reference_origin - shipments.shipping_method.currency_code - shipments.shipping_category.name - shipments.shipping_category.reference - shipments.shipping_category.reference_origin - shipments.tags.id - shipments.tags.name - tags.id - tags.name - resource_errors.code - resource_errors.name - resource_errors.id - resource_errors.message field: type: string description: "These are the valid values you can specify for the field key of the breakdown query and the related valid operators, based on that key:\n\n\n \n| Value | Operators |\n| --- | --------- |\n|**`customer.id`** |

`cardinality`

`value_count`

|\n|**`customer.email`** |

`cardinality`

`value_count`

|\n|**`customer.group_name`** |

`cardinality`

`value_count`

|\n|**`customer.reference`** |

`cardinality`

`value_count`

|\n|**`customer.reference_origin`** |

`cardinality`

`value_count`

|\n|**`line_items.code`** |

`cardinality`

`value_count`

|\n|**`line_items.discount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`line_items.id`** |

`cardinality`

`value_count`

|\n|**`line_items.item_id`** |

`cardinality`

`value_count`

|\n|**`line_items.options_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`line_items.quantity`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`line_items.tax_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`line_items.tax_rate`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`line_items.total_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`line_items.unit_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`line_items.options.id`** |

`cardinality`

`value_count`

|\n|**`line_items.options.quantity`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`line_items.options.total_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`line_items.options.unit_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`market.id`** |

`cardinality`

|\n|**`market.number`** |

`cardinality`

`value_count`

|\n|**`order.adjustment_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.adjustment_tax_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.adjustment_taxable_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.discount_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.duty_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.gift_card_code`** |

`value_count`

|\n|**`order.gift_card_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.id`** |

`cardinality`

`value_count`

|\n|**`order.line_item_options_count`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.number`** |

`value_count`

|\n|**`order.payment_method_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.payment_method_tax_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.payment_method_taxable_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.reference`** |

`cardinality`

`value_count`

|\n|**`order.reference_origin`** |

`cardinality`

`value_count`

|\n|**`order.shipments_count`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.shipping_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.shipping_taxable_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.skus_count`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.subtotal_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.subtotal_tax_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.subtotal_taxable_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.total_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.total_amount_with_taxes`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.total_tax_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.total_taxable_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.seconds_in_draft`** |

`avg`

`max`

`min`

`stats`

`percentiles`

|\n|**`order.seconds_in_approved`** |

`avg`

`max`

`min`

`stats`

`percentiles`

|\n|**`order.seconds_in_placed`** |

`avg`

`max`

`min`

`stats`

`percentiles`

|\n|**`order.refunds_total_amount_with_taxes`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.total_amount_with_taxes_net_of_refunds`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`refunds.id`** |

`value_count`

|\n|**`refunds.amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`refunds.number`** |

`value_count`

|\n|**`shipments.id`** |

`cardinality`

`value_count`

|\n|**`shipments.number`** |

`cardinality`

`value_count`

|\n|**`shipments.items_count`** |

`avg`

`max`

`min`

`stats`

`percentiles`

|\n|**`shipments.cost_amount`** |

`avg`

`max`

`min`

`stats`

`percentiles`

|\n|**`shipments.reference`** |

`cardinality`

`value_count`

|\n|**`shipments.reference_origin`** |

`cardinality`

`value_count`

|\n|**`shipments.seconds_in_picking`** |

`avg`

`max`

`min`

`stats`

`percentiles`

|\n|**`shipments.seconds_in_ready_to_ship`** |

`avg`

`max`

`min`

`stats`

`percentiles`

|\n|**`shipments.seconds_in_shipped`** |

`avg`

`max`

`min`

`stats`

`percentiles`

|\n|**`shipments.fulfillment_time`** |

`avg`

`max`

`min`

`stats`

`percentiles`

|\n|**`shipments.stock_location.id`** |

`cardinality`

`value_count`

|\n|**`shipments.stock_location.reference`** |

`cardinality`

`value_count`

|\n|**`shipments.stock_location.reference_origin`** |

`cardinality`

`value_count`

|\n|**`shipments.shipping_method.id`** |

`cardinality`

`value_count`

|\n|**`shipments.shipping_method.reference`** |

`cardinality`

`value_count`

|\n|**`shipments.shipping_method.reference_origin`** |

`cardinality`

`value_count`

|\n|**`shipments.shipping_category.id`** |

`cardinality`

`value_count`

|\n|**`shipments.shipping_category.reference`** |

`cardinality`

`value_count`

|\n|**`shipments.shipping_category.reference_origin`** |

`cardinality`

`value_count`

|\n|**`resource_errors.code`** |

`cardinality`

`value_count`

|\n|**`resource_errors.id`** |

`cardinality`

`value_count`

|\n|**`resource_errors.message`** |

`cardinality`

`value_count`

|\n" enum: - customer.id - customer.email - customer.group_name - customer.reference - customer.reference_origin - line_items.code - line_items.discount - line_items.id - line_items.item_id - line_items.options_amount - line_items.quantity - line_items.tax_amount - line_items.tax_rate - line_items.total_amount - line_items.unit_amount - line_items.options.id - line_items.options.quantity - line_items.options.total_amount - line_items.options.unit_amount - market.id - market.number - order.adjustment_amount - order.adjustment_tax_amount - order.adjustment_taxable_amount - order.discount_amount - order.duty_amount - order.gift_card_code - order.gift_card_amount - order.id - order.line_item_options_count - order.number - order.payment_method_amount - order.payment_method_tax_amount - order.payment_method_taxable_amount - order.reference - order.reference_origin - order.shipments_count - order.shipping_amount - order.shipping_taxable_amount - order.skus_count - order.subtotal_amount - order.subtotal_tax_amount - order.subtotal_taxable_amount - order.total_amount - order.total_amount_with_taxes - order.total_tax_amount - order.total_taxable_amount - order.seconds_in_draft - order.seconds_in_approved - order.seconds_in_placed - order.refunds_total_amount_with_taxes - order.total_amount_with_taxes_net_of_refunds - refunds.id - refunds.amount - refunds.number - shipments.id - shipments.number - shipments.items_count - shipments.cost_amount - shipments.reference - shipments.reference_origin - shipments.seconds_in_picking - shipments.seconds_in_ready_to_ship - shipments.seconds_in_shipped - shipments.fulfillment_time - shipments.stock_location.id - shipments.stock_location.reference - shipments.stock_location.reference_origin - shipments.shipping_method.id - shipments.shipping_method.reference - shipments.shipping_method.reference_origin - shipments.shipping_category.id - shipments.shipping_category.reference - shipments.shipping_category.reference_origin - resource_errors.code - resource_errors.id - resource_errors.message operator: type: string description: Operator to apply enum: - cardinality - value_count - avg - max - min - sum - stats - percentiles sort: type: string description: Result sorting enum: - asc - desc limit: type: integer description: Results limit default: 10 maximum: 100 condition: description: Condition to filter the data over the breakdown result, value of the operator must be a Number or Array of numbers if operator is a range oneOf: - type: object properties: eq: type: number - type: object properties: ne: type: number - type: object properties: gt: type: number - type: object properties: gte: type: number - type: object properties: lt: type: number - type: object properties: lte: type: number - type: object properties: gt_lt: type: array items: type: number - type: object properties: gte_lte: type: array items: type: number - type: object properties: gte_lt: type: array items: type: number - type: object properties: gt_lte: type: array items: type: number additionalProperties: false breakdown: type: object properties: by: type: string description: "Field to base your breakdown query.\n\nForbidden nesting\n\n These are the valid values you can specify for the by key of the breakdown query and the related forbidden values for the by key of the nested breakdown, based on the by key of the parent breakdown (i.e. for each row of the table below the full list of the valid values for the by key of the nested breakdown is given by all the values in the \"Value\" column except the values in the row's \"Forbidden nesting\" cell):\n\n\n \n| Value | Forbidden nesting |\n| --- | ------ |\n|**`billing_address.business`** |

`billing_address.geocoded`

`billing_address.localized`

`customer.*`

`shipping_address.*`

`line_items.item_type`

`order.freight_taxable`

`order.fulfillment_status`

`order.payment_status`

`order.status`

|\n|**`billing_address.city`** |

`billing_address.country_code`

`billing_address.state_code`

`customer.*`

`shipping_address.*`

`line_items.item_type`

|\n|**`billing_address.country_code`** |

`customer.*`

`shipping_address.*`

`line_items.item_type`

|\n|**`billing_address.geocoded`** |

`billing_address.*`

`customer.*`

`shipping_address.*`

`line_items.item_type`

|\n|**`billing_address.localized`** |

`billing_address.*`

`customer.*`

`shipping_address.*`

`line_items.item_type`

|\n|**`billing_address.state_code`** |

`billing_address.country_code`

`customer.*`

`shipping_address.*`

`line_items.item_type`

|\n|**`billing_address.zip_code`** |

`billing_address.country_code`

`billing_address.city`

`billing_address.geocoded`

`billing_address.localized`

`customer.*`

`shipping_address.*`

`line_items.item_type`

|\n|**`customer.id`** | |\n|**`customer.email`** | |\n|**`customer.group_name`** | |\n|**`customer.reference`** | |\n|**`customer.reference_origin`** | |\n|**`line_items.code`** | |\n|**`line_items.id`** | |\n|**`line_items.item_id`** | |\n|**`line_items.item_type`** | |\n|**`line_items.name`** | |\n|**`line_items.options.id`** |

`line_items.*`

`shipments.*`

|\n|**`line_items.options.name`** |

`line_items.*`

`shipments.*`

|\n|**`market.id`** |

`billing_address.geocoded`

`billing_address.localized`

`shipping_address.geocoded`

`shipping_address.localized`

`line_items.item_type`

|\n|**`market.name`** | |\n|**`market.number`** | |\n|**`order.customer_type`** | |\n|**`order.country_code`** | |\n|**`order.coupon_code`** | |\n|**`order.currency_code`** | |\n|**`order.freight_taxable`** | |\n|**`order.fulfillment_status`** | |\n|**`order.gift_card_code`** | |\n|**`order.guest`** | |\n|**`order.language_code`** | |\n|**`order.payment_status`** | |\n|**`order.reference`** | |\n|**`order.reference_origin`** | |\n|**`order.status`** | |\n|**`order.tax_included`** | |\n|**`order.placed_day_of_week`** | |\n|**`order.link_id`** | |\n|**`order.user_id`** | |\n|**`order.store_id`** | |\n|**`order.affiliate_code`** | |\n|**`payment_method.id`** | |\n|**`payment_method.source_type`** | |\n|**`payment_method.name`** | |\n|**`payment_method.moto`** | |\n|**`payment_method.issuer`** | |\n|**`payment_method.issuer_type`** | |\n|**`payment_method.card_type`** | |\n|**`shipping_address.business`** |

`shipping_address.geocoded`

`shipping_address.localized`

`customer.*`

`billing_address.*`

`line_items.item_type`

`order.freight_taxable`

`order.fulfillment_status`

`order.payment_status`

`order.status`

|\n|**`shipping_address.city`** |

`shipping_address.country_code`

`shipping_address.state_code`

`customer.*`

`billing_address.*`

`line_items.item_type`

|\n|**`shipping_address.country_code`** |

`customer.*`

`billing_address.*`

`line_items.item_type`

|\n|**`shipping_address.geocoded`** |

`billing_address.*`

`customer.*`

`shipping_address.*`

`line_items.item_type`

|\n|**`shipping_address.localized`** |

`billing_address.*`

`customer.*`

`shipping_address.*`

`line_items.item_type`

|\n|**`shipping_address.state_code`** |

`shipping_address.country_code`

`customer.*`

`billing_address.*`

`line_items.item_type`

|\n|**`shipping_address.zip_code`** |

`shipping_address.country_code`

`shipping_address.city`

`shipping_address.geocoded`

`shipping_address.localized`

`customer.*`

`billing_address.*`

`line_items.item_type`

|\n|**`shipments.status`** | |\n|**`shipments.reference`** | |\n|**`shipments.reference_origin`** | |\n|**`shipments.items`** | |\n|**`shipments.stock_location.name`** | |\n|**`shipments.stock_location.reference`** | |\n|**`shipments.stock_location.reference_origin`** | |\n|**`shipments.shipping_method.id`** | |\n|**`shipments.shipping_method.name`** | |\n|**`shipments.shipping_method.reference`** | |\n|**`shipments.shipping_method.reference_origin`** | |\n|**`shipments.shipping_method.currency_code`** | |\n|**`shipments.shipping_category.name`** | |\n|**`shipments.shipping_category.reference`** | |\n|**`shipments.shipping_category.reference_origin`** | |\n|**`shipments.tags.id`** | |\n|**`shipments.tags.name`** | |\n|**`tags.id`** | |\n|**`tags.name`** | |\n|**`resource_errors.code`** | |\n|**`resource_errors.name`** | |\n|**`resource_errors.id`** | |\n|**`resource_errors.message`** | |\n" enum: - billing_address.business - billing_address.city - billing_address.country_code - billing_address.geocoded - billing_address.localized - billing_address.state_code - billing_address.zip_code - customer.id - customer.email - customer.group_name - customer.reference - customer.reference_origin - line_items.code - line_items.id - line_items.item_id - line_items.item_type - line_items.name - line_items.options.id - line_items.options.name - market.id - market.name - market.number - organization.id - organization.name - organization.slug - order.customer_type - order.country_code - order.coupon_code - order.currency_code - order.freight_taxable - order.fulfillment_status - order.gift_card_code - order.guest - order.language_code - order.mode - order.payment_status - order.reference - order.reference_origin - order.status - order.tax_included - order.placed_day_of_week - order.link_id - order.user_id - order.store_id - order.affiliate_code - payment_method.id - payment_method.source_type - payment_method.name - payment_method.moto - payment_method.issuer - payment_method.issuer_type - payment_method.card_type - shipping_address.business - shipping_address.city - shipping_address.country_code - shipping_address.geocoded - shipping_address.localized - shipping_address.state_code - shipping_address.zip_code - shipments.status - shipments.reference - shipments.reference_origin - shipments.items - shipments.stock_location.name - shipments.stock_location.reference - shipments.stock_location.reference_origin - shipments.shipping_method.id - shipments.shipping_method.name - shipments.shipping_method.reference - shipments.shipping_method.reference_origin - shipments.shipping_method.currency_code - shipments.shipping_category.name - shipments.shipping_category.reference - shipments.shipping_category.reference_origin - shipments.tags.id - shipments.tags.name - tags.id - tags.name - resource_errors.code - resource_errors.name - resource_errors.id - resource_errors.message field: type: string description: "These are the valid values you can specify for the field key of the breakdown query and the related valid operators, based on that key:\n\n\n \n| Value | Operators |\n| --- | --------- |\n|**`customer.id`** |

`cardinality`

`value_count`

|\n|**`customer.email`** |

`cardinality`

`value_count`

|\n|**`customer.group_name`** |

`cardinality`

`value_count`

|\n|**`customer.reference`** |

`cardinality`

`value_count`

|\n|**`customer.reference_origin`** |

`cardinality`

`value_count`

|\n|**`line_items.code`** |

`cardinality`

`value_count`

|\n|**`line_items.discount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`line_items.id`** |

`cardinality`

`value_count`

|\n|**`line_items.item_id`** |

`cardinality`

`value_count`

|\n|**`line_items.options_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`line_items.quantity`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`line_items.tax_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`line_items.tax_rate`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`line_items.total_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`line_items.unit_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`line_items.options.id`** |

`cardinality`

`value_count`

|\n|**`line_items.options.quantity`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`line_items.options.total_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`line_items.options.unit_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`market.id`** |

`cardinality`

|\n|**`market.number`** |

`cardinality`

`value_count`

|\n|**`order.adjustment_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.adjustment_tax_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.adjustment_taxable_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.discount_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.duty_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.gift_card_code`** |

`value_count`

|\n|**`order.gift_card_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.id`** |

`cardinality`

`value_count`

|\n|**`order.line_item_options_count`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.number`** |

`value_count`

|\n|**`order.payment_method_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.payment_method_tax_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.payment_method_taxable_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.reference`** |

`cardinality`

`value_count`

|\n|**`order.reference_origin`** |

`cardinality`

`value_count`

|\n|**`order.shipments_count`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.shipping_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.shipping_taxable_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.skus_count`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.subtotal_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.subtotal_tax_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.subtotal_taxable_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.total_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.total_amount_with_taxes`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.total_tax_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.total_taxable_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.seconds_in_draft`** |

`avg`

`max`

`min`

`stats`

`percentiles`

|\n|**`order.seconds_in_approved`** |

`avg`

`max`

`min`

`stats`

`percentiles`

|\n|**`order.seconds_in_placed`** |

`avg`

`max`

`min`

`stats`

`percentiles`

|\n|**`order.refunds_total_amount_with_taxes`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`order.total_amount_with_taxes_net_of_refunds`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`refunds.id`** |

`value_count`

|\n|**`refunds.amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`refunds.number`** |

`value_count`

|\n|**`shipments.id`** |

`cardinality`

`value_count`

|\n|**`shipments.number`** |

`cardinality`

`value_count`

|\n|**`shipments.items_count`** |

`avg`

`max`

`min`

`stats`

`percentiles`

|\n|**`shipments.cost_amount`** |

`avg`

`max`

`min`

`stats`

`percentiles`

|\n|**`shipments.reference`** |

`cardinality`

`value_count`

|\n|**`shipments.reference_origin`** |

`cardinality`

`value_count`

|\n|**`shipments.seconds_in_picking`** |

`avg`

`max`

`min`

`stats`

`percentiles`

|\n|**`shipments.seconds_in_ready_to_ship`** |

`avg`

`max`

`min`

`stats`

`percentiles`

|\n|**`shipments.seconds_in_shipped`** |

`avg`

`max`

`min`

`stats`

`percentiles`

|\n|**`shipments.fulfillment_time`** |

`avg`

`max`

`min`

`stats`

`percentiles`

|\n|**`shipments.stock_location.id`** |

`cardinality`

`value_count`

|\n|**`shipments.stock_location.reference`** |

`cardinality`

`value_count`

|\n|**`shipments.stock_location.reference_origin`** |

`cardinality`

`value_count`

|\n|**`shipments.shipping_method.id`** |

`cardinality`

`value_count`

|\n|**`shipments.shipping_method.reference`** |

`cardinality`

`value_count`

|\n|**`shipments.shipping_method.reference_origin`** |

`cardinality`

`value_count`

|\n|**`shipments.shipping_category.id`** |

`cardinality`

`value_count`

|\n|**`shipments.shipping_category.reference`** |

`cardinality`

`value_count`

|\n|**`shipments.shipping_category.reference_origin`** |

`cardinality`

`value_count`

|\n|**`resource_errors.code`** |

`cardinality`

`value_count`

|\n|**`resource_errors.id`** |

`cardinality`

`value_count`

|\n|**`resource_errors.message`** |

`cardinality`

`value_count`

|\n" enum: - customer.id - customer.email - customer.group_name - customer.reference - customer.reference_origin - line_items.code - line_items.discount - line_items.id - line_items.item_id - line_items.options_amount - line_items.quantity - line_items.tax_amount - line_items.tax_rate - line_items.total_amount - line_items.unit_amount - line_items.options.id - line_items.options.quantity - line_items.options.total_amount - line_items.options.unit_amount - market.id - market.number - order.adjustment_amount - order.adjustment_tax_amount - order.adjustment_taxable_amount - order.discount_amount - order.duty_amount - order.gift_card_code - order.gift_card_amount - order.id - order.line_item_options_count - order.number - order.payment_method_amount - order.payment_method_tax_amount - order.payment_method_taxable_amount - order.reference - order.reference_origin - order.shipments_count - order.shipping_amount - order.shipping_taxable_amount - order.skus_count - order.subtotal_amount - order.subtotal_tax_amount - order.subtotal_taxable_amount - order.total_amount - order.total_amount_with_taxes - order.total_tax_amount - order.total_taxable_amount - order.seconds_in_draft - order.seconds_in_approved - order.seconds_in_placed - order.refunds_total_amount_with_taxes - order.total_amount_with_taxes_net_of_refunds - refunds.id - refunds.amount - refunds.number - shipments.id - shipments.number - shipments.items_count - shipments.cost_amount - shipments.reference - shipments.reference_origin - shipments.seconds_in_picking - shipments.seconds_in_ready_to_ship - shipments.seconds_in_shipped - shipments.fulfillment_time - shipments.stock_location.id - shipments.stock_location.reference - shipments.stock_location.reference_origin - shipments.shipping_method.id - shipments.shipping_method.reference - shipments.shipping_method.reference_origin - shipments.shipping_category.id - shipments.shipping_category.reference - shipments.shipping_category.reference_origin - resource_errors.code - resource_errors.id - resource_errors.message operator: type: string description: Operator to apply enum: - cardinality - value_count - avg - max - min - sum - stats - percentiles sort: type: string description: Result sorting enum: - asc - desc limit: type: integer description: Results limit default: 10 maximum: 100 condition: description: Condition to filter the data over the breakdown result, value of the operator must be a Number or Array of numbers if operator is a range oneOf: - type: object properties: eq: type: number - type: object properties: ne: type: number - type: object properties: gt: type: number - type: object properties: gte: type: number - type: object properties: lt: type: number - type: object properties: lte: type: number - type: object properties: gt_lt: type: array items: type: number - type: object properties: gte_lte: type: array items: type: number - type: object properties: gte_lt: type: array items: type: number - type: object properties: gt_lte: type: array items: type: number additionalProperties: false required: - by - field - operator meta: type: object properties: payload: type: boolean description: Set to true if you want to receive how the payload has been made braintreePayment: type: object properties: data: type: object required: - type - attributes properties: type: type: string description: The resource's type enum: - braintree_payments attributes: type: object properties: client_token: type: string description: The Braintree payment client token. Required by the Braintree JS SDK. example: xxxx.yyyy.zzzz nullable: false payment_method_nonce: type: string description: The Braintree payment method nonce. Sent by the Braintree JS SDK. example: xxxx.yyyy.zzzz nullable: true payment_id: type: string description: The Braintree payment ID used by local payment and sent by the Braintree JS SDK. example: xxxx.yyyy.zzzz nullable: true local: type: boolean description: Indicates if the payment is local, in such case Braintree will trigger a webhook call passing the "payment_id" and "payment_method_nonce" in order to complete the transaction. example: true nullable: true options: type: object description: Braintree payment options, 'customer_id' and 'payment_method_token'. example: customer_id: '1234567890' nullable: true payment_instrument: type: object description: Information about the payment instrument used in the transaction. example: issuer: cl bank card_type: visa nullable: true created_at: type: string description: Time at which the resource was created. example: '2018-01-01T12:00:00.000Z' nullable: false updated_at: type: string description: Time at which the resource was last updated. example: '2018-01-01T12:00:00.000Z' nullable: false reference: type: string description: A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever. example: ANY-EXTERNAL-REFEFERNCE nullable: true reference_origin: type: string description: Any identifier of the third party system that defines the reference code. example: ANY-EXTERNAL-REFEFERNCE-ORIGIN nullable: true metadata: type: object description: Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format. example: foo: bar nullable: true relationships: type: object properties: order: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - orders id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN payment_gateway: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - payment_gateways id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN event_stores: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - event_stores id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN orderUpdate: required: - data type: object properties: data: type: object required: - type - id - attributes properties: type: type: string description: The resource's type enum: - orders id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN attributes: type: object properties: number: type: string description: The order identifier. Can be specified if unique within the organization (for enterprise plans only), default to numeric ID otherwise. Cannot be passed by sales channels. example: '1234' nullable: true affiliate_code: type: string description: The affiliate code, if any, to track commissions using any third party services. example: xxxx-yyyy-zzzz nullable: true autorefresh: type: boolean description: Save this attribute as 'false' if you want prevent the order to be refreshed automatically at each change (much faster). example: true nullable: false place_async: type: boolean description: Save this attribute as 'true' if you want perform the place asynchronously. Payment errors, if any, will be collected afterwards. example: true nullable: false guest: type: boolean description: Indicates if the order has been placed as guest. example: true nullable: false customer_email: type: string description: The email address of the associated customer. When creating or updating an order, this is a shortcut to find or create the associated customer by email. example: john@example.com nullable: true customer_password: type: string description: The password of the associated customer. When creating or updating an order, this is a shortcut to sign up the associated customer. example: secret language_code: type: string description: The preferred language code (ISO 639-1) to be used when communicating with the customer. This can be useful when sending the order to 3rd party marketing tools and CRMs. If the language is supported, the hosted checkout will be localized accordingly. example: it nullable: true freight_taxable: type: boolean description: Indicates if taxes are applied to shipping costs. example: true nullable: false payment_method_taxable: type: boolean description: Indicates if taxes are applied to payment methods costs. example: true nullable: false adjustment_taxable: type: boolean description: Indicates if taxes are applied to positive adjustments. example: true nullable: false gift_card_taxable: type: boolean description: Indicates if taxes are applied to purchased gift cards. example: false nullable: false shipping_country_code_lock: type: string description: The country code that you want the shipping address to be locked to. This can be useful to make sure the shipping address belongs to a given shipping country, e.g. the one selected in a country selector page. Not relevant if order contains only digital products. example: IT nullable: true coupon_code: type: string description: The coupon code to be used for the order. If valid, it triggers a promotion adding a discount line item to the order. example: SUMMERDISCOUNT nullable: true gift_card_code: type: string description: The gift card code (at least the first 8 characters) to be used for the order. If valid, it uses the gift card balance to pay for the order. example: cc92c23e-967e-48b2-a323-59add603301f nullable: true cart_url: type: string description: The cart url on your site. If present, it will be used on our hosted checkout application. example: https://yourdomain.com/cart nullable: true return_url: type: string description: The return url on your site. If present, it will be used on our hosted checkout application. example: https://yourdomain.com/ nullable: true terms_url: type: string description: The terms and conditions url on your site. If present, it will be used on our hosted checkout application. example: https://yourdomain.com/terms nullable: true privacy_url: type: string description: The privacy policy url on your site. If present, it will be used on our hosted checkout application. example: https://yourdomain.com/privacy nullable: true _archive: type: boolean description: Send this attribute if you want to archive the order. example: true nullable: false _unarchive: type: boolean description: Send this attribute if you want to unarchive the order. example: true nullable: false _pending: type: boolean description: Send this attribute if you want to move a draft or placing order to pending. Cannot be passed by sales channels. example: true nullable: false _place: type: boolean description: Send this attribute if you want to place the order. example: true nullable: false _cancel: type: boolean description: Send this attribute if you want to cancel a placed order. The order's authorization will be automatically voided. example: true nullable: false _approve: type: boolean description: Send this attribute if you want to approve a placed order. Cannot be passed by sales channels. example: true nullable: false _approve_and_capture: type: boolean description: Send this attribute if you want to approve and capture a placed order. Cannot be passed by sales channels. example: true nullable: false _authorize: type: boolean description: Send this attribute if you want to authorize the order's payment source. example: true nullable: false _authorization_amount_cents: type: integer description: Send this attribute as a value in cents if you want to overwrite the amount to be authorized. example: 500 _capture: type: boolean description: Send this attribute if you want to capture an authorized order. Cannot be passed by sales channels. example: true nullable: false _refund: type: boolean description: Send this attribute if you want to refund a captured order. Cannot be passed by sales channels. example: true nullable: false _fulfill: type: boolean description: Send this attribute if you want to mark as fulfilled the order (shipments must be cancelled, shipped or delivered, alternatively order must be approved). Cannot be passed by sales channels. example: true nullable: false _update_taxes: type: boolean description: Send this attribute if you want to force tax calculation for this order (a tax calculator must be associated to the order's market). example: true nullable: false _nullify_payment_source: type: boolean description: Send this attribute if you want to nullify the payment source for this order. example: false nullable: false _fix_payment_source: type: boolean description: Send this attribute if you want to set the payment source associated with the last succeeded authorization. At the end of the fix the order should be placed and authorized and ready to be approved. A tentative to fix the payment source is done before approval automatically. Cannot be passed by sales channels. example: true nullable: false _billing_address_clone_id: type: string description: The id of the address that you want to clone to create the order's billing address. example: '1234' _shipping_address_clone_id: type: string description: The id of the address that you want to clone to create the order's shipping address. example: '1234' _customer_payment_source_id: type: string description: The id of the customer payment source (i.e. credit card) that you want to use as the order's payment source. example: '1234' _shipping_address_same_as_billing: type: boolean description: Send this attribute if you want the shipping address to be cloned from the order's billing address. example: true nullable: false _billing_address_same_as_shipping: type: boolean description: Send this attribute if you want the billing address to be cloned from the order's shipping address. example: true nullable: false _commit_invoice: type: boolean description: Send this attribute if you want commit the sales tax invoice to the associated tax calculator (currently supported by Avalara). example: true nullable: false _refund_invoice: type: boolean description: Send this attribute if you want refund the sales tax invoice to the associated tax calculator (currently supported by Avalara). example: true nullable: false _save_payment_source_to_customer_wallet: type: boolean description: Send this attribute if you want the order's payment source to be saved in the customer's wallet as a customer payment source. example: true nullable: false _save_shipping_address_to_customer_address_book: type: boolean description: Send this attribute if you want the order's shipping address to be saved in the customer's address book as a customer address. example: true nullable: false _save_billing_address_to_customer_address_book: type: boolean description: Send this attribute if you want the order's billing address to be saved in the customer's address book as a customer address. example: true nullable: false _refresh: type: boolean description: Send this attribute if you want to manually refresh the order. example: true nullable: false _refresh_prices: type: boolean description: Send this attribute if you want to refresh the prices of the line items associated to this order. Cannot be passed by sales channels. example: true nullable: false _validate: type: boolean description: Send this attribute if you want to trigger the external validation for the order. example: true nullable: false _create_subscriptions: type: boolean description: Send this attribute upon/after placing the order if you want to create order subscriptions from the line items that have a frequency. example: true nullable: false _start_editing: type: boolean description: Send this attribute if you want to edit the order after it is placed. Remember you cannot exceed the original total amount. Cannot be passed by sales channels. example: true nullable: false _stop_editing: type: boolean description: Send this attribute to stop the editing for the order and return back to placed status. Cannot be passed by sales channels. example: true nullable: false expires_at: type: string description: The expiration date/time of this order. Cannot be passed by sales channels. example: '2018-01-02T12:00:00.000Z' nullable: true expiration_info: type: object description: The information related to the order expiration, in case expires_at is not null. Cannot be passed by sales channels. example: summary_message: Your tickets are reserved for the remaining time. expired_message: Your session has expired. Please start your checkout again. redirect_url: https://yourshop.com/ nullable: true _reset_circuit: type: boolean description: Send this attribute if you want to reset the circuit breaker associated to this resource to 'closed' state and zero failures count. Cannot be passed by sales channels. example: true nullable: false _add_tags: type: string description: Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels. _remove_tags: type: string description: Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels. reference: type: string description: A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever. example: ANY-EXTERNAL-REFEFERNCE nullable: true reference_origin: type: string description: Any identifier of the third party system that defines the reference code. example: ANY-EXTERNAL-REFEFERNCE-ORIGIN nullable: true metadata: type: object description: Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format. example: foo: bar nullable: true relationships: type: object properties: market: required: - data type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - markets id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN customer: required: - data type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - customers id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN shipping_address: required: - data type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - addresses id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN billing_address: required: - data type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - addresses id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN store: required: - data type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - stores id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN payment_method: required: - data type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - payment_methods id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN payment_source: required: - data type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - adyen_payments - axerve_payments - braintree_payments - checkout_com_payments - external_payments - klarna_payments - paypal_payments - satispay_payments - stripe_payments - wire_transfers id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN oneOf: - $ref: '#/components/schemas/adyenPayment' - $ref: '#/components/schemas/axervePayment' - $ref: '#/components/schemas/braintreePayment' - $ref: '#/components/schemas/checkoutComPayment' - $ref: '#/components/schemas/externalPayment' - $ref: '#/components/schemas/klarnaPayment' - $ref: '#/components/schemas/paypalPayment' - $ref: '#/components/schemas/satispayPayment' - $ref: '#/components/schemas/stripePayment' - $ref: '#/components/schemas/wireTransfer' tags: required: - data type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - tags id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT