{ "openapi": "3.0.1", "info": { "title": "Commerce Layer Metrics API", "version": "3.1.21", "contact": { "name": "API Support", "url": "https://commercelayer.io", "email": "support@commercelayer.io" }, "description": "Headless Commerce for Global Brands." }, "servers": [ { "url": "https://{your-domain}.commercelayer.io/metrics", "description": "Commerce Layer Metrics API" }, { "url": "https://docs.commercelayer.io/metrics-api", "description": "API reference" } ], "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)" } } } } } } }, "/orders/breakdown": { "post": { "operationId": "POST/orders/breakdown", "summary": "Query breakdown on orders", "description": "Breakdowns are aggregations that summarize your data as metrics (based on specific operators) or statistics, computed on field values. When performing a breakdown query on the Metrics API endpoint you get in the response the value of the computation (based on the selected operator) on the selected field, aggregated by another field.\r\n\r\n### Nesting breakdowns\r\nBreakdowns can be nested recursively one into the other, up to one level (see example). The valid values allowed for the by key of the nested breakdown are strictly dependent on the value you specified in the by key of the parent breakdown. Hence, they are different for each resource you’re doing statistics on (see orders, returns, and carts for the related lists).You cannot group the nested breakdown by the same field by which you’re already grouping the parent breakdown.\r\n\r\nSingle breakdown request\r\n\r\n`{\r\n\t\"breakdown\": {\r\n\t \"by\": \"market.name\",\r\n\t \"field\": \"order.id\",\r\n\t \"operator\": \"value_count\",\r\n\t \"condition\": {\r\n\t \"gte_lte\": [ 10000, 100000 ]\r\n\t },\r\n\t \"sort\": \"desc\",\r\n\t \"limit\": 2\r\n\t}\r\n}`\r\n \r\n \r\n Nested breakdown request\r\n \r\n` {\r\n \"breakdown\": {\r\n \"by\": \"market.name\",\r\n \"field\": \"order.id\",\r\n \"operator\": \"value_count\",\r\n \"condition\": {\r\n \"gte_lte\": [ 10000, 100000 ] \r\n },\r\n \"sort\": \"desc\",\r\n \"limit\": 3,\r\n \"breakdown\": {\r\n \"by\": \"order.currency_code\",\r\n \"field\": \"order.total_amount_with_taxes\",\r\n \"operator\": \"sum\"\r\n \"sort\": \"desc\",\r\n \"limit\": 2\r\n }\r\n }\r\n }`", "tags": [ "orders" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/orders_breakdown_request" } } } }, "responses": { "200": { "description": "The breakdown result from orders", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "type": "object", "properties": { "billing_address.business": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "billing_address.city": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "billing_address.country_code": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "billing_address.geocoded": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "billing_address.localized": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "billing_address.state_code": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "billing_address.zip_code": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "customer.id": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "customer.email": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "customer.group_name": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "customer.reference": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "customer.reference_origin": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "line_items.code": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "line_items.id": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "line_items.item_id": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "line_items.item_type": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "line_items.name": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "line_items.options.id": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "line_items.options.name": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "market.id": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "market.name": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "market.number": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "organization.id": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "organization.name": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "organization.slug": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "order.customer_type": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "order.country_code": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "order.coupon_code": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "order.currency_code": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "order.freight_taxable": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "order.fulfillment_status": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "order.gift_card_code": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "order.guest": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "order.language_code": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "order.mode": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "order.payment_status": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "order.reference": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "order.reference_origin": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "order.status": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "order.tax_included": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "order.placed_day_of_week": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "order.link_id": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "order.user_id": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "order.store_id": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "order.affiliate_code": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "payment_method.id": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "payment_method.source_type": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "payment_method.name": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "payment_method.moto": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "payment_method.issuer": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "payment_method.issuer_type": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "payment_method.card_type": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "shipping_address.business": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "shipping_address.city": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "shipping_address.country_code": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "shipping_address.geocoded": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "shipping_address.localized": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "shipping_address.state_code": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "shipping_address.zip_code": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "shipments.status": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "shipments.reference": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "shipments.reference_origin": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "shipments.items": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "shipments.stock_location.name": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "shipments.stock_location.reference": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "shipments.stock_location.reference_origin": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "shipments.shipping_method.id": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "shipments.shipping_method.name": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "shipments.shipping_method.reference": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "shipments.shipping_method.reference_origin": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "shipments.shipping_method.currency_code": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "shipments.shipping_category.name": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "shipments.shipping_category.reference": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "shipments.shipping_category.reference_origin": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "shipments.tags.id": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "shipments.tags.name": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "tags.id": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "tags.name": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "resource_errors.code": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "resource_errors.name": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "resource_errors.id": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "resource_errors.message": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } } ] }, "meta": { "type": "object", "properties": { "type": { "type": "string", "description": "Action name" }, "trace_id": { "type": "string", "description": "Request ID" }, "mode": { "type": "string", "description": "Filter mode" }, "organization_id": { "type": "string", "description": "Organization ID from request" }, "market_ids": { "type": "array", "items": { "type": "string" }, "description": "Markets IDs from the organization" }, "payload": { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/orders_filter" }, "breakdown": { "$ref": "#/components/schemas/orders_breakdown_request/properties/breakdown" } } } } } } } } } } } } }, "/orders/date_breakdown": { "post": { "operationId": "POST/orders/date_breakdown", "summary": "Query date_breakdown on orders", "description": "Date breakdowns summarizes metrics data grouped by time intervals on a defined time range. They also support support breakdowns over the main date breakdown query and also supports all breakdown queries capabilities through the \"breakdown\" key, this also includes the possibility of nesting the breakdown over the main breakdown. \r\n\r\n\r\nSingle date breakdown request (no breakdown)\r\n\r\n`{\r\n\t\"date_breakdown\": {\r\n \"by\": \"shipments.cancelled_at\",\r\n \"field\": \"order.id\",\r\n \"interval\": \"month\",\r\n \"operator\": \"value_count\"\r\n }\r\n}`\r\n \r\n \r\nSingle date breakdown request with one breakdown\r\n \r\n` \r\n{\r\n\t\"date_breakdown\": {\r\n \"by\": \"shipments.cancelled_at\",\r\n \"field\": \"order.id\",\r\n \"interval\": \"month\",\r\n \"operator\": \"value_count\",\r\n \"breakdown\": {\r\n \"by\": \"order.currency_code\",\r\n \"field\": \"order.total_amount_with_taxes\",\r\n \"operator\": \"sum\",\r\n \"sort\": \"desc\",\r\n \"limit\": 5\r\n }\r\n }\r\n }`\r\n \r\n \r\nSingle date breakdown request with breakdown with a nested breakdown\r\n\r\n` \r\n{\r\n\"date_breakdown\": {\r\n \"by\": \"order.placed_at\",\r\n \"field\": \"order.total_amount_with_taxes\",\r\n \"operator\": \"stats\",\r\n \"interval\": \"month\",\r\n \"breakdown\": {\r\n \"by\": \"order.country_code\",\r\n \"field\": \"line_items.total_amount\",\r\n \"operator\": \"sum\",\r\n \"sort\": \"desc\",\r\n \"limit\": 20,\r\n \"breakdown\": {\r\n \"by\": \"order.currency_code\",\r\n \"field\": \"line_items.total_amount\",\r\n \"operator\": \"sum\",\r\n \"sort\": \"desc\",\r\n \"limit\": 21\r\n }\r\n }\r\n }\r\n }`\r\n ", "tags": [ "orders" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/orders_date_breakdown_request" } } } }, "responses": { "200": { "description": "The date_breakdown result from orders", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } }, "meta": { "type": "object", "properties": { "type": { "type": "string", "description": "Action name" }, "trace_id": { "type": "string", "description": "Request ID" }, "mode": { "type": "string", "description": "Filter mode" }, "organization_id": { "type": "string", "description": "Organization ID from request" }, "market_ids": { "type": "array", "items": { "type": "string" }, "description": "Markets IDs from the organization" }, "payload": { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/orders_filter" }, "date_breakdown": { "$ref": "#/components/schemas/orders_date_breakdown_request/properties/date_breakdown" } } } } } } } } } } } } }, "/orders/stats": { "post": { "operationId": "POST/orders/stats", "summary": "Query stats on orders", "description": "Stats are aggregations that summarize your data within an operator (depending of the field, some of them could not be available), such as: value_count, cardinality, avg, min, max, sum or stats (which returns avg, min, max, sum) computed on the field specificed. When performing a stats query on the Metrics API endpoint you get in the response the value of the computation (based on the selected operator) on the selected field.\r\n\r\nStats request\r\n\r\n`{\r\n\t \"stats\": {\r\n \"field\": \"order.total_amount_cents\",\r\n \"operator\": \"stats\"\r\n }\r\n}`", "tags": [ "orders" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/orders_stats_request" } } } }, "responses": { "200": { "description": "The stats result from orders", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "customer.id": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "customer.email": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "customer.group_name": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "customer.reference": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "customer.reference_origin": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "line_items.code": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "line_items.discount": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "line_items.id": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "line_items.item_id": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "line_items.options_amount": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "line_items.quantity": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "line_items.tax_amount": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "line_items.tax_rate": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "line_items.total_amount": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "line_items.unit_amount": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "line_items.options.id": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "line_items.options.quantity": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "line_items.options.total_amount": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "line_items.options.unit_amount": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "market.id": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "market.number": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "order.adjustment_amount": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "order.adjustment_tax_amount": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "order.adjustment_taxable_amount": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "order.discount_amount": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "order.duty_amount": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "order.gift_card_code": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "order.gift_card_amount": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "order.id": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "order.line_item_options_count": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "order.number": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "order.payment_method_amount": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "order.payment_method_tax_amount": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "order.payment_method_taxable_amount": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "order.reference": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "order.reference_origin": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "order.shipments_count": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "order.shipping_amount": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "order.shipping_taxable_amount": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "order.skus_count": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "order.subtotal_amount": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "order.subtotal_tax_amount": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "order.subtotal_taxable_amount": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "order.total_amount": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "order.total_amount_with_taxes": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "order.total_tax_amount": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "order.total_taxable_amount": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "order.seconds_in_draft": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "order.seconds_in_approved": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "order.seconds_in_placed": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "order.refunds_total_amount_with_taxes": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "order.total_amount_with_taxes_net_of_refunds": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "refunds.id": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "refunds.amount": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "refunds.number": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "shipments.id": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "shipments.number": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "shipments.items_count": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "shipments.cost_amount": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "shipments.reference": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "shipments.reference_origin": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "shipments.seconds_in_picking": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "shipments.seconds_in_ready_to_ship": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "shipments.seconds_in_shipped": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "shipments.fulfillment_time": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "shipments.stock_location.id": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "shipments.stock_location.reference": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "shipments.stock_location.reference_origin": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "shipments.shipping_method.id": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "shipments.shipping_method.reference": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "shipments.shipping_method.reference_origin": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "shipments.shipping_category.id": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "shipments.shipping_category.reference": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "shipments.shipping_category.reference_origin": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "resource_errors.code": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "resource_errors.id": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "resource_errors.message": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } }, "meta": { "type": "object", "properties": { "type": { "type": "string", "description": "Action name" }, "trace_id": { "type": "string", "description": "Request ID" }, "mode": { "type": "string", "description": "Filter mode" }, "organization_id": { "type": "string", "description": "Organization ID from request" }, "market_ids": { "type": "array", "items": { "type": "string" }, "description": "Markets IDs from the organization" }, "payload": { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/orders_filter" }, "stats": { "$ref": "#/components/schemas/orders_stats_request/properties/stats" } } } } } } } } } } } } }, "/orders/search": { "post": { "operationId": "POST/orders/search", "summary": "Query search on orders", "description": "Get search results from orders", "tags": [ "orders" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/orders_search_request" } } } }, "responses": { "200": { "description": "The search result from orders", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "date_from": { "type": "string", "description": "The lower limit of the date and time range used to filter the collected orders (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard).", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "date_to": { "type": "string", "description": "The upper limit of the date and time range used to filter the collected orders (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard).", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "date_field": { "type": "string", "description": "The date field (e.g. `created_at`, `updated_at`, etc.) where to apply the date and time range filter.", "enum": [ "current_date", "approved_at", "cancelled_at", "created_at", "placed_at", "archived_at", "updated_at", "fulfillment_updated_at", "payment_updated_at" ], "default": "current_date" }, "discounted": { "type": "boolean", "description": "Indicates a discount has been applied to the order." }, "refunded": { "type": "boolean", "description": "Indicates if the order has been partially or totally refunded." }, "gift_card": { "type": "boolean", "description": "Indicates if a gift card has been (or is set to be) used to pay — in total or in part - for the order." }, "coupon": { "type": "boolean", "description": "Indicates if a coupon code has been (or is set to be) used to pay — in total or in part — for the order." }, "customer_types": { "type": "string", "description": "The type of the associated customer. One of `new` or `returning`." }, "returned": { "type": "boolean", "description": "Indicates if a return is associated with the order." }, "options": { "type": "boolean", "description": "Indicates if at least one line item of the order has at least an option." }, "adjustment_amount": { "type": "number", "description": "The sum of all the adjustments applied to the order (float).", "example": 121 }, "adjustment_tax_amount": { "type": "number", "description": "The taxes applied to the order's adjustments (float).", "example": 121 }, "adjustment_taxable_amount": { "type": "number", "description": "The order's adjustment taxable amount (float).", "example": 121 }, "approved_at": { "type": "string", "description": "The date and time at which the order was approved (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard).", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "archived_at": { "type": "string", "description": "The date and time at which the order was archived (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard).", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "archived": { "type": "boolean", "description": "Indicates if the order has been archived." }, "cancelled_at": { "type": "string", "description": "The date and time at which the order was cancelled (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard).", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "country_codes": { "type": "string", "description": "The international 2-letter country code (as defined by the [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) standard), automatically inherited from the order's shipping address." }, "coupon_codes": { "type": "string", "description": "The coupon code to be used to pay — in total or in part — for the order. If valid, it triggers a promotion adding a discount line item to the order." }, "created_at": { "type": "string", "description": "The date and time at which the order was created (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard).", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "currency_codes": { "type": "string", "description": "The international 3-letter currency code (as defined by the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) standard), automatically inherited from the order's market." }, "discount_amount": { "type": "number", "description": "The sum of all the discounts applied to the order (float).", "example": 121 }, "duty_amount": { "type": "number", "description": "The duty amount that is calculated by external services (float).", "example": 121 }, "freight_taxable": { "type": "boolean", "description": "Indicates if taxes are applied to shipping costs." }, "fulfillment_statuses": { "type": "string", "description": "The order's fulfillment status. One of `unfulfilled` (default), `in_progress`, or `fulfilled`." }, "fulfillment_updated_at": { "type": "string", "description": "The date and time at which the order's fulfillment status was last updated (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard).", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "gift_card_codes": { "type": "string", "description": "The gift card code (at least the first 8 characters) to be used to pay — in total or in part — for the order. If valid, it uses the associated gift card balance." }, "gift_card_amount": { "type": "number", "description": "The sum of all the gift cards applied to the order (float).", "example": 121 }, "guest": { "type": "boolean", "description": "Indicates if the order has been placed as guest (by a non-logged in customer)." }, "ids": { "type": "string", "description": "The ID of the order." }, "language_codes": { "type": "string", "description": "The preferred language code (as defined by the [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) standard) to be used when communicating with the customer when checking out the order." }, "line_item_options_count": { "type": "integer", "description": "The total number of line item options associated with the order's line items.", "example": 8 }, "mode": { "type": "string", "description": "The order's environment (can be one of `test` or `live`).", "enum": [ "live", "test" ] }, "numbers": { "type": "integer", "description": "The numeric unique identifier for the order.", "example": 8 }, "payment_method_amount": { "type": "number", "description": "The costs of the payment method associated with the order (float).", "example": 121 }, "payment_method_tax_amount": { "type": "number", "description": "The taxes applied to the order's payment method costs (float).", "example": 121 }, "payment_method_taxable_amount": { "type": "number", "description": "The order's payment method taxable amount (float).", "example": 121 }, "payment_statuses": { "type": "string", "description": "The order's payment status. One of `unpaid` (default), `authorized`, `partially_authorized`, `paid`, `partially_paid`, `voided`, `partially_voided`, `refunded`, `partially_refunded` or `free`." }, "payment_updated_at": { "type": "string", "description": "The date and time at which the order's payment status was last updated (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard).", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "placed_at": { "type": "string", "description": "The date and time at which the order was placed (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard).", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "references": { "type": "string", "description": "Any external identifier that might be useful to link the order resource to other systems through the Commerce Layer core API." }, "reference_origins": { "type": "string", "description": "Any identifier of the 3rd-party system that defines the reference code." }, "shipments_count": { "type": "integer", "description": "The total number of shipments associated with the order.", "example": 8 }, "shipping_amount": { "type": "number", "description": "The sum of all the shipping costs of the order (float).", "example": 121 }, "shipping_taxable_amount": { "type": "number", "description": "The order's shipping taxable amount (float).", "example": 121 }, "skus_count": { "type": "integer", "description": "The total number of SKUs in the order's line items.", "example": 8 }, "statuses": { "type": "string", "description": "The order status. One of `placed`, `approved`, or `cancelled`." }, "subtotal_amount": { "type": "number", "description": "The sum of all the SKU line items total amounts (float).", "example": 121 }, "subtotal_tax_amount": { "type": "number", "description": "The taxes applied to the order's subtotal (float).", "example": 121 }, "subtotal_taxable_amount": { "type": "number", "description": "The order's subtotal taxable amount (float).", "example": 121 }, "tax_included": { "type": "boolean", "description": "Indicates if taxes are included in the order amounts (automatically inherited from the order's price list)." }, "total_amount": { "type": "number", "description": "The order's total amount (float).", "example": 121 }, "total_amount_with_taxes": { "type": "number", "description": "The order's total amount, taxes included (float).", "example": 121 }, "total_tax_amount": { "type": "number", "description": "The sum of all the taxes applied to the order (float).", "example": 121 }, "total_taxable_amount": { "type": "number", "description": "The order's total taxable amount (float).", "example": 121 }, "updated_at": { "type": "string", "description": "The date and time at which the order was last updated (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard).", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "current_date": { "type": "string", "description": "The date and time of the order's latest status change, regardless of the order's status (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard).", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "seconds_in_draft": { "type": "integer", "description": "The difference in seconds between `placed_at` and `created_at` (`null` if the order hasn't been placed yet).", "example": 8 }, "seconds_in_approved": { "type": "integer", "description": "The difference in seconds between `cancelled_at` and `approved_at` (`null` if the order hasn't been approved yet or no further status change happened after approval — e.g. the order has been regularly fulfilled).", "example": 8 }, "seconds_in_placed": { "type": "integer", "description": "The difference in seconds between `approved_at` and `placed_at` if the order has been approved or between `cancelled_at` and `placed_at` if the order has been cancelled before approval (`null` if the order hasn't been placed yet or no further status change happened after placement).", "example": 8 }, "placed_day_of_week": { "type": "integer", "description": "The day of week when the order was placed, expressed as an integer (`0` through `6`, from Sunday to Saturday — e.g. `1` is Monday).", "example": 8 }, "refunds_total_amount_with_taxes": { "type": "integer", "description": "Total amount of refunds (including taxes) associated with the order.", "example": 8 }, "total_amount_with_taxes_net_of_refunds": { "type": "number", "description": "The total amount of the order minus the total amount of refunds.", "example": 121 }, "aggregated_details": { "type": "string", "description": "Searchable field containing all orders data." }, "link_ids": { "type": "string", "description": "The link ID used during the checkout." }, "user_ids": { "type": "string", "description": "The user ID used to generate the link." }, "store_ids": { "type": "string", "description": "The store ID used during the checkout." }, "affiliate_codes": { "type": "string", "description": "The affiliate code used during the checkout." }, "billing_address": { "type": "object", "properties": { "business": { "type": "boolean", "description": "Indicates if the address is a business or a personal one." }, "city": { "type": "string", "description": "The city specified in the address." }, "country_code": { "type": "string", "description": "The international 2-letter country code (as defined by the [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) standard) specified in the address." }, "geocoded": { "type": "boolean", "description": "Indicates if the address has been successfully geocoded." }, "localized": { "type": "boolean", "description": "Indicates if the latitude and longitude of the address are present, either geocoded or manually updated." }, "state_code": { "type": "string", "description": "The state, province or region code specified in the address." }, "zip_code": { "type": "string", "description": "The ZIP or postal code specified in the address." }, "company": { "type": "string", "description": "The company specified in the address." }, "first_name": { "type": "string", "description": "The first name specified in the address." }, "last_name": { "type": "string", "description": "The last name specified in the address." } } }, "customer": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the customer." }, "email": { "type": "string", "description": "The email address of the customer." }, "group_name": { "type": "string", "description": "The name of the customer group the customer belongs to (if any)." }, "reference": { "type": "string", "description": "Any external identifier that might be useful to link the customer resource to other systems through the Commerce Layer core API." }, "reference_origin": { "type": "string", "description": "Any identifier of the 3rd-party system that defines the reference code." } } }, "line_items": { "type": "object", "properties": { "code": { "type": "string", "description": "The code of the associated SKU or bundle." }, "discount": { "type": "number", "description": "The discount applied to the line item (float).", "example": 121 }, "id": { "type": "string", "description": "The ID of the line item." }, "item_id": { "type": "string", "description": "The ID of the associated item." }, "item_type": { "type": "string", "description": "The type of the associated item. One of `sku`, `bundle`, `shipment`, `payment_method`, `adjustment`, `gift_card`, or a valid promotion type (e.g. `percentage_discount_promotion`, `free_shipping_promotion`, etc.)." }, "name": { "type": "string", "description": "The name of the line item. When missing, it gets populated with the name of the associated item (if present)." }, "options_amount": { "type": "number", "description": "The amount of the line item option (float).", "example": 121 }, "quantity": { "type": "integer", "description": "The line item's quantity.", "example": 8 }, "tax_amount": { "type": "number", "description": "The collected tax amount for the line item (float). Otherwise calculated as the line item's `(total_amount - discount) * tax_rate` (float).", "example": 121 }, "tax_rate": { "type": "number", "description": "The tax rate for the line item (if calculated).", "example": 121 }, "total_amount": { "type": "number", "description": "The total amount of the line item (float). Calculated as the line item's `unit_amount * quantity` + plus the associated line item options amount.", "example": 121 }, "unit_amount": { "type": "number", "description": "The unit amount of the line item (float).", "example": 121 }, "updated_at": { "type": "string", "description": "The date and time at which the line item was last updated (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard).", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" } } }, "line_items.options": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the line item option." }, "name": { "type": "string", "description": "The name of the line item option. When missing, it gets populated with the name of the associated SKU option." }, "quantity": { "type": "integer", "description": "The line item option's quantity.", "example": 8 }, "total_amount": { "type": "number", "description": "The total amount of the line item option (float). Calculated as the line item option's `unit_amount * quantity`.", "example": 121 }, "unit_amount": { "type": "number", "description": "The unit amount of the line item option (float).", "example": 121 } } }, "market": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the market." }, "name": { "type": "string", "description": "The name of the market." }, "number": { "type": "integer", "description": "The numeric unique identifier for the market.", "example": 8 } } }, "organization": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the organization." }, "name": { "type": "string", "description": "The name of the organization." }, "slug": { "type": "string", "description": "The name of the organization, parsed and converted into a URL-friendly slug." } } }, "payment_method": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the payment method." }, "source_type": { "type": "string", "description": "The payment source type. One of `AdyenPayment`, `BraintreePayment`, `CheckoutComPayment`, `CreditCard`, `ExternalPayment`, `KlarnaPayment`, `PaypalPayment`, `StripePayment`, or `WireTransfer`." }, "name": { "type": "string", "description": "The payment source type, titleized." }, "moto": { "type": "boolean", "description": "Indicates if the payment has been marked as MOTO (must be supported by the payment gateway)." }, "issuer": { "type": "string", "description": "The payment method's issuer (if present and provided by the payment gateway)." }, "issuer_type": { "type": "string", "description": "The type of issuer (if present and provided by the payment gateway)." }, "card_type": { "type": "string", "description": "The type of card used to pay for the order (if present and provided by the payment gateway)." } } }, "refunds": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the refund." }, "amount": { "type": "number", "description": "The refunded amount (float).", "example": 121 }, "number": { "type": "string", "description": "The transaction number associated with the refund (auto-generated)." } } }, "shipping_address": { "type": "object", "properties": { "business": { "type": "boolean", "description": "Indicates if the address is a business or a personal one." }, "city": { "type": "string", "description": "The city specified in the address." }, "country_code": { "type": "string", "description": "The international 2-letter country code (as defined by the [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) standard) specified in the address." }, "geocoded": { "type": "boolean", "description": "Indicates if the address has been successfully geocoded." }, "localized": { "type": "boolean", "description": "Indicates if the latitude and longitude of the address are present, either geocoded or manually updated." }, "state_code": { "type": "string", "description": "The state, province or region code specified in the address." }, "zip_code": { "type": "string", "description": "The ZIP or postal code specified in the address." } } }, "shipments": { "type": "object", "properties": { "id": { "type": "string", "description": "The shipment ID." }, "number": { "type": "string", "description": "The shipment number." }, "items_count": { "type": "integer", "description": "The shipment items count.", "example": 8 }, "cost_amount": { "type": "integer", "description": "The shipment cost amount.", "example": 8 }, "status": { "type": "string", "description": "The shipment status." }, "cancelled_at": { "type": "string", "description": "The date and time at which the shipment status was cancelled (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard).", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "delivered_at": { "type": "string", "description": "The date and time at which the shipment was delivered (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard).", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "on_hold_at": { "type": "string", "description": "The date and time at which the shipment status was put on hold (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard).", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "picking_at": { "type": "string", "description": "The date and time at which the shipment was picked (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard).", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "packing_at": { "type": "string", "description": "The date and time at which the shipment was packed (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard).", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "ready_to_ship_at": { "type": "string", "description": "The date and time at which the shipment was ready to ship (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard).", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "shipped_at": { "type": "string", "description": "The date and time at which the shipment was shipped (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard).", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "created_at": { "type": "string", "description": "The date and time at which the shipment was created (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard).", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "updated_at": { "type": "string", "description": "The date and time at which the shipment was updated (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard).", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "reference": { "type": "string", "description": "Any external identifier that might be useful to link the shipment resource to other systems through the Commerce Layer core API." }, "reference_origin": { "type": "string", "description": "Any identifier of the 3rd-party system that defines the reference code." }, "seconds_in_picking": { "type": "integer", "description": "The difference in seconds between `picking_at` and `packing_at` (`null` if the order hasn't been picked yet).", "example": 8 }, "seconds_in_ready_to_ship": { "type": "integer", "description": "The difference in seconds between `ready_to_ship_at` and `shipped_at` (`null` if the order hasn't been shipped yet).", "example": 8 }, "seconds_in_shipped": { "type": "integer", "description": "The difference in seconds between `delivered_at` and `shipped_at` (`null` if the order hasn't been delivered yet).", "example": 8 }, "fulfillment_time": { "type": "integer", "description": "The difference in seconds between `delivered_at` and `picking_at` or `shipped_at` and `picking_at`.", "example": 8 }, "items": { "type": "string", "description": "Array of the shipment items information." } } }, "shipments.stock_location": { "type": "object", "properties": { "id": { "type": "string", "description": "The shipment stock location ID." }, "name": { "type": "string", "description": "The shipment stock location name." }, "reference": { "type": "string", "description": "Any external identifier that might be useful to link the stock location reference resource to other systems through the Commerce Layer core API." }, "reference_origin": { "type": "string", "description": "Any identifier of the 3rd-party system that defines the reference code." } } }, "shipments.shipping_method": { "type": "object", "properties": { "id": { "type": "string", "description": "The shipment shipping method ID." }, "name": { "type": "string", "description": "The shipment shipping method name." }, "reference": { "type": "string", "description": "Any external identifier that might be useful to link the shipping method reference resource to other systems through the Commerce Layer core API." }, "reference_origin": { "type": "string", "description": "Any identifier of the 3rd-party system that defines the reference code." }, "currency_code": { "type": "string", "description": "The international 3-letter currency code (as defined by the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) standard), automatically inherited from the order's market." } } }, "shipments.shipping_category": { "type": "object", "properties": { "id": { "type": "string", "description": "The shipment shipping category ID." }, "name": { "type": "string", "description": "The shipment shipping category name." }, "reference": { "type": "string", "description": "Any external identifier that might be useful to link the shipping method reference resource to other systems through the Commerce Layer core API." }, "reference_origin": { "type": "string", "description": "Any identifier of the 3rd-party system that defines the reference code." } } }, "shipments.tags": { "type": "object", "properties": { "id": { "type": "string", "description": "The tag ID." }, "name": { "type": "string", "description": "The tag name." } } }, "tags": { "type": "object", "properties": { "id": { "type": "string", "description": "The tag ID." }, "name": { "type": "string", "description": "The tag name." } } }, "resource_errors": { "type": "object", "properties": { "code": { "type": "string", "description": "The resource errors code." }, "name": { "type": "string", "description": "The name of the resource error." }, "id": { "type": "string", "description": "The ID of the resource error." }, "message": { "type": "string", "description": "The resource error message." }, "created_at": { "type": "string", "description": "The date and time at which the resource error was created (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard).", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "updated_at": { "type": "string", "description": "The date and time at which the resource error was updated (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard).", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" } } } } } }, "meta": { "type": "object", "properties": { "type": { "type": "string", "description": "Action name" }, "trace_id": { "type": "string", "description": "Request ID" }, "mode": { "type": "string", "description": "Filter mode" }, "organization_id": { "type": "string", "description": "Organization ID from request" }, "market_ids": { "type": "array", "items": { "type": "string" }, "description": "Markets IDs from the organization" }, "payload": { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/orders_filter" }, "search": { "$ref": "#/components/schemas/orders_search_request/properties/search" } } }, "pagination": { "type": "object", "properties": { "record_count": { "type": "integer", "example": 8 }, "cursor": { "type": "string", "example": "LS0tCi0gJzIwMjEtMTEtMD" } } } } } } } } } } } } }, "/orders/export": { "post": { "operationId": "POST/orders/export", "summary": "Query export on orders", "description": "Get export results from orders", "tags": [ "orders" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/orders_export_request" } } } }, "responses": { "200": { "description": "The export result from orders", "content": { "text/csv": { "schema": { "type": "string", "format": "binary", "description": "CSV file with exported records (text/csv)" } } } } } } }, "/returns/breakdown": { "post": { "operationId": "POST/returns/breakdown", "summary": "Query breakdown on returns", "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\": \"organization.id\",\r\n \"field\": \"order.id\",\r\n \"operator\": \"value_count\",\r\n \"sort\": \"desc\",\r\n \"limit\": 5\r\n\t}\r\n}`\r\n \r\n \r\n Nested breakdown request\r\n \r\n` {\r\n\t\"breakdown\": {\r\n \"by\": \"organization.id\",\r\n \"field\": \"order.id\",\r\n \"operator\": \"value_count\",\r\n \"sort\": \"desc\",\r\n \"limit\": 5,\r\n \"breakdown\": {\r\n \"by\": \"line_items.name\",\r\n \"field\": \"line_items.id\",\r\n \"operator\": \"value_count\",\r\n \"sort\": \"desc\",\r\n \"limit\": 20\r\n }\r\n }\r\n }`", "tags": [ "returns" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/returns_breakdown_request" } } } }, "responses": { "200": { "description": "The breakdown result from returns", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "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": { "destination_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": { "destination_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": { "destination_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": { "destination_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": { "destination_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": { "destination_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": { "destination_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": { "origin_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": { "origin_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": { "origin_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": { "origin_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": { "origin_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": { "origin_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": { "origin_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": { "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": { "return.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": { "return.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": { "return.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": { "return.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": { "return.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": { "return_line_items.line_item_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": { "return_line_items.line_item_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": { "return_line_items.line_item_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": { "stock_location.name": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "stock_location.reference": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "stock_location.reference_origin": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } }, "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } } } }, { "type": "object", "properties": { "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 } } } ] } } } } } } } ] }, "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/returns_filter" }, "breakdown": { "$ref": "#/components/schemas/returns_breakdown_request/properties/breakdown" } } } } } } } } } } } } }, "/returns/date_breakdown": { "post": { "operationId": "POST/returns/date_breakdown", "summary": "Query date_breakdown on returns", "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\": \"return.created_at\",\r\n \"field\": \"return_line_items.line_item_total_amount\",\r\n \"operator\": \"stats\",\r\n \"interval\": \"month\"\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\": \"return.created_at\",\r\n \"field\": \"return_line_items.line_item_total_amount\",\r\n \"operator\": \"stats\",\r\n \"interval\": \"month\",\r\n \"breakdown\": {\r\n \"by\": \"return.reference\",\r\n \"field\": \"return_line_items.line_item_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\": \"return.created_at\",\r\n \"field\": \"return_line_items.line_item_total_amount\",\r\n \"operator\": \"stats\",\r\n \"interval\": \"month\",\r\n \"breakdown\": {\r\n \"by\": \"return.reference\",\r\n \"field\": \"return_line_items.line_item_total_amount\",\r\n \"operator\": \"sum\",\r\n \"sort\": \"desc\",\r\n \"limit\": 20,\r\n \"breakdown\": {\r\n \"by\": \"return.status\",\r\n \"field\": \"return_line_items.line_item_total_amount\",\r\n \"operator\": \"sum\",\r\n \"sort\": \"desc\",\r\n \"limit\": 21\r\n }\r\n }\r\n }\r\n }`\r\n ", "tags": [ "returns" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/returns_date_breakdown_request" } } } }, "responses": { "200": { "description": "The date_breakdown result from returns", "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/returns_filter" }, "date_breakdown": { "$ref": "#/components/schemas/returns_date_breakdown_request/properties/date_breakdown" } } } } } } } } } } } } }, "/returns/stats": { "post": { "operationId": "POST/returns/stats", "summary": "Query stats on returns", "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\": \"return_line_items.line_item_total_amount\",\r\n \"operator\": \"stats\"\r\n }\r\n}`", "tags": [ "returns" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/returns_stats_request" } } } }, "responses": { "200": { "description": "The stats result from returns", "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 } } } ] } } }, "destination_address.business": { "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 } } } ] } } }, "destination_address.city": { "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 } } } ] } } }, "destination_address.country_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 } } } ] } } }, "destination_address.geocoded": { "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 } } } ] } } }, "destination_address.localized": { "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 } } } ] } } }, "destination_address.state_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 } } } ] } } }, "destination_address.zip_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 } } } ] } } }, "origin_address.business": { "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 } } } ] } } }, "origin_address.city": { "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 } } } ] } } }, "origin_address.country_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 } } } ] } } }, "origin_address.geocoded": { "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 } } } ] } } }, "origin_address.localized": { "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 } } } ] } } }, "origin_address.state_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 } } } ] } } }, "origin_address.zip_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 } } } ] } } }, "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 } } } ] } } }, "return.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 } } } ] } } }, "return.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 } } } ] } } }, "return.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 } } } ] } } }, "return.status": { "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 } } } ] } } }, "return.mode": { "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 } } } ] } } }, "return.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 } } } ] } } }, "return.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 } } } ] } } }, "return.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 } } } ] } } }, "return_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 } } } ] } } }, "return_line_items.line_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 } } } ] } } }, "return_line_items.line_item_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 } } } ] } } }, "return_line_items.line_item_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 } } } ] } } }, "return_line_items.line_item_item_type": { "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 } } } ] } } }, "return_line_items.line_item_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 } } } ] } } }, "return_line_items.line_item_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 } } } ] } } }, "return_line_items.line_item_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 } } } ] } } }, "stock_location.id": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "stock_location.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 } } } ] } } }, "stock_location.reference": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } }, "stock_location.reference_origin": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "number", "example": 8 }, { "type": "string" }, { "type": "object", "properties": { "count": { "type": "number", "example": 8 }, "min": { "type": "number", "example": 8 }, "max": { "type": "number", "example": 8 }, "avg": { "type": "number", "example": 8 }, "sum": { "type": "number", "example": 8 } } } ] } } } } }, "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/returns_filter" }, "stats": { "$ref": "#/components/schemas/returns_stats_request/properties/stats" } } } } } } } } } } } } }, "/returns/search": { "post": { "operationId": "POST/returns/search", "summary": "Query search on returns", "description": "Get search results from returns", "tags": [ "returns" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/returns_search_request" } } } }, "responses": { "200": { "description": "The search result from returns", "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 returns (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 returns (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. `requested_at`, `rejected_at`, etc.) where to apply the date and time range filter.", "enum": [ "current_date", "approved_at", "archived_at", "cancelled_at", "created_at", "received_at", "rejected_at", "shipped_at", "updated_at", "restocked_at" ], "default": "current_date" }, "aggregated_details": { "type": "string", "description": "Searchable field containing all returns data." }, "approved_at": { "type": "string", "description": "The date and time at which the return was approved (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard).", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "archived_at": { "type": "string", "description": "The date and time at which the return was archived (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard).", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "archived": { "type": "boolean", "description": "Indicates if the return has been archived." }, "cancelled_at": { "type": "string", "description": "The date and time at which the return was cancelled (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard).", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "created_at": { "type": "string", "description": "The date and time at which the return 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" }, "numbers": { "type": "string", "description": "The numeric unique identifier for the return." }, "received_at": { "type": "string", "description": "The date and time at which the return was received (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard).", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "references": { "type": "string", "description": "Any external identifier that might be useful to link the return 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." }, "rejected_at": { "type": "string", "description": "The date and time at which the return was rejected (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard).", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "shipped_at": { "type": "string", "description": "The date and time at which the return was shipped (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard).", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "statuses": { "type": "string", "description": "The return status. One of `draft`, `requested`, `approved`, `cancelled`, `shipped`, `rejected` or `received`." }, "mode": { "type": "string", "description": "The return's environment (can be one of `test` or `live`).", "enum": [ "live", "test" ] }, "updated_at": { "type": "string", "description": "The date and time at which the return 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 return's latest status change, regardless of the return'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" }, "ids": { "type": "string", "description": "The ID of the return." }, "order_ids": { "type": "string", "description": "The ID of the order associated with the return." }, "skus_count": { "type": "integer", "description": "The total number of SKUs in the return's line items.", "example": 8 }, "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 associated market." }, "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)." } } }, "destination_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." } } }, "origin_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." } } }, "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." } } }, "return_line_items": { "type": "object", "properties": { "created_at": { "type": "string", "description": "The date and time at which the return line item 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" }, "quantity": { "type": "integer", "description": "The return line item quantity.", "example": 8 }, "restocked_at": { "type": "string", "description": "The date and time at which the return line item was restocked (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 return 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_item_id": { "type": "string", "description": "The ID of the return line item." }, "line_item_name": { "type": "string", "description": "The name of the associated SKU or bundle." }, "line_item_code": { "type": "string", "description": "The code of the associated SKU or bundle." }, "line_item_item_type": { "type": "string", "description": "The type of the associated item. One of `sku`, or `bundle`." }, "line_item_total_amount": { "type": "number", "description": "The total amount of the return line item (float).", "example": 121 }, "line_item_tax_amount": { "type": "number", "description": "The collected tax amount for the return line item (float).", "example": 121 }, "line_item_tax_rate": { "type": "number", "description": "The tax rate for the return line item (if calculated).", "example": 121 }, "line_item_updated_at": { "type": "string", "description": "The date and time at which the return 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" } } }, "stock_location": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the stock location." }, "name": { "type": "string", "description": "The name of the stock location." }, "reference": { "type": "string", "description": "Any external identifier that might be useful to link the stock location 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." } } }, "tags": { "type": "object", "properties": { "id": { "type": "string", "description": "The tag ID." }, "name": { "type": "string", "description": "The tag name." } } } } } }, "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/returns_filter" }, "search": { "$ref": "#/components/schemas/returns_search_request/properties/search" } } }, "pagination": { "type": "object", "properties": { "record_count": { "type": "integer", "example": 8 }, "cursor": { "type": "string", "example": "LS0tCi0gJzIwMjEtMTEtMD" } } } } } } } } } } } } }, "/returns/export": { "post": { "operationId": "POST/returns/export", "summary": "Query export on returns", "description": "Get export results from returns", "tags": [ "returns" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/returns_export_request" } } } }, "responses": { "200": { "description": "The export result from returns", "content": { "text/csv": { "schema": { "type": "string", "format": "binary", "description": "CSV file with exported records (text/csv)" } } } } } } }, "/usage/date_breakdown": { "post": { "operationId": "POST/usage/date_breakdown", "summary": "Query date_breakdown on usage", "description": "Get date_breakdown results from usage", "tags": [ "usage" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/usage_date_breakdown_request" } } } }, "responses": { "200": { "description": "The date_breakdown result from usage", "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": { "type": "number", "example": 8 }, "dimension": { "type": "object", "properties": { "dimension": { "type": "string" }, "value": { "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/usage_date_breakdown_filter" }, "date_breakdown": { "$ref": "#/components/schemas/usage_date_breakdown_request/properties/date_breakdown" } } } } } } } } } } } } }, "/usage/search": { "post": { "operationId": "POST/usage/search", "summary": "Query search on usage", "description": "Get search results from usage", "tags": [ "usage" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/usage_search_request" } } } }, "responses": { "200": { "description": "The search result from usage", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "dimension": { "type": "string", "description": "The dimension name." }, "date_from": { "type": "string", "description": "The lower limit of the date and time range used to filter the collected usage records (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 usage records (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" }, "mode": { "type": "string", "description": "Environment mode of the data.", "enum": [ "live", "test" ] }, "types": { "type": "string", "description": "Usage data type" }, "metadata": { "type": "object", "description": "Usage metadata object." }, "timestamp": { "type": "string", "description": "Timestamp of the record.", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "dimension_value_numeric": { "type": "number", "description": "Value of the dimension as a number.", "example": 121 }, "organization": { "type": "object", "properties": { "organization_id": { "type": "string", "description": "Organization identifier where the usage data belongs." } } } } } }, "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/usage_search_filter" }, "search": { "$ref": "#/components/schemas/usage_search_request/properties/search" } } }, "pagination": { "type": "object", "properties": { "record_count": { "type": "integer", "example": 8 }, "cursor": { "type": "string", "example": "LS0tCi0gJzIwMjEtMTEtMD" } } } } } } } } } } } } }, "/analysis/fbt": { "post": { "operationId": "POST/analysis/fbt", "summary": "Query fbt on analysis", "description": "Get fbt results from analysis", "tags": [ "analysis" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/analysis_fbt_request" } } } }, "responses": { "200": { "description": "The fbt result from analysis", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "item_id": { "type": "string" }, "value": { "type": "number", "example": 8 }, "type": { "type": "string" }, "name": { "type": "string" } } }, "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/analysis_fbt_filter" }, "fbt": { "$ref": "#/components/schemas/analysis_fbt_request/properties/fbt" } } } } } } } } } } } } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } }, "schemas": { "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_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_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" ] }, "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_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" } } } } }, "orders_filter": { "type": "object", "properties": { "billing_address": { "type": "object", "properties": { "business": { "type": "boolean", "description": "Indicates if the address is a business or a personal one." }, "cities": { "description": "The city specified in the address.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of cities" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of cities" } } } ] }, "country_codes": { "description": "The international 2-letter country code (as defined by the [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) standard) specified in the address.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of country_codes" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of country_codes" } } } ] }, "geocoded": { "type": "boolean", "description": "Indicates if the address has been successfully geocoded." }, "localized": { "type": "boolean", "description": "Indicates if the latitude and longitude of the address are present, either geocoded or manually updated." }, "state_codes": { "description": "The state, province or region code specified in the address.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of state_codes" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of state_codes" } } } ] }, "zip_codes": { "description": "The ZIP or postal code specified in the address.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of zip_codes" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of zip_codes" } } } ] }, "companies": { "description": "The company specified in the address.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of companies" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of companies" } } } ] }, "first_names": { "description": "The first name specified in the address.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of first_names" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of first_names" } } } ] }, "last_names": { "description": "The last name specified in the address.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of last_names" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of last_names" } } } ] } } }, "customer": { "type": "object", "properties": { "ids": { "description": "The ID of the customer.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of ids" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of ids" } } } ] }, "emails": { "description": "The email address of the customer.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of emails" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of emails" } } } ] }, "group_names": { "description": "The name of the customer group the customer belongs to (if any).", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of group_names" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of group_names" } } } ] }, "references": { "description": "Any external identifier that might be useful to link the customer resource to other systems through the Commerce Layer core API.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of references" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of references" } } } ] }, "reference_origins": { "description": "Any identifier of the 3rd-party system that defines the reference code.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of reference_origins" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of reference_origins" } } } ] } } }, "line_items": { "type": "object", "properties": { "codes": { "description": "The code of the associated SKU or bundle.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of codes" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of codes" } } } ] }, "discount": { "description": "The discount applied to the line item (float).", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to discount", "type": "number" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal discount", "type": "number" } } }, { "type": "object", "properties": { "gt": { "type": "number", "description": "Greater than discount" } } }, { "type": "object", "properties": { "gte": { "type": "number", "description": "Greater than equal discount" } } }, { "type": "object", "properties": { "lt": { "type": "number", "description": "Less than discount" } } }, { "type": "object", "properties": { "lte": { "type": "number", "description": "Less than equal discount" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than discount" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal discount" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than discount" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal discount" } } } ] }, "ids": { "description": "The ID of the line item.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of ids" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of ids" } } } ] }, "item_ids": { "description": "The ID of the associated item.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of item_ids" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of item_ids" } } } ] }, "types": { "description": "The type of the associated item. One of `sku`, `bundle`, `shipment`, `payment_method`, `adjustment`, `gift_card`, or a valid promotion type (e.g. `percentage_discount_promotion`, `free_shipping_promotion`, etc.).", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of types" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of types" } } } ] }, "names": { "description": "The name of the line item. When missing, it gets populated with the name of the associated item (if present).", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of names" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of names" } } } ] }, "options_amount": { "description": "The amount of the line item option (float).", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to options_amount", "type": "number" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal options_amount", "type": "number" } } }, { "type": "object", "properties": { "gt": { "type": "number", "description": "Greater than options_amount" } } }, { "type": "object", "properties": { "gte": { "type": "number", "description": "Greater than equal options_amount" } } }, { "type": "object", "properties": { "lt": { "type": "number", "description": "Less than options_amount" } } }, { "type": "object", "properties": { "lte": { "type": "number", "description": "Less than equal options_amount" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than options_amount" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal options_amount" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than options_amount" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal options_amount" } } } ] }, "quantity": { "description": "The line item's quantity.", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to quantity", "type": "integer" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal quantity", "type": "integer" } } }, { "type": "object", "properties": { "gt": { "type": "integer", "description": "Greater than quantity" } } }, { "type": "object", "properties": { "gte": { "type": "integer", "description": "Greater than equal quantity" } } }, { "type": "object", "properties": { "lt": { "type": "integer", "description": "Less than quantity" } } }, { "type": "object", "properties": { "lte": { "type": "integer", "description": "Less than equal quantity" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than quantity" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal quantity" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than quantity" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal quantity" } } } ] }, "tax_amount": { "description": "The collected tax amount for the line item (float). Otherwise calculated as the line item's `(total_amount - discount) * tax_rate` (float).", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to tax_amount", "type": "number" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal tax_amount", "type": "number" } } }, { "type": "object", "properties": { "gt": { "type": "number", "description": "Greater than tax_amount" } } }, { "type": "object", "properties": { "gte": { "type": "number", "description": "Greater than equal tax_amount" } } }, { "type": "object", "properties": { "lt": { "type": "number", "description": "Less than tax_amount" } } }, { "type": "object", "properties": { "lte": { "type": "number", "description": "Less than equal tax_amount" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than tax_amount" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal tax_amount" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than tax_amount" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal tax_amount" } } } ] }, "tax_rate": { "description": "The tax rate for the line item (if calculated).", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to tax_rate", "type": "number" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal tax_rate", "type": "number" } } }, { "type": "object", "properties": { "gt": { "type": "number", "description": "Greater than tax_rate" } } }, { "type": "object", "properties": { "gte": { "type": "number", "description": "Greater than equal tax_rate" } } }, { "type": "object", "properties": { "lt": { "type": "number", "description": "Less than tax_rate" } } }, { "type": "object", "properties": { "lte": { "type": "number", "description": "Less than equal tax_rate" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than tax_rate" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal tax_rate" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than tax_rate" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal tax_rate" } } } ] }, "total_amount": { "description": "The total amount of the line item (float). Calculated as the line item's `unit_amount * quantity` + plus the associated line item options amount.", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to total_amount", "type": "number" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal total_amount", "type": "number" } } }, { "type": "object", "properties": { "gt": { "type": "number", "description": "Greater than total_amount" } } }, { "type": "object", "properties": { "gte": { "type": "number", "description": "Greater than equal total_amount" } } }, { "type": "object", "properties": { "lt": { "type": "number", "description": "Less than total_amount" } } }, { "type": "object", "properties": { "lte": { "type": "number", "description": "Less than equal total_amount" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than total_amount" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal total_amount" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than total_amount" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal total_amount" } } } ] }, "unit_amount": { "description": "The unit amount of the line item (float).", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to unit_amount", "type": "number" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal unit_amount", "type": "number" } } }, { "type": "object", "properties": { "gt": { "type": "number", "description": "Greater than unit_amount" } } }, { "type": "object", "properties": { "gte": { "type": "number", "description": "Greater than equal unit_amount" } } }, { "type": "object", "properties": { "lt": { "type": "number", "description": "Less than unit_amount" } } }, { "type": "object", "properties": { "lte": { "type": "number", "description": "Less than equal unit_amount" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than unit_amount" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal unit_amount" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than unit_amount" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal unit_amount" } } } ] }, "updated_at": { "description": "The date and time at which the line item was last updated (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard).", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to updated_at", "type": "string" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal updated_at", "type": "string" } } }, { "type": "object", "properties": { "gt": { "type": "string", "description": "Greater than updated_at" } } }, { "type": "object", "properties": { "gte": { "type": "string", "description": "Greater than equal updated_at" } } }, { "type": "object", "properties": { "lt": { "type": "string", "description": "Less than updated_at" } } }, { "type": "object", "properties": { "lte": { "type": "string", "description": "Less than equal updated_at" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than updated_at" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal updated_at" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than updated_at" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal updated_at" } } } ] } } }, "line_items.options": { "type": "object", "properties": { "ids": { "description": "The ID of the line item option.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of ids" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of ids" } } } ] }, "names": { "description": "The name of the line item option. When missing, it gets populated with the name of the associated SKU option.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of names" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of names" } } } ] }, "quantity": { "description": "The line item option's quantity.", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to quantity", "type": "integer" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal quantity", "type": "integer" } } }, { "type": "object", "properties": { "gt": { "type": "integer", "description": "Greater than quantity" } } }, { "type": "object", "properties": { "gte": { "type": "integer", "description": "Greater than equal quantity" } } }, { "type": "object", "properties": { "lt": { "type": "integer", "description": "Less than quantity" } } }, { "type": "object", "properties": { "lte": { "type": "integer", "description": "Less than equal quantity" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than quantity" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal quantity" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than quantity" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal quantity" } } } ] }, "total_amount": { "description": "The total amount of the line item option (float). Calculated as the line item option's `unit_amount * quantity`.", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to total_amount", "type": "number" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal total_amount", "type": "number" } } }, { "type": "object", "properties": { "gt": { "type": "number", "description": "Greater than total_amount" } } }, { "type": "object", "properties": { "gte": { "type": "number", "description": "Greater than equal total_amount" } } }, { "type": "object", "properties": { "lt": { "type": "number", "description": "Less than total_amount" } } }, { "type": "object", "properties": { "lte": { "type": "number", "description": "Less than equal total_amount" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than total_amount" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal total_amount" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than total_amount" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal total_amount" } } } ] }, "unit_amount": { "description": "The unit amount of the line item option (float).", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to unit_amount", "type": "number" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal unit_amount", "type": "number" } } }, { "type": "object", "properties": { "gt": { "type": "number", "description": "Greater than unit_amount" } } }, { "type": "object", "properties": { "gte": { "type": "number", "description": "Greater than equal unit_amount" } } }, { "type": "object", "properties": { "lt": { "type": "number", "description": "Less than unit_amount" } } }, { "type": "object", "properties": { "lte": { "type": "number", "description": "Less than equal unit_amount" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than unit_amount" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal unit_amount" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than unit_amount" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal unit_amount" } } } ] } } }, "market": { "type": "object", "properties": { "ids": { "description": "The ID of the market.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of ids" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of ids" } } } ] }, "names": { "description": "The name of the market.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of names" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of names" } } } ] }, "numbers": { "description": "The numeric unique identifier for the market.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "integer", "example": 8 }, "description": "To include, array of numbers" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "integer", "example": 8 }, "description": "To exclude, array of numbers" } } } ] } } }, "organization": { "type": "object", "properties": { "ids": { "description": "The ID of the organization.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of ids" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of ids" } } } ] }, "names": { "description": "The name of the organization.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of names" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of names" } } } ] }, "slugs": { "description": "The name of the organization, parsed and converted into a URL-friendly slug.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of slugs" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of slugs" } } } ] } } }, "order": { "type": "object", "properties": { "date_from": { "type": "string", "description": "The lower limit of the date and time range used to filter the collected orders (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard).", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "date_to": { "type": "string", "description": "The upper limit of the date and time range used to filter the collected orders (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard).", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "date_field": { "type": "string", "description": "The date field (e.g. `created_at`, `updated_at`, etc.) where to apply the date and time range filter.", "enum": [ "current_date", "approved_at", "cancelled_at", "created_at", "placed_at", "archived_at", "updated_at", "fulfillment_updated_at", "payment_updated_at" ], "default": "current_date" }, "discounted": { "type": "boolean", "description": "Indicates a discount has been applied to the order." }, "refunded": { "type": "boolean", "description": "Indicates if the order has been partially or totally refunded." }, "gift_card": { "type": "boolean", "description": "Indicates if a gift card has been (or is set to be) used to pay — in total or in part - for the order." }, "coupon": { "type": "boolean", "description": "Indicates if a coupon code has been (or is set to be) used to pay — in total or in part — for the order." }, "customer_types": { "description": "The type of the associated customer. One of `new` or `returning`.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of customer_types" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of customer_types" } } } ] }, "returned": { "type": "boolean", "description": "Indicates if a return is associated with the order." }, "options": { "type": "boolean", "description": "Indicates if at least one line item of the order has at least an option." }, "adjustment_amount": { "description": "The sum of all the adjustments applied to the order (float).", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to adjustment_amount", "type": "number" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal adjustment_amount", "type": "number" } } }, { "type": "object", "properties": { "gt": { "type": "number", "description": "Greater than adjustment_amount" } } }, { "type": "object", "properties": { "gte": { "type": "number", "description": "Greater than equal adjustment_amount" } } }, { "type": "object", "properties": { "lt": { "type": "number", "description": "Less than adjustment_amount" } } }, { "type": "object", "properties": { "lte": { "type": "number", "description": "Less than equal adjustment_amount" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than adjustment_amount" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal adjustment_amount" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than adjustment_amount" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal adjustment_amount" } } } ] }, "adjustment_tax_amount": { "description": "The taxes applied to the order's adjustments (float).", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to adjustment_tax_amount", "type": "number" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal adjustment_tax_amount", "type": "number" } } }, { "type": "object", "properties": { "gt": { "type": "number", "description": "Greater than adjustment_tax_amount" } } }, { "type": "object", "properties": { "gte": { "type": "number", "description": "Greater than equal adjustment_tax_amount" } } }, { "type": "object", "properties": { "lt": { "type": "number", "description": "Less than adjustment_tax_amount" } } }, { "type": "object", "properties": { "lte": { "type": "number", "description": "Less than equal adjustment_tax_amount" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than adjustment_tax_amount" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal adjustment_tax_amount" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than adjustment_tax_amount" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal adjustment_tax_amount" } } } ] }, "adjustment_taxable_amount": { "description": "The order's adjustment taxable amount (float).", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to adjustment_taxable_amount", "type": "number" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal adjustment_taxable_amount", "type": "number" } } }, { "type": "object", "properties": { "gt": { "type": "number", "description": "Greater than adjustment_taxable_amount" } } }, { "type": "object", "properties": { "gte": { "type": "number", "description": "Greater than equal adjustment_taxable_amount" } } }, { "type": "object", "properties": { "lt": { "type": "number", "description": "Less than adjustment_taxable_amount" } } }, { "type": "object", "properties": { "lte": { "type": "number", "description": "Less than equal adjustment_taxable_amount" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than adjustment_taxable_amount" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal adjustment_taxable_amount" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than adjustment_taxable_amount" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal adjustment_taxable_amount" } } } ] }, "approved_at": { "description": "The date and time at which the order was approved (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard).", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to approved_at", "type": "string" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal approved_at", "type": "string" } } }, { "type": "object", "properties": { "gt": { "type": "string", "description": "Greater than approved_at" } } }, { "type": "object", "properties": { "gte": { "type": "string", "description": "Greater than equal approved_at" } } }, { "type": "object", "properties": { "lt": { "type": "string", "description": "Less than approved_at" } } }, { "type": "object", "properties": { "lte": { "type": "string", "description": "Less than equal approved_at" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than approved_at" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal approved_at" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than approved_at" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal approved_at" } } } ] }, "archived_at": { "description": "The date and time at which the order was archived (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard).", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to archived_at", "type": "string" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal archived_at", "type": "string" } } }, { "type": "object", "properties": { "gt": { "type": "string", "description": "Greater than archived_at" } } }, { "type": "object", "properties": { "gte": { "type": "string", "description": "Greater than equal archived_at" } } }, { "type": "object", "properties": { "lt": { "type": "string", "description": "Less than archived_at" } } }, { "type": "object", "properties": { "lte": { "type": "string", "description": "Less than equal archived_at" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than archived_at" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal archived_at" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than archived_at" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal archived_at" } } } ] }, "archived": { "type": "boolean", "description": "Indicates if the order has been archived." }, "cancelled_at": { "description": "The date and time at which the order was cancelled (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard).", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to cancelled_at", "type": "string" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal cancelled_at", "type": "string" } } }, { "type": "object", "properties": { "gt": { "type": "string", "description": "Greater than cancelled_at" } } }, { "type": "object", "properties": { "gte": { "type": "string", "description": "Greater than equal cancelled_at" } } }, { "type": "object", "properties": { "lt": { "type": "string", "description": "Less than cancelled_at" } } }, { "type": "object", "properties": { "lte": { "type": "string", "description": "Less than equal cancelled_at" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than cancelled_at" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal cancelled_at" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than cancelled_at" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal cancelled_at" } } } ] }, "country_codes": { "description": "The international 2-letter country code (as defined by the [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) standard), automatically inherited from the order's shipping address.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of country_codes" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of country_codes" } } } ] }, "coupon_codes": { "description": "The coupon code to be used to pay — in total or in part — for the order. If valid, it triggers a promotion adding a discount line item to the order.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of coupon_codes" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of coupon_codes" } } } ] }, "created_at": { "description": "The date and time at which the order was created (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard).", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to created_at", "type": "string" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal created_at", "type": "string" } } }, { "type": "object", "properties": { "gt": { "type": "string", "description": "Greater than created_at" } } }, { "type": "object", "properties": { "gte": { "type": "string", "description": "Greater than equal created_at" } } }, { "type": "object", "properties": { "lt": { "type": "string", "description": "Less than created_at" } } }, { "type": "object", "properties": { "lte": { "type": "string", "description": "Less than equal created_at" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than created_at" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal created_at" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than created_at" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal created_at" } } } ] }, "currency_codes": { "description": "The international 3-letter currency code (as defined by the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) standard), automatically inherited from the order's market.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of currency_codes" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of currency_codes" } } } ] }, "discount_amount": { "description": "The sum of all the discounts applied to the order (float).", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to discount_amount", "type": "number" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal discount_amount", "type": "number" } } }, { "type": "object", "properties": { "gt": { "type": "number", "description": "Greater than discount_amount" } } }, { "type": "object", "properties": { "gte": { "type": "number", "description": "Greater than equal discount_amount" } } }, { "type": "object", "properties": { "lt": { "type": "number", "description": "Less than discount_amount" } } }, { "type": "object", "properties": { "lte": { "type": "number", "description": "Less than equal discount_amount" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than discount_amount" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal discount_amount" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than discount_amount" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal discount_amount" } } } ] }, "duty_amount": { "description": "The duty amount that is calculated by external services (float).", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to duty_amount", "type": "number" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal duty_amount", "type": "number" } } }, { "type": "object", "properties": { "gt": { "type": "number", "description": "Greater than duty_amount" } } }, { "type": "object", "properties": { "gte": { "type": "number", "description": "Greater than equal duty_amount" } } }, { "type": "object", "properties": { "lt": { "type": "number", "description": "Less than duty_amount" } } }, { "type": "object", "properties": { "lte": { "type": "number", "description": "Less than equal duty_amount" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than duty_amount" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal duty_amount" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than duty_amount" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal duty_amount" } } } ] }, "freight_taxable": { "type": "boolean", "description": "Indicates if taxes are applied to shipping costs." }, "fulfillment_statuses": { "description": "The order's fulfillment status. One of `unfulfilled` (default), `in_progress`, or `fulfilled`.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of fulfillment_statuses" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of fulfillment_statuses" } } } ] }, "fulfillment_updated_at": { "description": "The date and time at which the order's fulfillment status was last updated (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard).", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to fulfillment_updated_at", "type": "string" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal fulfillment_updated_at", "type": "string" } } }, { "type": "object", "properties": { "gt": { "type": "string", "description": "Greater than fulfillment_updated_at" } } }, { "type": "object", "properties": { "gte": { "type": "string", "description": "Greater than equal fulfillment_updated_at" } } }, { "type": "object", "properties": { "lt": { "type": "string", "description": "Less than fulfillment_updated_at" } } }, { "type": "object", "properties": { "lte": { "type": "string", "description": "Less than equal fulfillment_updated_at" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than fulfillment_updated_at" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal fulfillment_updated_at" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than fulfillment_updated_at" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal fulfillment_updated_at" } } } ] }, "gift_card_codes": { "description": "The gift card code (at least the first 8 characters) to be used to pay — in total or in part — for the order. If valid, it uses the associated gift card balance.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of gift_card_codes" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of gift_card_codes" } } } ] }, "gift_card_amount": { "description": "The sum of all the gift cards applied to the order (float).", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to gift_card_amount", "type": "number" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal gift_card_amount", "type": "number" } } }, { "type": "object", "properties": { "gt": { "type": "number", "description": "Greater than gift_card_amount" } } }, { "type": "object", "properties": { "gte": { "type": "number", "description": "Greater than equal gift_card_amount" } } }, { "type": "object", "properties": { "lt": { "type": "number", "description": "Less than gift_card_amount" } } }, { "type": "object", "properties": { "lte": { "type": "number", "description": "Less than equal gift_card_amount" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than gift_card_amount" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal gift_card_amount" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than gift_card_amount" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal gift_card_amount" } } } ] }, "guest": { "type": "boolean", "description": "Indicates if the order has been placed as guest (by a non-logged in customer)." }, "ids": { "description": "The ID of the order.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of ids" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of ids" } } } ] }, "language_codes": { "description": "The preferred language code (as defined by the [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) standard) to be used when communicating with the customer when checking out the order.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of language_codes" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of language_codes" } } } ] }, "line_item_options_count": { "description": "The total number of line item options associated with the order's line items.", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to line_item_options_count", "type": "integer" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal line_item_options_count", "type": "integer" } } }, { "type": "object", "properties": { "gt": { "type": "integer", "description": "Greater than line_item_options_count" } } }, { "type": "object", "properties": { "gte": { "type": "integer", "description": "Greater than equal line_item_options_count" } } }, { "type": "object", "properties": { "lt": { "type": "integer", "description": "Less than line_item_options_count" } } }, { "type": "object", "properties": { "lte": { "type": "integer", "description": "Less than equal line_item_options_count" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than line_item_options_count" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal line_item_options_count" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than line_item_options_count" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal line_item_options_count" } } } ] }, "mode": { "type": "string", "description": "The order's environment (can be one of `test` or `live`).", "enum": [ "live", "test" ] }, "numbers": { "description": "The numeric unique identifier for the order.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "integer", "example": 8 }, "description": "To include, array of numbers" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "integer", "example": 8 }, "description": "To exclude, array of numbers" } } } ] }, "payment_method_amount": { "description": "The costs of the payment method associated with the order (float).", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to payment_method_amount", "type": "number" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal payment_method_amount", "type": "number" } } }, { "type": "object", "properties": { "gt": { "type": "number", "description": "Greater than payment_method_amount" } } }, { "type": "object", "properties": { "gte": { "type": "number", "description": "Greater than equal payment_method_amount" } } }, { "type": "object", "properties": { "lt": { "type": "number", "description": "Less than payment_method_amount" } } }, { "type": "object", "properties": { "lte": { "type": "number", "description": "Less than equal payment_method_amount" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than payment_method_amount" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal payment_method_amount" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than payment_method_amount" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal payment_method_amount" } } } ] }, "payment_method_tax_amount": { "description": "The taxes applied to the order's payment method costs (float).", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to payment_method_tax_amount", "type": "number" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal payment_method_tax_amount", "type": "number" } } }, { "type": "object", "properties": { "gt": { "type": "number", "description": "Greater than payment_method_tax_amount" } } }, { "type": "object", "properties": { "gte": { "type": "number", "description": "Greater than equal payment_method_tax_amount" } } }, { "type": "object", "properties": { "lt": { "type": "number", "description": "Less than payment_method_tax_amount" } } }, { "type": "object", "properties": { "lte": { "type": "number", "description": "Less than equal payment_method_tax_amount" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than payment_method_tax_amount" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal payment_method_tax_amount" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than payment_method_tax_amount" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal payment_method_tax_amount" } } } ] }, "payment_method_taxable_amount": { "description": "The order's payment method taxable amount (float).", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to payment_method_taxable_amount", "type": "number" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal payment_method_taxable_amount", "type": "number" } } }, { "type": "object", "properties": { "gt": { "type": "number", "description": "Greater than payment_method_taxable_amount" } } }, { "type": "object", "properties": { "gte": { "type": "number", "description": "Greater than equal payment_method_taxable_amount" } } }, { "type": "object", "properties": { "lt": { "type": "number", "description": "Less than payment_method_taxable_amount" } } }, { "type": "object", "properties": { "lte": { "type": "number", "description": "Less than equal payment_method_taxable_amount" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than payment_method_taxable_amount" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal payment_method_taxable_amount" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than payment_method_taxable_amount" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal payment_method_taxable_amount" } } } ] }, "payment_statuses": { "description": "The order's payment status. One of `unpaid` (default), `authorized`, `partially_authorized`, `paid`, `partially_paid`, `voided`, `partially_voided`, `refunded`, `partially_refunded` or `free`.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of payment_statuses" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of payment_statuses" } } } ] }, "payment_updated_at": { "description": "The date and time at which the order's payment status was last updated (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard).", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to payment_updated_at", "type": "string" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal payment_updated_at", "type": "string" } } }, { "type": "object", "properties": { "gt": { "type": "string", "description": "Greater than payment_updated_at" } } }, { "type": "object", "properties": { "gte": { "type": "string", "description": "Greater than equal payment_updated_at" } } }, { "type": "object", "properties": { "lt": { "type": "string", "description": "Less than payment_updated_at" } } }, { "type": "object", "properties": { "lte": { "type": "string", "description": "Less than equal payment_updated_at" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than payment_updated_at" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal payment_updated_at" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than payment_updated_at" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal payment_updated_at" } } } ] }, "placed_at": { "description": "The date and time at which the order was placed (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard).", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to placed_at", "type": "string" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal placed_at", "type": "string" } } }, { "type": "object", "properties": { "gt": { "type": "string", "description": "Greater than placed_at" } } }, { "type": "object", "properties": { "gte": { "type": "string", "description": "Greater than equal placed_at" } } }, { "type": "object", "properties": { "lt": { "type": "string", "description": "Less than placed_at" } } }, { "type": "object", "properties": { "lte": { "type": "string", "description": "Less than equal placed_at" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than placed_at" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal placed_at" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than placed_at" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal placed_at" } } } ] }, "references": { "description": "Any external identifier that might be useful to link the order resource to other systems through the Commerce Layer core API.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of references" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of references" } } } ] }, "reference_origins": { "description": "Any identifier of the 3rd-party system that defines the reference code.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of reference_origins" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of reference_origins" } } } ] }, "shipments_count": { "description": "The total number of shipments associated with the order.", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to shipments_count", "type": "integer" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal shipments_count", "type": "integer" } } }, { "type": "object", "properties": { "gt": { "type": "integer", "description": "Greater than shipments_count" } } }, { "type": "object", "properties": { "gte": { "type": "integer", "description": "Greater than equal shipments_count" } } }, { "type": "object", "properties": { "lt": { "type": "integer", "description": "Less than shipments_count" } } }, { "type": "object", "properties": { "lte": { "type": "integer", "description": "Less than equal shipments_count" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than shipments_count" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal shipments_count" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than shipments_count" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal shipments_count" } } } ] }, "shipping_amount": { "description": "The sum of all the shipping costs of the order (float).", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to shipping_amount", "type": "number" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal shipping_amount", "type": "number" } } }, { "type": "object", "properties": { "gt": { "type": "number", "description": "Greater than shipping_amount" } } }, { "type": "object", "properties": { "gte": { "type": "number", "description": "Greater than equal shipping_amount" } } }, { "type": "object", "properties": { "lt": { "type": "number", "description": "Less than shipping_amount" } } }, { "type": "object", "properties": { "lte": { "type": "number", "description": "Less than equal shipping_amount" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than shipping_amount" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal shipping_amount" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than shipping_amount" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal shipping_amount" } } } ] }, "shipping_taxable_amount": { "description": "The order's shipping taxable amount (float).", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to shipping_taxable_amount", "type": "number" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal shipping_taxable_amount", "type": "number" } } }, { "type": "object", "properties": { "gt": { "type": "number", "description": "Greater than shipping_taxable_amount" } } }, { "type": "object", "properties": { "gte": { "type": "number", "description": "Greater than equal shipping_taxable_amount" } } }, { "type": "object", "properties": { "lt": { "type": "number", "description": "Less than shipping_taxable_amount" } } }, { "type": "object", "properties": { "lte": { "type": "number", "description": "Less than equal shipping_taxable_amount" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than shipping_taxable_amount" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal shipping_taxable_amount" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than shipping_taxable_amount" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal shipping_taxable_amount" } } } ] }, "skus_count": { "description": "The total number of SKUs in the order's line items.", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to skus_count", "type": "integer" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal skus_count", "type": "integer" } } }, { "type": "object", "properties": { "gt": { "type": "integer", "description": "Greater than skus_count" } } }, { "type": "object", "properties": { "gte": { "type": "integer", "description": "Greater than equal skus_count" } } }, { "type": "object", "properties": { "lt": { "type": "integer", "description": "Less than skus_count" } } }, { "type": "object", "properties": { "lte": { "type": "integer", "description": "Less than equal skus_count" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than skus_count" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal skus_count" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than skus_count" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal skus_count" } } } ] }, "statuses": { "description": "The order status. One of `placed`, `approved`, or `cancelled`.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of statuses" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of statuses" } } } ] }, "subtotal_amount": { "description": "The sum of all the SKU line items total amounts (float).", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to subtotal_amount", "type": "number" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal subtotal_amount", "type": "number" } } }, { "type": "object", "properties": { "gt": { "type": "number", "description": "Greater than subtotal_amount" } } }, { "type": "object", "properties": { "gte": { "type": "number", "description": "Greater than equal subtotal_amount" } } }, { "type": "object", "properties": { "lt": { "type": "number", "description": "Less than subtotal_amount" } } }, { "type": "object", "properties": { "lte": { "type": "number", "description": "Less than equal subtotal_amount" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than subtotal_amount" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal subtotal_amount" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than subtotal_amount" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal subtotal_amount" } } } ] }, "subtotal_tax_amount": { "description": "The taxes applied to the order's subtotal (float).", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to subtotal_tax_amount", "type": "number" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal subtotal_tax_amount", "type": "number" } } }, { "type": "object", "properties": { "gt": { "type": "number", "description": "Greater than subtotal_tax_amount" } } }, { "type": "object", "properties": { "gte": { "type": "number", "description": "Greater than equal subtotal_tax_amount" } } }, { "type": "object", "properties": { "lt": { "type": "number", "description": "Less than subtotal_tax_amount" } } }, { "type": "object", "properties": { "lte": { "type": "number", "description": "Less than equal subtotal_tax_amount" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than subtotal_tax_amount" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal subtotal_tax_amount" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than subtotal_tax_amount" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal subtotal_tax_amount" } } } ] }, "subtotal_taxable_amount": { "description": "The order's subtotal taxable amount (float).", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to subtotal_taxable_amount", "type": "number" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal subtotal_taxable_amount", "type": "number" } } }, { "type": "object", "properties": { "gt": { "type": "number", "description": "Greater than subtotal_taxable_amount" } } }, { "type": "object", "properties": { "gte": { "type": "number", "description": "Greater than equal subtotal_taxable_amount" } } }, { "type": "object", "properties": { "lt": { "type": "number", "description": "Less than subtotal_taxable_amount" } } }, { "type": "object", "properties": { "lte": { "type": "number", "description": "Less than equal subtotal_taxable_amount" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than subtotal_taxable_amount" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal subtotal_taxable_amount" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than subtotal_taxable_amount" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal subtotal_taxable_amount" } } } ] }, "tax_included": { "type": "boolean", "description": "Indicates if taxes are included in the order amounts (automatically inherited from the order's price list)." }, "total_amount": { "description": "The order's total amount (float).", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to total_amount", "type": "number" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal total_amount", "type": "number" } } }, { "type": "object", "properties": { "gt": { "type": "number", "description": "Greater than total_amount" } } }, { "type": "object", "properties": { "gte": { "type": "number", "description": "Greater than equal total_amount" } } }, { "type": "object", "properties": { "lt": { "type": "number", "description": "Less than total_amount" } } }, { "type": "object", "properties": { "lte": { "type": "number", "description": "Less than equal total_amount" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than total_amount" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal total_amount" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than total_amount" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal total_amount" } } } ] }, "total_amount_with_taxes": { "description": "The order's total amount, taxes included (float).", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to total_amount_with_taxes", "type": "number" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal total_amount_with_taxes", "type": "number" } } }, { "type": "object", "properties": { "gt": { "type": "number", "description": "Greater than total_amount_with_taxes" } } }, { "type": "object", "properties": { "gte": { "type": "number", "description": "Greater than equal total_amount_with_taxes" } } }, { "type": "object", "properties": { "lt": { "type": "number", "description": "Less than total_amount_with_taxes" } } }, { "type": "object", "properties": { "lte": { "type": "number", "description": "Less than equal total_amount_with_taxes" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than total_amount_with_taxes" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal total_amount_with_taxes" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than total_amount_with_taxes" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal total_amount_with_taxes" } } } ] }, "total_tax_amount": { "description": "The sum of all the taxes applied to the order (float).", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to total_tax_amount", "type": "number" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal total_tax_amount", "type": "number" } } }, { "type": "object", "properties": { "gt": { "type": "number", "description": "Greater than total_tax_amount" } } }, { "type": "object", "properties": { "gte": { "type": "number", "description": "Greater than equal total_tax_amount" } } }, { "type": "object", "properties": { "lt": { "type": "number", "description": "Less than total_tax_amount" } } }, { "type": "object", "properties": { "lte": { "type": "number", "description": "Less than equal total_tax_amount" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than total_tax_amount" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal total_tax_amount" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than total_tax_amount" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal total_tax_amount" } } } ] }, "total_taxable_amount": { "description": "The order's total taxable amount (float).", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to total_taxable_amount", "type": "number" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal total_taxable_amount", "type": "number" } } }, { "type": "object", "properties": { "gt": { "type": "number", "description": "Greater than total_taxable_amount" } } }, { "type": "object", "properties": { "gte": { "type": "number", "description": "Greater than equal total_taxable_amount" } } }, { "type": "object", "properties": { "lt": { "type": "number", "description": "Less than total_taxable_amount" } } }, { "type": "object", "properties": { "lte": { "type": "number", "description": "Less than equal total_taxable_amount" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than total_taxable_amount" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal total_taxable_amount" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than total_taxable_amount" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal total_taxable_amount" } } } ] }, "updated_at": { "description": "The date and time at which the order was last updated (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard).", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to updated_at", "type": "string" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal updated_at", "type": "string" } } }, { "type": "object", "properties": { "gt": { "type": "string", "description": "Greater than updated_at" } } }, { "type": "object", "properties": { "gte": { "type": "string", "description": "Greater than equal updated_at" } } }, { "type": "object", "properties": { "lt": { "type": "string", "description": "Less than updated_at" } } }, { "type": "object", "properties": { "lte": { "type": "string", "description": "Less than equal updated_at" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than updated_at" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal updated_at" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than updated_at" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal updated_at" } } } ] }, "current_date": { "description": "The date and time of the order's latest status change, regardless of the order's status (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard).", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to current_date", "type": "string" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal current_date", "type": "string" } } }, { "type": "object", "properties": { "gt": { "type": "string", "description": "Greater than current_date" } } }, { "type": "object", "properties": { "gte": { "type": "string", "description": "Greater than equal current_date" } } }, { "type": "object", "properties": { "lt": { "type": "string", "description": "Less than current_date" } } }, { "type": "object", "properties": { "lte": { "type": "string", "description": "Less than equal current_date" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than current_date" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal current_date" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than current_date" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal current_date" } } } ] }, "seconds_in_draft": { "description": "The difference in seconds between `placed_at` and `created_at` (`null` if the order hasn't been placed yet).", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to seconds_in_draft", "type": "integer" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal seconds_in_draft", "type": "integer" } } }, { "type": "object", "properties": { "gt": { "type": "integer", "description": "Greater than seconds_in_draft" } } }, { "type": "object", "properties": { "gte": { "type": "integer", "description": "Greater than equal seconds_in_draft" } } }, { "type": "object", "properties": { "lt": { "type": "integer", "description": "Less than seconds_in_draft" } } }, { "type": "object", "properties": { "lte": { "type": "integer", "description": "Less than equal seconds_in_draft" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than seconds_in_draft" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal seconds_in_draft" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than seconds_in_draft" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal seconds_in_draft" } } } ] }, "seconds_in_approved": { "description": "The difference in seconds between `cancelled_at` and `approved_at` (`null` if the order hasn't been approved yet or no further status change happened after approval — e.g. the order has been regularly fulfilled).", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to seconds_in_approved", "type": "integer" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal seconds_in_approved", "type": "integer" } } }, { "type": "object", "properties": { "gt": { "type": "integer", "description": "Greater than seconds_in_approved" } } }, { "type": "object", "properties": { "gte": { "type": "integer", "description": "Greater than equal seconds_in_approved" } } }, { "type": "object", "properties": { "lt": { "type": "integer", "description": "Less than seconds_in_approved" } } }, { "type": "object", "properties": { "lte": { "type": "integer", "description": "Less than equal seconds_in_approved" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than seconds_in_approved" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal seconds_in_approved" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than seconds_in_approved" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal seconds_in_approved" } } } ] }, "seconds_in_placed": { "description": "The difference in seconds between `approved_at` and `placed_at` if the order has been approved or between `cancelled_at` and `placed_at` if the order has been cancelled before approval (`null` if the order hasn't been placed yet or no further status change happened after placement).", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to seconds_in_placed", "type": "integer" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal seconds_in_placed", "type": "integer" } } }, { "type": "object", "properties": { "gt": { "type": "integer", "description": "Greater than seconds_in_placed" } } }, { "type": "object", "properties": { "gte": { "type": "integer", "description": "Greater than equal seconds_in_placed" } } }, { "type": "object", "properties": { "lt": { "type": "integer", "description": "Less than seconds_in_placed" } } }, { "type": "object", "properties": { "lte": { "type": "integer", "description": "Less than equal seconds_in_placed" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than seconds_in_placed" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal seconds_in_placed" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than seconds_in_placed" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal seconds_in_placed" } } } ] }, "placed_day_of_week": { "description": "The day of week when the order was placed, expressed as an integer (`0` through `6`, from Sunday to Saturday — e.g. `1` is Monday).", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to placed_day_of_week", "type": "integer" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal placed_day_of_week", "type": "integer" } } }, { "type": "object", "properties": { "gt": { "type": "integer", "description": "Greater than placed_day_of_week" } } }, { "type": "object", "properties": { "gte": { "type": "integer", "description": "Greater than equal placed_day_of_week" } } }, { "type": "object", "properties": { "lt": { "type": "integer", "description": "Less than placed_day_of_week" } } }, { "type": "object", "properties": { "lte": { "type": "integer", "description": "Less than equal placed_day_of_week" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than placed_day_of_week" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal placed_day_of_week" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than placed_day_of_week" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal placed_day_of_week" } } } ] }, "refunds_total_amount_with_taxes": { "description": "Total amount of refunds (including taxes) associated with the order.", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to refunds_total_amount_with_taxes", "type": "integer" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal refunds_total_amount_with_taxes", "type": "integer" } } }, { "type": "object", "properties": { "gt": { "type": "integer", "description": "Greater than refunds_total_amount_with_taxes" } } }, { "type": "object", "properties": { "gte": { "type": "integer", "description": "Greater than equal refunds_total_amount_with_taxes" } } }, { "type": "object", "properties": { "lt": { "type": "integer", "description": "Less than refunds_total_amount_with_taxes" } } }, { "type": "object", "properties": { "lte": { "type": "integer", "description": "Less than equal refunds_total_amount_with_taxes" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than refunds_total_amount_with_taxes" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal refunds_total_amount_with_taxes" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than refunds_total_amount_with_taxes" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal refunds_total_amount_with_taxes" } } } ] }, "total_amount_with_taxes_net_of_refunds": { "description": "The total amount of the order minus the total amount of refunds.", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to total_amount_with_taxes_net_of_refunds", "type": "number" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal total_amount_with_taxes_net_of_refunds", "type": "number" } } }, { "type": "object", "properties": { "gt": { "type": "number", "description": "Greater than total_amount_with_taxes_net_of_refunds" } } }, { "type": "object", "properties": { "gte": { "type": "number", "description": "Greater than equal total_amount_with_taxes_net_of_refunds" } } }, { "type": "object", "properties": { "lt": { "type": "number", "description": "Less than total_amount_with_taxes_net_of_refunds" } } }, { "type": "object", "properties": { "lte": { "type": "number", "description": "Less than equal total_amount_with_taxes_net_of_refunds" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than total_amount_with_taxes_net_of_refunds" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal total_amount_with_taxes_net_of_refunds" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than total_amount_with_taxes_net_of_refunds" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal total_amount_with_taxes_net_of_refunds" } } } ] }, "aggregated_details": { "description": "Searchable field containing all orders data.", "type": "object", "properties": { "query": { "type": "string", "description": "Returns documents based on a provided query string aggregated_details" } } }, "link_ids": { "description": "The link ID used during the checkout.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of link_ids" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of link_ids" } } } ] }, "user_ids": { "description": "The user ID used to generate the link.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of user_ids" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of user_ids" } } } ] }, "store_ids": { "description": "The store ID used during the checkout.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of store_ids" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of store_ids" } } } ] }, "affiliate_codes": { "description": "The affiliate code used during the checkout.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of affiliate_codes" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of affiliate_codes" } } } ] } } }, "payment_method": { "type": "object", "properties": { "ids": { "description": "The ID of the payment method.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of ids" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of ids" } } } ] }, "source_types": { "description": "The payment source type. One of `AdyenPayment`, `BraintreePayment`, `CheckoutComPayment`, `CreditCard`, `ExternalPayment`, `KlarnaPayment`, `PaypalPayment`, `StripePayment`, or `WireTransfer`.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of source_types" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of source_types" } } } ] }, "names": { "description": "The payment source type, titleized.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of names" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of names" } } } ] }, "moto": { "type": "boolean", "description": "Indicates if the payment has been marked as MOTO (must be supported by the payment gateway)." }, "issuer": { "description": "The payment method's issuer (if present and provided by the payment gateway).", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of issuer" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of issuer" } } } ] }, "issuer_type": { "description": "The type of issuer (if present and provided by the payment gateway).", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of issuer_type" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of issuer_type" } } } ] }, "card_type": { "description": "The type of card used to pay for the order (if present and provided by the payment gateway).", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of card_type" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of card_type" } } } ] } } }, "refunds": { "type": "object", "properties": { "ids": { "description": "The ID of the refund.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of ids" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of ids" } } } ] }, "amount": { "description": "The refunded amount (float).", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to amount", "type": "number" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal amount", "type": "number" } } }, { "type": "object", "properties": { "gt": { "type": "number", "description": "Greater than amount" } } }, { "type": "object", "properties": { "gte": { "type": "number", "description": "Greater than equal amount" } } }, { "type": "object", "properties": { "lt": { "type": "number", "description": "Less than amount" } } }, { "type": "object", "properties": { "lte": { "type": "number", "description": "Less than equal amount" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than amount" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal amount" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than amount" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal amount" } } } ] }, "numbers": { "description": "The transaction number associated with the refund (auto-generated).", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of numbers" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of numbers" } } } ] } } }, "shipping_address": { "type": "object", "properties": { "business": { "type": "boolean", "description": "Indicates if the address is a business or a personal one." }, "cities": { "description": "The city specified in the address.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of cities" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of cities" } } } ] }, "country_codes": { "description": "The international 2-letter country code (as defined by the [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) standard) specified in the address.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of country_codes" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of country_codes" } } } ] }, "geocoded": { "type": "boolean", "description": "Indicates if the address has been successfully geocoded." }, "localized": { "type": "boolean", "description": "Indicates if the latitude and longitude of the address are present, either geocoded or manually updated." }, "state_codes": { "description": "The state, province or region code specified in the address.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of state_codes" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of state_codes" } } } ] }, "zip_codes": { "description": "The ZIP or postal code specified in the address.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of zip_codes" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of zip_codes" } } } ] } } }, "shipments": { "type": "object", "properties": { "ids": { "description": "The shipment ID.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of ids" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of ids" } } } ] }, "numbers": { "description": "The shipment number.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of numbers" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of numbers" } } } ] }, "items_count": { "description": "The shipment items count.", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to items_count", "type": "integer" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal items_count", "type": "integer" } } }, { "type": "object", "properties": { "gt": { "type": "integer", "description": "Greater than items_count" } } }, { "type": "object", "properties": { "gte": { "type": "integer", "description": "Greater than equal items_count" } } }, { "type": "object", "properties": { "lt": { "type": "integer", "description": "Less than items_count" } } }, { "type": "object", "properties": { "lte": { "type": "integer", "description": "Less than equal items_count" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than items_count" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal items_count" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than items_count" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal items_count" } } } ] }, "cost_amount": { "description": "The shipment cost amount.", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to cost_amount", "type": "integer" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal cost_amount", "type": "integer" } } }, { "type": "object", "properties": { "gt": { "type": "integer", "description": "Greater than cost_amount" } } }, { "type": "object", "properties": { "gte": { "type": "integer", "description": "Greater than equal cost_amount" } } }, { "type": "object", "properties": { "lt": { "type": "integer", "description": "Less than cost_amount" } } }, { "type": "object", "properties": { "lte": { "type": "integer", "description": "Less than equal cost_amount" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than cost_amount" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal cost_amount" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than cost_amount" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal cost_amount" } } } ] }, "statuses": { "description": "The shipment status.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of statuses" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of statuses" } } } ] }, "cancelled_at": { "description": "The date and time at which the shipment status was cancelled (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard).", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to cancelled_at", "type": "string" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal cancelled_at", "type": "string" } } }, { "type": "object", "properties": { "gt": { "type": "string", "description": "Greater than cancelled_at" } } }, { "type": "object", "properties": { "gte": { "type": "string", "description": "Greater than equal cancelled_at" } } }, { "type": "object", "properties": { "lt": { "type": "string", "description": "Less than cancelled_at" } } }, { "type": "object", "properties": { "lte": { "type": "string", "description": "Less than equal cancelled_at" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than cancelled_at" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal cancelled_at" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than cancelled_at" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal cancelled_at" } } } ] }, "delivered_at": { "description": "The date and time at which the shipment was delivered (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard).", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to delivered_at", "type": "string" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal delivered_at", "type": "string" } } }, { "type": "object", "properties": { "gt": { "type": "string", "description": "Greater than delivered_at" } } }, { "type": "object", "properties": { "gte": { "type": "string", "description": "Greater than equal delivered_at" } } }, { "type": "object", "properties": { "lt": { "type": "string", "description": "Less than delivered_at" } } }, { "type": "object", "properties": { "lte": { "type": "string", "description": "Less than equal delivered_at" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than delivered_at" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal delivered_at" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than delivered_at" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal delivered_at" } } } ] }, "on_hold_at": { "description": "The date and time at which the shipment status was put on hold (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard).", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to on_hold_at", "type": "string" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal on_hold_at", "type": "string" } } }, { "type": "object", "properties": { "gt": { "type": "string", "description": "Greater than on_hold_at" } } }, { "type": "object", "properties": { "gte": { "type": "string", "description": "Greater than equal on_hold_at" } } }, { "type": "object", "properties": { "lt": { "type": "string", "description": "Less than on_hold_at" } } }, { "type": "object", "properties": { "lte": { "type": "string", "description": "Less than equal on_hold_at" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than on_hold_at" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal on_hold_at" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than on_hold_at" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal on_hold_at" } } } ] }, "picking_at": { "description": "The date and time at which the shipment was picked (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard).", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to picking_at", "type": "string" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal picking_at", "type": "string" } } }, { "type": "object", "properties": { "gt": { "type": "string", "description": "Greater than picking_at" } } }, { "type": "object", "properties": { "gte": { "type": "string", "description": "Greater than equal picking_at" } } }, { "type": "object", "properties": { "lt": { "type": "string", "description": "Less than picking_at" } } }, { "type": "object", "properties": { "lte": { "type": "string", "description": "Less than equal picking_at" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than picking_at" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal picking_at" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than picking_at" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal picking_at" } } } ] }, "packing_at": { "description": "The date and time at which the shipment was packed (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard).", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to packing_at", "type": "string" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal packing_at", "type": "string" } } }, { "type": "object", "properties": { "gt": { "type": "string", "description": "Greater than packing_at" } } }, { "type": "object", "properties": { "gte": { "type": "string", "description": "Greater than equal packing_at" } } }, { "type": "object", "properties": { "lt": { "type": "string", "description": "Less than packing_at" } } }, { "type": "object", "properties": { "lte": { "type": "string", "description": "Less than equal packing_at" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than packing_at" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal packing_at" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than packing_at" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal packing_at" } } } ] }, "ready_to_ship_at": { "description": "The date and time at which the shipment was ready to ship (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard).", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to ready_to_ship_at", "type": "string" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal ready_to_ship_at", "type": "string" } } }, { "type": "object", "properties": { "gt": { "type": "string", "description": "Greater than ready_to_ship_at" } } }, { "type": "object", "properties": { "gte": { "type": "string", "description": "Greater than equal ready_to_ship_at" } } }, { "type": "object", "properties": { "lt": { "type": "string", "description": "Less than ready_to_ship_at" } } }, { "type": "object", "properties": { "lte": { "type": "string", "description": "Less than equal ready_to_ship_at" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than ready_to_ship_at" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal ready_to_ship_at" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than ready_to_ship_at" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal ready_to_ship_at" } } } ] }, "shipped_at": { "description": "The date and time at which the shipment was shipped (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard).", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to shipped_at", "type": "string" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal shipped_at", "type": "string" } } }, { "type": "object", "properties": { "gt": { "type": "string", "description": "Greater than shipped_at" } } }, { "type": "object", "properties": { "gte": { "type": "string", "description": "Greater than equal shipped_at" } } }, { "type": "object", "properties": { "lt": { "type": "string", "description": "Less than shipped_at" } } }, { "type": "object", "properties": { "lte": { "type": "string", "description": "Less than equal shipped_at" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than shipped_at" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal shipped_at" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than shipped_at" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal shipped_at" } } } ] }, "created_at": { "description": "The date and time at which the shipment was created (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard).", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to created_at", "type": "string" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal created_at", "type": "string" } } }, { "type": "object", "properties": { "gt": { "type": "string", "description": "Greater than created_at" } } }, { "type": "object", "properties": { "gte": { "type": "string", "description": "Greater than equal created_at" } } }, { "type": "object", "properties": { "lt": { "type": "string", "description": "Less than created_at" } } }, { "type": "object", "properties": { "lte": { "type": "string", "description": "Less than equal created_at" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than created_at" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal created_at" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than created_at" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal created_at" } } } ] }, "updated_at": { "description": "The date and time at which the shipment was updated (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard).", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to updated_at", "type": "string" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal updated_at", "type": "string" } } }, { "type": "object", "properties": { "gt": { "type": "string", "description": "Greater than updated_at" } } }, { "type": "object", "properties": { "gte": { "type": "string", "description": "Greater than equal updated_at" } } }, { "type": "object", "properties": { "lt": { "type": "string", "description": "Less than updated_at" } } }, { "type": "object", "properties": { "lte": { "type": "string", "description": "Less than equal updated_at" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than updated_at" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal updated_at" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than updated_at" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal updated_at" } } } ] }, "references": { "description": "Any external identifier that might be useful to link the shipment resource to other systems through the Commerce Layer core API.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of references" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of references" } } } ] }, "reference_origins": { "description": "Any identifier of the 3rd-party system that defines the reference code.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of reference_origins" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of reference_origins" } } } ] }, "seconds_in_picking": { "description": "The difference in seconds between `picking_at` and `packing_at` (`null` if the order hasn't been picked yet).", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to seconds_in_picking", "type": "integer" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal seconds_in_picking", "type": "integer" } } }, { "type": "object", "properties": { "gt": { "type": "integer", "description": "Greater than seconds_in_picking" } } }, { "type": "object", "properties": { "gte": { "type": "integer", "description": "Greater than equal seconds_in_picking" } } }, { "type": "object", "properties": { "lt": { "type": "integer", "description": "Less than seconds_in_picking" } } }, { "type": "object", "properties": { "lte": { "type": "integer", "description": "Less than equal seconds_in_picking" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than seconds_in_picking" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal seconds_in_picking" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than seconds_in_picking" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal seconds_in_picking" } } } ] }, "seconds_in_ready_to_ship": { "description": "The difference in seconds between `ready_to_ship_at` and `shipped_at` (`null` if the order hasn't been shipped yet).", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to seconds_in_ready_to_ship", "type": "integer" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal seconds_in_ready_to_ship", "type": "integer" } } }, { "type": "object", "properties": { "gt": { "type": "integer", "description": "Greater than seconds_in_ready_to_ship" } } }, { "type": "object", "properties": { "gte": { "type": "integer", "description": "Greater than equal seconds_in_ready_to_ship" } } }, { "type": "object", "properties": { "lt": { "type": "integer", "description": "Less than seconds_in_ready_to_ship" } } }, { "type": "object", "properties": { "lte": { "type": "integer", "description": "Less than equal seconds_in_ready_to_ship" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than seconds_in_ready_to_ship" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal seconds_in_ready_to_ship" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than seconds_in_ready_to_ship" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal seconds_in_ready_to_ship" } } } ] }, "seconds_in_shipped": { "description": "The difference in seconds between `delivered_at` and `shipped_at` (`null` if the order hasn't been delivered yet).", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to seconds_in_shipped", "type": "integer" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal seconds_in_shipped", "type": "integer" } } }, { "type": "object", "properties": { "gt": { "type": "integer", "description": "Greater than seconds_in_shipped" } } }, { "type": "object", "properties": { "gte": { "type": "integer", "description": "Greater than equal seconds_in_shipped" } } }, { "type": "object", "properties": { "lt": { "type": "integer", "description": "Less than seconds_in_shipped" } } }, { "type": "object", "properties": { "lte": { "type": "integer", "description": "Less than equal seconds_in_shipped" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than seconds_in_shipped" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal seconds_in_shipped" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than seconds_in_shipped" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal seconds_in_shipped" } } } ] }, "fulfillment_time": { "description": "The difference in seconds between `delivered_at` and `picking_at` or `shipped_at` and `picking_at`.", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to fulfillment_time", "type": "integer" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal fulfillment_time", "type": "integer" } } }, { "type": "object", "properties": { "gt": { "type": "integer", "description": "Greater than fulfillment_time" } } }, { "type": "object", "properties": { "gte": { "type": "integer", "description": "Greater than equal fulfillment_time" } } }, { "type": "object", "properties": { "lt": { "type": "integer", "description": "Less than fulfillment_time" } } }, { "type": "object", "properties": { "lte": { "type": "integer", "description": "Less than equal fulfillment_time" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than fulfillment_time" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal fulfillment_time" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than fulfillment_time" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "integer", "example": 8 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal fulfillment_time" } } } ] }, "items": { "description": "Array of the shipment items information.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of items" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of items" } } } ] } } }, "shipments.stock_location": { "type": "object", "properties": { "ids": { "description": "The shipment stock location ID.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of ids" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of ids" } } } ] }, "names": { "description": "The shipment stock location name.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of names" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of names" } } } ] }, "references": { "description": "Any external identifier that might be useful to link the stock location reference resource to other systems through the Commerce Layer core API.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of references" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of references" } } } ] }, "reference_origins": { "description": "Any identifier of the 3rd-party system that defines the reference code.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of reference_origins" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of reference_origins" } } } ] } } }, "shipments.shipping_method": { "type": "object", "properties": { "ids": { "description": "The shipment shipping method ID.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of ids" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of ids" } } } ] }, "names": { "description": "The shipment shipping method name.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of names" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of names" } } } ] }, "references": { "description": "Any external identifier that might be useful to link the shipping method reference resource to other systems through the Commerce Layer core API.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of references" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of references" } } } ] }, "reference_origins": { "description": "Any identifier of the 3rd-party system that defines the reference code.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of reference_origins" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of reference_origins" } } } ] }, "currency_codes": { "description": "The international 3-letter currency code (as defined by the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) standard), automatically inherited from the order's market.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of currency_codes" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of currency_codes" } } } ] } } }, "shipments.shipping_category": { "type": "object", "properties": { "ids": { "description": "The shipment shipping category ID.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of ids" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of ids" } } } ] }, "names": { "description": "The shipment shipping category name.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of names" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of names" } } } ] }, "references": { "description": "Any external identifier that might be useful to link the shipping method reference resource to other systems through the Commerce Layer core API.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of references" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of references" } } } ] }, "reference_origins": { "description": "Any identifier of the 3rd-party system that defines the reference code.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of reference_origins" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of reference_origins" } } } ] } } }, "shipments.tags": { "type": "object", "properties": { "ids": { "description": "The tag ID.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of ids" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of ids" } } } ] }, "names": { "description": "The tag name.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of names" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of names" } } } ] } } }, "tags": { "type": "object", "properties": { "ids": { "description": "The tag ID.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of ids" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of ids" } } } ] }, "names": { "description": "The tag name.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of names" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of names" } } } ] } } }, "resource_errors": { "type": "object", "properties": { "codes": { "description": "The resource errors code.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of codes" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of codes" } } } ] }, "names": { "description": "The name of the resource error.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of names" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of names" } } } ] }, "ids": { "description": "The ID of the resource error.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of ids" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of ids" } } } ] }, "messages": { "description": "The resource error message.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of messages" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of messages" } } } ] }, "created_at": { "description": "The date and time at which the resource error was created (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard).", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to created_at", "type": "string" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal created_at", "type": "string" } } }, { "type": "object", "properties": { "gt": { "type": "string", "description": "Greater than created_at" } } }, { "type": "object", "properties": { "gte": { "type": "string", "description": "Greater than equal created_at" } } }, { "type": "object", "properties": { "lt": { "type": "string", "description": "Less than created_at" } } }, { "type": "object", "properties": { "lte": { "type": "string", "description": "Less than equal created_at" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than created_at" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal created_at" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than created_at" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal created_at" } } } ] }, "updated_at": { "description": "The date and time at which the resource error was updated (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard).", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to updated_at", "type": "string" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal updated_at", "type": "string" } } }, { "type": "object", "properties": { "gt": { "type": "string", "description": "Greater than updated_at" } } }, { "type": "object", "properties": { "gte": { "type": "string", "description": "Greater than equal updated_at" } } }, { "type": "object", "properties": { "lt": { "type": "string", "description": "Less than updated_at" } } }, { "type": "object", "properties": { "lte": { "type": "string", "description": "Less than equal updated_at" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than updated_at" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal updated_at" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than updated_at" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal updated_at" } } } ] } } } } }, "orders_search_fields": { "type": "string", "enum": [ "billing_address.business", "billing_address.city", "billing_address.country_code", "billing_address.geocoded", "billing_address.localized", "billing_address.state_code", "billing_address.zip_code", "billing_address.company", "billing_address.first_name", "billing_address.last_name", "customer.id", "customer.email", "customer.group_name", "customer.reference", "customer.reference_origin", "line_items.code", "line_items.discount", "line_items.id", "line_items.item_id", "line_items.item_type", "line_items.name", "line_items.options_amount", "line_items.quantity", "line_items.tax_amount", "line_items.tax_rate", "line_items.total_amount", "line_items.unit_amount", "line_items.updated_at", "line_items.options.id", "line_items.options.name", "line_items.options.quantity", "line_items.options.total_amount", "line_items.options.unit_amount", "market.id", "market.name", "market.number", "organization.id", "organization.name", "organization.slug", "order.discounted", "order.refunded", "order.gift_card", "order.coupon", "order.customer_type", "order.returned", "order.options", "order.adjustment_amount", "order.adjustment_tax_amount", "order.adjustment_taxable_amount", "order.approved_at", "order.archived_at", "order.archived", "order.cancelled_at", "order.country_code", "order.coupon_code", "order.created_at", "order.currency_code", "order.discount_amount", "order.duty_amount", "order.freight_taxable", "order.fulfillment_status", "order.fulfillment_updated_at", "order.gift_card_code", "order.gift_card_amount", "order.guest", "order.id", "order.language_code", "order.line_item_options_count", "order.mode", "order.number", "order.payment_method_amount", "order.payment_method_tax_amount", "order.payment_method_taxable_amount", "order.payment_status", "order.payment_updated_at", "order.placed_at", "order.reference", "order.reference_origin", "order.shipments_count", "order.shipping_amount", "order.shipping_taxable_amount", "order.skus_count", "order.status", "order.subtotal_amount", "order.subtotal_tax_amount", "order.subtotal_taxable_amount", "order.tax_included", "order.total_amount", "order.total_amount_with_taxes", "order.total_tax_amount", "order.total_taxable_amount", "order.updated_at", "order.current_date", "order.seconds_in_draft", "order.seconds_in_approved", "order.seconds_in_placed", "order.placed_day_of_week", "order.refunds_total_amount_with_taxes", "order.total_amount_with_taxes_net_of_refunds", "order.aggregated_details", "order.link_id", "order.user_id", "order.store_id", "order.affiliate_code", "payment_method.id", "payment_method.source_type", "payment_method.name", "payment_method.moto", "payment_method.issuer", "payment_method.issuer_type", "payment_method.card_type", "refunds.id", "refunds.amount", "refunds.number", "shipping_address.business", "shipping_address.city", "shipping_address.country_code", "shipping_address.geocoded", "shipping_address.localized", "shipping_address.state_code", "shipping_address.zip_code", "shipments.id", "shipments.number", "shipments.items_count", "shipments.cost_amount", "shipments.status", "shipments.cancelled_at", "shipments.delivered_at", "shipments.on_hold_at", "shipments.picking_at", "shipments.packing_at", "shipments.ready_to_ship_at", "shipments.shipped_at", "shipments.created_at", "shipments.updated_at", "shipments.reference", "shipments.reference_origin", "shipments.seconds_in_picking", "shipments.seconds_in_ready_to_ship", "shipments.seconds_in_shipped", "shipments.fulfillment_time", "shipments.items", "shipments.stock_location.id", "shipments.stock_location.name", "shipments.stock_location.reference", "shipments.stock_location.reference_origin", "shipments.shipping_method.id", "shipments.shipping_method.name", "shipments.shipping_method.reference", "shipments.shipping_method.reference_origin", "shipments.shipping_method.currency_code", "shipments.shipping_category.id", "shipments.shipping_category.name", "shipments.shipping_category.reference", "shipments.shipping_category.reference_origin", "shipments.tags.id", "shipments.tags.name", "tags.id", "tags.name", "resource_errors.code", "resource_errors.name", "resource_errors.id", "resource_errors.message", "resource_errors.created_at", "resource_errors.updated_at" ] }, "orders_export_fields": { "type": "string", "enum": [ "billing_address.business", "billing_address.city", "billing_address.country_code", "billing_address.geocoded", "billing_address.localized", "billing_address.state_code", "billing_address.zip_code", "billing_address.company", "billing_address.first_name", "billing_address.last_name", "customer.id", "customer.email", "customer.group_name", "customer.reference", "customer.reference_origin", "market.id", "market.name", "market.number", "organization.id", "organization.name", "organization.slug", "order.discounted", "order.refunded", "order.gift_card", "order.coupon", "order.customer_type", "order.returned", "order.options", "order.adjustment_amount", "order.adjustment_tax_amount", "order.adjustment_taxable_amount", "order.approved_at", "order.archived_at", "order.archived", "order.cancelled_at", "order.country_code", "order.coupon_code", "order.created_at", "order.currency_code", "order.discount_amount", "order.duty_amount", "order.freight_taxable", "order.fulfillment_status", "order.fulfillment_updated_at", "order.gift_card_code", "order.gift_card_amount", "order.guest", "order.id", "order.language_code", "order.line_item_options_count", "order.mode", "order.number", "order.payment_method_amount", "order.payment_method_tax_amount", "order.payment_method_taxable_amount", "order.payment_status", "order.payment_updated_at", "order.placed_at", "order.reference", "order.reference_origin", "order.shipments_count", "order.shipping_amount", "order.shipping_taxable_amount", "order.skus_count", "order.status", "order.subtotal_amount", "order.subtotal_tax_amount", "order.subtotal_taxable_amount", "order.tax_included", "order.total_amount", "order.total_amount_with_taxes", "order.total_tax_amount", "order.total_taxable_amount", "order.updated_at", "order.current_date", "order.seconds_in_draft", "order.seconds_in_approved", "order.seconds_in_placed", "order.placed_day_of_week", "order.refunds_total_amount_with_taxes", "order.total_amount_with_taxes_net_of_refunds", "order.aggregated_details", "order.link_id", "order.user_id", "order.store_id", "order.affiliate_code", "payment_method.id", "payment_method.source_type", "payment_method.name", "payment_method.moto", "payment_method.issuer", "payment_method.issuer_type", "payment_method.card_type", "shipping_address.business", "shipping_address.city", "shipping_address.country_code", "shipping_address.geocoded", "shipping_address.localized", "shipping_address.state_code", "shipping_address.zip_code", "tags.id", "tags.name" ] }, "orders_breakdown_request": { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/orders_filter" }, "breakdown": { "type": "object", "description": "Check available [fields](#/components/schemas/orders_breakdown_request/properties/breakdown/properties/field/description)", "required": [ "by", "field", "operator" ], "properties": { "by": { "type": "string", "description": "Field to base your breakdown query.\n\nForbidden nesting\n\n These are the valid values you can specify for the by key of the breakdown query and the related forbidden values for the by key of the nested breakdown, based on the by key of the parent breakdown (i.e. for each row of the table below the full list of the valid values for the by key of the nested breakdown is given by all the values in the \"Value\" column except the values in the row's \"Forbidden nesting\" cell):\n\n\n \n| Value | Forbidden nesting |\n| --- | ------ |\n|**`billing_address.business`** |

`billing_address.geocoded`

`billing_address.localized`

`customer.*`

`shipping_address.*`

`line_items.item_type`

`order.freight_taxable`

`order.fulfillment_status`

`order.payment_status`

`order.status`

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

`billing_address.country_code`

`billing_address.state_code`

`customer.*`

`shipping_address.*`

`line_items.item_type`

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

`customer.*`

`shipping_address.*`

`line_items.item_type`

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

`billing_address.*`

`customer.*`

`shipping_address.*`

`line_items.item_type`

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

`billing_address.*`

`customer.*`

`shipping_address.*`

`line_items.item_type`

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

`billing_address.country_code`

`customer.*`

`shipping_address.*`

`line_items.item_type`

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

`billing_address.country_code`

`billing_address.city`

`billing_address.geocoded`

`billing_address.localized`

`customer.*`

`shipping_address.*`

`line_items.item_type`

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

`line_items.*`

`shipments.*`

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

`line_items.*`

`shipments.*`

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

`billing_address.geocoded`

`billing_address.localized`

`shipping_address.geocoded`

`shipping_address.localized`

`line_items.item_type`

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

`shipping_address.geocoded`

`shipping_address.localized`

`customer.*`

`billing_address.*`

`line_items.item_type`

`order.freight_taxable`

`order.fulfillment_status`

`order.payment_status`

`order.status`

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

`shipping_address.country_code`

`shipping_address.state_code`

`customer.*`

`billing_address.*`

`line_items.item_type`

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

`customer.*`

`billing_address.*`

`line_items.item_type`

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

`billing_address.*`

`customer.*`

`shipping_address.*`

`line_items.item_type`

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

`billing_address.*`

`customer.*`

`shipping_address.*`

`line_items.item_type`

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

`shipping_address.country_code`

`customer.*`

`billing_address.*`

`line_items.item_type`

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

`shipping_address.country_code`

`shipping_address.city`

`shipping_address.geocoded`

`shipping_address.localized`

`customer.*`

`billing_address.*`

`line_items.item_type`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`cardinality`

`value_count`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`cardinality`

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

`cardinality`

`value_count`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`value_count`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`cardinality`

`value_count`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`value_count`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`stats`

`percentiles`

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

`avg`

`max`

`min`

`stats`

`percentiles`

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

`avg`

`max`

`min`

`stats`

`percentiles`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`value_count`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`avg`

`max`

`min`

`stats`

`percentiles`

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

`avg`

`max`

`min`

`stats`

`percentiles`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`avg`

`max`

`min`

`stats`

`percentiles`

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

`avg`

`max`

`min`

`stats`

`percentiles`

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

`avg`

`max`

`min`

`stats`

`percentiles`

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

`avg`

`max`

`min`

`stats`

`percentiles`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`billing_address.geocoded`

`billing_address.localized`

`customer.*`

`shipping_address.*`

`line_items.item_type`

`order.freight_taxable`

`order.fulfillment_status`

`order.payment_status`

`order.status`

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

`billing_address.country_code`

`billing_address.state_code`

`customer.*`

`shipping_address.*`

`line_items.item_type`

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

`customer.*`

`shipping_address.*`

`line_items.item_type`

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

`billing_address.*`

`customer.*`

`shipping_address.*`

`line_items.item_type`

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

`billing_address.*`

`customer.*`

`shipping_address.*`

`line_items.item_type`

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

`billing_address.country_code`

`customer.*`

`shipping_address.*`

`line_items.item_type`

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

`billing_address.country_code`

`billing_address.city`

`billing_address.geocoded`

`billing_address.localized`

`customer.*`

`shipping_address.*`

`line_items.item_type`

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

`line_items.*`

`shipments.*`

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

`line_items.*`

`shipments.*`

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

`billing_address.geocoded`

`billing_address.localized`

`shipping_address.geocoded`

`shipping_address.localized`

`line_items.item_type`

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

`shipping_address.geocoded`

`shipping_address.localized`

`customer.*`

`billing_address.*`

`line_items.item_type`

`order.freight_taxable`

`order.fulfillment_status`

`order.payment_status`

`order.status`

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

`shipping_address.country_code`

`shipping_address.state_code`

`customer.*`

`billing_address.*`

`line_items.item_type`

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

`customer.*`

`billing_address.*`

`line_items.item_type`

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

`billing_address.*`

`customer.*`

`shipping_address.*`

`line_items.item_type`

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

`billing_address.*`

`customer.*`

`shipping_address.*`

`line_items.item_type`

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

`shipping_address.country_code`

`customer.*`

`billing_address.*`

`line_items.item_type`

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

`shipping_address.country_code`

`shipping_address.city`

`shipping_address.geocoded`

`shipping_address.localized`

`customer.*`

`billing_address.*`

`line_items.item_type`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`cardinality`

`value_count`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`cardinality`

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

`cardinality`

`value_count`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`value_count`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`cardinality`

`value_count`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`value_count`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`stats`

`percentiles`

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

`avg`

`max`

`min`

`stats`

`percentiles`

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

`avg`

`max`

`min`

`stats`

`percentiles`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`value_count`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`avg`

`max`

`min`

`stats`

`percentiles`

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

`avg`

`max`

`min`

`stats`

`percentiles`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`avg`

`max`

`min`

`stats`

`percentiles`

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

`avg`

`max`

`min`

`stats`

`percentiles`

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

`avg`

`max`

`min`

`stats`

`percentiles`

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

`avg`

`max`

`min`

`stats`

`percentiles`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

|\n", "enum": [ "customer.id", "customer.email", "customer.group_name", "customer.reference", "customer.reference_origin", "line_items.code", "line_items.discount", "line_items.id", "line_items.item_id", "line_items.options_amount", "line_items.quantity", "line_items.tax_amount", "line_items.tax_rate", "line_items.total_amount", "line_items.unit_amount", "line_items.options.id", "line_items.options.quantity", "line_items.options.total_amount", "line_items.options.unit_amount", "market.id", "market.number", "order.adjustment_amount", "order.adjustment_tax_amount", "order.adjustment_taxable_amount", "order.discount_amount", "order.duty_amount", "order.gift_card_code", "order.gift_card_amount", "order.id", "order.line_item_options_count", "order.number", "order.payment_method_amount", "order.payment_method_tax_amount", "order.payment_method_taxable_amount", "order.reference", "order.reference_origin", "order.shipments_count", "order.shipping_amount", "order.shipping_taxable_amount", "order.skus_count", "order.subtotal_amount", "order.subtotal_tax_amount", "order.subtotal_taxable_amount", "order.total_amount", "order.total_amount_with_taxes", "order.total_tax_amount", "order.total_taxable_amount", "order.seconds_in_draft", "order.seconds_in_approved", "order.seconds_in_placed", "order.refunds_total_amount_with_taxes", "order.total_amount_with_taxes_net_of_refunds", "refunds.id", "refunds.amount", "refunds.number", "shipments.id", "shipments.number", "shipments.items_count", "shipments.cost_amount", "shipments.reference", "shipments.reference_origin", "shipments.seconds_in_picking", "shipments.seconds_in_ready_to_ship", "shipments.seconds_in_shipped", "shipments.fulfillment_time", "shipments.stock_location.id", "shipments.stock_location.reference", "shipments.stock_location.reference_origin", "shipments.shipping_method.id", "shipments.shipping_method.reference", "shipments.shipping_method.reference_origin", "shipments.shipping_category.id", "shipments.shipping_category.reference", "shipments.shipping_category.reference_origin", "resource_errors.code", "resource_errors.id", "resource_errors.message" ] }, "operator": { "type": "string", "description": "Operator to apply", "enum": [ "cardinality", "value_count", "avg", "max", "min", "sum", "stats", "percentiles" ] }, "sort": { "type": "string", "description": "Result sorting", "enum": [ "asc", "desc" ] }, "limit": { "type": "integer", "description": "Results limit", "default": 10, "maximum": 100 }, "condition": { "description": "Condition to filter the data over the breakdown result, value of the operator must be a Number or Array of numbers if operator is a range", "oneOf": [ { "type": "object", "properties": { "eq": { "type": "number" } } }, { "type": "object", "properties": { "ne": { "type": "number" } } }, { "type": "object", "properties": { "gt": { "type": "number" } } }, { "type": "object", "properties": { "gte": { "type": "number" } } }, { "type": "object", "properties": { "lt": { "type": "number" } } }, { "type": "object", "properties": { "lte": { "type": "number" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "number" } } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "number" } } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "number" } } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "number" } } } } ], "additionalProperties": false } }, "required": [ "by", "field", "operator" ] } } }, "meta": { "type": "object", "properties": { "payload": { "type": "boolean", "description": "Set to true if you want to receive how the payload has been made" } } } } }, "orders_date_breakdown_request": { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/orders_filter" }, "date_breakdown": { "type": "object", "description": "Check available [fields](#/components/schemas/orders_date_breakdown_request/properties/date_breakdown/properties/field/description)", "required": [ "by", "field", "operator" ], "properties": { "by": { "type": "string", "description": "Field to base your date breakdown query", "enum": [ "order.approved_at", "order.archived_at", "order.cancelled_at", "order.created_at", "order.fulfillment_updated_at", "order.payment_updated_at", "order.placed_at", "order.updated_at", "order.current_date", "shipments.cancelled_at", "shipments.delivered_at", "shipments.on_hold_at", "shipments.picking_at", "shipments.packing_at", "shipments.ready_to_ship_at", "shipments.shipped_at", "shipments.created_at", "shipments.updated_at", "resource_errors.created_at", "resource_errors.updated_at" ] }, "field": { "type": "string", "description": "These are the valid values you can specify for the field key of the date_breakdown query and the related valid operators, based on that key:\n\n\n \n| Value | Operators |\n| --- | --------- |\n|**`customer.id`** |

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`cardinality`

`value_count`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`cardinality`

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

`cardinality`

`value_count`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`value_count`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`cardinality`

`value_count`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`value_count`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`stats`

`percentiles`

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

`avg`

`max`

`min`

`stats`

`percentiles`

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

`avg`

`max`

`min`

`stats`

`percentiles`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`value_count`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`avg`

`max`

`min`

`stats`

`percentiles`

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

`avg`

`max`

`min`

`stats`

`percentiles`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`avg`

`max`

`min`

`stats`

`percentiles`

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

`avg`

`max`

`min`

`stats`

`percentiles`

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

`avg`

`max`

`min`

`stats`

`percentiles`

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

`avg`

`max`

`min`

`stats`

`percentiles`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`billing_address.geocoded`

`billing_address.localized`

`customer.*`

`shipping_address.*`

`line_items.item_type`

`order.freight_taxable`

`order.fulfillment_status`

`order.payment_status`

`order.status`

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

`billing_address.country_code`

`billing_address.state_code`

`customer.*`

`shipping_address.*`

`line_items.item_type`

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

`customer.*`

`shipping_address.*`

`line_items.item_type`

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

`billing_address.*`

`customer.*`

`shipping_address.*`

`line_items.item_type`

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

`billing_address.*`

`customer.*`

`shipping_address.*`

`line_items.item_type`

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

`billing_address.country_code`

`customer.*`

`shipping_address.*`

`line_items.item_type`

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

`billing_address.country_code`

`billing_address.city`

`billing_address.geocoded`

`billing_address.localized`

`customer.*`

`shipping_address.*`

`line_items.item_type`

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

`line_items.*`

`shipments.*`

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

`line_items.*`

`shipments.*`

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

`billing_address.geocoded`

`billing_address.localized`

`shipping_address.geocoded`

`shipping_address.localized`

`line_items.item_type`

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

`shipping_address.geocoded`

`shipping_address.localized`

`customer.*`

`billing_address.*`

`line_items.item_type`

`order.freight_taxable`

`order.fulfillment_status`

`order.payment_status`

`order.status`

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

`shipping_address.country_code`

`shipping_address.state_code`

`customer.*`

`billing_address.*`

`line_items.item_type`

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

`customer.*`

`billing_address.*`

`line_items.item_type`

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

`billing_address.*`

`customer.*`

`shipping_address.*`

`line_items.item_type`

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

`billing_address.*`

`customer.*`

`shipping_address.*`

`line_items.item_type`

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

`shipping_address.country_code`

`customer.*`

`billing_address.*`

`line_items.item_type`

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

`shipping_address.country_code`

`shipping_address.city`

`shipping_address.geocoded`

`shipping_address.localized`

`customer.*`

`billing_address.*`

`line_items.item_type`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`cardinality`

`value_count`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`cardinality`

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

`cardinality`

`value_count`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`value_count`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`cardinality`

`value_count`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`value_count`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`stats`

`percentiles`

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

`avg`

`max`

`min`

`stats`

`percentiles`

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

`avg`

`max`

`min`

`stats`

`percentiles`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`value_count`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`avg`

`max`

`min`

`stats`

`percentiles`

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

`avg`

`max`

`min`

`stats`

`percentiles`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`avg`

`max`

`min`

`stats`

`percentiles`

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

`avg`

`max`

`min`

`stats`

`percentiles`

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

`avg`

`max`

`min`

`stats`

`percentiles`

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

`avg`

`max`

`min`

`stats`

`percentiles`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`billing_address.geocoded`

`billing_address.localized`

`customer.*`

`shipping_address.*`

`line_items.item_type`

`order.freight_taxable`

`order.fulfillment_status`

`order.payment_status`

`order.status`

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

`billing_address.country_code`

`billing_address.state_code`

`customer.*`

`shipping_address.*`

`line_items.item_type`

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

`customer.*`

`shipping_address.*`

`line_items.item_type`

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

`billing_address.*`

`customer.*`

`shipping_address.*`

`line_items.item_type`

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

`billing_address.*`

`customer.*`

`shipping_address.*`

`line_items.item_type`

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

`billing_address.country_code`

`customer.*`

`shipping_address.*`

`line_items.item_type`

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

`billing_address.country_code`

`billing_address.city`

`billing_address.geocoded`

`billing_address.localized`

`customer.*`

`shipping_address.*`

`line_items.item_type`

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

`line_items.*`

`shipments.*`

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

`line_items.*`

`shipments.*`

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

`billing_address.geocoded`

`billing_address.localized`

`shipping_address.geocoded`

`shipping_address.localized`

`line_items.item_type`

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

`shipping_address.geocoded`

`shipping_address.localized`

`customer.*`

`billing_address.*`

`line_items.item_type`

`order.freight_taxable`

`order.fulfillment_status`

`order.payment_status`

`order.status`

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

`shipping_address.country_code`

`shipping_address.state_code`

`customer.*`

`billing_address.*`

`line_items.item_type`

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

`customer.*`

`billing_address.*`

`line_items.item_type`

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

`billing_address.*`

`customer.*`

`shipping_address.*`

`line_items.item_type`

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

`billing_address.*`

`customer.*`

`shipping_address.*`

`line_items.item_type`

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

`shipping_address.country_code`

`customer.*`

`billing_address.*`

`line_items.item_type`

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

`shipping_address.country_code`

`shipping_address.city`

`shipping_address.geocoded`

`shipping_address.localized`

`customer.*`

`billing_address.*`

`line_items.item_type`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`cardinality`

`value_count`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`cardinality`

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

`cardinality`

`value_count`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`value_count`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`cardinality`

`value_count`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`value_count`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`stats`

`percentiles`

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

`avg`

`max`

`min`

`stats`

`percentiles`

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

`avg`

`max`

`min`

`stats`

`percentiles`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`value_count`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`avg`

`max`

`min`

`stats`

`percentiles`

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

`avg`

`max`

`min`

`stats`

`percentiles`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`avg`

`max`

`min`

`stats`

`percentiles`

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

`avg`

`max`

`min`

`stats`

`percentiles`

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

`avg`

`max`

`min`

`stats`

`percentiles`

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

`avg`

`max`

`min`

`stats`

`percentiles`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

|\n", "enum": [ "customer.id", "customer.email", "customer.group_name", "customer.reference", "customer.reference_origin", "line_items.code", "line_items.discount", "line_items.id", "line_items.item_id", "line_items.options_amount", "line_items.quantity", "line_items.tax_amount", "line_items.tax_rate", "line_items.total_amount", "line_items.unit_amount", "line_items.options.id", "line_items.options.quantity", "line_items.options.total_amount", "line_items.options.unit_amount", "market.id", "market.number", "order.adjustment_amount", "order.adjustment_tax_amount", "order.adjustment_taxable_amount", "order.discount_amount", "order.duty_amount", "order.gift_card_code", "order.gift_card_amount", "order.id", "order.line_item_options_count", "order.number", "order.payment_method_amount", "order.payment_method_tax_amount", "order.payment_method_taxable_amount", "order.reference", "order.reference_origin", "order.shipments_count", "order.shipping_amount", "order.shipping_taxable_amount", "order.skus_count", "order.subtotal_amount", "order.subtotal_tax_amount", "order.subtotal_taxable_amount", "order.total_amount", "order.total_amount_with_taxes", "order.total_tax_amount", "order.total_taxable_amount", "order.seconds_in_draft", "order.seconds_in_approved", "order.seconds_in_placed", "order.refunds_total_amount_with_taxes", "order.total_amount_with_taxes_net_of_refunds", "refunds.id", "refunds.amount", "refunds.number", "shipments.id", "shipments.number", "shipments.items_count", "shipments.cost_amount", "shipments.reference", "shipments.reference_origin", "shipments.seconds_in_picking", "shipments.seconds_in_ready_to_ship", "shipments.seconds_in_shipped", "shipments.fulfillment_time", "shipments.stock_location.id", "shipments.stock_location.reference", "shipments.stock_location.reference_origin", "shipments.shipping_method.id", "shipments.shipping_method.reference", "shipments.shipping_method.reference_origin", "shipments.shipping_category.id", "shipments.shipping_category.reference", "shipments.shipping_category.reference_origin", "resource_errors.code", "resource_errors.id", "resource_errors.message" ] }, "operator": { "type": "string", "description": "Operator to apply", "enum": [ "cardinality", "value_count", "avg", "max", "min", "sum", "stats", "percentiles" ] }, "sort": { "type": "string", "description": "Result sorting", "enum": [ "asc", "desc" ] }, "limit": { "type": "integer", "description": "Results limit", "default": 10, "maximum": 100 }, "condition": { "description": "Condition to filter the data over the breakdown result, value of the operator must be a Number or Array of numbers if operator is a range", "oneOf": [ { "type": "object", "properties": { "eq": { "type": "number" } } }, { "type": "object", "properties": { "ne": { "type": "number" } } }, { "type": "object", "properties": { "gt": { "type": "number" } } }, { "type": "object", "properties": { "gte": { "type": "number" } } }, { "type": "object", "properties": { "lt": { "type": "number" } } }, { "type": "object", "properties": { "lte": { "type": "number" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "number" } } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "number" } } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "number" } } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "number" } } } } ], "additionalProperties": false } }, "required": [ "by", "field", "operator" ] } } } } }, "meta": { "type": "object", "properties": { "payload": { "type": "boolean", "description": "Set to true if you want to receive how the payload has been made" } } } } }, "orders_stats_request": { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/orders_filter" }, "stats": { "type": "object", "description": "Check available [fields](#/components/schemas/orders_stats_request/properties/stats/properties/field/description)", "required": [ "field" ], "properties": { "field": { "type": "string", "description": "These are the valid values you can specify for the field key of the stats query and the related valid operators, based on that key:\n\n\n \n| Value | Operators |\n| --- | --------- |\n|**`customer.id`** |

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`cardinality`

`value_count`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`cardinality`

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

`cardinality`

`value_count`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`value_count`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`cardinality`

`value_count`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`value_count`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`stats`

`percentiles`

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

`avg`

`max`

`min`

`stats`

`percentiles`

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

`avg`

`max`

`min`

`stats`

`percentiles`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`value_count`

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

`avg`

`max`

`min`

`sum`

`stats`

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

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`avg`

`max`

`min`

`stats`

`percentiles`

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

`avg`

`max`

`min`

`stats`

`percentiles`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`avg`

`max`

`min`

`stats`

`percentiles`

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

`avg`

`max`

`min`

`stats`

`percentiles`

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

`avg`

`max`

`min`

`stats`

`percentiles`

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

`avg`

`max`

`min`

`stats`

`percentiles`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

|\n", "enum": [ "customer.id", "customer.email", "customer.group_name", "customer.reference", "customer.reference_origin", "line_items.code", "line_items.discount", "line_items.id", "line_items.item_id", "line_items.options_amount", "line_items.quantity", "line_items.tax_amount", "line_items.tax_rate", "line_items.total_amount", "line_items.unit_amount", "line_items.options.id", "line_items.options.quantity", "line_items.options.total_amount", "line_items.options.unit_amount", "market.id", "market.number", "order.adjustment_amount", "order.adjustment_tax_amount", "order.adjustment_taxable_amount", "order.discount_amount", "order.duty_amount", "order.gift_card_code", "order.gift_card_amount", "order.id", "order.line_item_options_count", "order.number", "order.payment_method_amount", "order.payment_method_tax_amount", "order.payment_method_taxable_amount", "order.reference", "order.reference_origin", "order.shipments_count", "order.shipping_amount", "order.shipping_taxable_amount", "order.skus_count", "order.subtotal_amount", "order.subtotal_tax_amount", "order.subtotal_taxable_amount", "order.total_amount", "order.total_amount_with_taxes", "order.total_tax_amount", "order.total_taxable_amount", "order.seconds_in_draft", "order.seconds_in_approved", "order.seconds_in_placed", "order.refunds_total_amount_with_taxes", "order.total_amount_with_taxes_net_of_refunds", "refunds.id", "refunds.amount", "refunds.number", "shipments.id", "shipments.number", "shipments.items_count", "shipments.cost_amount", "shipments.reference", "shipments.reference_origin", "shipments.seconds_in_picking", "shipments.seconds_in_ready_to_ship", "shipments.seconds_in_shipped", "shipments.fulfillment_time", "shipments.stock_location.id", "shipments.stock_location.reference", "shipments.stock_location.reference_origin", "shipments.shipping_method.id", "shipments.shipping_method.reference", "shipments.shipping_method.reference_origin", "shipments.shipping_category.id", "shipments.shipping_category.reference", "shipments.shipping_category.reference_origin", "resource_errors.code", "resource_errors.id", "resource_errors.message" ] }, "operator": { "type": "string", "description": "Operator to apply", "enum": [ "cardinality", "value_count", "avg", "max", "min", "sum", "stats", "percentiles" ] } } }, "meta": { "type": "object", "properties": { "payload": { "type": "boolean", "description": "Set to true if you want to receive how the payload has been made" } } } } }, "orders_search_request": { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/orders_filter" }, "search": { "type": "object", "required": [ "fields" ], "properties": { "sort": { "type": "string", "description": "Result sorting", "enum": [ "asc", "desc" ] }, "limit": { "type": "integer", "description": "Results limit", "default": 50, "maximum": 100 }, "sort_by": { "$ref": "#/components/schemas/orders_search_fields" }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/orders_search_fields" } } } }, "meta": { "type": "object", "properties": { "payload": { "type": "boolean", "description": "Set to true if you want to receive how the payload has been made" } } } } }, "orders_export_request": { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/orders_filter" }, "search": { "type": "object", "required": [ "fields" ], "properties": { "sort": { "type": "string", "description": "Result sorting", "enum": [ "asc", "desc" ], "default": "desc" }, "sort_by": { "$ref": "#/components/schemas/orders_export_fields" }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/orders_export_fields" }, "description": "Fields to export (order/return and single-level references only, no line_items). tags.name and tags.id return joined values." } } }, "meta": { "type": "object", "properties": { "payload": { "type": "boolean", "description": "Set to true if you want to receive how the payload has been made" } } } } }, "returns_filter": { "type": "object", "properties": { "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" } } } ] } } }, "destination_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" } } } ] } } }, "origin_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" } } } ] } } }, "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" } } } ] } } }, "return": { "type": "object", "properties": { "date_from": { "type": "string", "description": "The lower limit of the date and time range used to filter the collected returns (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 returns (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. `requested_at`, `rejected_at`, etc.) where to apply the date and time range filter.", "enum": [ "current_date", "approved_at", "archived_at", "cancelled_at", "created_at", "received_at", "rejected_at", "shipped_at", "updated_at", "restocked_at" ], "default": "current_date" }, "aggregated_details": { "description": "Searchable field containing all returns data.", "type": "object", "properties": { "query": { "type": "string", "description": "Returns documents based on a provided query string aggregated_details" } } }, "approved_at": { "description": "The date and time at which the return was approved (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard).", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to approved_at", "type": "string" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal approved_at", "type": "string" } } }, { "type": "object", "properties": { "gt": { "type": "string", "description": "Greater than approved_at" } } }, { "type": "object", "properties": { "gte": { "type": "string", "description": "Greater than equal approved_at" } } }, { "type": "object", "properties": { "lt": { "type": "string", "description": "Less than approved_at" } } }, { "type": "object", "properties": { "lte": { "type": "string", "description": "Less than equal approved_at" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than approved_at" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal approved_at" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than approved_at" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal approved_at" } } } ] }, "archived_at": { "description": "The date and time at which the return was archived (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard).", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to archived_at", "type": "string" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal archived_at", "type": "string" } } }, { "type": "object", "properties": { "gt": { "type": "string", "description": "Greater than archived_at" } } }, { "type": "object", "properties": { "gte": { "type": "string", "description": "Greater than equal archived_at" } } }, { "type": "object", "properties": { "lt": { "type": "string", "description": "Less than archived_at" } } }, { "type": "object", "properties": { "lte": { "type": "string", "description": "Less than equal archived_at" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than archived_at" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal archived_at" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than archived_at" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal archived_at" } } } ] }, "archived": { "type": "boolean", "description": "Indicates if the return has been archived." }, "cancelled_at": { "description": "The date and time at which the return was cancelled (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard).", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to cancelled_at", "type": "string" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal cancelled_at", "type": "string" } } }, { "type": "object", "properties": { "gt": { "type": "string", "description": "Greater than cancelled_at" } } }, { "type": "object", "properties": { "gte": { "type": "string", "description": "Greater than equal cancelled_at" } } }, { "type": "object", "properties": { "lt": { "type": "string", "description": "Less than cancelled_at" } } }, { "type": "object", "properties": { "lte": { "type": "string", "description": "Less than equal cancelled_at" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than cancelled_at" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal cancelled_at" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than cancelled_at" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal cancelled_at" } } } ] }, "created_at": { "description": "The date and time at which the return 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" } } } ] }, "numbers": { "description": "The numeric unique identifier for the return.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of numbers" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of numbers" } } } ] }, "received_at": { "description": "The date and time at which the return was received (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 received_at", "type": "string" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal received_at", "type": "string" } } }, { "type": "object", "properties": { "gt": { "type": "string", "description": "Greater than received_at" } } }, { "type": "object", "properties": { "gte": { "type": "string", "description": "Greater than equal received_at" } } }, { "type": "object", "properties": { "lt": { "type": "string", "description": "Less than received_at" } } }, { "type": "object", "properties": { "lte": { "type": "string", "description": "Less than equal received_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 received_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 received_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 received_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 received_at" } } } ] }, "references": { "description": "Any external identifier that might be useful to link the return 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" } } } ] }, "rejected_at": { "description": "The date and time at which the return was rejected (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 rejected_at", "type": "string" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal rejected_at", "type": "string" } } }, { "type": "object", "properties": { "gt": { "type": "string", "description": "Greater than rejected_at" } } }, { "type": "object", "properties": { "gte": { "type": "string", "description": "Greater than equal rejected_at" } } }, { "type": "object", "properties": { "lt": { "type": "string", "description": "Less than rejected_at" } } }, { "type": "object", "properties": { "lte": { "type": "string", "description": "Less than equal rejected_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 rejected_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 rejected_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 rejected_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 rejected_at" } } } ] }, "shipped_at": { "description": "The date and time at which the return was shipped (complete date plus hours, minutes and seconds — according to the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) standard).", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to shipped_at", "type": "string" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal shipped_at", "type": "string" } } }, { "type": "object", "properties": { "gt": { "type": "string", "description": "Greater than shipped_at" } } }, { "type": "object", "properties": { "gte": { "type": "string", "description": "Greater than equal shipped_at" } } }, { "type": "object", "properties": { "lt": { "type": "string", "description": "Less than shipped_at" } } }, { "type": "object", "properties": { "lte": { "type": "string", "description": "Less than equal shipped_at" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than shipped_at" } } }, { "type": "object", "properties": { "gte_lte": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than equal shipped_at" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than shipped_at" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "string", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal shipped_at" } } } ] }, "statuses": { "description": "The return status. One of `draft`, `requested`, `approved`, `cancelled`, `shipped`, `rejected` or `received`.", "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" } } } ] }, "mode": { "type": "string", "description": "The return's environment (can be one of `test` or `live`).", "enum": [ "live", "test" ] }, "updated_at": { "description": "The date and time at which the return 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 return's latest status change, regardless of the return'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" } } } ] }, "ids": { "description": "The ID of the return.", "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" } } } ] }, "order_ids": { "description": "The ID of the order associated with the return.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of order_ids" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of order_ids" } } } ] }, "skus_count": { "description": "The total number of SKUs in the return'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" } } } ] }, "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 associated 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" } } } ] } } }, "return_line_items": { "type": "object", "properties": { "created_at": { "description": "The date and time at which the return line item 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" } } } ] }, "quantity": { "description": "The return line item 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" } } } ] }, "restocked_at": { "description": "The date and time at which the return line item was restocked (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 restocked_at", "type": "string" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal restocked_at", "type": "string" } } }, { "type": "object", "properties": { "gt": { "type": "string", "description": "Greater than restocked_at" } } }, { "type": "object", "properties": { "gte": { "type": "string", "description": "Greater than equal restocked_at" } } }, { "type": "object", "properties": { "lt": { "type": "string", "description": "Less than restocked_at" } } }, { "type": "object", "properties": { "lte": { "type": "string", "description": "Less than equal restocked_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 restocked_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 restocked_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 restocked_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 restocked_at" } } } ] }, "updated_at": { "description": "The date and time at which the return 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_item_ids": { "description": "The ID of the return line item.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of line_item_ids" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of line_item_ids" } } } ] }, "line_item_names": { "description": "The name of the associated SKU or bundle.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of line_item_names" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of line_item_names" } } } ] }, "line_item_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 line_item_codes" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of line_item_codes" } } } ] }, "line_item_item_types": { "description": "The type of the associated item. One of `sku`, or `bundle`.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of line_item_item_types" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of line_item_item_types" } } } ] }, "line_item_total_amount": { "description": "The total amount of the return line item (float).", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to line_item_total_amount", "type": "number" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal line_item_total_amount", "type": "number" } } }, { "type": "object", "properties": { "gt": { "type": "number", "description": "Greater than line_item_total_amount" } } }, { "type": "object", "properties": { "gte": { "type": "number", "description": "Greater than equal line_item_total_amount" } } }, { "type": "object", "properties": { "lt": { "type": "number", "description": "Less than line_item_total_amount" } } }, { "type": "object", "properties": { "lte": { "type": "number", "description": "Less than equal line_item_total_amount" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than line_item_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 line_item_total_amount" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than line_item_total_amount" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal line_item_total_amount" } } } ] }, "line_item_tax_amount": { "description": "The collected tax amount for the return line item (float).", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to line_item_tax_amount", "type": "number" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal line_item_tax_amount", "type": "number" } } }, { "type": "object", "properties": { "gt": { "type": "number", "description": "Greater than line_item_tax_amount" } } }, { "type": "object", "properties": { "gte": { "type": "number", "description": "Greater than equal line_item_tax_amount" } } }, { "type": "object", "properties": { "lt": { "type": "number", "description": "Less than line_item_tax_amount" } } }, { "type": "object", "properties": { "lte": { "type": "number", "description": "Less than equal line_item_tax_amount" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than line_item_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 line_item_tax_amount" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than line_item_tax_amount" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal line_item_tax_amount" } } } ] }, "line_item_tax_rate": { "description": "The tax rate for the return line item (if calculated).", "oneOf": [ { "type": "object", "properties": { "eq": { "description": "Equals to line_item_tax_rate", "type": "number" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal line_item_tax_rate", "type": "number" } } }, { "type": "object", "properties": { "gt": { "type": "number", "description": "Greater than line_item_tax_rate" } } }, { "type": "object", "properties": { "gte": { "type": "number", "description": "Greater than equal line_item_tax_rate" } } }, { "type": "object", "properties": { "lt": { "type": "number", "description": "Less than line_item_tax_rate" } } }, { "type": "object", "properties": { "lte": { "type": "number", "description": "Less than equal line_item_tax_rate" } } }, { "type": "object", "properties": { "gt_lt": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than line_item_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 line_item_tax_rate" } } }, { "type": "object", "properties": { "gte_lt": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than equal, less than line_item_tax_rate" } } }, { "type": "object", "properties": { "gt_lte": { "type": "array", "items": { "type": "number", "example": 121 }, "minItems": 2, "maxItems": 2, "description": "Greater than, less than equal line_item_tax_rate" } } } ] }, "line_item_updated_at": { "description": "The date and time at which the return 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 line_item_updated_at", "type": "string" } } }, { "type": "object", "properties": { "ne": { "description": "Not equal line_item_updated_at", "type": "string" } } }, { "type": "object", "properties": { "gt": { "type": "string", "description": "Greater than line_item_updated_at" } } }, { "type": "object", "properties": { "gte": { "type": "string", "description": "Greater than equal line_item_updated_at" } } }, { "type": "object", "properties": { "lt": { "type": "string", "description": "Less than line_item_updated_at" } } }, { "type": "object", "properties": { "lte": { "type": "string", "description": "Less than equal line_item_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 line_item_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 line_item_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 line_item_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 line_item_updated_at" } } } ] } } }, "stock_location": { "type": "object", "properties": { "ids": { "description": "The ID of the stock location.", "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 stock location.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of names" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of names" } } } ] }, "references": { "description": "Any external identifier that might be useful to link the stock location 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" } } } ] } } }, "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" } } } ] } } } } }, "returns_search_fields": { "type": "string", "enum": [ "customer.id", "customer.email", "customer.group_name", "destination_address.business", "destination_address.city", "destination_address.country_code", "destination_address.geocoded", "destination_address.localized", "destination_address.state_code", "destination_address.zip_code", "origin_address.business", "origin_address.city", "origin_address.country_code", "origin_address.geocoded", "origin_address.localized", "origin_address.state_code", "origin_address.zip_code", "market.id", "market.name", "market.number", "organization.id", "organization.name", "organization.slug", "return.aggregated_details", "return.approved_at", "return.archived_at", "return.archived", "return.cancelled_at", "return.created_at", "return.number", "return.received_at", "return.reference", "return.reference_origin", "return.rejected_at", "return.shipped_at", "return.status", "return.mode", "return.updated_at", "return.current_date", "return.id", "return.order_id", "return.skus_count", "return.currency_code", "return_line_items.created_at", "return_line_items.quantity", "return_line_items.restocked_at", "return_line_items.updated_at", "return_line_items.line_item_id", "return_line_items.line_item_name", "return_line_items.line_item_code", "return_line_items.line_item_item_type", "return_line_items.line_item_total_amount", "return_line_items.line_item_tax_amount", "return_line_items.line_item_tax_rate", "return_line_items.line_item_updated_at", "stock_location.id", "stock_location.name", "stock_location.reference", "stock_location.reference_origin", "tags.id", "tags.name" ] }, "returns_export_fields": { "type": "string", "enum": [ "customer.id", "customer.email", "customer.group_name", "destination_address.business", "destination_address.city", "destination_address.country_code", "destination_address.geocoded", "destination_address.localized", "destination_address.state_code", "destination_address.zip_code", "origin_address.business", "origin_address.city", "origin_address.country_code", "origin_address.geocoded", "origin_address.localized", "origin_address.state_code", "origin_address.zip_code", "market.id", "market.name", "market.number", "organization.id", "organization.name", "organization.slug", "return.aggregated_details", "return.approved_at", "return.archived_at", "return.archived", "return.cancelled_at", "return.created_at", "return.number", "return.received_at", "return.reference", "return.reference_origin", "return.rejected_at", "return.shipped_at", "return.status", "return.mode", "return.updated_at", "return.current_date", "return.id", "return.order_id", "return.skus_count", "return.currency_code", "stock_location.id", "stock_location.name", "stock_location.reference", "stock_location.reference_origin", "tags.id", "tags.name" ] }, "returns_breakdown_request": { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/returns_filter" }, "breakdown": { "type": "object", "description": "Check available [fields](#/components/schemas/returns_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|**`customer.email`** | |\n|**`customer.group_name`** | |\n|**`destination_address.business`** |

`destination_address.geocoded`

`destination_address.localized`

`customer.*`

`origin_address.*`

|\n|**`destination_address.city`** |

`destination_address.country_code`

`destination_address.state_code`

`customer.*`

`origin_address.*`

|\n|**`destination_address.country_code`** |

`customer.*`

`origin_address.*`

|\n|**`destination_address.geocoded`** |

`destination_address.*`

`customer.*`

`origin_address.*`

|\n|**`destination_address.localized`** |

`destination_address.*`

`customer.*`

`origin_address.*`

|\n|**`destination_address.state_code`** |

`destination_address.country_code`

`customer.*`

`origin_address.*`

|\n|**`destination_address.zip_code`** |

`destination_address.country_code`

`destination_address.city`

`destination_address.geocoded`

`destination_address.localized`

`customer.*`

`origin_address.*`

|\n|**`origin_address.business`** |

`origin_address.geocoded`

`origin_address.localized`

`customer.*`

`destination_address.*`

|\n|**`origin_address.city`** |

`origin_address.country_code`

`origin_address.state_code`

`customer.*`

`destination_address.*`

|\n|**`origin_address.country_code`** |

`customer.*`

`destrintation_address.*`

|\n|**`origin_address.geocoded`** |

`destination_address.*`

`customer.*`

`origin_address.*`

|\n|**`origin_address.localized`** |

`destination_address.*`

`customer.*`

`origin_address.*`

|\n|**`origin_address.state_code`** |

`origin_address.country_code`

`customer.*`

`destination_address.*`

|\n|**`origin_address.zip_code`** |

`origin_address.country_code`

`origin_address.city`

`origin_address.geocoded`

`origin_address.localized`

`customer.*`

`destination_address.*`

|\n|**`market.id`** | |\n|**`market.name`** | |\n|**`market.number`** | |\n|**`return.reference`** | |\n|**`return.reference_origin`** | |\n|**`return.status`** | |\n|**`return.currency_code`** | |\n|**`return_line_items.line_item_name`** | |\n|**`return_line_items.line_item_code`** | |\n|**`return_line_items.line_item_item_type`** | |\n|**`stock_location.name`** | |\n|**`stock_location.reference`** | |\n|**`stock_location.reference_origin`** | |\n|**`tags.id`** | |\n|**`tags.name`** | |\n", "enum": [ "customer.email", "customer.group_name", "destination_address.business", "destination_address.city", "destination_address.country_code", "destination_address.geocoded", "destination_address.localized", "destination_address.state_code", "destination_address.zip_code", "origin_address.business", "origin_address.city", "origin_address.country_code", "origin_address.geocoded", "origin_address.localized", "origin_address.state_code", "origin_address.zip_code", "market.id", "market.name", "market.number", "organization.id", "organization.name", "organization.slug", "return.reference", "return.reference_origin", "return.status", "return.mode", "return.currency_code", "return_line_items.line_item_name", "return_line_items.line_item_code", "return_line_items.line_item_item_type", "stock_location.name", "stock_location.reference", "stock_location.reference_origin", "tags.id", "tags.name" ] }, "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`** |

`value_count`

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

`value_count`

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

`value_count`

|\n|**`destination_address.business`** |

`value_count`

|\n|**`destination_address.city`** |

`value_count`

|\n|**`destination_address.country_code`** |

`value_count`

|\n|**`destination_address.geocoded`** |

`value_count`

|\n|**`destination_address.localized`** |

`value_count`

|\n|**`destination_address.state_code`** |

`value_count`

|\n|**`destination_address.zip_code`** |

`value_count`

|\n|**`origin_address.business`** |

`value_count`

|\n|**`origin_address.city`** |

`value_count`

|\n|**`origin_address.country_code`** |

`value_count`

|\n|**`origin_address.geocoded`** |

`value_count`

|\n|**`origin_address.localized`** |

`value_count`

|\n|**`origin_address.state_code`** |

`value_count`

|\n|**`origin_address.zip_code`** |

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

|\n|**`return.number`** |

`value_count`

|\n|**`return.reference`** |

`value_count`

|\n|**`return.reference_origin`** |

`value_count`

|\n|**`return.status`** |

`value_count`

|\n|**`return.id`** |

`cardinality`

`value_count`

|\n|**`return.order_id`** |

`value_count`

|\n|**`return.skus_count`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`return_line_items.quantity`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`return_line_items.line_item_id`** |

`value_count`

|\n|**`return_line_items.line_item_name`** |

`value_count`

|\n|**`return_line_items.line_item_code`** |

`value_count`

|\n|**`return_line_items.line_item_item_type`** |

`value_count`

|\n|**`return_line_items.line_item_total_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`return_line_items.line_item_tax_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`return_line_items.line_item_tax_rate`** |

`avg`

`max`

`min`

`sum`

`stats`

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

`value_count`

|\n|**`stock_location.name`** |

`value_count`

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

`value_count`

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

`value_count`

|\n", "enum": [ "customer.id", "customer.email", "customer.group_name", "destination_address.business", "destination_address.city", "destination_address.country_code", "destination_address.geocoded", "destination_address.localized", "destination_address.state_code", "destination_address.zip_code", "origin_address.business", "origin_address.city", "origin_address.country_code", "origin_address.geocoded", "origin_address.localized", "origin_address.state_code", "origin_address.zip_code", "market.id", "market.number", "return.number", "return.reference", "return.reference_origin", "return.status", "return.mode", "return.id", "return.order_id", "return.skus_count", "return_line_items.quantity", "return_line_items.line_item_id", "return_line_items.line_item_name", "return_line_items.line_item_code", "return_line_items.line_item_item_type", "return_line_items.line_item_total_amount", "return_line_items.line_item_tax_amount", "return_line_items.line_item_tax_rate", "stock_location.id", "stock_location.name", "stock_location.reference", "stock_location.reference_origin" ] }, "operator": { "type": "string", "description": "Operator to apply", "enum": [ "value_count", "cardinality", "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|**`customer.email`** | |\n|**`customer.group_name`** | |\n|**`destination_address.business`** |

`destination_address.geocoded`

`destination_address.localized`

`customer.*`

`origin_address.*`

|\n|**`destination_address.city`** |

`destination_address.country_code`

`destination_address.state_code`

`customer.*`

`origin_address.*`

|\n|**`destination_address.country_code`** |

`customer.*`

`origin_address.*`

|\n|**`destination_address.geocoded`** |

`destination_address.*`

`customer.*`

`origin_address.*`

|\n|**`destination_address.localized`** |

`destination_address.*`

`customer.*`

`origin_address.*`

|\n|**`destination_address.state_code`** |

`destination_address.country_code`

`customer.*`

`origin_address.*`

|\n|**`destination_address.zip_code`** |

`destination_address.country_code`

`destination_address.city`

`destination_address.geocoded`

`destination_address.localized`

`customer.*`

`origin_address.*`

|\n|**`origin_address.business`** |

`origin_address.geocoded`

`origin_address.localized`

`customer.*`

`destination_address.*`

|\n|**`origin_address.city`** |

`origin_address.country_code`

`origin_address.state_code`

`customer.*`

`destination_address.*`

|\n|**`origin_address.country_code`** |

`customer.*`

`destrintation_address.*`

|\n|**`origin_address.geocoded`** |

`destination_address.*`

`customer.*`

`origin_address.*`

|\n|**`origin_address.localized`** |

`destination_address.*`

`customer.*`

`origin_address.*`

|\n|**`origin_address.state_code`** |

`origin_address.country_code`

`customer.*`

`destination_address.*`

|\n|**`origin_address.zip_code`** |

`origin_address.country_code`

`origin_address.city`

`origin_address.geocoded`

`origin_address.localized`

`customer.*`

`destination_address.*`

|\n|**`market.id`** | |\n|**`market.name`** | |\n|**`market.number`** | |\n|**`return.reference`** | |\n|**`return.reference_origin`** | |\n|**`return.status`** | |\n|**`return.currency_code`** | |\n|**`return_line_items.line_item_name`** | |\n|**`return_line_items.line_item_code`** | |\n|**`return_line_items.line_item_item_type`** | |\n|**`stock_location.name`** | |\n|**`stock_location.reference`** | |\n|**`stock_location.reference_origin`** | |\n|**`tags.id`** | |\n|**`tags.name`** | |\n", "enum": [ "customer.email", "customer.group_name", "destination_address.business", "destination_address.city", "destination_address.country_code", "destination_address.geocoded", "destination_address.localized", "destination_address.state_code", "destination_address.zip_code", "origin_address.business", "origin_address.city", "origin_address.country_code", "origin_address.geocoded", "origin_address.localized", "origin_address.state_code", "origin_address.zip_code", "market.id", "market.name", "market.number", "organization.id", "organization.name", "organization.slug", "return.reference", "return.reference_origin", "return.status", "return.mode", "return.currency_code", "return_line_items.line_item_name", "return_line_items.line_item_code", "return_line_items.line_item_item_type", "stock_location.name", "stock_location.reference", "stock_location.reference_origin", "tags.id", "tags.name" ] }, "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`** |

`value_count`

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

`value_count`

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

`value_count`

|\n|**`destination_address.business`** |

`value_count`

|\n|**`destination_address.city`** |

`value_count`

|\n|**`destination_address.country_code`** |

`value_count`

|\n|**`destination_address.geocoded`** |

`value_count`

|\n|**`destination_address.localized`** |

`value_count`

|\n|**`destination_address.state_code`** |

`value_count`

|\n|**`destination_address.zip_code`** |

`value_count`

|\n|**`origin_address.business`** |

`value_count`

|\n|**`origin_address.city`** |

`value_count`

|\n|**`origin_address.country_code`** |

`value_count`

|\n|**`origin_address.geocoded`** |

`value_count`

|\n|**`origin_address.localized`** |

`value_count`

|\n|**`origin_address.state_code`** |

`value_count`

|\n|**`origin_address.zip_code`** |

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

|\n|**`return.number`** |

`value_count`

|\n|**`return.reference`** |

`value_count`

|\n|**`return.reference_origin`** |

`value_count`

|\n|**`return.status`** |

`value_count`

|\n|**`return.id`** |

`cardinality`

`value_count`

|\n|**`return.order_id`** |

`value_count`

|\n|**`return.skus_count`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`return_line_items.quantity`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`return_line_items.line_item_id`** |

`value_count`

|\n|**`return_line_items.line_item_name`** |

`value_count`

|\n|**`return_line_items.line_item_code`** |

`value_count`

|\n|**`return_line_items.line_item_item_type`** |

`value_count`

|\n|**`return_line_items.line_item_total_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`return_line_items.line_item_tax_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`return_line_items.line_item_tax_rate`** |

`avg`

`max`

`min`

`sum`

`stats`

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

`value_count`

|\n|**`stock_location.name`** |

`value_count`

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

`value_count`

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

`value_count`

|\n", "enum": [ "customer.id", "customer.email", "customer.group_name", "destination_address.business", "destination_address.city", "destination_address.country_code", "destination_address.geocoded", "destination_address.localized", "destination_address.state_code", "destination_address.zip_code", "origin_address.business", "origin_address.city", "origin_address.country_code", "origin_address.geocoded", "origin_address.localized", "origin_address.state_code", "origin_address.zip_code", "market.id", "market.number", "return.number", "return.reference", "return.reference_origin", "return.status", "return.mode", "return.id", "return.order_id", "return.skus_count", "return_line_items.quantity", "return_line_items.line_item_id", "return_line_items.line_item_name", "return_line_items.line_item_code", "return_line_items.line_item_item_type", "return_line_items.line_item_total_amount", "return_line_items.line_item_tax_amount", "return_line_items.line_item_tax_rate", "stock_location.id", "stock_location.name", "stock_location.reference", "stock_location.reference_origin" ] }, "operator": { "type": "string", "description": "Operator to apply", "enum": [ "value_count", "cardinality", "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" } } } } }, "returns_date_breakdown_request": { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/returns_filter" }, "date_breakdown": { "type": "object", "description": "Check available [fields](#/components/schemas/returns_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": [ "return.approved_at", "return.archived_at", "return.cancelled_at", "return.created_at", "return.received_at", "return.rejected_at", "return.shipped_at", "return.updated_at", "return.current_date" ] }, "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`** |

