chore(docs): Generated API Reference (#2100)
Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>
This commit is contained in:
co-authored by
shahednasser
parent
501bda6aae
commit
605fa625a2
+28
-28
@@ -56,34 +56,6 @@ paths:
|
||||
$ref: paths/auth.yaml
|
||||
/auth/{email}:
|
||||
$ref: paths/auth_{email}.yaml
|
||||
/collections/{id}:
|
||||
$ref: paths/collections_{id}.yaml
|
||||
/collections:
|
||||
$ref: paths/collections.yaml
|
||||
/gift-cards/{code}:
|
||||
$ref: paths/gift-cards_{code}.yaml
|
||||
/customers/me/addresses:
|
||||
$ref: paths/customers_me_addresses.yaml
|
||||
/customers:
|
||||
$ref: paths/customers.yaml
|
||||
/customers/me/addresses/{address_id}:
|
||||
$ref: paths/customers_me_addresses_{address_id}.yaml
|
||||
/customers/me:
|
||||
$ref: paths/customers_me.yaml
|
||||
/customers/me/payment-methods:
|
||||
$ref: paths/customers_me_payment-methods.yaml
|
||||
/customers/me/orders:
|
||||
$ref: paths/customers_me_orders.yaml
|
||||
/customers/password-token:
|
||||
$ref: paths/customers_password-token.yaml
|
||||
/customers/password-reset:
|
||||
$ref: paths/customers_password-reset.yaml
|
||||
/orders/cart/{cart_id}:
|
||||
$ref: paths/orders_cart_{cart_id}.yaml
|
||||
/orders/{id}:
|
||||
$ref: paths/orders_{id}.yaml
|
||||
/orders:
|
||||
$ref: paths/orders.yaml
|
||||
/carts/{id}/shipping-methods:
|
||||
$ref: paths/carts_{id}_shipping-methods.yaml
|
||||
/carts/{id}/taxes:
|
||||
@@ -108,6 +80,34 @@ paths:
|
||||
$ref: paths/carts_{id}_payment-sessions_{provider_id}_refresh.yaml
|
||||
/carts/{id}/payment-session:
|
||||
$ref: paths/carts_{id}_payment-session.yaml
|
||||
/collections/{id}:
|
||||
$ref: paths/collections_{id}.yaml
|
||||
/collections:
|
||||
$ref: paths/collections.yaml
|
||||
/customers/me/addresses:
|
||||
$ref: paths/customers_me_addresses.yaml
|
||||
/customers:
|
||||
$ref: paths/customers.yaml
|
||||
/customers/me/addresses/{address_id}:
|
||||
$ref: paths/customers_me_addresses_{address_id}.yaml
|
||||
/customers/me:
|
||||
$ref: paths/customers_me.yaml
|
||||
/customers/me/payment-methods:
|
||||
$ref: paths/customers_me_payment-methods.yaml
|
||||
/customers/me/orders:
|
||||
$ref: paths/customers_me_orders.yaml
|
||||
/customers/password-token:
|
||||
$ref: paths/customers_password-token.yaml
|
||||
/customers/password-reset:
|
||||
$ref: paths/customers_password-reset.yaml
|
||||
/gift-cards/{code}:
|
||||
$ref: paths/gift-cards_{code}.yaml
|
||||
/orders/cart/{cart_id}:
|
||||
$ref: paths/orders_cart_{cart_id}.yaml
|
||||
/orders/{id}:
|
||||
$ref: paths/orders_{id}.yaml
|
||||
/orders:
|
||||
$ref: paths/orders.yaml
|
||||
/products/{id}:
|
||||
$ref: paths/products_{id}.yaml
|
||||
/products:
|
||||
|
||||
@@ -4,6 +4,139 @@ get:
|
||||
description: Retrieves a list of a Customer's Orders.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- in: query
|
||||
name: q
|
||||
description: Query used for searching orders.
|
||||
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
|
||||
- in: query
|
||||
name: fulfillment_status
|
||||
style: form
|
||||
explode: false
|
||||
description: Fulfillment status to search for.
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
- in: query
|
||||
name: payment_status
|
||||
style: form
|
||||
explode: false
|
||||
description: Payment status to search for.
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
- 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: email
|
||||
description: to search for.
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: region_id
|
||||
description: to search for.
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: currency_code
|
||||
description: to search for.
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: tax_rate
|
||||
description: to search for.
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: created_at
|
||||
description: Date comparison for when resulting collections 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 collections 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 collections 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: limit
|
||||
description: How many orders to return.
|
||||
|
||||
Reference in New Issue
Block a user