266 lines
7.0 KiB
YAML
266 lines
7.0 KiB
YAML
get:
|
|
operationId: GetOrders
|
|
summary: List Orders
|
|
description: Retrieves a list of Orders
|
|
x-authenticated: true
|
|
parameters:
|
|
- in: query
|
|
name: q
|
|
description: >-
|
|
Query used for searching orders by shipping address first name, orders'
|
|
email, and orders' display ID
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: id
|
|
description: ID of the order to search for.
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: status
|
|
style: form
|
|
explode: false
|
|
description: Status to search for
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
enum:
|
|
- pending
|
|
- completed
|
|
- archived
|
|
- canceled
|
|
- requires_action
|
|
- in: query
|
|
name: fulfillment_status
|
|
style: form
|
|
explode: false
|
|
description: Fulfillment status to search for.
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
enum:
|
|
- not_fulfilled
|
|
- fulfilled
|
|
- partially_fulfilled
|
|
- shipped
|
|
- partially_shipped
|
|
- canceled
|
|
- returned
|
|
- partially_returned
|
|
- requires_action
|
|
- in: query
|
|
name: payment_status
|
|
style: form
|
|
explode: false
|
|
description: Payment status to search for.
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
enum:
|
|
- captured
|
|
- awaiting
|
|
- not_paid
|
|
- refunded
|
|
- partially_refunded
|
|
- canceled
|
|
- requires_action
|
|
- in: query
|
|
name: display_id
|
|
description: Display ID to search for.
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: cart_id
|
|
description: to search for.
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: customer_id
|
|
description: to search for.
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: email
|
|
description: to search for.
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: region_id
|
|
style: form
|
|
explode: false
|
|
description: Regions to search orders by
|
|
schema:
|
|
oneOf:
|
|
- type: string
|
|
description: ID of a Region.
|
|
- type: array
|
|
items:
|
|
type: string
|
|
description: ID of a Region.
|
|
- in: query
|
|
name: currency_code
|
|
style: form
|
|
explode: false
|
|
description: Currency code to search for
|
|
schema:
|
|
type: string
|
|
externalDocs:
|
|
url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
|
|
description: See a list of codes.
|
|
- in: query
|
|
name: tax_rate
|
|
description: to search for.
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: created_at
|
|
description: Date comparison for when resulting orders were created.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
lt:
|
|
type: string
|
|
description: filter by dates less than this date
|
|
format: date
|
|
gt:
|
|
type: string
|
|
description: filter by dates greater than this date
|
|
format: date
|
|
lte:
|
|
type: string
|
|
description: filter by dates less than or equal to this date
|
|
format: date
|
|
gte:
|
|
type: string
|
|
description: filter by dates greater than or equal to this date
|
|
format: date
|
|
- in: query
|
|
name: updated_at
|
|
description: Date comparison for when resulting orders were updated.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
lt:
|
|
type: string
|
|
description: filter by dates less than this date
|
|
format: date
|
|
gt:
|
|
type: string
|
|
description: filter by dates greater than this date
|
|
format: date
|
|
lte:
|
|
type: string
|
|
description: filter by dates less than or equal to this date
|
|
format: date
|
|
gte:
|
|
type: string
|
|
description: filter by dates greater than or equal to this date
|
|
format: date
|
|
- in: query
|
|
name: canceled_at
|
|
description: Date comparison for when resulting orders were canceled.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
lt:
|
|
type: string
|
|
description: filter by dates less than this date
|
|
format: date
|
|
gt:
|
|
type: string
|
|
description: filter by dates greater than this date
|
|
format: date
|
|
lte:
|
|
type: string
|
|
description: filter by dates less than or equal to this date
|
|
format: date
|
|
gte:
|
|
type: string
|
|
description: filter by dates greater than or equal to this date
|
|
format: date
|
|
- in: query
|
|
name: sales_channel_id
|
|
style: form
|
|
explode: false
|
|
description: Filter by Sales Channels
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: The ID of a Sales Channel
|
|
- in: query
|
|
name: offset
|
|
description: How many orders to skip before the results.
|
|
schema:
|
|
type: integer
|
|
default: 0
|
|
- in: query
|
|
name: limit
|
|
description: Limit the number of orders returned.
|
|
schema:
|
|
type: integer
|
|
default: 50
|
|
- in: query
|
|
name: expand
|
|
description: >-
|
|
(Comma separated) Which fields should be expanded in each order of the
|
|
result.
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: fields
|
|
description: >-
|
|
(Comma separated) Which fields should be included in each order of the
|
|
result.
|
|
schema:
|
|
type: string
|
|
x-codeSamples:
|
|
- lang: JavaScript
|
|
label: JS Client
|
|
source:
|
|
$ref: ../code_samples/JavaScript/orders/getundefined
|
|
- lang: Shell
|
|
label: cURL
|
|
source:
|
|
$ref: ../code_samples/Shell/orders/getundefined
|
|
security:
|
|
- api_token: []
|
|
- cookie_auth: []
|
|
tags:
|
|
- Order
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
properties:
|
|
orders:
|
|
type: array
|
|
items:
|
|
$ref: ../components/schemas/order.yaml
|
|
count:
|
|
type: integer
|
|
description: The total number of items available
|
|
offset:
|
|
type: integer
|
|
description: The number of items skipped before these items
|
|
limit:
|
|
type: integer
|
|
description: The number of items per page
|
|
'400':
|
|
$ref: ../components/responses/400_error.yaml
|
|
'401':
|
|
$ref: ../components/responses/unauthorized.yaml
|
|
'404':
|
|
$ref: ../components/responses/not_found_error.yaml
|
|
'409':
|
|
$ref: ../components/responses/invalid_state_error.yaml
|
|
'422':
|
|
$ref: ../components/responses/invalid_request_error.yaml
|
|
'500':
|
|
$ref: ../components/responses/500_error.yaml
|