`value_count`

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

`value_count`

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

`value_count`

|\n|**`destination_address.business`** |

`value_count`

|\n|**`destination_address.city`** |

`value_count`

|\n|**`destination_address.country_code`** |

`value_count`

|\n|**`destination_address.geocoded`** |

`value_count`

|\n|**`destination_address.localized`** |

`value_count`

|\n|**`destination_address.state_code`** |

`value_count`

|\n|**`destination_address.zip_code`** |

`value_count`

|\n|**`origin_address.business`** |

`value_count`

|\n|**`origin_address.city`** |

`value_count`

|\n|**`origin_address.country_code`** |

`value_count`

|\n|**`origin_address.geocoded`** |

`value_count`

|\n|**`origin_address.localized`** |

`value_count`

|\n|**`origin_address.state_code`** |

`value_count`

|\n|**`origin_address.zip_code`** |

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

|\n|**`return.number`** |

`value_count`

|\n|**`return.reference`** |

`value_count`

|\n|**`return.reference_origin`** |

`value_count`

|\n|**`return.status`** |

`value_count`

|\n|**`return.id`** |

`cardinality`

`value_count`

|\n|**`return.order_id`** |

`value_count`

|\n|**`return.skus_count`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`return_line_items.quantity`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`return_line_items.line_item_id`** |

`value_count`

|\n|**`return_line_items.line_item_name`** |

`value_count`

|\n|**`return_line_items.line_item_code`** |

`value_count`

|\n|**`return_line_items.line_item_item_type`** |

`value_count`

|\n|**`return_line_items.line_item_total_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`return_line_items.line_item_tax_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`return_line_items.line_item_tax_rate`** |

`avg`

`max`

`min`

`sum`

`stats`

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

`value_count`

|\n|**`stock_location.name`** |

`value_count`

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

`value_count`

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

`value_count`

|\n", "enum": [ "customer.id", "customer.email", "customer.group_name", "destination_address.business", "destination_address.city", "destination_address.country_code", "destination_address.geocoded", "destination_address.localized", "destination_address.state_code", "destination_address.zip_code", "origin_address.business", "origin_address.city", "origin_address.country_code", "origin_address.geocoded", "origin_address.localized", "origin_address.state_code", "origin_address.zip_code", "market.id", "market.number", "return.number", "return.reference", "return.reference_origin", "return.status", "return.mode", "return.id", "return.order_id", "return.skus_count", "return_line_items.quantity", "return_line_items.line_item_id", "return_line_items.line_item_name", "return_line_items.line_item_code", "return_line_items.line_item_item_type", "return_line_items.line_item_total_amount", "return_line_items.line_item_tax_amount", "return_line_items.line_item_tax_rate", "stock_location.id", "stock_location.name", "stock_location.reference", "stock_location.reference_origin" ] }, "operator": { "type": "string", "description": "Operator to apply", "enum": [ "value_count", "cardinality", "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/returns_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|**`customer.email`** | |\n|**`customer.group_name`** | |\n|**`destination_address.business`** |

`destination_address.geocoded`

`destination_address.localized`

`customer.*`

`origin_address.*`

|\n|**`destination_address.city`** |

`destination_address.country_code`

`destination_address.state_code`

`customer.*`

`origin_address.*`

|\n|**`destination_address.country_code`** |

`customer.*`

`origin_address.*`

|\n|**`destination_address.geocoded`** |

`destination_address.*`

`customer.*`

`origin_address.*`

|\n|**`destination_address.localized`** |

`destination_address.*`

`customer.*`

`origin_address.*`

|\n|**`destination_address.state_code`** |

`destination_address.country_code`

`customer.*`

`origin_address.*`

|\n|**`destination_address.zip_code`** |

`destination_address.country_code`

`destination_address.city`

`destination_address.geocoded`

`destination_address.localized`

`customer.*`

`origin_address.*`

|\n|**`origin_address.business`** |

`origin_address.geocoded`

`origin_address.localized`

`customer.*`

`destination_address.*`

|\n|**`origin_address.city`** |

`origin_address.country_code`

`origin_address.state_code`

`customer.*`

`destination_address.*`

|\n|**`origin_address.country_code`** |

`customer.*`

`destrintation_address.*`

|\n|**`origin_address.geocoded`** |

`destination_address.*`

`customer.*`

`origin_address.*`

|\n|**`origin_address.localized`** |

`destination_address.*`

`customer.*`

`origin_address.*`

|\n|**`origin_address.state_code`** |

`origin_address.country_code`

`customer.*`

`destination_address.*`

|\n|**`origin_address.zip_code`** |

`origin_address.country_code`

`origin_address.city`

`origin_address.geocoded`

`origin_address.localized`

`customer.*`

`destination_address.*`

|\n|**`market.id`** | |\n|**`market.name`** | |\n|**`market.number`** | |\n|**`return.reference`** | |\n|**`return.reference_origin`** | |\n|**`return.status`** | |\n|**`return.currency_code`** | |\n|**`return_line_items.line_item_name`** | |\n|**`return_line_items.line_item_code`** | |\n|**`return_line_items.line_item_item_type`** | |\n|**`stock_location.name`** | |\n|**`stock_location.reference`** | |\n|**`stock_location.reference_origin`** | |\n|**`tags.id`** | |\n|**`tags.name`** | |\n", "enum": [ "customer.email", "customer.group_name", "destination_address.business", "destination_address.city", "destination_address.country_code", "destination_address.geocoded", "destination_address.localized", "destination_address.state_code", "destination_address.zip_code", "origin_address.business", "origin_address.city", "origin_address.country_code", "origin_address.geocoded", "origin_address.localized", "origin_address.state_code", "origin_address.zip_code", "market.id", "market.name", "market.number", "organization.id", "organization.name", "organization.slug", "return.reference", "return.reference_origin", "return.status", "return.mode", "return.currency_code", "return_line_items.line_item_name", "return_line_items.line_item_code", "return_line_items.line_item_item_type", "stock_location.name", "stock_location.reference", "stock_location.reference_origin", "tags.id", "tags.name" ] }, "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`** |

`value_count`

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

`value_count`

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

`value_count`

|\n|**`destination_address.business`** |

`value_count`

|\n|**`destination_address.city`** |

`value_count`

|\n|**`destination_address.country_code`** |

`value_count`

|\n|**`destination_address.geocoded`** |

`value_count`

|\n|**`destination_address.localized`** |

`value_count`

|\n|**`destination_address.state_code`** |

`value_count`

|\n|**`destination_address.zip_code`** |

`value_count`

|\n|**`origin_address.business`** |

`value_count`

|\n|**`origin_address.city`** |

`value_count`

|\n|**`origin_address.country_code`** |

`value_count`

|\n|**`origin_address.geocoded`** |

`value_count`

|\n|**`origin_address.localized`** |

`value_count`

|\n|**`origin_address.state_code`** |

`value_count`

|\n|**`origin_address.zip_code`** |

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

|\n|**`return.number`** |

`value_count`

|\n|**`return.reference`** |

`value_count`

|\n|**`return.reference_origin`** |

`value_count`

|\n|**`return.status`** |

`value_count`

|\n|**`return.id`** |

`cardinality`

`value_count`

|\n|**`return.order_id`** |

`value_count`

|\n|**`return.skus_count`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`return_line_items.quantity`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`return_line_items.line_item_id`** |

`value_count`

|\n|**`return_line_items.line_item_name`** |

`value_count`

|\n|**`return_line_items.line_item_code`** |

`value_count`

|\n|**`return_line_items.line_item_item_type`** |

`value_count`

|\n|**`return_line_items.line_item_total_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`return_line_items.line_item_tax_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`return_line_items.line_item_tax_rate`** |

`avg`

`max`

`min`

`sum`

`stats`

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

`value_count`

|\n|**`stock_location.name`** |

`value_count`

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

`value_count`

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

`value_count`

|\n", "enum": [ "customer.id", "customer.email", "customer.group_name", "destination_address.business", "destination_address.city", "destination_address.country_code", "destination_address.geocoded", "destination_address.localized", "destination_address.state_code", "destination_address.zip_code", "origin_address.business", "origin_address.city", "origin_address.country_code", "origin_address.geocoded", "origin_address.localized", "origin_address.state_code", "origin_address.zip_code", "market.id", "market.number", "return.number", "return.reference", "return.reference_origin", "return.status", "return.mode", "return.id", "return.order_id", "return.skus_count", "return_line_items.quantity", "return_line_items.line_item_id", "return_line_items.line_item_name", "return_line_items.line_item_code", "return_line_items.line_item_item_type", "return_line_items.line_item_total_amount", "return_line_items.line_item_tax_amount", "return_line_items.line_item_tax_rate", "stock_location.id", "stock_location.name", "stock_location.reference", "stock_location.reference_origin" ] }, "operator": { "type": "string", "description": "Operator to apply", "enum": [ "value_count", "cardinality", "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|**`customer.email`** | |\n|**`customer.group_name`** | |\n|**`destination_address.business`** |

`destination_address.geocoded`

`destination_address.localized`

`customer.*`

`origin_address.*`

|\n|**`destination_address.city`** |

`destination_address.country_code`

`destination_address.state_code`

`customer.*`

`origin_address.*`

|\n|**`destination_address.country_code`** |

`customer.*`

`origin_address.*`

|\n|**`destination_address.geocoded`** |

`destination_address.*`

`customer.*`

`origin_address.*`

|\n|**`destination_address.localized`** |

`destination_address.*`

`customer.*`

`origin_address.*`

|\n|**`destination_address.state_code`** |

`destination_address.country_code`

`customer.*`

`origin_address.*`

|\n|**`destination_address.zip_code`** |

`destination_address.country_code`

`destination_address.city`

`destination_address.geocoded`

`destination_address.localized`

`customer.*`

`origin_address.*`

|\n|**`origin_address.business`** |

`origin_address.geocoded`

`origin_address.localized`

`customer.*`

`destination_address.*`

|\n|**`origin_address.city`** |

`origin_address.country_code`

`origin_address.state_code`

`customer.*`

`destination_address.*`

|\n|**`origin_address.country_code`** |

`customer.*`

`destrintation_address.*`

|\n|**`origin_address.geocoded`** |

`destination_address.*`

`customer.*`

`origin_address.*`

|\n|**`origin_address.localized`** |

`destination_address.*`

`customer.*`

`origin_address.*`

|\n|**`origin_address.state_code`** |

`origin_address.country_code`

`customer.*`

`destination_address.*`

|\n|**`origin_address.zip_code`** |

`origin_address.country_code`

`origin_address.city`

`origin_address.geocoded`

`origin_address.localized`

`customer.*`

`destination_address.*`

|\n|**`market.id`** | |\n|**`market.name`** | |\n|**`market.number`** | |\n|**`return.reference`** | |\n|**`return.reference_origin`** | |\n|**`return.status`** | |\n|**`return.currency_code`** | |\n|**`return_line_items.line_item_name`** | |\n|**`return_line_items.line_item_code`** | |\n|**`return_line_items.line_item_item_type`** | |\n|**`stock_location.name`** | |\n|**`stock_location.reference`** | |\n|**`stock_location.reference_origin`** | |\n|**`tags.id`** | |\n|**`tags.name`** | |\n", "enum": [ "customer.email", "customer.group_name", "destination_address.business", "destination_address.city", "destination_address.country_code", "destination_address.geocoded", "destination_address.localized", "destination_address.state_code", "destination_address.zip_code", "origin_address.business", "origin_address.city", "origin_address.country_code", "origin_address.geocoded", "origin_address.localized", "origin_address.state_code", "origin_address.zip_code", "market.id", "market.name", "market.number", "organization.id", "organization.name", "organization.slug", "return.reference", "return.reference_origin", "return.status", "return.mode", "return.currency_code", "return_line_items.line_item_name", "return_line_items.line_item_code", "return_line_items.line_item_item_type", "stock_location.name", "stock_location.reference", "stock_location.reference_origin", "tags.id", "tags.name" ] }, "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`** |

`value_count`

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

`value_count`

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

`value_count`

|\n|**`destination_address.business`** |

`value_count`

|\n|**`destination_address.city`** |

`value_count`

|\n|**`destination_address.country_code`** |

`value_count`

|\n|**`destination_address.geocoded`** |

`value_count`

|\n|**`destination_address.localized`** |

`value_count`

|\n|**`destination_address.state_code`** |

`value_count`

|\n|**`destination_address.zip_code`** |

`value_count`

|\n|**`origin_address.business`** |

`value_count`

|\n|**`origin_address.city`** |

`value_count`

|\n|**`origin_address.country_code`** |

`value_count`

|\n|**`origin_address.geocoded`** |

`value_count`

|\n|**`origin_address.localized`** |

`value_count`

|\n|**`origin_address.state_code`** |

`value_count`

|\n|**`origin_address.zip_code`** |

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

|\n|**`return.number`** |

`value_count`

|\n|**`return.reference`** |

`value_count`

|\n|**`return.reference_origin`** |

`value_count`

|\n|**`return.status`** |

`value_count`

|\n|**`return.id`** |

`cardinality`

`value_count`

|\n|**`return.order_id`** |

`value_count`

|\n|**`return.skus_count`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`return_line_items.quantity`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`return_line_items.line_item_id`** |

`value_count`

|\n|**`return_line_items.line_item_name`** |

`value_count`

|\n|**`return_line_items.line_item_code`** |

`value_count`

|\n|**`return_line_items.line_item_item_type`** |

`value_count`

|\n|**`return_line_items.line_item_total_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`return_line_items.line_item_tax_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`return_line_items.line_item_tax_rate`** |

`avg`

`max`

`min`

`sum`

`stats`

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

`value_count`

|\n|**`stock_location.name`** |

`value_count`

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

`value_count`

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

`value_count`

|\n", "enum": [ "customer.id", "customer.email", "customer.group_name", "destination_address.business", "destination_address.city", "destination_address.country_code", "destination_address.geocoded", "destination_address.localized", "destination_address.state_code", "destination_address.zip_code", "origin_address.business", "origin_address.city", "origin_address.country_code", "origin_address.geocoded", "origin_address.localized", "origin_address.state_code", "origin_address.zip_code", "market.id", "market.number", "return.number", "return.reference", "return.reference_origin", "return.status", "return.mode", "return.id", "return.order_id", "return.skus_count", "return_line_items.quantity", "return_line_items.line_item_id", "return_line_items.line_item_name", "return_line_items.line_item_code", "return_line_items.line_item_item_type", "return_line_items.line_item_total_amount", "return_line_items.line_item_tax_amount", "return_line_items.line_item_tax_rate", "stock_location.id", "stock_location.name", "stock_location.reference", "stock_location.reference_origin" ] }, "operator": { "type": "string", "description": "Operator to apply", "enum": [ "value_count", "cardinality", "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" } } } } }, "returns_stats_request": { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/returns_filter" }, "stats": { "type": "object", "description": "Check available [fields](#/components/schemas/returns_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`** |

`value_count`

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

`value_count`

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

`value_count`

|\n|**`destination_address.business`** |

`value_count`

|\n|**`destination_address.city`** |

`value_count`

|\n|**`destination_address.country_code`** |

`value_count`

|\n|**`destination_address.geocoded`** |

`value_count`

|\n|**`destination_address.localized`** |

`value_count`

|\n|**`destination_address.state_code`** |

`value_count`

|\n|**`destination_address.zip_code`** |

`value_count`

|\n|**`origin_address.business`** |

`value_count`

|\n|**`origin_address.city`** |

`value_count`

|\n|**`origin_address.country_code`** |

`value_count`

|\n|**`origin_address.geocoded`** |

`value_count`

|\n|**`origin_address.localized`** |

`value_count`

|\n|**`origin_address.state_code`** |

`value_count`

|\n|**`origin_address.zip_code`** |

`value_count`

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

`cardinality`

`value_count`

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

`cardinality`

`value_count`

|\n|**`return.number`** |

`value_count`

|\n|**`return.reference`** |

`value_count`

|\n|**`return.reference_origin`** |

`value_count`

|\n|**`return.status`** |

`value_count`

|\n|**`return.id`** |

`cardinality`

`value_count`

|\n|**`return.order_id`** |

`value_count`

|\n|**`return.skus_count`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`return_line_items.quantity`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`return_line_items.line_item_id`** |

`value_count`

|\n|**`return_line_items.line_item_name`** |

`value_count`

|\n|**`return_line_items.line_item_code`** |

`value_count`

|\n|**`return_line_items.line_item_item_type`** |

`value_count`

|\n|**`return_line_items.line_item_total_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`return_line_items.line_item_tax_amount`** |

`avg`

`max`

`min`

`sum`

`stats`

|\n|**`return_line_items.line_item_tax_rate`** |

`avg`

`max`

`min`

`sum`

`stats`

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

`value_count`

|\n|**`stock_location.name`** |

`value_count`

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

`value_count`

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

`value_count`

|\n", "enum": [ "customer.id", "customer.email", "customer.group_name", "destination_address.business", "destination_address.city", "destination_address.country_code", "destination_address.geocoded", "destination_address.localized", "destination_address.state_code", "destination_address.zip_code", "origin_address.business", "origin_address.city", "origin_address.country_code", "origin_address.geocoded", "origin_address.localized", "origin_address.state_code", "origin_address.zip_code", "market.id", "market.number", "return.number", "return.reference", "return.reference_origin", "return.status", "return.mode", "return.id", "return.order_id", "return.skus_count", "return_line_items.quantity", "return_line_items.line_item_id", "return_line_items.line_item_name", "return_line_items.line_item_code", "return_line_items.line_item_item_type", "return_line_items.line_item_total_amount", "return_line_items.line_item_tax_amount", "return_line_items.line_item_tax_rate", "stock_location.id", "stock_location.name", "stock_location.reference", "stock_location.reference_origin" ] }, "operator": { "type": "string", "description": "Operator to apply", "enum": [ "value_count", "cardinality", "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" } } } } }, "returns_search_request": { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/returns_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/returns_search_fields" }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/returns_search_fields" } } } }, "meta": { "type": "object", "properties": { "payload": { "type": "boolean", "description": "Set to true if you want to receive how the payload has been made" } } } } }, "returns_export_request": { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/returns_filter" }, "search": { "type": "object", "required": [ "fields" ], "properties": { "sort": { "type": "string", "description": "Result sorting", "enum": [ "asc", "desc" ], "default": "desc" }, "sort_by": { "$ref": "#/components/schemas/returns_export_fields" }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/returns_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" } } } } }, "usage_date_breakdown_filter": { "type": "object", "properties": { "usage": { "type": "object", "properties": { "dimension": { "description": "The dimension name.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of dimension" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of dimension" } } } ] }, "date_from": { "type": "string", "description": "The lower limit of the date and time range used to filter the collected usage records (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 usage records (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" }, "mode": { "type": "string", "description": "Environment mode of the data.", "enum": [ "live", "test" ] }, "types": { "description": "Usage data type", "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" } } } ] }, "metadata": { "type": "object", "description": "Usage metadata object." }, "timestamp": { "type": "string", "description": "Timestamp of the record.", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "dimension_value_numeric": { "type": "number", "description": "Value of the dimension as a number.", "example": 121 } } }, "organization": { "type": "object", "properties": { "ids": { "description": "Organization identifier where the usage data belongs.", "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of ids" } } } } } } }, "usage_date_breakdown_request": { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/usage_date_breakdown_filter" }, "date_breakdown": { "type": "object", "required": [ "interval", "by_dimension" ], "properties": { "interval": { "type": "string", "description": "Interval to query", "enum": [ "day", "month", "year" ] }, "by_dimension": { "type": "boolean", "description": "Enables a nested breakdown by dimension" } } }, "meta": { "type": "object", "properties": { "payload": { "type": "boolean", "description": "Set to true if you want to receive how the payload has been made" } } } } }, "usage_search_filter": { "type": "object", "properties": { "usage": { "type": "object", "properties": { "dimension": { "description": "The dimension name.", "oneOf": [ { "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of dimension" } } }, { "type": "object", "properties": { "not_in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To exclude, array of dimension" } } } ] }, "date_from": { "type": "string", "description": "The lower limit of the date and time range used to filter the collected usage records (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 usage records (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" }, "mode": { "type": "string", "description": "Environment mode of the data.", "enum": [ "live", "test" ] }, "types": { "description": "Usage data type", "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" } } } ] }, "metadata": { "type": "object", "description": "Usage metadata object." }, "timestamp": { "type": "string", "description": "Timestamp of the record.", "format": "%Y-%m-%dT%H:%M:%SZ", "example": "2022-07-06T21:41:03Z" }, "dimension_value_numeric": { "type": "number", "description": "Value of the dimension as a number.", "example": 121 } } }, "organization": { "type": "object", "properties": { "ids": { "description": "Organization identifier where the usage data belongs.", "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of ids" } } } } } } }, "usage_search_request": { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/usage_search_filter" }, "search": { "type": "object", "required": [ "sort" ], "properties": { "sort": { "type": "string", "description": "Result sorting", "enum": [ "asc", "desc" ] }, "limit": { "type": "integer", "description": "Results limit" } } }, "meta": { "type": "object", "properties": { "payload": { "type": "boolean", "description": "Set to true if you want to receive how the payload has been made" } } } } }, "analysis_fbt_filter": { "type": "object", "properties": { "line_items": { "type": "object", "properties": { "item_ids": { "description": "The ID of the associated item.", "type": "object", "properties": { "in": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "To include, array of item_ids" } } } } } } }, "analysis_fbt_request": { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/analysis_fbt_filter" }, "fbt": { "type": "object", "properties": {} }, "meta": { "type": "object", "properties": { "payload": { "type": "boolean", "description": "Set to true if you want to receive how the payload has been made" } } } }, "required": [ "filter" ] } } }, "tags": [ { "name": "carts", "description": "Operations with carts resource" }, { "name": "orders", "description": "Operations with orders resource" }, { "name": "returns", "description": "Operations with returns resource" }, { "name": "usage", "description": "Operations with usage resource" }, { "name": "analysis", "description": "Operations with analysis resource" } ], "security": [ { "bearerAuth": [] } ] }