openapi: 3.1.0 info: title: Commerce Layer addresses carts 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: carts description: Operations with carts resource paths: /carts/breakdown: post: operationId: POST/carts/breakdown summary: Query breakdown on carts 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: - carts requestBody: required: true content: application/vnd.api+json: schema: $ref: '#/components/schemas/carts_breakdown_request' responses: '200': description: The breakdown result from carts 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.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.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.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.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: 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: 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/carts_filter' breakdown: $ref: '#/components/schemas/carts_breakdown_request/properties/breakdown' /carts/date_breakdown: post: operationId: POST/carts/date_breakdown summary: Query date_breakdown on carts 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\": \"order.created_at\",\r\n \"field\": \"order.total_amount_with_taxes\",\r\n \"operator\": \"stats\",\r\n \"interval\": \"year\"\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\": \"order.created_at\",\r\n \"field\": \"order.total_amount_with_taxes\",\r\n \"operator\": \"stats\",\r\n \"interval\": \"year\",\r\n \"breakdown\": {\r\n \"by\": \"order.customer_type\",\r\n \"field\": \"line_items.total_amount\",\r\n \"operator\": \"sum\",\r\n \"sort\": \"desc\",\r\n \"limit\": 20\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\"date_breakdown\": {\r\n \"by\": \"order.created_at\",\r\n \"field\": \"order.total_amount_with_taxes\",\r\n \"operator\": \"stats\",\r\n \"interval\": \"year\",\r\n \"breakdown\": {\r\n \"by\": \"order.customer_type\",\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 }`" tags: - carts requestBody: required: true content: application/vnd.api+json: schema: $ref: '#/components/schemas/carts_date_breakdown_request' responses: '200': description: The date_breakdown result from carts 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/carts_filter' date_breakdown: $ref: '#/components/schemas/carts_date_breakdown_request/properties/date_breakdown' /carts/stats: post: operationId: POST/carts/stats summary: Query stats on carts 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: - carts requestBody: required: true content: application/vnd.api+json: schema: $ref: '#/components/schemas/carts_stats_request' responses: '200': description: The stats result from carts 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 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/carts_filter' stats: $ref: '#/components/schemas/carts_stats_request/properties/stats' /carts/search: post: operationId: POST/carts/search summary: Query search on carts description: Get search results from carts tags: - carts requestBody: required: true content: application/vnd.api+json: schema: $ref: '#/components/schemas/carts_search_request' responses: '200': description: The search result from carts 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 - created_at - updated_at default: current_date discounted: type: boolean description: Indicates a discount has been applied to the order. 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. payment_statuses: type: string description: The order's payment status. Always `unpaid` for carts. fulfillment_statuses: type: string description: The order's fulfillment status. Aways `unfulfilled` for carts. 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`. 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 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. 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 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 `draft` (default), `pending`. 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' aggregated_details: type: string description: Searchable field containing all carts 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. 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). 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. 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/carts_filter' search: $ref: '#/components/schemas/carts_search_request/properties/search' pagination: type: object properties: record_count: type: integer example: 8 cursor: type: string example: LS0tCi0gJzIwMjEtMTEtMD /carts/export: post: operationId: POST/carts/export summary: Query export on carts description: Get export results from carts tags: - carts requestBody: required: true content: application/vnd.api+json: schema: $ref: '#/components/schemas/carts_export_request' responses: '200': description: The export result from carts content: text/csv: schema: type: string format: binary description: CSV file with exported records (text/csv) components: schemas: carts_breakdown_request: type: object properties: filter: $ref: '#/components/schemas/carts_filter' breakdown: type: object description: Check available [fields](#/components/schemas/carts_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.*`

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

`line_items.*`

|\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.gift_card_code`** | |\n|**`order.guest`** | |\n|**`order.language_code`** | |\n|**`order.reference`** | |\n|**`order.reference_origin`** | |\n|**`order.status`** | |\n|**`order.tax_included`** | |\n|**`order.link_id`** | |\n|**`order.user_id`** | |\n|**`order.store_id`** | |\n|**`order.affiliate_code`** | |\n|**`payment_method.source_type`** | |\n|**`payment_method.name`** | |\n|**`payment_method.moto`** | |\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|**`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.gift_card_code - order.guest - order.language_code - order.mode - order.reference - order.reference_origin - order.status - order.tax_included - order.link_id - order.user_id - order.store_id - order.affiliate_code - payment_method.source_type - payment_method.name - payment_method.moto - 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 - 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|**`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 - 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 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.*`

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

`line_items.*`

