63 lines
1.6 KiB
YAML
63 lines
1.6 KiB
YAML
get:
|
|
operationId: GetOrders
|
|
summary: Look Up an Order
|
|
description: Look up an order using filters.
|
|
parameters:
|
|
- in: query
|
|
name: display_id
|
|
required: true
|
|
description: The display id given to the Order.
|
|
schema:
|
|
type: number
|
|
- in: query
|
|
name: email
|
|
style: form
|
|
explode: false
|
|
description: The email associated with this order.
|
|
required: true
|
|
schema:
|
|
type: string
|
|
format: email
|
|
- in: query
|
|
name: shipping_address
|
|
style: form
|
|
explode: false
|
|
description: The shipping address associated with this order.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
postal_code:
|
|
type: string
|
|
description: The postal code of the shipping address
|
|
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
|
|
tags:
|
|
- Order
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
order:
|
|
$ref: ../components/schemas/order.yaml
|
|
'400':
|
|
$ref: ../components/responses/400_error.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
|