|\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.gift_card_code`** | |\n|**`order.guest`** | |\n|**`order.language_code`** | |\n|**`order.reference`** | |\n|**`order.reference_origin`** | |\n|**`order.status`** | |\n|**`order.tax_included`** | |\n|**`order.link_id`** | |\n|**`order.user_id`** | |\n|**`order.store_id`** | |\n|**`order.affiliate_code`** | |\n|**`payment_method.source_type`** | |\n|**`payment_method.name`** | |\n|**`payment_method.moto`** | |\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|**`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.gift_card_code - order.guest - order.language_code - order.mode - order.reference - order.reference_origin - order.status - order.tax_included - order.link_id - order.user_id - order.store_id - order.affiliate_code - payment_method.source_type - payment_method.name - payment_method.moto - 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 - 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|**`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 - 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 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 carts_date_breakdown_request: type: object properties: filter: $ref: '#/components/schemas/carts_filter' date_breakdown: type: object description: Check available [fields](#/components/schemas/carts_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.created_at - order.updated_at - order.current_date - 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|**`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 - 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 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/carts_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.*`

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

`line_items.*`

|\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.gift_card_code`** | |\n|**`order.guest`** | |\n|**`order.language_code`** | |\n|**`order.reference`** | |\n|**`order.reference_origin`** | |\n|**`order.status`** | |\n|**`order.tax_included`** | |\n|**`order.link_id`** | |\n|**`order.user_id`** | |\n|**`order.store_id`** | |\n|**`order.affiliate_code`** | |\n|**`payment_method.source_type`** | |\n|**`payment_method.name`** | |\n|**`payment_method.moto`** | |\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|**`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.gift_card_code - order.guest - order.language_code - order.mode - order.reference - order.reference_origin - order.status - order.tax_included - order.link_id - order.user_id - order.store_id - order.affiliate_code - payment_method.source_type - payment_method.name - payment_method.moto - 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 - 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|**`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 - 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 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.*`

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

`line_items.*`

|\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.gift_card_code`** | |\n|**`order.guest`** | |\n|**`order.language_code`** | |\n|**`order.reference`** | |\n|**`order.reference_origin`** | |\n|**`order.status`** | |\n|**`order.tax_included`** | |\n|**`order.link_id`** | |\n|**`order.user_id`** | |\n|**`order.store_id`** | |\n|**`order.affiliate_code`** | |\n|**`payment_method.source_type`** | |\n|**`payment_method.name`** | |\n|**`payment_method.moto`** | |\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|**`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.gift_card_code - order.guest - order.language_code - order.mode - order.reference - order.reference_origin - order.status - order.tax_included - order.link_id - order.user_id - order.store_id - order.affiliate_code - payment_method.source_type - payment_method.name - payment_method.moto - 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 - 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|**`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 - 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 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 carts_stats_request: type: object properties: filter: $ref: '#/components/schemas/carts_filter' stats: type: object description: Check available [fields](#/components/schemas/carts_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|**`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 - 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 meta: type: object properties: payload: type: boolean description: Set to true if you want to receive how the payload has been made carts_search_request: type: object properties: filter: $ref: '#/components/schemas/carts_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/carts_search_fields' fields: type: array items: $ref: '#/components/schemas/carts_search_fields' meta: type: object properties: payload: type: boolean description: Set to true if you want to receive how the payload has been made carts_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 - 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.gift_card - order.payment_status - order.fulfillment_status - order.coupon - order.customer_type - order.options - order.adjustment_amount - order.adjustment_tax_amount - order.adjustment_taxable_amount - order.country_code - order.coupon_code - order.created_at - order.currency_code - order.discount_amount - order.duty_amount - order.freight_taxable - 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.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.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 - 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 - resource_errors.code - resource_errors.name - resource_errors.id - resource_errors.message - resource_errors.created_at - resource_errors.updated_at carts_export_request: type: object properties: filter: $ref: '#/components/schemas/carts_filter' search: type: object required: - fields properties: sort: type: string description: Result sorting enum: - asc - desc default: desc sort_by: $ref: '#/components/schemas/carts_export_fields' fields: type: array items: $ref: '#/components/schemas/carts_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 carts_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 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 - created_at - updated_at default: current_date discounted: type: boolean description: Indicates a discount has been applied to the order. 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. payment_statuses: type: string description: The order's payment status. Always `unpaid` for carts. fulfillment_statuses: type: string description: The order's fulfillment status. Aways `unfulfilled` for carts. 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 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 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. 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 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 `draft` (default), `pending`. 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 aggregated_details: description: Searchable field containing all carts 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). 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 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 carts_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 - 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.gift_card - order.payment_status - order.fulfillment_status - order.coupon - order.customer_type - order.options - order.adjustment_amount - order.adjustment_tax_amount - order.adjustment_taxable_amount - order.country_code - order.coupon_code - order.created_at - order.currency_code - order.discount_amount - order.duty_amount - order.freight_taxable - 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.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.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 - 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 securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT