asyavee/medusa-store
1
0 Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

chore(docs): Updated API Reference (v2) (#8954)

Browse Source 
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]andShahed Nasser authored and GitHub committed 2024-09-03 07:18:42 +00:00
1 parent 6652db45ef
commit edc19e748b
151 files changed
+15987 -35933
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

www/apps/api-reference/specs/admin/components/schemas/AdminCreateInventoryItem.yaml
+1 -1
View File
@@ -1,5 +1,6 @@
type: object type: object
description: SUMMARY description: SUMMARY
x-schemaName: AdminCreateInventoryItem
properties: properties:
sku: sku:
type: string type: string
@@ -56,4 +57,3 @@ properties:
metadata: metadata:
type: object type: object
description: The inventory item's metadata. description: The inventory item's metadata.
x-schemaName: AdminCreateInventoryItem
www/apps/api-reference/specs/admin/components/schemas/AdminCreateProductCategory.yaml
+4 -4
View File
@@ -1,5 +1,6 @@
type: object type: object
description: SUMMARY description: SUMMARY
x-schemaName: AdminCreateProductCategory
required: required:
- name - name
properties: properties:
@@ -27,11 +28,10 @@ properties:
type: string type: string
title: parent_category_id title: parent_category_id
description: The product category's parent category id. description: The product category's parent category id.
metadata:
type: object
description: The product category's metadata.
rank: rank:
type: number type: number
title: rank title: rank
description: The product category's rank. description: The product category's rank.
x-schemaName: AdminCreateProductCategory metadata:
type: object
description: The product category's metadata.
www/apps/api-reference/specs/admin/components/schemas/AdminCreateProductTag.yaml
+1 -1
View File
@@ -1,5 +1,6 @@
type: object type: object
description: SUMMARY description: SUMMARY
x-schemaName: AdminCreateProductTag
required: required:
- value - value
properties: properties:
@@ -10,4 +11,3 @@ properties:
metadata: metadata:
type: object type: object
description: The product tag's metadata. description: The product tag's metadata.
x-schemaName: AdminCreateProductTag
www/apps/api-reference/specs/admin/components/schemas/AdminCreateRefundReason.yaml
+1 -1
View File
@@ -1,5 +1,6 @@
type: object type: object
description: SUMMARY description: SUMMARY
x-schemaName: AdminCreateRefundReason
required: required:
- label - label
properties: properties:
@@ -11,4 +12,3 @@ properties:
type: string type: string
title: description title: description
description: The refund reason's description. description: The refund reason's description.
x-schemaName: AdminCreateRefundReason
www/apps/api-reference/specs/admin/components/schemas/AdminCreateRegion.yaml
+5 -5
View File
@@ -1,5 +1,6 @@
type: object type: object
description: SUMMARY description: SUMMARY
x-schemaName: AdminCreateRegion
required: required:
- name - name
- currency_code - currency_code
@@ -23,6 +24,10 @@ properties:
type: boolean type: boolean
title: automatic_taxes title: automatic_taxes
description: The region's automatic taxes. description: The region's automatic taxes.
is_tax_inclusive:
type: boolean
title: is_tax_inclusive
description: The region's is tax inclusive.
payment_providers: payment_providers:
type: array type: array
description: The region's payment providers. description: The region's payment providers.
@@ -33,8 +38,3 @@ properties:
metadata: metadata:
type: object type: object
description: The region's metadata. description: The region's metadata.
is_tax_inclusive:
type: boolean
title: is_tax_inclusive
description: The region's is tax inclusive.
x-schemaName: AdminCreateRegion
www/apps/api-reference/specs/admin/components/schemas/AdminCreateReservation.yaml
+1 -1
View File
@@ -1,5 +1,6 @@
type: object type: object
description: SUMMARY description: SUMMARY
x-schemaName: AdminCreateReservation
required: required:
- location_id - location_id
- inventory_item_id - inventory_item_id
@@ -28,4 +29,3 @@ properties:
metadata: metadata:
type: object type: object
description: The reservation's metadata. description: The reservation's metadata.
x-schemaName: AdminCreateReservation
www/apps/api-reference/specs/admin/components/schemas/AdminCreateShippingOption.yaml
+5 -2
View File
@@ -1,5 +1,6 @@
type: object type: object
description: SUMMARY description: SUMMARY
x-schemaName: AdminCreateShippingOption
required: required:
- name - name
- service_zone_id - service_zone_id
@@ -26,9 +27,10 @@ properties:
description: The shipping option's data. description: The shipping option's data.
price_type: price_type:
type: string type: string
description: The shipping option's price type.
enum: enum:
- calculated
- flat - flat
- calculated
provider_id: provider_id:
type: string type: string
title: provider_id title: provider_id
@@ -42,6 +44,7 @@ properties:
oneOf: oneOf:
- type: object - type: object
description: The price's prices. description: The price's prices.
x-schemaName: AdminCreateShippingOptionPriceWithCurrency
required: required:
- currency_code - currency_code
- amount - amount
@@ -56,6 +59,7 @@ properties:
description: The price's amount. description: The price's amount.
- type: object - type: object
description: The price's prices. description: The price's prices.
x-schemaName: AdminCreateShippingOptionPriceWithRegion
required: required:
- region_id - region_id
- amount - amount
@@ -73,4 +77,3 @@ properties:
description: The shipping option's rules. description: The shipping option's rules.
items: items:
$ref: ./AdminCreateShippingOptionRule.yaml $ref: ./AdminCreateShippingOptionRule.yaml
x-schemaName: AdminCreateShippingOption
www/apps/api-reference/specs/admin/components/schemas/AdminCreateShippingOptionRule.yaml
+6 -5
View File
@@ -1,5 +1,6 @@
type: object type: object
description: The rule's rules. description: The rule's rules.
x-schemaName: AdminCreateShippingOptionRule
required: required:
- operator - operator
- attribute - attribute
@@ -7,14 +8,15 @@ required:
properties: properties:
operator: operator:
type: string type: string
description: The rule's operator.
enum: enum:
- in - gt
- lt
- eq - eq
- ne - ne
- gt - in
- gte
- lt
- lte - lte
- gte
- nin - nin
attribute: attribute:
type: string type: string
@@ -31,4 +33,3 @@ properties:
type: string type: string
title: value title: value
description: The value's details. description: The value's details.
x-schemaName: AdminCreateShippingOptionRule
www/apps/api-reference/specs/admin/components/schemas/AdminCreateShippingProfile.yaml
+18
View File
@@ -0,0 +1,18 @@
type: object
description: SUMMARY
required:
- name
- type
properties:
name:
type: string
title: name
description: The shipping profile's name.
type:
type: string
title: type
description: The shipping profile's type.
metadata:
type: object
description: The shipping profile's metadata.
x-schemaName: AdminCreateShippingProfile
www/apps/api-reference/specs/admin/components/schemas/AdminDeletePaymentCollectionResponse.yaml
+3 -3
View File
@@ -1,5 +1,6 @@
type: object type: object
description: SUMMARY description: SUMMARY
x-schemaName: AdminDeletePaymentCollectionResponse
required: required:
- id - id
- object - object
@@ -12,10 +13,9 @@ properties:
object: object:
type: string type: string
title: object title: object
description: The name of the deleted object. description: SUMMARY
default: payment-collection default: payment-collection
deleted: deleted:
type: boolean type: boolean
title: deleted title: deleted
description: Whether the payment collection was deleted. description: SUMMARY
x-schemaName: AdminDeletePaymentCollectionResponse
www/apps/api-reference/specs/admin/components/schemas/AdminExchangeDeleteResponse.yaml
+2 -2
View File
@@ -1,5 +1,6 @@
type: object type: object
description: SUMMARY description: SUMMARY
x-schemaName: AdminExchangeDeleteResponse
required: required:
- id - id
- object - object
@@ -17,5 +18,4 @@ properties:
deleted: deleted:
type: boolean type: boolean
title: deleted title: deleted
description: Whether the exchange was deleted. description: Whether the Exchange was deleted.
x-schemaName: AdminExchangeDeleteResponse
www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentSet.yaml
+11 -11
View File
@@ -1,5 +1,15 @@
type: object type: object
description: The fulfillment set that the service zone belongs to. description: The fulfillment set's parent.
x-schemaName: AdminFulfillmentSet
required:
- id
- name
- type
- location
- service_zones
- created_at
- updated_at
- deleted_at
properties: properties:
id: id:
type: string type: string
@@ -35,13 +45,3 @@ properties:
format: date-time format: date-time
title: deleted_at title: deleted_at
description: The parent's deleted at. description: The parent's deleted at.
required:
- id
- name
- type
- location
- service_zones
- created_at
- updated_at
- deleted_at
x-schemaName: AdminFulfillmentSet
www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantParams.yaml
+445 -13
View File
@@ -1,18 +1,18 @@
type: object type: object
description: The product's variants. description: SUMMARY
x-schemaName: AdminProductVariantParams x-schemaName: AdminProductVariantParams
properties: properties:
q: q:
type: string type: string
title: q title: q
description: The variant's q. description: The product's q.
id: id:
oneOf: oneOf:
- type: string - type: string
title: id title: id
description: The variant's ID. description: The product's ID.
- type: array - type: array
description: The variant's ID. description: The product's ID.
items: items:
type: string type: string
title: id title: id
@@ -20,14 +20,14 @@ properties:
manage_inventory: manage_inventory:
type: boolean type: boolean
title: manage_inventory title: manage_inventory
description: The variant's manage inventory. description: The product's manage inventory.
allow_backorder: allow_backorder:
type: boolean type: boolean
title: allow_backorder title: allow_backorder
description: The variant's allow backorder. description: The product's allow backorder.
created_at: created_at:
type: object type: object
description: The variant's created at. description: The product's created at.
properties: properties:
$and: $and:
type: array type: array
@@ -81,6 +81,150 @@ properties:
description: Filter by values not matching the conditions in this parameter. description: Filter by values not matching the conditions in this parameter.
- type: object - type: object
description: Filter by values not matching the conditions in this parameter. description: Filter by values not matching the conditions in this parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for numbers
and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter. Useful
for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array - type: array
description: Filter by values not matching the conditions in this parameter. description: Filter by values not matching the conditions in this parameter.
items: items:
@@ -154,7 +298,7 @@ properties:
description: Filter by whether a value for this parameter exists (not `null`). description: Filter by whether a value for this parameter exists (not `null`).
updated_at: updated_at:
type: object type: object
description: The variant's updated at. description: The product's updated at.
properties: properties:
$and: $and:
type: array type: array
@@ -208,6 +352,150 @@ properties:
description: Filter by values not matching the conditions in this parameter. description: Filter by values not matching the conditions in this parameter.
- type: object - type: object
description: Filter by values not matching the conditions in this parameter. description: Filter by values not matching the conditions in this parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for numbers
and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter. Useful
for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array - type: array
description: Filter by values not matching the conditions in this parameter. description: Filter by values not matching the conditions in this parameter.
items: items:
@@ -281,7 +569,7 @@ properties:
description: Filter by whether a value for this parameter exists (not `null`). description: Filter by whether a value for this parameter exists (not `null`).
deleted_at: deleted_at:
type: object type: object
description: The variant's deleted at. description: The product's deleted at.
properties: properties:
$and: $and:
type: array type: array
@@ -335,6 +623,150 @@ properties:
description: Filter by values not matching the conditions in this parameter. description: Filter by values not matching the conditions in this parameter.
- type: object - type: object
description: Filter by values not matching the conditions in this parameter. description: Filter by values not matching the conditions in this parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for numbers
and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter. Useful
for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array - type: array
description: Filter by values not matching the conditions in this parameter. description: Filter by values not matching the conditions in this parameter.
items: items:
@@ -409,19 +841,19 @@ properties:
limit: limit:
type: number type: number
title: limit title: limit
description: The variant's limit. description: The product's limit.
offset: offset:
type: number type: number
title: offset title: offset
description: The variant's offset. description: The product's offset.
order: order:
type: string type: string
title: order title: order
description: The variant's order. description: The product's order.
fields: fields:
type: string type: string
title: fields title: fields
description: The variant's fields. description: The product's fields.
$and: $and:
type: array type: array
description: >- description: >-
www/apps/api-reference/specs/admin/components/schemas/AdminReturnReasonDeleteResponse.yaml
+2 -2
View File
@@ -1,5 +1,6 @@
type: object type: object
description: SUMMARY description: SUMMARY
x-schemaName: AdminReturnReasonDeleteResponse
required: required:
- id - id
- object - object
@@ -17,5 +18,4 @@ properties:
deleted: deleted:
type: boolean type: boolean
title: deleted title: deleted
description: Whether the return reason was deleted. description: Whether the Return Reason was deleted.
x-schemaName: AdminReturnReasonDeleteResponse
www/apps/api-reference/specs/admin/components/schemas/AdminServiceZoneDeleteResponse.yaml
+3 -4
View File
@@ -1,5 +1,6 @@
type: object type: object
description: SUMMARY description: SUMMARY
x-schemaName: AdminServiceZoneDeleteResponse
required: required:
- id - id
- object - object
@@ -8,16 +9,14 @@ properties:
id: id:
type: string type: string
title: id title: id
description: The service zone's ID. description: The fulfillment set's ID.
object: object:
type: string type: string
title: object title: object
description: The name of the deleted object. description: The name of the deleted object.
default: service_zone
deleted: deleted:
type: boolean type: boolean
title: deleted title: deleted
description: Whether the service zone was deleted. description: Whether the Fulfillment Set was deleted.
parent: parent:
$ref: ./AdminFulfillmentSet.yaml $ref: ./AdminFulfillmentSet.yaml
x-schemaName: AdminServiceZoneDeleteResponse
www/apps/api-reference/specs/admin/components/schemas/StoreCreatePaymentCollection.yaml
+1 -1
View File
@@ -1,5 +1,6 @@
type: object type: object
description: SUMMARY description: SUMMARY
x-schemaName: StoreCreatePaymentCollection
required: required:
- cart_id - cart_id
properties: properties:
@@ -7,4 +8,3 @@ properties:
type: string type: string
title: cart_id title: cart_id
description: The payment collection's cart id. description: The payment collection's cart id.
x-schemaName: StoreCreatePaymentCollection
www/apps/api-reference/specs/admin/components/schemas/StoreCreateReturnItem.yaml
+1 -1
View File
@@ -1,5 +1,6 @@
type: object type: object
description: The item's items. description: The item's items.
x-schemaName: StoreCreateReturnItem
required: required:
- id - id
- quantity - quantity
@@ -20,4 +21,3 @@ properties:
type: string type: string
title: note title: note
description: The item's note. description: The item's note.
x-schemaName: StoreCreateReturnItem
www/apps/api-reference/specs/admin/components/schemas/StoreCreateReturnShipping.yaml
+1 -1
View File
@@ -1,5 +1,6 @@
type: object type: object
description: The return's return shipping. description: The return's return shipping.
x-schemaName: StoreCreateReturnShipping
required: required:
- option_id - option_id
properties: properties:
@@ -11,4 +12,3 @@ properties:
type: number type: number
title: price title: price
description: The return shipping's price. description: The return shipping's price.
x-schemaName: StoreCreateReturnShipping
www/apps/api-reference/specs/admin/openapi.full.yaml
+5692 -12934
View File
File diff suppressed because it is too large. Load diff
www/apps/api-reference/specs/admin/paths/admin_customer-groups.yaml
+87 -125
View File
@@ -63,12 +63,12 @@ get:
with `-`. with `-`.
- name: q - name: q
in: query in: query
description: The customer group's q. description: Search term to filter the customer group's searchable properties.
required: false required: false
schema: schema:
type: string type: string
title: q title: q
description: The customer group's q. description: Search term to filter the customer group's searchable properties.
- name: id - name: id
in: query in: query
required: false required: false
@@ -76,13 +76,13 @@ get:
oneOf: oneOf:
- type: string - type: string
title: id title: id
description: The customer group's ID. description: Filter by a customer group's IDs.
- type: array - type: array
description: The customer group's ID. description: Filter by customer group IDs.
items: items:
type: string type: string
title: id title: id
description: The id's ID. description: A customer group's ID.
- name: name - name: name
in: query in: query
required: false required: false
@@ -90,13 +90,13 @@ get:
oneOf: oneOf:
- type: string - type: string
title: name title: name
description: The customer group's name. description: Filter by a customer group's name.
- type: array - type: array
description: The customer group's name. description: Filter by customer group names.
items: items:
type: string type: string
title: name title: name
description: The name's details. description: A customer group's name.
- name: customers - name: customers
in: query in: query
required: false required: false
@@ -104,13 +104,13 @@ get:
oneOf: oneOf:
- type: string - type: string
title: customers title: customers
description: The customer group's customers. description: Filter by the ID of a customer to retrieve its groups.
- type: array - type: array
description: The customer group's customers. description: Filter by customer IDs to retrieve their groups.
items: items:
type: string type: string
title: customers title: customers
description: The customer's customers. description: A customer's ID.
- $ref: ../components/schemas/AdminCustomerInGroupFilters.yaml - $ref: ../components/schemas/AdminCustomerInGroupFilters.yaml
- name: created_by - name: created_by
in: query in: query
@@ -119,20 +119,24 @@ get:
oneOf: oneOf:
- type: string - type: string
title: created_by title: created_by
description: The customer group's created by. description: >-
Filter by an ID of a user to retrieve the customer groups they
created.
- type: array - type: array
description: The customer group's created by. description: >-
Filter by the IDs of users to retrieve the customer groups they
created.
items: items:
type: string type: string
title: created_by title: created_by
description: The created by's details. description: The user's ID.
- name: created_at - name: created_at
in: query in: query
description: The customer group's created at. description: Filter the customer group by its creation date.
required: false required: false
schema: schema:
type: object type: object
description: The customer group's created at. description: Filter the customer group by its creation date.
properties: properties:
$and: $and:
type: array type: array
@@ -156,11 +160,11 @@ get:
title: $eq title: $eq
description: Filter by an exact match. description: Filter by an exact match.
- type: array - type: array
description: Filter by an exact match. description: Filter by multiple exact matches.
items: items:
type: string type: string
title: $eq title: $eq
description: Filter by an exact match. description: An exact match.
$ne: $ne:
type: string type: string
title: $ne title: $ne
@@ -171,21 +175,19 @@ get:
items: items:
type: string type: string
title: $in title: $in
description: Filter by values in this array. description: The value to match.
$nin: $nin:
type: array type: array
description: Filter by values not in this array. description: Filter by values not in this array.
items: items:
type: string type: string
title: $nin title: $nin
description: Filter by values not in this array. description: The value not to match.
$not: $not:
oneOf: oneOf:
- type: string - type: string
title: $not title: $not
description: >- description: Filter by values not matching this parameter.
Filter by values not matching the conditions in this
parameter.
- type: object - type: object
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
@@ -213,50 +215,46 @@ get:
title: $eq title: $eq
description: Filter by an exact match. description: Filter by an exact match.
- type: array - type: array
description: Filter by an exact match. description: Filter by multiple exact matches.
items: items:
type: string type: string
title: $eq title: $eq
description: Filter by an exact match. description: The value to match.
$ne: $ne:
type: string type: string
title: $ne title: $ne
description: Filter by values not equal to this parameter. description: Filter by values not matching this parameter.
$in: $in:
type: array type: array
description: Filter by values in this array. description: Filter by values in this array.
items: items:
type: string type: string
title: $in title: $in
description: Filter by values in this array. description: The value to match.
$nin: $nin:
type: array type: array
description: Filter by values not in this array. description: Filter by values not in this array.
items: items:
type: string type: string
title: $nin title: $nin
description: Filter by values not in this array. description: The value to not match
$not: $not:
oneOf: oneOf:
- type: string - type: string
title: $not title: $not
description: >- description: Filter by values not matching this parameter
Filter by values not matching the conditions in this
parameter.
- type: object - type: object
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
parameter. parameter.
- type: array - type: array
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the values of this
parameter. parameter.
items: items:
type: string type: string
title: $not title: $not
description: >- description: The values to not match.
Filter by values not matching the conditions in this
parameter.
$gt: $gt:
type: string type: string
title: $gt title: $gt
@@ -307,9 +305,7 @@ get:
items: items:
type: string type: string
title: $overlap title: $overlap
description: >- description: The value to match.
Filter arrays that have overlapping values with this
parameter.
$contains: $contains:
type: array type: array
description: >- description: >-
@@ -318,16 +314,14 @@ get:
items: items:
type: string type: string
title: $contains title: $contains
description: >- description: The values to match.
Filter arrays that contain some of the values of this
parameter.
$contained: $contained:
type: array type: array
description: Filter arrays that contain all values of this parameter. description: Filter arrays that contain all values of this parameter.
items: items:
type: string type: string
title: $contained title: $contained
description: Filter arrays that contain all values of this parameter. description: The values to match.
$exists: $exists:
type: boolean type: boolean
title: $exists title: $exists
@@ -335,15 +329,11 @@ get:
Filter by whether a value for this parameter exists (not Filter by whether a value for this parameter exists (not
`null`). `null`).
- type: array - type: array
description: >- description: Filter by values not matching those in this parameter.
Filter by values not matching the conditions in this
parameter.
items: items:
type: string type: string
title: $not title: $not
description: >- description: The values to not match.
Filter by values not matching the conditions in this
parameter.
$gt: $gt:
type: string type: string
title: $gt title: $gt
@@ -390,32 +380,32 @@ get:
items: items:
type: string type: string
title: $overlap title: $overlap
description: Filter arrays that have overlapping values with this parameter. description: The values to match.
$contains: $contains:
type: array type: array
description: Filter arrays that contain some of the values of this parameter. description: Filter arrays that contain some of the values of this parameter.
items: items:
type: string type: string
title: $contains title: $contains
description: Filter arrays that contain some of the values of this parameter. description: The values to match.
$contained: $contained:
type: array type: array
description: Filter arrays that contain all values of this parameter. description: Filter arrays that contain all values of this parameter.
items: items:
type: string type: string
title: $contained title: $contained
description: Filter arrays that contain all values of this parameter. description: The values to match.
$exists: $exists:
type: boolean type: boolean
title: $exists title: $exists
description: Filter by whether a value for this parameter exists (not `null`). description: Filter by whether a value for this parameter exists (not `null`).
- name: updated_at - name: updated_at
in: query in: query
description: The customer group's updated at. description: Filter the customer groups by their update date.
required: false required: false
schema: schema:
type: object type: object
description: The customer group's updated at. description: Filter the customer groups by their update date.
properties: properties:
$and: $and:
type: array type: array
@@ -439,11 +429,11 @@ get:
title: $eq title: $eq
description: Filter by an exact match. description: Filter by an exact match.
- type: array - type: array
description: Filter by an exact match. description: Filter by multiple exact matches.
items: items:
type: string type: string
title: $eq title: $eq
description: Filter by an exact match. description: An exact match.
$ne: $ne:
type: string type: string
title: $ne title: $ne
@@ -454,21 +444,19 @@ get:
items: items:
type: string type: string
title: $in title: $in
description: Filter by values in this array. description: The value to match.
$nin: $nin:
type: array type: array
description: Filter by values not in this array. description: Filter by values not in this array.
items: items:
type: string type: string
title: $nin title: $nin
description: Filter by values not in this array. description: The value not to match.
$not: $not:
oneOf: oneOf:
- type: string - type: string
title: $not title: $not
description: >- description: Filter by values not matching this parameter.
Filter by values not matching the conditions in this
parameter.
- type: object - type: object
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
@@ -496,50 +484,46 @@ get:
title: $eq title: $eq
description: Filter by an exact match. description: Filter by an exact match.
- type: array - type: array
description: Filter by an exact match. description: Filter by multiple exact matches.
items: items:
type: string type: string
title: $eq title: $eq
description: Filter by an exact match. description: The value to match.
$ne: $ne:
type: string type: string
title: $ne title: $ne
description: Filter by values not equal to this parameter. description: Filter by values not matching this parameter.
$in: $in:
type: array type: array
description: Filter by values in this array. description: Filter by values in this array.
items: items:
type: string type: string
title: $in title: $in
description: Filter by values in this array. description: The value to match.
$nin: $nin:
type: array type: array
description: Filter by values not in this array. description: Filter by values not in this array.
items: items:
type: string type: string
title: $nin title: $nin
description: Filter by values not in this array. description: The value to not match
$not: $not:
oneOf: oneOf:
- type: string - type: string
title: $not title: $not
description: >- description: Filter by values not matching this parameter
Filter by values not matching the conditions in this
parameter.
- type: object - type: object
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
parameter. parameter.
- type: array - type: array
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the values of this
parameter. parameter.
items: items:
type: string type: string
title: $not title: $not
description: >- description: The values to not match.
Filter by values not matching the conditions in this
parameter.
$gt: $gt:
type: string type: string
title: $gt title: $gt
@@ -590,9 +574,7 @@ get:
items: items:
type: string type: string
title: $overlap title: $overlap
description: >- description: The value to match.
Filter arrays that have overlapping values with this
parameter.
$contains: $contains:
type: array type: array
description: >- description: >-
@@ -601,16 +583,14 @@ get:
items: items:
type: string type: string
title: $contains title: $contains
description: >- description: The values to match.
Filter arrays that contain some of the values of this
parameter.
$contained: $contained:
type: array type: array
description: Filter arrays that contain all values of this parameter. description: Filter arrays that contain all values of this parameter.
items: items:
type: string type: string
title: $contained title: $contained
description: Filter arrays that contain all values of this parameter. description: The values to match.
$exists: $exists:
type: boolean type: boolean
title: $exists title: $exists
@@ -618,15 +598,11 @@ get:
Filter by whether a value for this parameter exists (not Filter by whether a value for this parameter exists (not
`null`). `null`).
- type: array - type: array
description: >- description: Filter by values not matching those in this parameter.
Filter by values not matching the conditions in this
parameter.
items: items:
type: string type: string
title: $not title: $not
description: >- description: The values to not match.
Filter by values not matching the conditions in this
parameter.
$gt: $gt:
type: string type: string
title: $gt title: $gt
@@ -673,32 +649,32 @@ get:
items: items:
type: string type: string
title: $overlap title: $overlap
description: Filter arrays that have overlapping values with this parameter. description: The values to match.
$contains: $contains:
type: array type: array
description: Filter arrays that contain some of the values of this parameter. description: Filter arrays that contain some of the values of this parameter.
items: items:
type: string type: string
title: $contains title: $contains
description: Filter arrays that contain some of the values of this parameter. description: The values to match.
$contained: $contained:
type: array type: array
description: Filter arrays that contain all values of this parameter. description: Filter arrays that contain all values of this parameter.
items: items:
type: string type: string
title: $contained title: $contained
description: Filter arrays that contain all values of this parameter. description: The values to match.
$exists: $exists:
type: boolean type: boolean
title: $exists title: $exists
description: Filter by whether a value for this parameter exists (not `null`). description: Filter by whether a value for this parameter exists (not `null`).
- name: deleted_at - name: deleted_at
in: query in: query
description: The customer group's deleted at. description: Filter the customer groups by their deletion date.
required: false required: false
schema: schema:
type: object type: object
description: The customer group's deleted at. description: Filter the customer groups by their deletion date.
properties: properties:
$and: $and:
type: array type: array
@@ -722,11 +698,11 @@ get:
title: $eq title: $eq
description: Filter by an exact match. description: Filter by an exact match.
- type: array - type: array
description: Filter by an exact match. description: Filter by multiple exact matches.
items: items:
type: string type: string
title: $eq title: $eq
description: Filter by an exact match. description: An exact match.
$ne: $ne:
type: string type: string
title: $ne title: $ne
@@ -737,21 +713,19 @@ get:
items: items:
type: string type: string
title: $in title: $in
description: Filter by values in this array. description: The value to match.
$nin: $nin:
type: array type: array
description: Filter by values not in this array. description: Filter by values not in this array.
items: items:
type: string type: string
title: $nin title: $nin
description: Filter by values not in this array. description: The value not to match.
$not: $not:
oneOf: oneOf:
- type: string - type: string
title: $not title: $not
description: >- description: Filter by values not matching this parameter.
Filter by values not matching the conditions in this
parameter.
- type: object - type: object
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
@@ -779,50 +753,46 @@ get:
title: $eq title: $eq
description: Filter by an exact match. description: Filter by an exact match.
- type: array - type: array
description: Filter by an exact match. description: Filter by multiple exact matches.
items: items:
type: string type: string
title: $eq title: $eq
description: Filter by an exact match. description: The value to match.
$ne: $ne:
type: string type: string
title: $ne title: $ne
description: Filter by values not equal to this parameter. description: Filter by values not matching this parameter.
$in: $in:
type: array type: array
description: Filter by values in this array. description: Filter by values in this array.
items: items:
type: string type: string
title: $in title: $in
description: Filter by values in this array. description: The value to match.
$nin: $nin:
type: array type: array
description: Filter by values not in this array. description: Filter by values not in this array.
items: items:
type: string type: string
title: $nin title: $nin
description: Filter by values not in this array. description: The value to not match
$not: $not:
oneOf: oneOf:
- type: string - type: string
title: $not title: $not
description: >- description: Filter by values not matching this parameter
Filter by values not matching the conditions in this
parameter.
- type: object - type: object
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
parameter. parameter.
- type: array - type: array
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the values of this
parameter. parameter.
items: items:
type: string type: string
title: $not title: $not
description: >- description: The values to not match.
Filter by values not matching the conditions in this
parameter.
$gt: $gt:
type: string type: string
title: $gt title: $gt
@@ -873,9 +843,7 @@ get:
items: items:
type: string type: string
title: $overlap title: $overlap
description: >- description: The value to match.
Filter arrays that have overlapping values with this
parameter.
$contains: $contains:
type: array type: array
description: >- description: >-
@@ -884,16 +852,14 @@ get:
items: items:
type: string type: string
title: $contains title: $contains
description: >- description: The values to match.
Filter arrays that contain some of the values of this
parameter.
$contained: $contained:
type: array type: array
description: Filter arrays that contain all values of this parameter. description: Filter arrays that contain all values of this parameter.
items: items:
type: string type: string
title: $contained title: $contained
description: Filter arrays that contain all values of this parameter. description: The values to match.
$exists: $exists:
type: boolean type: boolean
title: $exists title: $exists
@@ -901,15 +867,11 @@ get:
Filter by whether a value for this parameter exists (not Filter by whether a value for this parameter exists (not
`null`). `null`).
- type: array - type: array
description: >- description: Filter by values not matching those in this parameter.
Filter by values not matching the conditions in this
parameter.
items: items:
type: string type: string
title: $not title: $not
description: >- description: The values to not match.
Filter by values not matching the conditions in this
parameter.
$gt: $gt:
type: string type: string
title: $gt title: $gt
@@ -956,21 +918,21 @@ get:
items: items:
type: string type: string
title: $overlap title: $overlap
description: Filter arrays that have overlapping values with this parameter. description: The values to match.
$contains: $contains:
type: array type: array
description: Filter arrays that contain some of the values of this parameter. description: Filter arrays that contain some of the values of this parameter.
items: items:
type: string type: string
title: $contains title: $contains
description: Filter arrays that contain some of the values of this parameter. description: The values to match.
$contained: $contained:
type: array type: array
description: Filter arrays that contain all values of this parameter. description: Filter arrays that contain all values of this parameter.
items: items:
type: string type: string
title: $contained title: $contained
description: Filter arrays that contain all values of this parameter. description: The values to match.
$exists: $exists:
type: boolean type: boolean
title: $exists title: $exists
www/apps/api-reference/specs/admin/paths/admin_customers.yaml
+1524 -441
View File
File diff suppressed because it is too large. Load diff
www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses.yaml
+26 -24
View File
@@ -3,7 +3,7 @@ get:
summary: List Addresses summary: List Addresses
description: >- description: >-
Retrieve a list of addresses in a customer. The addresses can be filtered by Retrieve a list of addresses in a customer. The addresses can be filtered by
fields like FILTER FIELDS. The addresses can also be paginated. fields like `query`. The addresses can also be paginated.
x-authenticated: true x-authenticated: true
parameters: parameters:
- name: id - name: id
@@ -69,12 +69,12 @@ get:
with `-`. with `-`.
- name: q - name: q
in: query in: query
description: The customer's q. description: Search term to apply on the address's searchable properties.
required: false required: false
schema: schema:
type: string type: string
title: q title: q
description: The customer's q. description: Search term to apply on the address's searchable properties.
- name: company - name: company
in: query in: query
required: false required: false
@@ -82,13 +82,13 @@ get:
oneOf: oneOf:
- type: string - type: string
title: company title: company
description: The customer's company. description: Filter by a company.
- type: array - type: array
description: The customer's company. description: Filter by companies.
items: items:
type: string type: string
title: company title: company
description: The company's details. description: A company's name.
- name: city - name: city
in: query in: query
required: false required: false
@@ -96,13 +96,13 @@ get:
oneOf: oneOf:
- type: string - type: string
title: city title: city
description: The customer's city. description: Filter by a city.
- type: array - type: array
description: The customer's city. description: Filter by cities.
items: items:
type: string type: string
title: city title: city
description: The city's details. description: A city's name.
- name: country_code - name: country_code
in: query in: query
required: false required: false
@@ -110,13 +110,13 @@ get:
oneOf: oneOf:
- type: string - type: string
title: country_code title: country_code
description: The customer's country code. description: Filter by a currency code.
- type: array - type: array
description: The customer's country code. description: Filter by currency codes.
items: items:
type: string type: string
title: country_code title: country_code
description: The country code's details. description: A currency code.
- name: province - name: province
in: query in: query
required: false required: false
@@ -124,13 +124,13 @@ get:
oneOf: oneOf:
- type: string - type: string
title: province title: province
description: The customer's province. description: Filter by a province.
- type: array - type: array
description: The customer's province. description: Filter by provinces.
items: items:
type: string type: string
title: province title: province
description: The province's details. description: A province code.
- name: postal_code - name: postal_code
in: query in: query
required: false required: false
@@ -138,13 +138,13 @@ get:
oneOf: oneOf:
- type: string - type: string
title: postal_code title: postal_code
description: The customer's postal code. description: Filter by a postal code.
- type: array - type: array
description: The customer's postal code. description: Filter by postal codes.
items: items:
type: string type: string
title: postal_code title: postal_code
description: The postal code's details. description: A postal code.
- name: $and - name: $and
in: query in: query
description: >- description: >-
@@ -192,7 +192,7 @@ get:
schema: schema:
allOf: allOf:
- type: object - type: object
description: SUMMARY description: The paginated list of customer addresses.
required: required:
- limit - limit
- offset - offset
@@ -201,23 +201,25 @@ get:
limit: limit:
type: number type: number
title: limit title: limit
description: The customer's limit. description: The maximum number of items returned.
offset: offset:
type: number type: number
title: offset title: offset
description: The customer's offset. description: >-
The number of items skipped before retrieving the returned
items.
count: count:
type: number type: number
title: count title: count
description: The customer's count. description: The total number of items.
- type: object - type: object
description: SUMMARY description: The paginated list of customer addresses
required: required:
- addresses - addresses
properties: properties:
addresses: addresses:
type: array type: array
description: The customer's addresses. description: The customer addresses.
items: items:
$ref: ../components/schemas/AdminCustomerAddress.yaml $ref: ../components/schemas/AdminCustomerAddress.yaml
'400': '400':
www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses_{address_id}.yaml
+2 -2
View File
@@ -2,8 +2,8 @@ get:
operationId: GetCustomersIdAddressesAddress_id operationId: GetCustomersIdAddressesAddress_id
summary: List Addresses summary: List Addresses
description: >- description: >-
Retrieve a list of addresses in a customer. The addresses can be filtered by Retrieve a list of a customer's addresses. The addresses can be filtered by
fields like FILTER FIELDS. The addresses can also be paginated. fields like `company`. The addresses can also be paginated.
x-authenticated: true x-authenticated: true
parameters: parameters:
- name: id - name: id
www/apps/api-reference/specs/admin/paths/admin_draft-orders.yaml
+1103 -592
View File
File diff suppressed because it is too large. Load diff
www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}.yaml
+1 -1
View File
@@ -3,7 +3,7 @@ get:
summary: Get a Draft Order summary: Get a Draft Order
description: >- description: >-
Retrieve a draft order by its ID. You can expand the draft order's relations Retrieve a draft order by its ID. You can expand the draft order's relations
or select the fields that should be returned. or select the fields that should be returned using the query parameters.
x-authenticated: true x-authenticated: true
parameters: parameters:
- name: id - name: id
www/apps/api-reference/specs/admin/paths/admin_exchanges.yaml
+80 -122
View File
@@ -63,11 +63,11 @@ get:
with `-`. with `-`.
- name: deleted_at - name: deleted_at
in: query in: query
description: The exchange's deleted at. description: Filter by an exchange's deletion date.
required: false required: false
schema: schema:
type: object type: object
description: The exchange's deleted at. description: Filter by an exchange's deletion date.
properties: properties:
$and: $and:
type: array type: array
@@ -91,11 +91,11 @@ get:
title: $eq title: $eq
description: Filter by an exact match. description: Filter by an exact match.
- type: array - type: array
description: Filter by an exact match. description: Filter by multiple exact matches.
items: items:
type: string type: string
title: $eq title: $eq
description: Filter by an exact match. description: An exact match.
$ne: $ne:
type: string type: string
title: $ne title: $ne
@@ -106,21 +106,19 @@ get:
items: items:
type: string type: string
title: $in title: $in
description: Filter by values in this array. description: The value to match.
$nin: $nin:
type: array type: array
description: Filter by values not in this array. description: Filter by values not in this array.
items: items:
type: string type: string
title: $nin title: $nin
description: Filter by values not in this array. description: The value not to match.
$not: $not:
oneOf: oneOf:
- type: string - type: string
title: $not title: $not
description: >- description: Filter by values not matching this parameter.
Filter by values not matching the conditions in this
parameter.
- type: object - type: object
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
@@ -148,50 +146,46 @@ get:
title: $eq title: $eq
description: Filter by an exact match. description: Filter by an exact match.
- type: array - type: array
description: Filter by an exact match. description: Filter by multiple exact matches.
items: items:
type: string type: string
title: $eq title: $eq
description: Filter by an exact match. description: The value to match.
$ne: $ne:
type: string type: string
title: $ne title: $ne
description: Filter by values not equal to this parameter. description: Filter by values not matching this parameter.
$in: $in:
type: array type: array
description: Filter by values in this array. description: Filter by values in this array.
items: items:
type: string type: string
title: $in title: $in
description: Filter by values in this array. description: The value to match.
$nin: $nin:
type: array type: array
description: Filter by values not in this array. description: Filter by values not in this array.
items: items:
type: string type: string
title: $nin title: $nin
description: Filter by values not in this array. description: The value to not match
$not: $not:
oneOf: oneOf:
- type: string - type: string
title: $not title: $not
description: >- description: Filter by values not matching this parameter
Filter by values not matching the conditions in this
parameter.
- type: object - type: object
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
parameter. parameter.
- type: array - type: array
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the values of this
parameter. parameter.
items: items:
type: string type: string
title: $not title: $not
description: >- description: The values to not match.
Filter by values not matching the conditions in this
parameter.
$gt: $gt:
type: string type: string
title: $gt title: $gt
@@ -242,9 +236,7 @@ get:
items: items:
type: string type: string
title: $overlap title: $overlap
description: >- description: The value to match.
Filter arrays that have overlapping values with this
parameter.
$contains: $contains:
type: array type: array
description: >- description: >-
@@ -253,16 +245,14 @@ get:
items: items:
type: string type: string
title: $contains title: $contains
description: >- description: The values to match.
Filter arrays that contain some of the values of this
parameter.
$contained: $contained:
type: array type: array
description: Filter arrays that contain all values of this parameter. description: Filter arrays that contain all values of this parameter.
items: items:
type: string type: string
title: $contained title: $contained
description: Filter arrays that contain all values of this parameter. description: The values to match.
$exists: $exists:
type: boolean type: boolean
title: $exists title: $exists
@@ -270,15 +260,11 @@ get:
Filter by whether a value for this parameter exists (not Filter by whether a value for this parameter exists (not
`null`). `null`).
- type: array - type: array
description: >- description: Filter by values not matching those in this parameter.
Filter by values not matching the conditions in this
parameter.
items: items:
type: string type: string
title: $not title: $not
description: >- description: The values to not match.
Filter by values not matching the conditions in this
parameter.
$gt: $gt:
type: string type: string
title: $gt title: $gt
@@ -325,33 +311,33 @@ get:
items: items:
type: string type: string
title: $overlap title: $overlap
description: Filter arrays that have overlapping values with this parameter. description: The values to match.
$contains: $contains:
type: array type: array
description: Filter arrays that contain some of the values of this parameter. description: Filter arrays that contain some of the values of this parameter.
items: items:
type: string type: string
title: $contains title: $contains
description: Filter arrays that contain some of the values of this parameter. description: The values to match.
$contained: $contained:
type: array type: array
description: Filter arrays that contain all values of this parameter. description: Filter arrays that contain all values of this parameter.
items: items:
type: string type: string
title: $contained title: $contained
description: Filter arrays that contain all values of this parameter. description: The values to match.
$exists: $exists:
type: boolean type: boolean
title: $exists title: $exists
description: Filter by whether a value for this parameter exists (not `null`). description: Filter by whether a value for this parameter exists (not `null`).
- name: q - name: q
in: query in: query
description: The exchange's q. description: Search term to apply on an exchange's searchable properties.
required: false required: false
schema: schema:
type: string type: string
title: q title: q
description: The exchange's q. description: Search term to apply on an exchange's searchable properties.
- name: id - name: id
in: query in: query
required: false required: false
@@ -359,13 +345,13 @@ get:
oneOf: oneOf:
- type: string - type: string
title: id title: id
description: The exchange's ID. description: Filter by an exchange ID.
- type: array - type: array
description: The exchange's ID. description: Filter by exchange IDs.
items: items:
type: string type: string
title: id title: id
description: The id's ID. description: An exchange ID.
- name: order_id - name: order_id
in: query in: query
required: false required: false
@@ -373,13 +359,13 @@ get:
oneOf: oneOf:
- type: string - type: string
title: order_id title: order_id
description: The exchange's order id. description: Filter by an exchange's order ID.
- type: array - type: array
description: The exchange's order id. description: Filter by order IDs that the exchanges belong to.
items: items:
type: string type: string
title: order_id title: order_id
description: The order id's details. description: An order's ID.
- name: status - name: status
in: query in: query
required: false required: false
@@ -387,20 +373,20 @@ get:
oneOf: oneOf:
- type: string - type: string
title: status title: status
description: The exchange's status. description: Filter by an exchange's status.
- type: array - type: array
description: The exchange's status. description: Filter by exchange statuses.
items: items:
type: string type: string
title: status title: status
description: The status's details. description: An exchange status.
- name: created_at - name: created_at
in: query in: query
description: The exchange's created at. description: Filter by the exchange's creation date.
required: false required: false
schema: schema:
type: object type: object
description: The exchange's created at. description: Filter by the exchange's creation date.
properties: properties:
$and: $and:
type: array type: array
@@ -424,11 +410,11 @@ get:
title: $eq title: $eq
description: Filter by an exact match. description: Filter by an exact match.
- type: array - type: array
description: Filter by an exact match. description: Filter by multiple exact matches.
items: items:
type: string type: string
title: $eq title: $eq
description: Filter by an exact match. description: An exact match.
$ne: $ne:
type: string type: string
title: $ne title: $ne
@@ -439,21 +425,19 @@ get:
items: items:
type: string type: string
title: $in title: $in
description: Filter by values in this array. description: The value to match.
$nin: $nin:
type: array type: array
description: Filter by values not in this array. description: Filter by values not in this array.
items: items:
type: string type: string
title: $nin title: $nin
description: Filter by values not in this array. description: The value not to match.
$not: $not:
oneOf: oneOf:
- type: string - type: string
title: $not title: $not
description: >- description: Filter by values not matching this parameter.
Filter by values not matching the conditions in this
parameter.
- type: object - type: object
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
@@ -481,50 +465,46 @@ get:
title: $eq title: $eq
description: Filter by an exact match. description: Filter by an exact match.
- type: array - type: array
description: Filter by an exact match. description: Filter by multiple exact matches.
items: items:
type: string type: string
title: $eq title: $eq
description: Filter by an exact match. description: The value to match.
$ne: $ne:
type: string type: string
title: $ne title: $ne
description: Filter by values not equal to this parameter. description: Filter by values not matching this parameter.
$in: $in:
type: array type: array
description: Filter by values in this array. description: Filter by values in this array.
items: items:
type: string type: string
title: $in title: $in
description: Filter by values in this array. description: The value to match.
$nin: $nin:
type: array type: array
description: Filter by values not in this array. description: Filter by values not in this array.
items: items:
type: string type: string
title: $nin title: $nin
description: Filter by values not in this array. description: The value to not match
$not: $not:
oneOf: oneOf:
- type: string - type: string
title: $not title: $not
description: >- description: Filter by values not matching this parameter
Filter by values not matching the conditions in this
parameter.
- type: object - type: object
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
parameter. parameter.
- type: array - type: array
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the values of this
parameter. parameter.
items: items:
type: string type: string
title: $not title: $not
description: >- description: The values to not match.
Filter by values not matching the conditions in this
parameter.
$gt: $gt:
type: string type: string
title: $gt title: $gt
@@ -575,9 +555,7 @@ get:
items: items:
type: string type: string
title: $overlap title: $overlap
description: >- description: The value to match.
Filter arrays that have overlapping values with this
parameter.
$contains: $contains:
type: array type: array
description: >- description: >-
@@ -586,16 +564,14 @@ get:
items: items:
type: string type: string
title: $contains title: $contains
description: >- description: The values to match.
Filter arrays that contain some of the values of this
parameter.
$contained: $contained:
type: array type: array
description: Filter arrays that contain all values of this parameter. description: Filter arrays that contain all values of this parameter.
items: items:
type: string type: string
title: $contained title: $contained
description: Filter arrays that contain all values of this parameter. description: The values to match.
$exists: $exists:
type: boolean type: boolean
title: $exists title: $exists
@@ -603,15 +579,11 @@ get:
Filter by whether a value for this parameter exists (not Filter by whether a value for this parameter exists (not
`null`). `null`).
- type: array - type: array
description: >- description: Filter by values not matching those in this parameter.
Filter by values not matching the conditions in this
parameter.
items: items:
type: string type: string
title: $not title: $not
description: >- description: The values to not match.
Filter by values not matching the conditions in this
parameter.
$gt: $gt:
type: string type: string
title: $gt title: $gt
@@ -658,32 +630,32 @@ get:
items: items:
type: string type: string
title: $overlap title: $overlap
description: Filter arrays that have overlapping values with this parameter. description: The values to match.
$contains: $contains:
type: array type: array
description: Filter arrays that contain some of the values of this parameter. description: Filter arrays that contain some of the values of this parameter.
items: items:
type: string type: string
title: $contains title: $contains
description: Filter arrays that contain some of the values of this parameter. description: The values to match.
$contained: $contained:
type: array type: array
description: Filter arrays that contain all values of this parameter. description: Filter arrays that contain all values of this parameter.
items: items:
type: string type: string
title: $contained title: $contained
description: Filter arrays that contain all values of this parameter. description: The values to match.
$exists: $exists:
type: boolean type: boolean
title: $exists title: $exists
description: Filter by whether a value for this parameter exists (not `null`). description: Filter by whether a value for this parameter exists (not `null`).
- name: updated_at - name: updated_at
in: query in: query
description: The exchange's updated at. description: Filter by the exchange's update date.
required: false required: false
schema: schema:
type: object type: object
description: The exchange's updated at. description: Filter by the exchange's update date.
properties: properties:
$and: $and:
type: array type: array
@@ -707,11 +679,11 @@ get:
title: $eq title: $eq
description: Filter by an exact match. description: Filter by an exact match.
- type: array - type: array
description: Filter by an exact match. description: Filter by multiple exact matches.
items: items:
type: string type: string
title: $eq title: $eq
description: Filter by an exact match. description: An exact match.
$ne: $ne:
type: string type: string
title: $ne title: $ne
@@ -722,21 +694,19 @@ get:
items: items:
type: string type: string
title: $in title: $in
description: Filter by values in this array. description: The value to match.
$nin: $nin:
type: array type: array
description: Filter by values not in this array. description: Filter by values not in this array.
items: items:
type: string type: string
title: $nin title: $nin
description: Filter by values not in this array. description: The value not to match.
$not: $not:
oneOf: oneOf:
- type: string - type: string
title: $not title: $not
description: >- description: Filter by values not matching this parameter.
Filter by values not matching the conditions in this
parameter.
- type: object - type: object
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
@@ -764,50 +734,46 @@ get:
title: $eq title: $eq
description: Filter by an exact match. description: Filter by an exact match.
- type: array - type: array
description: Filter by an exact match. description: Filter by multiple exact matches.
items: items:
type: string type: string
title: $eq title: $eq
description: Filter by an exact match. description: The value to match.
$ne: $ne:
type: string type: string
title: $ne title: $ne
description: Filter by values not equal to this parameter. description: Filter by values not matching this parameter.
$in: $in:
type: array type: array
description: Filter by values in this array. description: Filter by values in this array.
items: items:
type: string type: string
title: $in title: $in
description: Filter by values in this array. description: The value to match.
$nin: $nin:
type: array type: array
description: Filter by values not in this array. description: Filter by values not in this array.
items: items:
type: string type: string
title: $nin title: $nin
description: Filter by values not in this array. description: The value to not match
$not: $not:
oneOf: oneOf:
- type: string - type: string
title: $not title: $not
description: >- description: Filter by values not matching this parameter
Filter by values not matching the conditions in this
parameter.
- type: object - type: object
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
parameter. parameter.
- type: array - type: array
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the values of this
parameter. parameter.
items: items:
type: string type: string
title: $not title: $not
description: >- description: The values to not match.
Filter by values not matching the conditions in this
parameter.
$gt: $gt:
type: string type: string
title: $gt title: $gt
@@ -858,9 +824,7 @@ get:
items: items:
type: string type: string
title: $overlap title: $overlap
description: >- description: The value to match.
Filter arrays that have overlapping values with this
parameter.
$contains: $contains:
type: array type: array
description: >- description: >-
@@ -869,16 +833,14 @@ get:
items: items:
type: string type: string
title: $contains title: $contains
description: >- description: The values to match.
Filter arrays that contain some of the values of this
parameter.
$contained: $contained:
type: array type: array
description: Filter arrays that contain all values of this parameter. description: Filter arrays that contain all values of this parameter.
items: items:
type: string type: string
title: $contained title: $contained
description: Filter arrays that contain all values of this parameter. description: The values to match.
$exists: $exists:
type: boolean type: boolean
title: $exists title: $exists
@@ -886,15 +848,11 @@ get:
Filter by whether a value for this parameter exists (not Filter by whether a value for this parameter exists (not
`null`). `null`).
- type: array - type: array
description: >- description: Filter by values not matching those in this parameter.
Filter by values not matching the conditions in this
parameter.
items: items:
type: string type: string
title: $not title: $not
description: >- description: The values to not match.
Filter by values not matching the conditions in this
parameter.
$gt: $gt:
type: string type: string
title: $gt title: $gt
@@ -941,21 +899,21 @@ get:
items: items:
type: string type: string
title: $overlap title: $overlap
description: Filter arrays that have overlapping values with this parameter. description: The values to match.
$contains: $contains:
type: array type: array
description: Filter arrays that contain some of the values of this parameter. description: Filter arrays that contain some of the values of this parameter.
items: items:
type: string type: string
title: $contains title: $contains
description: Filter arrays that contain some of the values of this parameter. description: The values to match.
$contained: $contained:
type: array type: array
description: Filter arrays that contain all values of this parameter. description: Filter arrays that contain all values of this parameter.
items: items:
type: string type: string
title: $contained title: $contained
description: Filter arrays that contain all values of this parameter. description: The values to match.
$exists: $exists:
type: boolean type: boolean
title: $exists title: $exists
www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}.yaml
+3 -3
View File
@@ -1,9 +1,9 @@
get: get:
operationId: GetExchangesId operationId: GetExchangesId
summary: Get a Exchange summary: Get an Exchange
description: >- description: >-
Retrieve a exchange by its ID. You can expand the exchange's relations or Retrieve an exchange by its ID. You can expand the exchange's relations or
select the fields that should be returned. select the fields that should be returned using query parameters.
x-authenticated: true x-authenticated: true
parameters: parameters:
- name: id - name: id
www/apps/api-reference/specs/admin/paths/admin_fulfillment-providers.yaml
+10 -10
View File
@@ -69,29 +69,29 @@ get:
oneOf: oneOf:
- type: string - type: string
title: id title: id
description: The fulfillment provider's ID. description: Filter by a fulfillment provider's ID.
- type: array - type: array
description: The fulfillment provider's ID. description: Filter by fulfillment provider IDs.
items: items:
type: string type: string
title: id title: id
description: The id's ID. description: A fulfillment provider ID.
- name: is_enabled - name: is_enabled
in: query in: query
description: The fulfillment provider's is enabled. description: Filter by whether the fulfillment provider is enabled.
required: false required: false
schema: schema:
type: boolean type: boolean
title: is_enabled title: is_enabled
description: The fulfillment provider's is enabled. description: Filter by whether the fulfillment provider is enabled.
- name: q - name: q
in: query in: query
description: The fulfillment provider's q. description: Search term to filter a fulfillment provider's searchable properties.
required: false required: false
schema: schema:
type: string type: string
title: q title: q
description: The fulfillment provider's q. description: Search term to filter a fulfillment provider's searchable properties.
- name: stock_location_id - name: stock_location_id
in: query in: query
required: false required: false
@@ -99,13 +99,13 @@ get:
oneOf: oneOf:
- type: string - type: string
title: stock_location_id title: stock_location_id
description: The fulfillment provider's stock location id. description: Filter by associated stock location's ID.
- type: array - type: array
description: The fulfillment provider's stock location id. description: Filter by associated stock location IDs.
items: items:
type: string type: string
title: stock_location_id title: stock_location_id
description: The stock location id's details. description: A stock location's ID.
security: security:
- api_token: [] - api_token: []
- cookie_auth: [] - cookie_auth: []
www/apps/api-reference/specs/admin/paths/admin_fulfillment-sets_{id}_service-zones_{zone_id}.yaml
+4 -6
View File
@@ -1,10 +1,8 @@
get: get:
operationId: GetFulfillmentSetsIdServiceZonesZone_id operationId: GetFulfillmentSetsIdServiceZonesZone_id
summary: List Service Zones summary: Get a Service Zone in a Fulfillment Set
description: >- x-sidebar-summary: Get a Service Zone
Retrieve a list of service zones in a fulfillment set. The service zones can description: Retrieve a service zone that belongs to a fulfillment set. be paginated.
be filtered by fields like FILTER FIELDS. The service zones can also be
paginated.
x-authenticated: true x-authenticated: true
parameters: parameters:
- name: id - name: id
@@ -15,7 +13,7 @@ get:
type: string type: string
- name: zone_id - name: zone_id
in: path in: path
description: The fulfillment set's zone id. description: The service zone's ID.
required: true required: true
schema: schema:
type: string type: string
www/apps/api-reference/specs/admin/paths/admin_inventory-items.yaml
+221 -115
View File
@@ -163,151 +163,253 @@ get:
description: The inventory item's requires shipping. description: The inventory item's requires shipping.
- name: weight - name: weight
in: query in: query
description: The inventory item's weight. description: Filter the inventory item's weight.
required: false required: false
schema: schema:
description: The inventory item's weight. description: Filter the inventory item's weight.
required:
- $eq
- $ne
- $in
- $nin
- $like
- $ilike
- $re
- $contains
- $gt
- $gte
- $lt
- $lte
properties: properties:
$eq: {} $eq:
$ne: {} type: string
$in: {} description: Filter by an exact match.
$nin: {} $ne:
$like: {} type: string
$ilike: {} description: Filter by values not matching this parameter.
$re: {} $in:
$contains: {} type: array
$gt: {} description: Filter by values in this array's items.
$gte: {} items:
$lt: {} type: string
$lte: {} $nin:
type: array
description: Filter by values not in this array's items.
items:
type: string
$like:
type: string
description: Apply a `like` filter. Useful for strings only.
$ilike:
type: string
description: Apply a case-insensitive `like` filter. Useful for strings only.
$re:
type: string
description: Apply a regex filter. Useful for strings only.
$contains:
type: array
description: Filter arrays that contain some of the values of this parameter.
items:
type: string
$gt:
type: string
description: >-
Filter by values greater than this parameter. Useful for numbers
and dates only.
$gte:
type: string
description: >-
Filter by values greater than or equal to this parameter. Useful
for numbers and dates only.
$lt:
type: string
description: >-
Filter by values less than this parameter. Useful for numbers and
dates only.
$lte:
type: string
description: >-
Filter by values less than or equal to this parameter. Useful for
numbers and dates only.
- name: length - name: length
in: query in: query
description: The inventory item's length. description: Filter the inventory item's length.
required: false required: false
schema: schema:
description: The inventory item's length. description: Filter the inventory item's length.
required:
- $eq
- $ne
- $in
- $nin
- $like
- $ilike
- $re
- $contains
- $gt
- $gte
- $lt
- $lte
properties: properties:
$eq: {} $eq:
$ne: {} type: string
$in: {} description: Filter by an exact match.
$nin: {} $ne:
$like: {} type: string
$ilike: {} description: Filter by values not matching this parameter.
$re: {} $in:
$contains: {} type: array
$gt: {} description: Filter by values in this array's items.
$gte: {} items:
$lt: {} type: string
$lte: {} $nin:
type: array
description: Filter by values not in this array's items.
items:
type: string
$like:
type: string
description: Apply a `like` filter. Useful for strings only.
$ilike:
type: string
description: Apply a case-insensitive `like` filter. Useful for strings only.
$re:
type: string
description: Apply a regex filter. Useful for strings only.
$contains:
type: array
description: Filter arrays that contain some of the values of this parameter.
items:
type: string
$gt:
type: string
description: >-
Filter by values greater than this parameter. Useful for numbers
and dates only.
$gte:
type: string
description: >-
Filter by values greater than or equal to this parameter. Useful
for numbers and dates only.
$lt:
type: string
description: >-
Filter by values less than this parameter. Useful for numbers and
dates only.
$lte:
type: string
description: >-
Filter by values less than or equal to this parameter. Useful for
numbers and dates only.
- name: height - name: height
in: query in: query
description: The inventory item's height. description: Filter by the inventory item's height.
required: false required: false
schema: schema:
description: The inventory item's height. description: Filter by the inventory item's height.
required:
- $eq
- $ne
- $in
- $nin
- $like
- $ilike
- $re
- $contains
- $gt
- $gte
- $lt
- $lte
properties: properties:
$eq: {} $eq:
$ne: {} type: string
$in: {} description: Filter by an exact match.
$nin: {} $ne:
$like: {} type: string
$ilike: {} description: Filter by values not matching this parameter.
$re: {} $in:
$contains: {} type: array
$gt: {} description: Filter by values in this array's items.
$gte: {} items:
$lt: {} type: string
$lte: {} $nin:
type: array
description: Filter by values not in this array's items.
items:
type: string
$like:
type: string
description: Apply a `like` filter. Useful for strings only.
$ilike:
type: string
description: Apply a case-insensitive `like` filter. Useful for strings only.
$re:
type: string
description: Apply a regex filter. Useful for strings only.
$contains:
type: array
description: Filter arrays that contain some of the values of this parameter.
items:
type: string
$gt:
type: string
description: >-
Filter by values greater than this parameter. Useful for numbers
and dates only.
$gte:
type: string
description: >-
Filter by values greater than or equal to this parameter. Useful
for numbers and dates only.
$lt:
type: string
description: >-
Filter by values less than this parameter. Useful for numbers and
dates only.
$lte:
type: string
description: >-
Filter by values less than or equal to this parameter. Useful for
numbers and dates only.
- name: width - name: width
in: query in: query
description: The inventory item's width. description: Filter by the inventory item's width.
required: false required: false
schema: schema:
description: The inventory item's width. description: Filter by the inventory item's width.
required:
- $eq
- $ne
- $in
- $nin
- $like
- $ilike
- $re
- $contains
- $gt
- $gte
- $lt
- $lte
properties: properties:
$eq: {} $eq:
$ne: {} type: string
$in: {} description: Filter by an exact match.
$nin: {} $ne:
$like: {} type: string
$ilike: {} description: Filter by values not matching this parameter.
$re: {} $in:
$contains: {} type: array
$gt: {} description: Filter by values in this array's items.
$gte: {} items:
$lt: {} type: string
$lte: {} $nin:
type: array
description: Filter by values not in this array's items.
items:
type: string
$like:
type: string
description: Apply a `like` filter. Useful for strings only.
$ilike:
type: string
description: Apply a case-insensitive `like` filter. Useful for strings only.
$re:
type: string
description: Apply a regex filter. Useful for strings only.
$contains:
type: array
description: Filter arrays that contain some of the values of this parameter.
items:
type: string
$gt:
type: string
description: >-
Filter by values greater than this parameter. Useful for numbers
and dates only.
$gte:
type: string
description: >-
Filter by values greater than or equal to this parameter. Useful
for numbers and dates only.
$lt:
type: string
description: >-
Filter by values less than this parameter. Useful for numbers and
dates only.
$lte:
type: string
description: >-
Filter by values less than or equal to this parameter. Useful for
numbers and dates only.
- name: location_levels - name: location_levels
in: query in: query
description: The inventory item's location levels. description: Filter by the inventory item's associated location IDs.
required: false required: false
schema: schema:
type: object type: object
description: The inventory item's location levels. description: Filter by the inventory item's associated location IDs.
properties: properties:
location_id: location_id:
oneOf: oneOf:
- type: string - type: string
title: location_id title: location_id
description: The location level's location id. description: The associated location's ID.
- type: array - type: array
description: The location level's location id. description: >-
The location IDs to retrieve inventory items associated with
them.
items: items:
type: string type: string
title: location_id title: location_id
description: The location id's details. description: A location's ID.
required: required:
- location_id - location_id
- name: $and - name: $and
@@ -315,7 +417,9 @@ get:
required: false required: false
schema: schema:
type: array type: array
description: The inventory item's $and. description: >-
Join query parameters with an AND condition. Each object's content is
the same type as the expected query parameters.
items: items:
type: object type: object
title: $and title: $and
@@ -324,7 +428,9 @@ get:
required: false required: false
schema: schema:
type: array type: array
description: The inventory item's $or. description: >-
Join query parameters with an OR condition. Each object's content is
the same type as the expected query parameters.
items: items:
type: object type: object
title: $or title: $or
www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels.yaml
+13 -9
View File
@@ -1,10 +1,10 @@
get: get:
operationId: GetInventoryItemsIdLocationLevels operationId: GetInventoryItemsIdLocationLevels
summary: List Location Levels summary: List Inventory Levels
description: >- description: >-
Retrieve a list of location levels in a inventory item. The location levels Retrieve a list of inventory levels associated with an inventory item. The
can be filtered by fields like FILTER FIELDS. The location levels can also inventory levels can be filtered by fields like `location_id`. The inventory
be paginated. levels can also be paginated.
x-authenticated: true x-authenticated: true
parameters: parameters:
- name: id - name: id
@@ -75,19 +75,21 @@ get:
oneOf: oneOf:
- type: string - type: string
title: location_id title: location_id
description: The inventory item's location id. description: Filter by an associated location's ID.
- type: array - type: array
description: The inventory item's location id. description: Filter by associated location IDs.
items: items:
type: string type: string
title: location_id title: location_id
description: The location id's details. description: An associated location ID.
- name: $and - name: $and
in: query in: query
required: false required: false
schema: schema:
type: array type: array
description: The inventory item's $and. description: >-
Join query parameters with an AND condition. Each object's content is
the same type as the expected query parameters.
items: items:
type: object type: object
title: $and title: $and
@@ -96,7 +98,9 @@ get:
required: false required: false
schema: schema:
type: array type: array
description: The inventory item's $or. description: >-
Join query parameters with an OR condition. Each object's content is
the same type as the expected query parameters.
items: items:
type: object type: object
title: $or title: $or
www/apps/api-reference/specs/admin/paths/admin_invites.yaml
+26 -454
View File
@@ -63,12 +63,12 @@ get:
with `-`. with `-`.
- name: q - name: q
in: query in: query
description: The invite's q. description: Search term to apply on an invite's searchable properties.
required: false required: false
schema: schema:
type: string type: string
title: q title: q
description: The invite's q. description: Search term to apply on an invite's searchable properties.
- name: id - name: id
in: query in: query
required: false required: false
@@ -76,13 +76,13 @@ get:
oneOf: oneOf:
- type: string - type: string
title: id title: id
description: The invite's ID. description: Filter by an invite's ID.
- type: array - type: array
description: The invite's ID. description: Filter by invite IDs.
items: items:
type: string type: string
title: id title: id
description: The id's ID. description: An invite's ID.
- name: email - name: email
in: query in: query
required: false required: false
@@ -90,22 +90,22 @@ get:
oneOf: oneOf:
- type: string - type: string
title: email title: email
description: The invite's email. description: Filter by an invite's email.
format: email format: email
- type: array - type: array
description: The invite's email. description: Filter by invite emails.
items: items:
type: string type: string
title: email title: email
description: The email's details. description: An email.
format: email format: email
- name: created_at - name: created_at
in: query in: query
description: The invite's created at. description: Filter by the invite's creation date.
required: false required: false
schema: schema:
type: object type: object
description: The invite's created at. description: Filter by the invite's creation date.
properties: properties:
$and: $and:
type: array type: array
@@ -163,150 +163,6 @@ get:
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
parameter. parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array - type: array
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
@@ -384,11 +240,11 @@ get:
description: Filter by whether a value for this parameter exists (not `null`). description: Filter by whether a value for this parameter exists (not `null`).
- name: updated_at - name: updated_at
in: query in: query
description: The invite's updated at. description: Filter by the invite's update date.
required: false required: false
schema: schema:
type: object type: object
description: The invite's updated at. description: Filter by the invite's update date.
properties: properties:
$and: $and:
type: array type: array
@@ -446,150 +302,6 @@ get:
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
parameter. parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array - type: array
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
@@ -667,11 +379,11 @@ get:
description: Filter by whether a value for this parameter exists (not `null`). description: Filter by whether a value for this parameter exists (not `null`).
- name: deleted_at - name: deleted_at
in: query in: query
description: The invite's deleted at. description: Filter by the invite's deletion date.
required: false required: false
schema: schema:
type: object type: object
description: The invite's deleted at. description: Filter by the invite's deletion date.
properties: properties:
$and: $and:
type: array type: array
@@ -729,150 +441,6 @@ get:
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
parameter. parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array - type: array
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
@@ -953,7 +521,9 @@ get:
required: false required: false
schema: schema:
type: array type: array
description: The invite's $and. description: >-
Join query parameters with an AND condition. Each object's content is
the same type as the expected query parameters.
items: items:
type: object type: object
title: $and title: $and
@@ -962,7 +532,9 @@ get:
required: false required: false
schema: schema:
type: array type: array
description: The invite's $or. description: >-
Join query parameters with an OR condition. Each object's content is
the same type as the expected query parameters.
items: items:
type: object type: object
title: $or title: $or
@@ -981,7 +553,7 @@ get:
schema: schema:
allOf: allOf:
- type: object - type: object
description: SUMMARY description: The paginated list of invites.
required: required:
- limit - limit
- offset - offset
@@ -990,23 +562,23 @@ get:
limit: limit:
type: number type: number
title: limit title: limit
description: The invite's limit. description: The maximum number of items retrieved.
offset: offset:
type: number type: number
title: offset title: offset
description: The invite's offset. description: The number of items skipped before the returned items.
count: count:
type: number type: number
title: count title: count
description: The invite's count. description: The total number of items.
- type: object - type: object
description: SUMMARY description: The paginated list of invites.
required: required:
- invites - invites
properties: properties:
invites: invites:
type: array type: array
description: The invite's invites. description: The list of invites.
items: items:
$ref: ../components/schemas/AdminInvite.yaml $ref: ../components/schemas/AdminInvite.yaml
'400': '400':
www/apps/api-reference/specs/admin/paths/admin_invites_{id}.yaml
+3 -3
View File
@@ -1,9 +1,9 @@
get: get:
operationId: GetInvitesId operationId: GetInvitesId
summary: Get a Invite summary: Get an Invite
description: >- description: >-
Retrieve a invite by its ID. You can expand the invite's relations or select Retrieve an invite by its ID. You can expand the invite's relations or
the fields that should be returned. select the fields that should be returned.
x-authenticated: false x-authenticated: false
parameters: parameters:
- name: id - name: id
www/apps/api-reference/specs/admin/paths/admin_notifications.yaml
+16 -10
View File
@@ -63,12 +63,12 @@ get:
with `-`. with `-`.
- name: q - name: q
in: query in: query
description: The notification's q. description: Search term to apply on the notification's searchable properties.
required: false required: false
schema: schema:
type: string type: string
title: q title: q
description: The notification's q. description: Search term to apply on the notification's searchable properties.
- name: id - name: id
in: query in: query
required: false required: false
@@ -76,13 +76,13 @@ get:
oneOf: oneOf:
- type: string - type: string
title: id title: id
description: The notification's ID. description: Filter by a notification ID.
- type: array - type: array
description: The notification's ID. description: Filter by notification IDs.
items: items:
type: string type: string
title: id title: id
description: The id's ID. description: A notification ID.
- name: channel - name: channel
in: query in: query
required: false required: false
@@ -90,19 +90,23 @@ get:
oneOf: oneOf:
- type: string - type: string
title: channel title: channel
description: The notification's channel. description: Filter by a notification channel.
example: email
- type: array - type: array
description: The notification's channel. description: Filter by notification channels.
items: items:
type: string type: string
title: channel title: channel
description: The channel's details. description: A notification channel.
example: email
- name: $and - name: $and
in: query in: query
required: false required: false
schema: schema:
type: array type: array
description: The notification's $and. description: >-
Join query parameters with an AND condition. Each object's content is
the same type as the expected query parameters.
items: items:
type: object type: object
title: $and title: $and
@@ -111,7 +115,9 @@ get:
required: false required: false
schema: schema:
type: array type: array
description: The notification's $or. description: >-
Join query parameters with an OR condition. Each object's content is
the same type as the expected query parameters.
items: items:
type: object type: object
title: $or title: $or
www/apps/api-reference/specs/admin/paths/admin_orders.yaml
+63 -598
View File
@@ -68,27 +68,55 @@ get:
oneOf: oneOf:
- type: string - type: string
title: id title: id
description: The order's ID. description: Filter by an order ID.
- type: array - type: array
description: The order's ID. description: Filter by order IDs.
items: items:
type: string type: string
title: id title: id
description: The id's ID. description: An order's ID.
- name: name - name: status
in: query in: query
required: false required: false
schema: schema:
oneOf: oneOf:
- type: string - type: string
title: name title: status
description: The order's name. description: Filter by the order's status.
- type: array - type: array
description: The order's name. description: Filter by order statuses.
items: items:
type: string type: string
title: name title: status
description: The name's details. description: An order's status.
- name: $and
in: query
description: >-
Join query parameters with an AND condition. Each object's content is
the same type as the expected query parameters.
required: false
schema:
type: array
description: >-
Join query parameters with an AND condition. Each object's content is
the same type as the expected query parameters.
items:
type: object
title: $and
- name: $or
in: query
description: >-
Join query parameters with an OR condition. Each object's content is the
same type as the expected query parameters.
required: false
schema:
type: array
description: >-
Join query parameters with an OR condition. Each object's content is
the same type as the expected query parameters.
items:
type: object
title: $or
- name: sales_channel_id - name: sales_channel_id
in: query in: query
description: The order's sales channel id. description: The order's sales channel id.
@@ -109,8 +137,16 @@ get:
description: The order's fulfillment status. description: The order's fulfillment status.
items: items:
type: string type: string
title: fulfillment_status
description: The fulfillment status's details. description: The fulfillment status's details.
enum:
- canceled
- not_fulfilled
- partially_fulfilled
- fulfilled
- partially_shipped
- shipped
- partially_delivered
- delivered
- name: payment_status - name: payment_status
in: query in: query
description: The order's payment status. description: The order's payment status.
@@ -120,8 +156,18 @@ get:
description: The order's payment status. description: The order's payment status.
items: items:
type: string type: string
title: payment_status
description: The payment status's details. description: The payment status's details.
enum:
- canceled
- not_paid
- awaiting
- authorized
- partially_authorized
- captured
- partially_captured
- partially_refunded
- refunded
- requires_action
- name: region_id - name: region_id
in: query in: query
description: The order's region id. description: The order's region id.
@@ -707,587 +753,6 @@ get:
type: boolean type: boolean
title: $exists title: $exists
description: Filter by whether a value for this parameter exists (not `null`). description: Filter by whether a value for this parameter exists (not `null`).
- name: status
in: query
required: false
schema:
oneOf:
- type: string
title: status
description: The order's status.
- type: array
description: The order's status.
items:
type: string
title: status
description: The status's details.
- type: object
description: The order's status.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
oneOf:
- type: string
title: $ne
description: Filter by values not equal to this parameter.
- type: array
description: Filter by values not equal to this parameter.
items:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
oneOf:
- type: string
title: $in
description: Filter by values in this array.
- type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
oneOf:
- type: string
title: $nin
description: Filter by values not in this array.
- type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each
object's content is the same type as the expected
query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each
object's content is the same type as the expected
query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in
this parameter.
- type: object
description: >-
Filter by values not matching the conditions in
this parameter.
- type: array
description: >-
Filter by values not matching the conditions in
this parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in
this parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful
for numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this
parameter. Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for
strings only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of
this parameter.
$contained:
type: array
description: >-
Filter arrays that contain all values of this
parameter.
items:
type: string
title: $contained
description: >-
Filter arrays that contain all values of this
parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists
(not `null`).
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition.
Each object's content is the same type as the
expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each
object's content is the same type as the
expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions
in this parameter.
- type: object
description: >-
Filter by values not matching the conditions
in this parameter.
- type: array
description: >-
Filter by values not matching the conditions
in this parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the
conditions in this parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter.
Useful for numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this
parameter. Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter.
Useful for numbers and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this
parameter. Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful
for strings only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with
this parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values
with this parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of
this parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values
of this parameter.
$contained:
type: array
description: >-
Filter arrays that contain all values of this
parameter.
items:
type: string
title: $contained
description: >-
Filter arrays that contain all values of this
parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter
exists (not `null`).
$gt:
oneOf:
- type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
- type: array
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
items:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
oneOf:
- type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
- type: array
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
items:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this
parameter. Useful for numbers and dates only.
$lt:
oneOf:
- type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
- type: array
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
items:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
$lte:
oneOf:
- type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
- type: array
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
items:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- name: $and
in: query
description: >-
Join query parameters with an AND condition. Each object's content is
the same type as the expected query parameters.
required: false
schema:
type: array
description: >-
Join query parameters with an AND condition. Each object's content is
the same type as the expected query parameters.
items:
type: object
title: $and
- name: $or
in: query
description: >-
Join query parameters with an OR condition. Each object's content is the
same type as the expected query parameters.
required: false
schema:
type: array
description: >-
Join query parameters with an OR condition. Each object's content is
the same type as the expected query parameters.
items:
type: object
title: $or
security: security:
- api_token: [] - api_token: []
- cookie_auth: [] - cookie_auth: []
@@ -1307,7 +772,7 @@ get:
schema: schema:
allOf: allOf:
- type: object - type: object
description: SUMMARY description: The paginated list of orders
required: required:
- limit - limit
- offset - offset
@@ -1316,23 +781,23 @@ get:
limit: limit:
type: number type: number
title: limit title: limit
description: The order's limit. description: The maximum number of items returned.
offset: offset:
type: number type: number
title: offset title: offset
description: The order's offset. description: The number of items skipped before the returned items.
count: count:
type: number type: number
title: count title: count
description: The order's count. description: The total count of items.
- type: object - type: object
description: SUMMARY description: The paginated list of orders.
required: required:
- orders - orders
properties: properties:
orders: orders:
type: array type: array
description: The order's orders. description: The list of orders.
items: items:
$ref: ../components/schemas/AdminOrder.yaml $ref: ../components/schemas/AdminOrder.yaml
'400': '400':
www/apps/api-reference/specs/admin/paths/admin_orders_{id}.yaml
+2 -2
View File
@@ -1,8 +1,8 @@
get: get:
operationId: GetOrdersId operationId: GetOrdersId
summary: Get a Order summary: Get an Order
description: >- description: >-
Retrieve a order by its ID. You can expand the order's relations or select Retrieve an order by its ID. You can expand the order's relations or select
the fields that should be returned. the fields that should be returned.
x-authenticated: true x-authenticated: true
parameters: parameters:
www/apps/api-reference/specs/admin/paths/admin_orders_{id}_changes.yaml
+9 -4
View File
@@ -1,9 +1,14 @@
get: get:
operationId: GetOrdersIdChanges operationId: GetOrdersIdChanges
summary: List Changes summary: List Changes on an Order
description: >- x-sidebar-summary: List Changes
Retrieve a list of changes in a order. The changes can be filtered by fields description: >
like FILTER FIELDS. The changes can also be paginated. Retrieve a list of changes made on an order, including returns, exchanges,
etc...
The changes can be filtered by fields like FILTER FIELDS. The changes can
also be paginated.
x-authenticated: true x-authenticated: true
parameters: parameters:
- name: id - name: id
www/apps/api-reference/specs/admin/paths/admin_orders_{id}_preview.yaml
+2 -4
View File
@@ -1,9 +1,7 @@
get: get:
operationId: GetOrdersIdPreview operationId: GetOrdersIdPreview
summary: List Previews summary: Get Preview
description: >- description: Retrieve a preview of an order using its associated change, such as an edit.
Retrieve a list of previews in a order. The previews can be filtered by
fields like FILTER FIELDS. The previews can also be paginated.
x-authenticated: true x-authenticated: true
parameters: parameters:
- name: id - name: id
www/apps/api-reference/specs/admin/paths/admin_payments.yaml
+30 -454
View File
@@ -63,12 +63,12 @@ get:
with `-`. with `-`.
- name: q - name: q
in: query in: query
description: The payment's q. description: Search term to filter the payment's searchable properties.
required: false required: false
schema: schema:
type: string type: string
title: q title: q
description: The payment's q. description: Search term to filter the payment's searchable properties.
- name: id - name: id
in: query in: query
required: false required: false
@@ -76,13 +76,13 @@ get:
oneOf: oneOf:
- type: string - type: string
title: id title: id
description: The payment's ID. description: Filter by a payment ID.
- type: array - type: array
description: The payment's ID. description: Filter by payment IDs.
items: items:
type: string type: string
title: id title: id
description: The id's ID. description: A payment ID.
- name: payment_session_id - name: payment_session_id
in: query in: query
required: false required: false
@@ -90,20 +90,24 @@ get:
oneOf: oneOf:
- type: string - type: string
title: payment_session_id title: payment_session_id
description: The payment's payment session id. description: >-
Filter by a payment session ID to retrieve its associated
payments.
- type: array - type: array
description: The payment's payment session id. description: >-
Filter by payment session IDs to retrieve their associated
payments.
items: items:
type: string type: string
title: payment_session_id title: payment_session_id
description: The payment session id's details. description: A payment session's ID.
- name: created_at - name: created_at
in: query in: query
description: The payment's created at. description: Filter by the payment's creation date.
required: false required: false
schema: schema:
type: object type: object
description: The payment's created at. description: Filter by the payment's creation date.
properties: properties:
$and: $and:
type: array type: array
@@ -161,150 +165,6 @@ get:
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
parameter. parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array - type: array
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
@@ -382,11 +242,11 @@ get:
description: Filter by whether a value for this parameter exists (not `null`). description: Filter by whether a value for this parameter exists (not `null`).
- name: updated_at - name: updated_at
in: query in: query
description: The payment's updated at. description: Filter by the payment's update date.
required: false required: false
schema: schema:
type: object type: object
description: The payment's updated at. description: Filter by the payment's update date.
properties: properties:
$and: $and:
type: array type: array
@@ -444,150 +304,6 @@ get:
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
parameter. parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array - type: array
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
@@ -665,11 +381,11 @@ get:
description: Filter by whether a value for this parameter exists (not `null`). description: Filter by whether a value for this parameter exists (not `null`).
- name: deleted_at - name: deleted_at
in: query in: query
description: The payment's deleted at. description: Filter by the payment's deletion date.
required: false required: false
schema: schema:
type: object type: object
description: The payment's deleted at. description: Filter by the payment's deletion date.
properties: properties:
$and: $and:
type: array type: array
@@ -727,150 +443,6 @@ get:
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
parameter. parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array - type: array
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
@@ -951,7 +523,9 @@ get:
required: false required: false
schema: schema:
type: array type: array
description: The payment's $and. description: >-
Join query parameters with an AND condition. Each object's content is
the same type as the expected query parameters.
items: items:
type: object type: object
title: $and title: $and
@@ -960,7 +534,9 @@ get:
required: false required: false
schema: schema:
type: array type: array
description: The payment's $or. description: >-
Join query parameters with an OR condition. Each object's content is
the same type as the expected query parameters.
items: items:
type: object type: object
title: $or title: $or
@@ -983,7 +559,7 @@ get:
schema: schema:
allOf: allOf:
- type: object - type: object
description: SUMMARY description: The paginated list of payments.
required: required:
- limit - limit
- offset - offset
@@ -992,23 +568,23 @@ get:
limit: limit:
type: number type: number
title: limit title: limit
description: The payment's limit. description: The maximum number of returned items.
offset: offset:
type: number type: number
title: offset title: offset
description: The payment's offset. description: The number of items skipped before the returned items.
count: count:
type: number type: number
title: count title: count
description: The payment's count. description: The total number of payments.
- type: object - type: object
description: SUMMARY description: The paginated list of payments.
required: required:
- payments - payments
properties: properties:
payments: payments:
type: array type: array
description: The payment's payments. description: The list of payments.
items: items:
$ref: ../components/schemas/AdminPayment.yaml $ref: ../components/schemas/AdminPayment.yaml
'400': '400':
www/apps/api-reference/specs/admin/paths/admin_payments_payment-providers.yaml
+22 -17
View File
@@ -1,9 +1,10 @@
get: get:
operationId: GetPaymentsPaymentProviders operationId: GetPaymentsPaymentProviders
summary: List Payments summary: List Payment Providers
description: >- description: >-
Retrieve a list of payments. The payments can be filtered by fields such as Retrieve a list of payment providers. The payment providers can be filtered
`id`. The payments can also be sorted or paginated. by fields such as `id`. The payment providers can also be sorted or
paginated.
x-authenticated: true x-authenticated: true
parameters: parameters:
- name: expand - name: expand
@@ -63,32 +64,34 @@ get:
with `-`. with `-`.
- name: id - name: id
in: query in: query
required: false required: true
schema: schema:
oneOf: oneOf:
- type: string - type: string
title: id title: id
description: The payment's ID. description: Filter by a payment provider's ID.
- type: array - type: array
description: The payment's ID. description: Filter by payment provider IDs.
items: items:
type: string type: string
title: id title: id
description: The id's ID. description: A payment provider ID.
- name: is_enabled - name: is_enabled
in: query in: query
description: The payment's is enabled. description: Filter by whether the payment provider is enabled.
required: false required: false
schema: schema:
type: boolean type: boolean
title: is_enabled title: is_enabled
description: The payment's is enabled. description: Filter by whether the payment provider is enabled.
- name: $and - name: $and
in: query in: query
required: false required: false
schema: schema:
type: array type: array
description: The payment's $and. description: >-
Join query parameters with an AND condition. Each object's content is
the same type as the expected query parameters.
items: items:
type: object type: object
title: $and title: $and
@@ -97,7 +100,9 @@ get:
required: false required: false
schema: schema:
type: array type: array
description: The payment's $or. description: >-
Join query parameters with an OR condition. Each object's content is
the same type as the expected query parameters.
items: items:
type: object type: object
title: $or title: $or
@@ -120,7 +125,7 @@ get:
schema: schema:
allOf: allOf:
- type: object - type: object
description: SUMMARY description: The list of payment providers.
required: required:
- limit - limit
- offset - offset
@@ -129,23 +134,23 @@ get:
limit: limit:
type: number type: number
title: limit title: limit
description: The payment's limit. description: The maximum number of items returned.
offset: offset:
type: number type: number
title: offset title: offset
description: The payment's offset. description: The number of items skipped before the returned items.
count: count:
type: number type: number
title: count title: count
description: The payment's count. description: The total number of items.
- type: object - type: object
description: SUMMARY description: The paginated list of payment providers.
required: required:
- payment_providers - payment_providers
properties: properties:
payment_providers: payment_providers:
type: array type: array
description: The payment's payment providers. description: The list of payment providers.
items: items:
$ref: ../components/schemas/AdminPaymentProvider.yaml $ref: ../components/schemas/AdminPaymentProvider.yaml
'400': '400':
www/apps/api-reference/specs/admin/paths/admin_price-lists.yaml
+16 -304
View File
@@ -63,12 +63,12 @@ get:
with `-`. with `-`.
- name: q - name: q
in: query in: query
description: The price list's q. description: Search term to filter the price list's searchable properties.
required: false required: false
schema: schema:
type: string type: string
title: q title: q
description: The price list's q. description: Search term to filter the price list's searchable properties.
- name: id - name: id
in: query in: query
required: false required: false
@@ -76,20 +76,20 @@ get:
oneOf: oneOf:
- type: string - type: string
title: id title: id
description: The price list's ID. description: Filter by a price list ID.
- type: array - type: array
description: The price list's ID. description: Filter by price list IDs.
items: items:
type: string type: string
title: id title: id
description: The id's ID. description: A price list ID.
- name: starts_at - name: starts_at
in: query in: query
description: The price list's starts at. description: Filter by a price list's start date.
required: false required: false
schema: schema:
type: object type: object
description: The price list's starts at. description: Filter by a price list's start date.
properties: properties:
$and: $and:
type: array type: array
@@ -147,150 +147,6 @@ get:
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
parameter. parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array - type: array
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
@@ -368,11 +224,11 @@ get:
description: Filter by whether a value for this parameter exists (not `null`). description: Filter by whether a value for this parameter exists (not `null`).
- name: ends_at - name: ends_at
in: query in: query
description: The price list's ends at. description: Filter by the price list's end date.
required: false required: false
schema: schema:
type: object type: object
description: The price list's ends at. description: Filter by the price list's end date.
properties: properties:
$and: $and:
type: array type: array
@@ -430,150 +286,6 @@ get:
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
parameter. parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array - type: array
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
@@ -651,28 +363,28 @@ get:
description: Filter by whether a value for this parameter exists (not `null`). description: Filter by whether a value for this parameter exists (not `null`).
- name: status - name: status
in: query in: query
description: The price list's status. description: Filter by the price list's status.
required: false required: false
schema: schema:
type: array type: array
description: The price list's status. description: Filter by the price list's status.
items: items:
type: string type: string
description: The status's details. description: A price list's status.
enum: enum:
- draft
- active - active
- draft
- name: rules_count - name: rules_count
in: query in: query
description: The price list's rules count. description: Filter by the price list's rules count.
required: false required: false
schema: schema:
type: array type: array
description: The price list's rules count. description: Filter by the price list's rules count.
items: items:
type: number type: number
title: rules_count title: rules_count
description: The rules count's details. description: The price list's rule count.
- name: $and - name: $and
in: query in: query
description: >- description: >-
www/apps/api-reference/specs/admin/paths/admin_price-preferences.yaml
+11 -11
View File
@@ -69,13 +69,13 @@ get:
oneOf: oneOf:
- type: string - type: string
title: id title: id
description: The price preference's ID. description: Filter by a price preference ID.
- type: array - type: array
description: The price preference's ID. description: Filter by price preference IDs.
items: items:
type: string type: string
title: id title: id
description: The id's ID. description: A price preference ID.
- name: attribute - name: attribute
in: query in: query
required: false required: false
@@ -83,13 +83,13 @@ get:
oneOf: oneOf:
- type: string - type: string
title: attribute title: attribute
description: The price preference's attribute. description: Filter by a price preference's attribute.
- type: array - type: array
description: The price preference's attribute. description: Filter by price preference attributes.
items: items:
type: string type: string
title: attribute title: attribute
description: The attribute's details. description: A price preference's attribute.
- name: value - name: value
in: query in: query
required: false required: false
@@ -97,21 +97,21 @@ get:
oneOf: oneOf:
- type: string - type: string
title: value title: value
description: The price preference's value. description: Filter by a price preference's value.
- type: array - type: array
description: The price preference's value. description: Filter by price preference values.
items: items:
type: string type: string
title: value title: value
description: The value's details. description: A price preference's value.
- name: q - name: q
in: query in: query
description: The price preference's q. description: Search term to apply on the price preference's searchable properties.
required: false required: false
schema: schema:
type: string type: string
title: q title: q
description: The price preference's q. description: Search term to apply on the price preference's searchable properties.
- name: $and - name: $and
in: query in: query
description: >- description: >-
www/apps/api-reference/specs/admin/paths/admin_product-categories.yaml
+50 -462
View File
@@ -64,12 +64,12 @@ get:
with `-`. with `-`.
- name: q - name: q
in: query in: query
description: The product category's q. description: Search term to filter on the product category's searchable properties.
required: false required: false
schema: schema:
type: string type: string
title: q title: q
description: The product category's q. description: Search term to filter on the product category's searchable properties.
- name: id - name: id
in: query in: query
required: false required: false
@@ -77,13 +77,13 @@ get:
oneOf: oneOf:
- type: string - type: string
title: id title: id
description: The product category's ID. description: Filter by a product category's ID.
- type: array - type: array
description: The product category's ID. description: Filter by product category IDs.
items: items:
type: string type: string
title: id title: id
description: The id's ID. description: A product category ID.
- name: description - name: description
in: query in: query
required: false required: false
@@ -91,13 +91,17 @@ get:
oneOf: oneOf:
- type: string - type: string
title: description title: description
description: The product category's description. description: >-
Filter by the category's description. This performs a full-text
search. To do keyword search, use the `q` parameter instead.
- type: array - type: array
description: The product category's description. description: >-
Filter by category descriptions. This performs a full-text search.
To do keyword search, use the `q` parameter instead.
items: items:
type: string type: string
title: description title: description
description: The description's details. description: The category's description.
- name: handle - name: handle
in: query in: query
required: false required: false
@@ -105,13 +109,13 @@ get:
oneOf: oneOf:
- type: string - type: string
title: handle title: handle
description: The product category's handle. description: Filter by a category's handle.
- type: array - type: array
description: The product category's handle. description: Filter by category handles.
items: items:
type: string type: string
title: handle title: handle
description: The handle's details. description: A category's handle.
- name: parent_category_id - name: parent_category_id
in: query in: query
required: false required: false
@@ -119,52 +123,64 @@ get:
oneOf: oneOf:
- type: string - type: string
title: parent_category_id title: parent_category_id
description: The product category's parent category id. description: Filter by a parent category's ID to retrieve its child categories.
- type: array - type: array
description: The product category's parent category id. description: Filter by parent category IDs to retrieve their child categories.
items: items:
type: string type: string
title: parent_category_id title: parent_category_id
description: The parent category id's details. description: A parent category's ID.
- name: include_ancestors_tree - name: include_ancestors_tree
in: query in: query
description: The product category's include ancestors tree. description: >-
Whether to include the parent category of each category. If enabled, the
parent category is set in the `parent_category` property of each
category object.
required: false required: false
schema: schema:
type: boolean type: boolean
title: include_ancestors_tree title: include_ancestors_tree
description: The product category's include ancestors tree. description: >-
Whether to include the parent category of each category. If enabled,
the parent category is set in the `parent_category` property of each
category object.
- name: include_descendants_tree - name: include_descendants_tree
in: query in: query
description: The product category's include descendants tree. description: >-
Whether to include the child categories of each category. If enabled,
the child categories are added to the `category_children` property of
each category object.
required: false required: false
schema: schema:
type: boolean type: boolean
title: include_descendants_tree title: include_descendants_tree
description: The product category's include descendants tree. description: >-
Whether to include the child categories of each category. If enabled,
the child categories are added to the `category_children` property of
each category object.
- name: is_internal - name: is_internal
in: query in: query
description: The product category's is internal. description: Filter by whether the category is internal.
required: false required: false
schema: schema:
type: boolean type: boolean
title: is_internal title: is_internal
description: The product category's is internal. description: Filter by whether the category is internal.
- name: is_active - name: is_active
in: query in: query
description: The product category's is active. description: Filter by whether the category is active.
required: false required: false
schema: schema:
type: boolean type: boolean
title: is_active title: is_active
description: The product category's is active. description: Filter by whether the category is active.
- name: created_at - name: created_at
in: query in: query
description: The product category's created at. description: Filter by the category's creation date.
required: false required: false
schema: schema:
type: object type: object
description: The product category's created at. description: Filter by the category's creation date.
properties: properties:
$and: $and:
type: array type: array
@@ -222,150 +238,6 @@ get:
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
parameter. parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array - type: array
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
@@ -443,11 +315,11 @@ get:
description: Filter by whether a value for this parameter exists (not `null`). description: Filter by whether a value for this parameter exists (not `null`).
- name: updated_at - name: updated_at
in: query in: query
description: The product category's updated at. description: Filter by the category's update date.
required: false required: false
schema: schema:
type: object type: object
description: The product category's updated at. description: Filter by the category's update date.
properties: properties:
$and: $and:
type: array type: array
@@ -505,150 +377,6 @@ get:
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
parameter. parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array - type: array
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
@@ -726,11 +454,11 @@ get:
description: Filter by whether a value for this parameter exists (not `null`). description: Filter by whether a value for this parameter exists (not `null`).
- name: deleted_at - name: deleted_at
in: query in: query
description: The product category's deleted at. description: Filter by the category's deletion date.
required: false required: false
schema: schema:
type: object type: object
description: The product category's deleted at. description: Filter by the category's deletion date.
properties: properties:
$and: $and:
type: array type: array
@@ -788,150 +516,6 @@ get:
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
parameter. parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array - type: array
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
@@ -1012,7 +596,9 @@ get:
required: false required: false
schema: schema:
type: array type: array
description: The product category's $and. description: >-
Join query parameters with an AND condition. Each object's content is
the same type as the expected query parameters.
items: items:
type: object type: object
title: $and title: $and
@@ -1021,7 +607,9 @@ get:
required: false required: false
schema: schema:
type: array type: array
description: The product category's $or. description: >-
Join query parameters with an OR condition. Each object's content is
the same type as the expected query parameters.
items: items:
type: object type: object
title: $or title: $or
www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}.yaml
+12 -4
View File
@@ -69,20 +69,28 @@ get:
with `-`. with `-`.
- name: include_ancestors_tree - name: include_ancestors_tree
in: query in: query
description: The product category's include ancestors tree. description: >-
Whether to retrieve the category's parent. When enabled, the parent
category is set in the `parent_category` property.
required: false required: false
schema: schema:
type: boolean type: boolean
title: include_ancestors_tree title: include_ancestors_tree
description: The product category's include ancestors tree. description: >-
Whether to retrieve the category's parent. When enabled, the parent
category is set in the `parent_category` property.
- name: include_descendants_tree - name: include_descendants_tree
in: query in: query
description: The product category's include descendants tree. description: >-
Whether to retrieve a list of child categories. When enabled, the parent
categories are added to the `category_children` property.
required: false required: false
schema: schema:
type: boolean type: boolean
title: include_descendants_tree title: include_descendants_tree
description: The product category's include descendants tree. description: >-
Whether to retrieve a list of child categories. When enabled, the
parent categories are added to the `category_children` property.
security: security:
- api_token: [] - api_token: []
- cookie_auth: [] - cookie_auth: []
www/apps/api-reference/specs/admin/paths/admin_product-tags.yaml
+20 -448
View File
@@ -63,12 +63,12 @@ get:
with `-`. with `-`.
- name: q - name: q
in: query in: query
description: The product tag's q. description: Search term to filter the product tag's searchable properties.
required: false required: false
schema: schema:
type: string type: string
title: q title: q
description: The product tag's q. description: Search term to filter the product tag's searchable properties.
- name: id - name: id
in: query in: query
required: false required: false
@@ -76,13 +76,13 @@ get:
oneOf: oneOf:
- type: string - type: string
title: id title: id
description: The product tag's ID. description: Filter by a product tag's ID.
- type: array - type: array
description: The product tag's ID. description: Filter by product tag IDs.
items: items:
type: string type: string
title: id title: id
description: The id's ID. description: A product tag's ID.
- name: value - name: value
in: query in: query
required: false required: false
@@ -90,20 +90,20 @@ get:
oneOf: oneOf:
- type: string - type: string
title: value title: value
description: The product tag's value. description: Filter by a product tag's value.
- type: array - type: array
description: The product tag's value. description: Filter by product tag values.
items: items:
type: string type: string
title: value title: value
description: The value's details. description: A tag value.
- name: created_at - name: created_at
in: query in: query
description: The product tag's created at. description: Filter by the tag's creation date.
required: false required: false
schema: schema:
type: object type: object
description: The product tag's created at. description: Filter by the tag's creation date.
properties: properties:
$and: $and:
type: array type: array
@@ -161,150 +161,6 @@ get:
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
parameter. parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array - type: array
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
@@ -382,11 +238,11 @@ get:
description: Filter by whether a value for this parameter exists (not `null`). description: Filter by whether a value for this parameter exists (not `null`).
- name: updated_at - name: updated_at
in: query in: query
description: The product tag's updated at. description: Filter by the tag's update date.
required: false required: false
schema: schema:
type: object type: object
description: The product tag's updated at. description: Filter by the tag's update date.
properties: properties:
$and: $and:
type: array type: array
@@ -444,150 +300,6 @@ get:
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
parameter. parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array - type: array
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
@@ -665,11 +377,11 @@ get:
description: Filter by whether a value for this parameter exists (not `null`). description: Filter by whether a value for this parameter exists (not `null`).
- name: deleted_at - name: deleted_at
in: query in: query
description: The product tag's deleted at. description: Filter by the tag's deletion date.
required: false required: false
schema: schema:
type: object type: object
description: The product tag's deleted at. description: Filter by the tag's deletion date.
properties: properties:
$and: $and:
type: array type: array
@@ -727,150 +439,6 @@ get:
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
parameter. parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array - type: array
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
@@ -951,7 +519,9 @@ get:
required: false required: false
schema: schema:
type: array type: array
description: The product tag's $and. description: >-
Join query parameters with an AND condition. Each object's content is
the same type as the expected query parameters.
items: items:
type: object type: object
title: $and title: $and
@@ -960,7 +530,9 @@ get:
required: false required: false
schema: schema:
type: array type: array
description: The product tag's $or. description: >-
Join query parameters with an OR condition. Each object's content is
the same type as the expected query parameters.
items: items:
type: object type: object
title: $or title: $or
www/apps/api-reference/specs/admin/paths/admin_product-types.yaml
+20 -448
View File
@@ -63,12 +63,12 @@ get:
with `-`. with `-`.
- name: q - name: q
in: query in: query
description: The product type's q. description: Search term to filter the product type's searchable properties.
required: false required: false
schema: schema:
type: string type: string
title: q title: q
description: The product type's q. description: Search term to filter the product type's searchable properties.
- name: id - name: id
in: query in: query
required: false required: false
@@ -76,13 +76,13 @@ get:
oneOf: oneOf:
- type: string - type: string
title: id title: id
description: The product type's ID. description: Filter by a product type's ID.
- type: array - type: array
description: The product type's ID. description: Filter by product type IDs.
items: items:
type: string type: string
title: id title: id
description: The id's ID. description: A product type's ID.
- name: value - name: value
in: query in: query
required: false required: false
@@ -90,20 +90,20 @@ get:
oneOf: oneOf:
- type: string - type: string
title: value title: value
description: The product type's value. description: Filter by a type's value.
- type: array - type: array
description: The product type's value. description: Filter by values.
items: items:
type: string type: string
title: value title: value
description: The value's details. description: A type's value.
- name: created_at - name: created_at
in: query in: query
description: The product type's created at. description: Filter by the type's creation date.
required: false required: false
schema: schema:
type: object type: object
description: The product type's created at. description: Filter by the type's creation date.
properties: properties:
$and: $and:
type: array type: array
@@ -161,150 +161,6 @@ get:
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
parameter. parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array - type: array
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
@@ -382,11 +238,11 @@ get:
description: Filter by whether a value for this parameter exists (not `null`). description: Filter by whether a value for this parameter exists (not `null`).
- name: updated_at - name: updated_at
in: query in: query
description: The product type's updated at. description: Filter by the type's update date.
required: false required: false
schema: schema:
type: object type: object
description: The product type's updated at. description: Filter by the type's update date.
properties: properties:
$and: $and:
type: array type: array
@@ -444,150 +300,6 @@ get:
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
parameter. parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array - type: array
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
@@ -665,11 +377,11 @@ get:
description: Filter by whether a value for this parameter exists (not `null`). description: Filter by whether a value for this parameter exists (not `null`).
- name: deleted_at - name: deleted_at
in: query in: query
description: The product type's deleted at. description: Filter by the type's deletion date.
required: false required: false
schema: schema:
type: object type: object
description: The product type's deleted at. description: Filter by the type's deletion date.
properties: properties:
$and: $and:
type: array type: array
@@ -727,150 +439,6 @@ get:
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
parameter. parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array - type: array
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
@@ -951,7 +519,9 @@ get:
required: false required: false
schema: schema:
type: array type: array
description: The product type's $and. description: >-
Join query parameters with an AND condition. Each object's content is
the same type as the expected query parameters.
items: items:
type: object type: object
title: $and title: $and
@@ -960,7 +530,9 @@ get:
required: false required: false
schema: schema:
type: array type: array
description: The product type's $or. description: >-
Join query parameters with an OR condition. Each object's content is
the same type as the expected query parameters.
items: items:
type: object type: object
title: $or title: $or
www/apps/api-reference/specs/admin/paths/admin_product-variants.yaml
+15 -447
View File
@@ -63,12 +63,12 @@ get:
with `-`. with `-`.
- name: q - name: q
in: query in: query
description: The product variant's q. description: Search term to filter the product variant's searchable properties.
required: false required: false
schema: schema:
type: string type: string
title: q title: q
description: The product variant's q. description: Search term to filter the product variant's searchable properties.
- name: id - name: id
in: query in: query
required: false required: false
@@ -76,36 +76,36 @@ get:
oneOf: oneOf:
- type: string - type: string
title: id title: id
description: The product variant's ID. description: Filter by a variant's ID.
- type: array - type: array
description: The product variant's ID. description: Filter by variant IDs.
items: items:
type: string type: string
title: id title: id
description: The id's ID. description: A variant's ID.
- name: manage_inventory - name: manage_inventory
in: query in: query
description: The product variant's manage inventory. description: Filter by whether a variant's `manage_inventory` is enabled.
required: false required: false
schema: schema:
type: boolean type: boolean
title: manage_inventory title: manage_inventory
description: The product variant's manage inventory. description: Filter by whether a variant's `manage_inventory` is enabled.
- name: allow_backorder - name: allow_backorder
in: query in: query
description: The product variant's allow backorder. description: Filter by whether backorder is allowed for a variant.
required: false required: false
schema: schema:
type: boolean type: boolean
title: allow_backorder title: allow_backorder
description: The product variant's allow backorder. description: Filter by whether backorder is allowed for a variant.
- name: created_at - name: created_at
in: query in: query
description: The product variant's created at. description: Filter by the product variant's creation date.
required: false required: false
schema: schema:
type: object type: object
description: The product variant's created at. description: Filter by the product variant's creation date.
properties: properties:
$and: $and:
type: array type: array
@@ -163,150 +163,6 @@ get:
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
parameter. parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array - type: array
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
@@ -384,11 +240,11 @@ get:
description: Filter by whether a value for this parameter exists (not `null`). description: Filter by whether a value for this parameter exists (not `null`).
- name: updated_at - name: updated_at
in: query in: query
description: The product variant's updated at. description: Filter by the product variant's update date.
required: false required: false
schema: schema:
type: object type: object
description: The product variant's updated at. description: Filter by the product variant's update date.
properties: properties:
$and: $and:
type: array type: array
@@ -446,150 +302,6 @@ get:
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
parameter. parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array - type: array
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
@@ -667,11 +379,11 @@ get:
description: Filter by whether a value for this parameter exists (not `null`). description: Filter by whether a value for this parameter exists (not `null`).
- name: deleted_at - name: deleted_at
in: query in: query
description: The product variant's deleted at. description: Filter by the product variant's deletion date.
required: false required: false
schema: schema:
type: object type: object
description: The product variant's deleted at. description: Filter by the product variant's deletion date.
properties: properties:
$and: $and:
type: array type: array
@@ -729,150 +441,6 @@ get:
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
parameter. parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array - type: array
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
www/apps/api-reference/specs/admin/paths/admin_products.yaml
+491 -5016
View File
File diff suppressed because it is too large. Load diff
www/apps/api-reference/specs/admin/paths/admin_products_{id}_options.yaml
+30 -35
View File
@@ -1,9 +1,10 @@
get: get:
operationId: GetProductsIdOptions operationId: GetProductsIdOptions
summary: List Options summary: List a Product's Options
x-sidebar-summary: List Options
description: >- description: >-
Retrieve a list of options in a product. The options can be filtered by Retrieve a list of options of a product. The options can be filtered by
fields like FILTER FIELDS. The options can also be paginated. fields like `id`. The options can also be paginated.
x-authenticated: true x-authenticated: true
parameters: parameters:
- name: id - name: id
@@ -69,12 +70,12 @@ get:
with `-`. with `-`.
- name: q - name: q
in: query in: query
description: The product's q. description: Search term to filter the product option's searchable fields.
required: false required: false
schema: schema:
type: string type: string
title: q title: q
description: The product's q. description: Search term to filter the product option's searchable fields.
- name: id - name: id
in: query in: query
required: false required: false
@@ -82,13 +83,13 @@ get:
oneOf: oneOf:
- type: string - type: string
title: id title: id
description: The product's ID. description: Filter by the product option's ID.
- type: array - type: array
description: The product's ID. description: Filter by product option IDs.
items: items:
type: string type: string
title: id title: id
description: The id's ID. description: A product option's ID.
- name: title - name: title
in: query in: query
required: false required: false
@@ -96,44 +97,38 @@ get:
oneOf: oneOf:
- type: string - type: string
title: title title: title
description: The product's title. description: Filter by a title.
- type: array - type: array
description: The product's title. description: Filter by titles.
items: items:
type: string type: string
title: title title: title
description: The title's details. description: An option's title.
- name: product_id
in: query
required: false
schema:
oneOf:
- type: string
title: product_id
description: The product's product id.
- type: array
description: The product's product id.
items:
type: string
title: product_id
description: The product id's details.
- name: $and - name: $and
in: query in: query
description: The product's $and. description: >-
Join query parameters with an AND condition. Each object's content is
the same type as the expected query parameters.
required: false required: false
schema: schema:
type: array type: array
description: The product's $and. description: >-
Join query parameters with an AND condition. Each object's content is
the same type as the expected query parameters.
items: items:
type: object type: object
title: $and title: $and
- name: $or - name: $or
in: query in: query
description: The product's $or. description: >-
Join query parameters with an OR condition. Each object's content is the
same type as the expected query parameters.
required: false required: false
schema: schema:
type: array type: array
description: The product's $or. description: >-
Join query parameters with an OR condition. Each object's content is
the same type as the expected query parameters.
items: items:
type: object type: object
title: $or title: $or
@@ -156,7 +151,7 @@ get:
schema: schema:
allOf: allOf:
- type: object - type: object
description: SUMMARY description: The paginated list of product options.
required: required:
- limit - limit
- offset - offset
@@ -165,23 +160,23 @@ get:
limit: limit:
type: number type: number
title: limit title: limit
description: The product's limit. description: The maximum number of items returned.
offset: offset:
type: number type: number
title: offset title: offset
description: The product's offset. description: The number of items skipped before the returned items.
count: count:
type: number type: number
title: count title: count
description: The product's count. description: The total number of items.
- type: object - type: object
description: SUMMARY description: The paginated list of product options.
required: required:
- product_options - product_options
properties: properties:
product_options: product_options:
type: array type: array
description: The product's product options. description: The list of product options.
items: items:
$ref: ../components/schemas/AdminProductOption.yaml $ref: ../components/schemas/AdminProductOption.yaml
'400': '400':
www/apps/api-reference/specs/admin/paths/admin_products_{id}_options_{option_id}.yaml
+3 -4
View File
@@ -1,9 +1,8 @@
get: get:
operationId: GetProductsIdOptionsOption_id operationId: GetProductsIdOptionsOption_id
summary: List Options summary: Get a Product's Option
description: >- x-sidebar-summary: Get Option
Retrieve a list of options in a product. The options can be filtered by description: Retrieve a product's option by its ID.
fields like FILTER FIELDS. The options can also be paginated.
x-authenticated: true x-authenticated: true
parameters: parameters:
- name: id - name: id
www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants.yaml
+491 -7
View File
@@ -1,6 +1,7 @@
get: get:
operationId: GetProductsIdVariants operationId: GetProductsIdVariants
summary: List Variants summary: List Variants of a Product
x-sidebar-summary: List Variants
description: >- description: >-
Retrieve a list of variants in a product. The variants can be filtered by Retrieve a list of variants in a product. The variants can be filtered by
fields like FILTER FIELDS. The variants can also be paginated. fields like FILTER FIELDS. The variants can also be paginated.
@@ -67,6 +68,489 @@ get:
The field to sort the data by. By default, the sort order is The field to sort the data by. By default, the sort order is
ascending. To change the order to descending, prefix the field name ascending. To change the order to descending, prefix the field name
with `-`. with `-`.
- name: q
in: query
description: Search term to filter the variant's search attributes.
required: false
schema:
type: string
title: q
description: Search term to filter the variant's search attributes.
- name: id
in: query
required: false
schema:
oneOf:
- type: string
title: id
description: Filter by a variant's ID.
- type: array
description: Filter by variant IDs.
items:
type: string
title: id
description: A variant ID.
- name: manage_inventory
in: query
description: Filter by whether a variant's `manage_inventory` property is enabled.
required: false
schema:
type: boolean
title: manage_inventory
description: Filter by whether a variant's `manage_inventory` property is enabled.
- name: allow_backorder
in: query
description: Filter by whether backorders are allowed for the variant.
required: false
schema:
type: boolean
title: allow_backorder
description: Filter by whether backorders are allowed for the variant.
- name: created_at
in: query
description: Filter by the product's creation date.
required: false
schema:
type: object
description: Filter by the product's creation date.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's content
is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's content
is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for numbers
and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter. Useful
for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for numbers and
dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter. Useful for
numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: Apply a case-insensitive `like` filter. Useful for strings only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: Filter arrays that have overlapping values with this parameter.
items:
type: string
title: $overlap
description: Filter arrays that have overlapping values with this parameter.
$contains:
type: array
description: Filter arrays that contain some of the values of this parameter.
items:
type: string
title: $contains
description: Filter arrays that contain some of the values of this parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
- name: updated_at
in: query
description: Filter by the product's update date.
required: false
schema:
type: object
description: Filter by the product's update date.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's content
is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's content
is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for numbers
and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter. Useful
for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for numbers and
dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter. Useful for
numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: Apply a case-insensitive `like` filter. Useful for strings only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: Filter arrays that have overlapping values with this parameter.
items:
type: string
title: $overlap
description: Filter arrays that have overlapping values with this parameter.
$contains:
type: array
description: Filter arrays that contain some of the values of this parameter.
items:
type: string
title: $contains
description: Filter arrays that contain some of the values of this parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
- name: deleted_at
in: query
description: Filter by the product's deletion date.
required: false
schema:
type: object
description: Filter by the product's deletion date.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's content
is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's content
is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for numbers
and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter. Useful
for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for numbers and
dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter. Useful for
numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: Apply a case-insensitive `like` filter. Useful for strings only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: Filter arrays that have overlapping values with this parameter.
items:
type: string
title: $overlap
description: Filter arrays that have overlapping values with this parameter.
$contains:
type: array
description: Filter arrays that contain some of the values of this parameter.
items:
type: string
title: $contains
description: Filter arrays that contain some of the values of this parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
- name: $and
in: query
description: >-
Join query parameters with an AND condition. Each object's content is
the same type as the expected query parameters.
required: false
schema:
type: array
description: >-
Join query parameters with an AND condition. Each object's content is
the same type as the expected query parameters.
items:
type: object
title: $and
- name: $or
in: query
description: >-
Join query parameters with an OR condition. Each object's content is the
same type as the expected query parameters.
required: false
schema:
type: array
description: >-
Join query parameters with an OR condition. Each object's content is
the same type as the expected query parameters.
items:
type: object
title: $or
security: security:
- api_token: [] - api_token: []
- cookie_auth: [] - cookie_auth: []
@@ -86,7 +570,7 @@ get:
schema: schema:
allOf: allOf:
- type: object - type: object
description: SUMMARY description: The paginated list of product variants.
required: required:
- limit - limit
- offset - offset
@@ -95,23 +579,23 @@ get:
limit: limit:
type: number type: number
title: limit title: limit
description: The product's limit. description: The maximum number of returned items.
offset: offset:
type: number type: number
title: offset title: offset
description: The product's offset. description: The number of items skipped before the returned item.
count: count:
type: number type: number
title: count title: count
description: The product's count. description: The total number of items.
- type: object - type: object
description: SUMMARY description: The paginated list of product variants.
required: required:
- variants - variants
properties: properties:
variants: variants:
type: array type: array
description: The product's variants. description: The list of product variants.
items: items:
$ref: ../components/schemas/AdminProductVariant.yaml $ref: ../components/schemas/AdminProductVariant.yaml
'400': '400':
www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}.yaml
+4 -5
View File
@@ -1,9 +1,8 @@
get: get:
operationId: GetProductsIdVariantsVariant_id operationId: GetProductsIdVariantsVariant_id
summary: List Variants summary: Get Variant of a Product
description: >- x-sidebar-summary: Get Variant
Retrieve a list of variants in a product. The variants can be filtered by description: Retrieve a product's variant by its ID.
fields like FILTER FIELDS. The variants can also be paginated.
x-authenticated: true x-authenticated: true
parameters: parameters:
- name: id - name: id
@@ -14,7 +13,7 @@ get:
type: string type: string
- name: variant_id - name: variant_id
in: path in: path
description: The product's variant id. description: The variant's ID.
required: true required: true
schema: schema:
type: string type: string
www/apps/api-reference/specs/admin/paths/admin_promotions.yaml
+37 -459
View File
@@ -63,12 +63,12 @@ get:
with `-`. with `-`.
- name: q - name: q
in: query in: query
description: The promotion's q. description: Search term to filter the promotion's searchable attributes.
required: false required: false
schema: schema:
type: string type: string
title: q title: q
description: The promotion's q. description: Search term to filter the promotion's searchable attributes.
- name: code - name: code
in: query in: query
required: false required: false
@@ -76,13 +76,13 @@ get:
oneOf: oneOf:
- type: string - type: string
title: code title: code
description: The promotion's code. description: Filter by a promotion code.
- type: array - type: array
description: The promotion's code. description: Filter by promotion codes.
items: items:
type: string type: string
title: code title: code
description: The code's details. description: A promotion code.
- name: campaign_id - name: campaign_id
in: query in: query
required: false required: false
@@ -90,39 +90,43 @@ get:
oneOf: oneOf:
- type: string - type: string
title: campaign_id title: campaign_id
description: The promotion's campaign id. description: Filter by a campaign's ID to retrieve its associated promotions.
- type: array - type: array
description: The promotion's campaign id. description: Filter by campaign IDs to retrieve their associated promotions.
items: items:
type: string type: string
title: campaign_id title: campaign_id
description: The campaign id's details. description: A campaign's ID.
- name: application_method - name: application_method
in: query in: query
description: The promotion's application method. description: >-
Apply filters on the application methods to retrieve the promotions of
the matching application methods.
required: false required: false
schema: schema:
type: object type: object
description: The promotion's application method. description: >-
Apply filters on the application methods to retrieve the promotions of
the matching application methods.
properties: properties:
currency_code: currency_code:
oneOf: oneOf:
- type: string - type: string
title: currency_code title: currency_code
description: The application method's currency code. description: Filter by a currency code.
- type: array - type: array
description: The application method's currency code. description: Filter by currency codes.
items: items:
type: string type: string
title: currency_code title: currency_code
description: The currency code's details. description: A currency code.
- name: created_at - name: created_at
in: query in: query
description: The promotion's created at. description: Filter by a promotion's creation date.
required: false required: false
schema: schema:
type: object type: object
description: The promotion's created at. description: Filter by a promotion's creation date.
properties: properties:
$and: $and:
type: array type: array
@@ -180,150 +184,6 @@ get:
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
parameter. parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array - type: array
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
@@ -401,11 +261,11 @@ get:
description: Filter by whether a value for this parameter exists (not `null`). description: Filter by whether a value for this parameter exists (not `null`).
- name: updated_at - name: updated_at
in: query in: query
description: The promotion's updated at. description: Filter by a promotion's update date.
required: false required: false
schema: schema:
type: object type: object
description: The promotion's updated at. description: Filter by a promotion's update date.
properties: properties:
$and: $and:
type: array type: array
@@ -463,150 +323,6 @@ get:
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
parameter. parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array - type: array
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
@@ -684,11 +400,11 @@ get:
description: Filter by whether a value for this parameter exists (not `null`). description: Filter by whether a value for this parameter exists (not `null`).
- name: deleted_at - name: deleted_at
in: query in: query
description: The promotion's deleted at. description: Filter by a promotion's deletion date.
required: false required: false
schema: schema:
type: object type: object
description: The promotion's deleted at. description: Filter by a promotion's deletion date.
properties: properties:
$and: $and:
type: array type: array
@@ -746,150 +462,6 @@ get:
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
parameter. parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array - type: array
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
@@ -970,7 +542,9 @@ get:
required: false required: false
schema: schema:
type: array type: array
description: The promotion's $and. description: >-
Join query parameters with an AND condition. Each object's content is
the same type as the expected query parameters.
items: items:
type: object type: object
title: $and title: $and
@@ -979,7 +553,9 @@ get:
required: false required: false
schema: schema:
type: array type: array
description: The promotion's $or. description: >-
Join query parameters with an OR condition. Each object's content is
the same type as the expected query parameters.
items: items:
type: object type: object
title: $or title: $or
@@ -1002,7 +578,7 @@ get:
schema: schema:
allOf: allOf:
- type: object - type: object
description: SUMMARY description: The paginated list of promotions.
required: required:
- limit - limit
- offset - offset
@@ -1011,23 +587,25 @@ get:
limit: limit:
type: number type: number
title: limit title: limit
description: The promotion's limit. description: The maximum number of items returned.
offset: offset:
type: number type: number
title: offset title: offset
description: The promotion's offset. description: >-
The number of items skipped before retrieving the returned
items.
count: count:
type: number type: number
title: count title: count
description: The promotion's count. description: The total number of items.
- type: object - type: object
description: SUMMARY description: The paginated list of promotions.
required: required:
- promotions - promotions
properties: properties:
promotions: promotions:
type: array type: array
description: The promotion's promotions. description: The list of promotions.
items: items:
$ref: ../components/schemas/AdminPromotion.yaml $ref: ../components/schemas/AdminPromotion.yaml
'400': '400':
www/apps/api-reference/specs/admin/paths/admin_promotions_rule-attribute-options_{rule_type}.yaml
+31 -12
View File
@@ -1,34 +1,53 @@
get: get:
operationId: GetPromotionsRuleAttributeOptionsRule_type operationId: GetPromotionsRuleAttributeOptionsRule_type
summary: List Rule Attribute Options summary: List Rule Attribute Options of a Rule Type
description: >- x-sidebar-summary: List Rule Attribute Options
Retrieve a list of rule attribute options in a promotion. The rule attribute description: >
options can be filtered by fields like FILTER FIELDS. The rule attribute Retrieve a list of attributes for the promotion and application method types
options can also be paginated. specified in the query parameters.
Only the attributes of the rule type specified in the path parameter are
retrieved:
- If `rule_type` is `rules`, the attributes of the promotion's type are
retrieved. - If `rule_type` is `target-rules`, the target rules' attributes
of the application method's type are retrieved. - If `rule_type` is
`buy-rules`, the buy rules' attributes of the application method's type are
retrieved.
x-authenticated: true x-authenticated: true
parameters: parameters:
- name: rule_type - name: rule_type
in: path in: path
description: The promotion's rule type. description: The rule type.
required: true required: true
schema: schema:
type: string type: string
enum:
- rules
- target-rules
- buy-rules
- name: promotion_type - name: promotion_type
in: query in: query
description: The promotion's promotion type. description: The promotion type to retrieve rules for.
required: false required: false
schema: schema:
type: string type: string
title: promotion_type title: promotion_type
description: The promotion's promotion type. description: The promotion type to retrieve rules for.
enum:
- standard
- buyget
- name: application_method_type - name: application_method_type
in: query in: query
description: The promotion's application method type. description: The application method type to retrieve rules for.
required: false required: false
schema: schema:
type: string type: string
title: application_method_type title: application_method_type
description: The promotion's application method type. description: The application method type to retrieve rules for.
enum:
- fixed
- percentage
security: security:
- api_token: [] - api_token: []
- cookie_auth: [] - cookie_auth: []
@@ -48,13 +67,13 @@ get:
application/json: application/json:
schema: schema:
type: object type: object
description: SUMMARY description: The list of attributes.
required: required:
- attributes - attributes
properties: properties:
attributes: attributes:
type: array type: array
description: The promotion's attributes. description: The list of attributes.
items: items:
$ref: ../components/schemas/AdminRuleAttributeOption.yaml $ref: ../components/schemas/AdminRuleAttributeOption.yaml
'400': '400':
www/apps/api-reference/specs/admin/paths/admin_promotions_rule-value-options_{rule_type}_{rule_attribute_id}.yaml
+27 -12
View File
@@ -1,20 +1,29 @@
get: get:
operationId: GetPromotionsRuleValueOptionsRule_typeRule_attribute_id operationId: GetPromotionsRuleValueOptionsRule_typeRule_attribute_id
summary: 'List ' summary: List Rule Values Given a Rule Attribute
description: >- x-sidebar-summary: List Rule Values
Retrieve a list of in a promotion. The can be filtered by fields like description: >
FILTER FIELDS. The can also be paginated. Retrieve all potential values for promotion rules and target and buy rules
based on the specified rule attribute and type.
For example, if you provide the ID of the `currency_code` rule attribute,
and set `rule_type` to `rules`, a list of currencies are retrieved in
label-value pairs.
x-authenticated: true x-authenticated: true
parameters: parameters:
- name: rule_type - name: rule_type
in: path in: path
description: The promotion's rule type. description: The rule type.
required: true required: true
schema: schema:
type: string type: string
enum:
- rules
- target-rules
- buy-rules
- name: rule_attribute_id - name: rule_attribute_id
in: path in: path
description: The promotion's rule attribute id. description: The rule attribute's ID.
required: true required: true
schema: schema:
type: string type: string
@@ -75,20 +84,26 @@ get:
with `-`. with `-`.
- name: promotion_type - name: promotion_type
in: query in: query
description: The promotion's promotion type. description: The promotion type to retrieve rules for.
required: false required: false
schema: schema:
type: string type: string
title: promotion_type title: promotion_type
description: The promotion's promotion type. description: The promotion type to retrieve rules for.
enum:
- standard
- buyget
- name: application_method_type - name: application_method_type
in: query in: query
description: The promotion's application method type. description: The application method type to retrieve rules for.
required: false required: false
schema: schema:
type: string type: string
title: application_method_type title: application_method_type
description: The promotion's application method type. description: The application method type to retrieve rules for.
enum:
- fixed
- percentage
security: security:
- api_token: [] - api_token: []
- cookie_auth: [] - cookie_auth: []
@@ -108,13 +123,13 @@ get:
application/json: application/json:
schema: schema:
type: object type: object
description: SUMMARY description: The list of rule values.
required: required:
- values - values
properties: properties:
values: values:
type: array type: array
description: The promotion's values. description: The list of rule values.
items: items:
$ref: ../components/schemas/AdminRuleValueOption.yaml $ref: ../components/schemas/AdminRuleValueOption.yaml
'400': '400':
www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_{rule_type}.yaml
+17 -7
View File
@@ -1,9 +1,15 @@
get: get:
operationId: GetPromotionsIdRule_type operationId: GetPromotionsIdRule_type
summary: 'List ' summary: List Rules of a Promotion
description: >- x-sidebar-summary: List Rules
Retrieve a list of in a promotion. The can be filtered by fields like description: >
FILTER FIELDS. The can also be paginated. Retrieve a list of rules in a promotion. The type of rules retrieved depend
on the value of the `rule_type` path parameter:
- If `rule_type` is `rules`, the promotion's rules are retrivied. - If
`rule_type` is `target-rules`, the target rules of the promotion's
application method are retrieved. - If `rule_type` is `buy-rules`, the buy
rules of the promotion's application method are retrieved.
x-authenticated: true x-authenticated: true
parameters: parameters:
- name: id - name: id
@@ -14,10 +20,14 @@ get:
type: string type: string
- name: rule_type - name: rule_type
in: path in: path
description: The promotion's rule type. description: The type of rules to retrieve.
required: true required: true
schema: schema:
type: string type: string
enum:
- rules
- target-rules
- buy-rules
- name: expand - name: expand
in: query in: query
description: Comma-separated relations that should be expanded in the returned data. description: Comma-separated relations that should be expanded in the returned data.
@@ -91,13 +101,13 @@ get:
application/json: application/json:
schema: schema:
type: object type: object
description: SUMMARY description: The list of promotion rules.
required: required:
- rules - rules
properties: properties:
rules: rules:
type: array type: array
description: The promotion's rules. description: The list of promotion rules.
items: items:
$ref: ../components/schemas/AdminPromotionRule.yaml $ref: ../components/schemas/AdminPromotionRule.yaml
'400': '400':
www/apps/api-reference/specs/admin/paths/admin_refund-reasons.yaml
+5 -5
View File
@@ -68,21 +68,21 @@ get:
oneOf: oneOf:
- type: string - type: string
title: id title: id
description: The refund reason's ID. description: Filter by a refund reason's ID.
- type: array - type: array
description: The refund reason's ID. description: Filter by refund reason IDs.
items: items:
type: string type: string
title: id title: id
description: The id's ID. description: A refund reason ID.
- name: q - name: q
in: query in: query
description: The refund reason's q. description: Search term to filter the refund reason's searchable properties.
required: false required: false
schema: schema:
type: string type: string
title: q title: q
description: The refund reason's q. description: Search term to filter the refund reason's searchable properties.
- name: $and - name: $and
in: query in: query
description: >- description: >-
www/apps/api-reference/specs/admin/paths/admin_regions.yaml
+31 -457
View File
@@ -63,12 +63,12 @@ get:
with `-`. with `-`.
- name: q - name: q
in: query in: query
description: The region's q. description: Search term to filter the region's searchable properties.
required: false required: false
schema: schema:
type: string type: string
title: q title: q
description: The region's q. description: Search term to filter the region's searchable properties.
- name: id - name: id
in: query in: query
required: false required: false
@@ -76,13 +76,13 @@ get:
oneOf: oneOf:
- type: string - type: string
title: id title: id
description: The region's ID. description: Filter by a region's ID.
- type: array - type: array
description: The region's ID. description: Filter by region IDs.
items: items:
type: string type: string
title: id title: id
description: The id's ID. description: A region's ID.
- name: code - name: code
in: query in: query
required: false required: false
@@ -90,13 +90,13 @@ get:
oneOf: oneOf:
- type: string - type: string
title: code title: code
description: The region's code. description: Filter by a currency code.
- type: array - type: array
description: The region's code. description: Filter by currency codes.
items: items:
type: string type: string
title: code title: code
description: The code's details. description: A currency code.
- name: name - name: name
in: query in: query
required: false required: false
@@ -104,20 +104,20 @@ get:
oneOf: oneOf:
- type: string - type: string
title: name title: name
description: The region's name. description: Filter by a region's name.
- type: array - type: array
description: The region's name. description: Filter by region names.
items: items:
type: string type: string
title: name title: name
description: The name's details. description: A region's name.
- name: created_at - name: created_at
in: query in: query
description: The region's created at. description: Filter by a region's creation date.
required: false required: false
schema: schema:
type: object type: object
description: The region's created at. description: Filter by a region's creation date.
properties: properties:
$and: $and:
type: array type: array
@@ -175,150 +175,6 @@ get:
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
parameter. parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array - type: array
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
@@ -396,11 +252,11 @@ get:
description: Filter by whether a value for this parameter exists (not `null`). description: Filter by whether a value for this parameter exists (not `null`).
- name: updated_at - name: updated_at
in: query in: query
description: The region's updated at. description: Filter by a region's update date.
required: false required: false
schema: schema:
type: object type: object
description: The region's updated at. description: Filter by a region's update date.
properties: properties:
$and: $and:
type: array type: array
@@ -458,150 +314,6 @@ get:
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
parameter. parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array - type: array
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
@@ -679,11 +391,11 @@ get:
description: Filter by whether a value for this parameter exists (not `null`). description: Filter by whether a value for this parameter exists (not `null`).
- name: deleted_at - name: deleted_at
in: query in: query
description: The region's deleted at. description: Filter by a region's deletion date.
required: false required: false
schema: schema:
type: object type: object
description: The region's deleted at. description: Filter by a region's deletion date.
properties: properties:
$and: $and:
type: array type: array
@@ -741,150 +453,6 @@ get:
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
parameter. parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array - type: array
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
@@ -965,7 +533,9 @@ get:
required: false required: false
schema: schema:
type: array type: array
description: The region's $and. description: >-
Join query parameters with an AND condition. Each object's content is
the same type as the expected query parameters.
items: items:
type: object type: object
title: $and title: $and
@@ -974,7 +544,9 @@ get:
required: false required: false
schema: schema:
type: array type: array
description: The region's $or. description: >-
Join query parameters with an OR condition. Each object's content is
the same type as the expected query parameters.
items: items:
type: object type: object
title: $or title: $or
@@ -997,7 +569,7 @@ get:
schema: schema:
allOf: allOf:
- type: object - type: object
description: SUMMARY description: The paginated list of regions.
required: required:
- limit - limit
- offset - offset
@@ -1006,23 +578,25 @@ get:
limit: limit:
type: number type: number
title: limit title: limit
description: The region's limit. description: The maximum number of items returned.
offset: offset:
type: number type: number
title: offset title: offset
description: The region's offset. description: >-
The number of items skipped before retrieving the returned
items.
count: count:
type: number type: number
title: count title: count
description: The region's count. description: The total number of items.
- type: object - type: object
description: SUMMARY description: The paginated list of regions.
required: required:
- regions - regions
properties: properties:
regions: regions:
type: array type: array
description: The region's regions. description: The list of regions.
items: items:
$ref: ../components/schemas/AdminRegion.yaml $ref: ../components/schemas/AdminRegion.yaml
'400': '400':
www/apps/api-reference/specs/admin/paths/admin_reservations.yaml
+93 -483
View File
@@ -68,13 +68,13 @@ get:
oneOf: oneOf:
- type: string - type: string
title: location_id title: location_id
description: The reservation's location id. description: Filter by a location's ID to retrieve its associated reservations.
- type: array - type: array
description: The reservation's location id. description: Filter by location IDs to retrieve its associated reservations.
items: items:
type: string type: string
title: location_id title: location_id
description: The location id's details. description: A location ID.
- name: inventory_item_id - name: inventory_item_id
in: query in: query
required: false required: false
@@ -82,13 +82,17 @@ get:
oneOf: oneOf:
- type: string - type: string
title: inventory_item_id title: inventory_item_id
description: The reservation's inventory item id. description: >-
Filter by an inventory item's ID to retrieve its associated
reservations.
- type: array - type: array
description: The reservation's inventory item id. description: >-
Filter by inventory item IDs to retrieve its associated
reservations.
items: items:
type: string type: string
title: inventory_item_id title: inventory_item_id
description: The inventory item id's details. description: An inventory item ID
- name: line_item_id - name: line_item_id
in: query in: query
required: false required: false
@@ -96,13 +100,15 @@ get:
oneOf: oneOf:
- type: string - type: string
title: line_item_id title: line_item_id
description: The reservation's line item id. description: >-
Filter by a line item's ID to retrieve its associated
reservations.
- type: array - type: array
description: The reservation's line item id. description: Filter by line item IDs to retrieve its associated reservations.
items: items:
type: string type: string
title: line_item_id title: line_item_id
description: The line item id's details. description: A line item ID
- name: created_by - name: created_by
in: query in: query
required: false required: false
@@ -110,13 +116,15 @@ get:
oneOf: oneOf:
- type: string - type: string
title: created_by title: created_by
description: The reservation's created by. description: >-
Filter by the ID of a user to retrieve the reservations they
created.
- type: array - type: array
description: The reservation's created by. description: Filter by user IDs to retrieve the reservations they created.
items: items:
type: string type: string
title: created_by title: created_by
description: The created by's details. description: A user's ID.
- name: description - name: description
in: query in: query
required: false required: false
@@ -124,42 +132,74 @@ get:
oneOf: oneOf:
- type: string - type: string
title: description title: description
description: The reservation's description. description: >-
Filter by a reservation's description. This filter applies a
full-text match. To search by keywords, use the `q` query
parameter instead.
- type: object - type: object
description: The reservation's description. description: Apply filters on the reservation's description.
required:
- $eq
- $ne
- $in
- $nin
- $like
- $ilike
- $re
- $contains
- $gt
- $gte
- $lt
- $lte
properties: properties:
$eq: {} $eq:
$ne: {} type: string
$in: {} description: Filter by an exact match.
$nin: {} $ne:
$like: {} type: string
$ilike: {} description: Filter by values not matching this parameter.
$re: {} $in:
$contains: {} type: array
$gt: {} description: Filter by values in this array's items.
$gte: {} items:
$lt: {} type: string
$lte: {} $nin:
type: array
description: Filter by values not in this array's items.
items:
type: string
$like:
type: string
description: Apply a `like` filter. Useful for strings only.
$ilike:
type: string
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$re:
type: string
description: Apply a regex filter. Useful for strings only.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
$gt:
type: string
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
description: >-
Filter by values less than this parameter. Useful for numbers
and dates only.
$lte:
type: string
description: >-
Filter by values less than or equal to this parameter. Useful
for numbers and dates only.
- name: created_at - name: created_at
in: query in: query
description: The reservation's created at. description: Filter by a reservation's creation date.
required: false required: false
schema: schema:
type: object type: object
description: The reservation's created at. description: Filter by a reservation's creation date.
properties: properties:
$and: $and:
type: array type: array
@@ -217,150 +257,6 @@ get:
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
parameter. parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array - type: array
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
@@ -438,11 +334,11 @@ get:
description: Filter by whether a value for this parameter exists (not `null`). description: Filter by whether a value for this parameter exists (not `null`).
- name: updated_at - name: updated_at
in: query in: query
description: The reservation's updated at. description: Filter by a reservation's update date.
required: false required: false
schema: schema:
type: object type: object
description: The reservation's updated at. description: Filter by a reservation's update date.
properties: properties:
$and: $and:
type: array type: array
@@ -500,150 +396,6 @@ get:
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
parameter. parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array - type: array
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
@@ -721,11 +473,11 @@ get:
description: Filter by whether a value for this parameter exists (not `null`). description: Filter by whether a value for this parameter exists (not `null`).
- name: deleted_at - name: deleted_at
in: query in: query
description: The reservation's deleted at. description: Filter by a reservation's deletion date.
required: false required: false
schema: schema:
type: object type: object
description: The reservation's deleted at. description: Filter by a reservation's deletion date.
properties: properties:
$and: $and:
type: array type: array
@@ -783,150 +535,6 @@ get:
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
parameter. parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array - type: array
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
@@ -1021,7 +629,7 @@ get:
schema: schema:
allOf: allOf:
- type: object - type: object
description: SUMMARY description: The paginated list of reservations.
required: required:
- limit - limit
- offset - offset
@@ -1030,23 +638,25 @@ get:
limit: limit:
type: number type: number
title: limit title: limit
description: The reservation's limit. description: The maximum number of items returned.
offset: offset:
type: number type: number
title: offset title: offset
description: The reservation's offset. description: >-
The number of items skipped before retrieving the returned
items.
count: count:
type: number type: number
title: count title: count
description: The reservation's count. description: The total number of items.
- type: object - type: object
description: SUMMARY description: The paginated list of reservations.
required: required:
- reservations - reservations
properties: properties:
reservations: reservations:
type: array type: array
description: The reservation's reservations. description: The list of reservations`.
items: items:
$ref: ../components/schemas/ReservationResponse.yaml $ref: ../components/schemas/ReservationResponse.yaml
'400': '400':
www/apps/api-reference/specs/admin/paths/admin_return-reasons.yaml
+45 -459
View File
@@ -63,12 +63,12 @@ get:
with `-`. with `-`.
- name: q - name: q
in: query in: query
description: The return reason's q. description: Search term to filter the return reason's searchable properties.
required: false required: false
schema: schema:
type: string type: string
title: q title: q
description: The return reason's q. description: Search term to filter the return reason's searchable properties.
- name: id - name: id
in: query in: query
required: false required: false
@@ -76,13 +76,13 @@ get:
oneOf: oneOf:
- type: string - type: string
title: id title: id
description: The return reason's ID. description: Filter by a return reason ID.
- type: array - type: array
description: The return reason's ID. description: Filter by return reason IDs.
items: items:
type: string type: string
title: id title: id
description: The id's ID. description: A return reason ID.
- name: value - name: value
in: query in: query
required: false required: false
@@ -90,13 +90,13 @@ get:
oneOf: oneOf:
- type: string - type: string
title: value title: value
description: The return reason's value. description: Filter by a return reason's value.
- type: array - type: array
description: The return reason's value. description: Filter by return reason values.
items: items:
type: string type: string
title: value title: value
description: The value's details. description: A return reason value.
- name: label - name: label
in: query in: query
required: false required: false
@@ -104,13 +104,13 @@ get:
oneOf: oneOf:
- type: string - type: string
title: label title: label
description: The return reason's label. description: Filter by a return reason's label.
- type: array - type: array
description: The return reason's label. description: Filter by return reason labels.
items: items:
type: string type: string
title: label title: label
description: The label's details. description: A return reason label.
- name: description - name: description
in: query in: query
required: false required: false
@@ -118,13 +118,19 @@ get:
oneOf: oneOf:
- type: string - type: string
title: description title: description
description: The return reason's description. description: >-
Filter by a description. This filter looks for an exact match of
the return reason's description. To search by a term or keywords,
use the `q` query parameter instead.
- type: array - type: array
description: The return reason's description. description: >-
Filter by descriptions. This filter looks for an exact match of
the return reason's description. To search by a term or keywords,
use the `q` query parameter instead.
items: items:
type: string type: string
title: description title: description
description: The description's details. description: A return reason's description.
- name: parent_return_reason_id - name: parent_return_reason_id
in: query in: query
required: false required: false
@@ -132,20 +138,24 @@ get:
oneOf: oneOf:
- type: string - type: string
title: parent_return_reason_id title: parent_return_reason_id
description: The return reason's parent return reason id. description: >-
Filter by a return reason's ID to retrieve its child return
reasons.
- type: array - type: array
description: The return reason's parent return reason id. description: >-
Filter by return reason IDs to retrieve their child return
reasons.
items: items:
type: string type: string
title: parent_return_reason_id title: parent_return_reason_id
description: The parent return reason id's details. description: The return reason's ID.
- name: created_at - name: created_at
in: query in: query
description: The return reason's created at. description: Filter by a return reason's creation date.
required: false required: false
schema: schema:
type: object type: object
description: The return reason's created at. description: Filter by a return reason's creation date.
properties: properties:
$and: $and:
type: array type: array
@@ -203,150 +213,6 @@ get:
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
parameter. parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array - type: array
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
@@ -424,11 +290,11 @@ get:
description: Filter by whether a value for this parameter exists (not `null`). description: Filter by whether a value for this parameter exists (not `null`).
- name: updated_at - name: updated_at
in: query in: query
description: The return reason's updated at. description: Filter by a return reason's update date.
required: false required: false
schema: schema:
type: object type: object
description: The return reason's updated at. description: Filter by a return reason's update date.
properties: properties:
$and: $and:
type: array type: array
@@ -486,150 +352,6 @@ get:
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
parameter. parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array - type: array
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
@@ -707,11 +429,11 @@ get:
description: Filter by whether a value for this parameter exists (not `null`). description: Filter by whether a value for this parameter exists (not `null`).
- name: deleted_at - name: deleted_at
in: query in: query
description: The return reason's deleted at. description: Filter by a return reason's deletion date.
required: false required: false
schema: schema:
type: object type: object
description: The return reason's deleted at. description: Filter by a return reason's deletion date.
properties: properties:
$and: $and:
type: array type: array
@@ -769,150 +491,6 @@ get:
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
parameter. parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array - type: array
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
@@ -990,21 +568,29 @@ get:
description: Filter by whether a value for this parameter exists (not `null`). description: Filter by whether a value for this parameter exists (not `null`).
- name: $and - name: $and
in: query in: query
description: The return reason's $and. description: >-
Join query parameters with an AND condition. Each object's content is
the same type as the expected query parameters.
required: false required: false
schema: schema:
type: array type: array
description: The return reason's $and. description: >-
Join query parameters with an AND condition. Each object's content is
the same type as the expected query parameters.
items: items:
type: object type: object
title: $and title: $and
- name: $or - name: $or
in: query in: query
description: The return reason's $or. description: >-
Join query parameters with an OR condition. Each object's content is the
same type as the expected query parameters.
required: false required: false
schema: schema:
type: array type: array
description: The return reason's $or. description: >-
Join query parameters with an OR condition. Each object's content is
the same type as the expected query parameters.
items: items:
type: object type: object
title: $or title: $or
www/apps/api-reference/specs/admin/paths/admin_returns.yaml
+57 -592
View File
@@ -68,27 +68,55 @@ get:
oneOf: oneOf:
- type: string - type: string
title: id title: id
description: The return's ID. description: Filter by a return's ID.
- type: array - type: array
description: The return's ID. description: Filter by return IDs.
items: items:
type: string type: string
title: id title: id
description: The id's ID. description: A return ID.
- name: name - name: status
in: query in: query
required: false required: false
schema: schema:
oneOf: oneOf:
- type: string - type: string
title: name title: status
description: The return's name. description: Filter by a return status.
- type: array - type: array
description: The return's name. description: Filter by return statuses.
items: items:
type: string type: string
title: name title: status
description: The name's details. description: A return status.
- name: $and
in: query
description: >-
Join query parameters with an AND condition. Each object's content is
the same type as the expected query parameters.
required: false
schema:
type: array
description: >-
Join query parameters with an AND condition. Each object's content is
the same type as the expected query parameters.
items:
type: object
title: $and
- name: $or
in: query
description: >-
Join query parameters with an OR condition. Each object's content is the
same type as the expected query parameters.
required: false
schema:
type: array
description: >-
Join query parameters with an OR condition. Each object's content is
the same type as the expected query parameters.
items:
type: object
title: $or
- name: sales_channel_id - name: sales_channel_id
in: query in: query
description: The return's sales channel id. description: The return's sales channel id.
@@ -109,8 +137,16 @@ get:
description: The return's fulfillment status. description: The return's fulfillment status.
items: items:
type: string type: string
title: fulfillment_status
description: The fulfillment status's details. description: The fulfillment status's details.
enum:
- canceled
- not_fulfilled
- partially_fulfilled
- fulfilled
- partially_shipped
- shipped
- partially_delivered
- delivered
- name: payment_status - name: payment_status
in: query in: query
description: The return's payment status. description: The return's payment status.
@@ -120,8 +156,18 @@ get:
description: The return's payment status. description: The return's payment status.
items: items:
type: string type: string
title: payment_status
description: The payment status's details. description: The payment status's details.
enum:
- canceled
- not_paid
- awaiting
- authorized
- partially_authorized
- captured
- partially_captured
- partially_refunded
- refunded
- requires_action
- name: region_id - name: region_id
in: query in: query
description: The return's region id. description: The return's region id.
@@ -707,587 +753,6 @@ get:
type: boolean type: boolean
title: $exists title: $exists
description: Filter by whether a value for this parameter exists (not `null`). description: Filter by whether a value for this parameter exists (not `null`).
- name: status
in: query
required: false
schema:
oneOf:
- type: string
title: status
description: The return's status.
- type: array
description: The return's status.
items:
type: string
title: status
description: The status's details.
- type: object
description: The return's status.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
oneOf:
- type: string
title: $ne
description: Filter by values not equal to this parameter.
- type: array
description: Filter by values not equal to this parameter.
items:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
oneOf:
- type: string
title: $in
description: Filter by values in this array.
- type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
oneOf:
- type: string
title: $nin
description: Filter by values not in this array.
- type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each
object's content is the same type as the expected
query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each
object's content is the same type as the expected
query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in
this parameter.
- type: object
description: >-
Filter by values not matching the conditions in
this parameter.
- type: array
description: >-
Filter by values not matching the conditions in
this parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in
this parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful
for numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this
parameter. Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for
strings only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of
this parameter.
$contained:
type: array
description: >-
Filter arrays that contain all values of this
parameter.
items:
type: string
title: $contained
description: >-
Filter arrays that contain all values of this
parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists
(not `null`).
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition.
Each object's content is the same type as the
expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each
object's content is the same type as the
expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions
in this parameter.
- type: object
description: >-
Filter by values not matching the conditions
in this parameter.
- type: array
description: >-
Filter by values not matching the conditions
in this parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the
conditions in this parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter.
Useful for numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this
parameter. Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter.
Useful for numbers and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this
parameter. Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful
for strings only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with
this parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values
with this parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of
this parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values
of this parameter.
$contained:
type: array
description: >-
Filter arrays that contain all values of this
parameter.
items:
type: string
title: $contained
description: >-
Filter arrays that contain all values of this
parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter
exists (not `null`).
$gt:
oneOf:
- type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
- type: array
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
items:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
oneOf:
- type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
- type: array
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
items:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this
parameter. Useful for numbers and dates only.
$lt:
oneOf:
- type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
- type: array
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
items:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
$lte:
oneOf:
- type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
- type: array
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
items:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- name: $and
in: query
description: >-
Join query parameters with an AND condition. Each object's content is
the same type as the expected query parameters.
required: false
schema:
type: array
description: >-
Join query parameters with an AND condition. Each object's content is
the same type as the expected query parameters.
items:
type: object
title: $and
- name: $or
in: query
description: >-
Join query parameters with an OR condition. Each object's content is the
same type as the expected query parameters.
required: false
schema:
type: array
description: >-
Join query parameters with an OR condition. Each object's content is
the same type as the expected query parameters.
items:
type: object
title: $or
security: security:
- api_token: [] - api_token: []
- cookie_auth: [] - cookie_auth: []
www/apps/api-reference/specs/admin/paths/admin_sales-channels.yaml
+45 -463
View File
@@ -63,12 +63,12 @@ get:
with `-`. with `-`.
- name: q - name: q
in: query in: query
description: The sales channel's q. description: Search term to filter the sales channel's searchable properties.
required: false required: false
schema: schema:
type: string type: string
title: q title: q
description: The sales channel's q. description: Search term to filter the sales channel's searchable properties.
- name: id - name: id
in: query in: query
required: false required: false
@@ -76,13 +76,13 @@ get:
oneOf: oneOf:
- type: string - type: string
title: id title: id
description: The sales channel's ID. description: Filter by a sales channel ID.
- type: array - type: array
description: The sales channel's ID. description: Filter by sales channel IDs.
items: items:
type: string type: string
title: id title: id
description: The id's ID. description: A sales channel ID.
- name: name - name: name
in: query in: query
required: false required: false
@@ -90,13 +90,13 @@ get:
oneOf: oneOf:
- type: string - type: string
title: name title: name
description: The sales channel's name. description: Filter by a sales channel name.
- type: array - type: array
description: The sales channel's name. description: Filter by sales channel names.
items: items:
type: string type: string
title: name title: name
description: The name's details. description: A sales channel name.
- name: description - name: description
in: query in: query
description: The sales channel's description. description: The sales channel's description.
@@ -104,22 +104,24 @@ get:
schema: schema:
type: string type: string
title: description title: description
description: The sales channel's description. description: >-
Filter by a description. This filter matches an entire description. To
search by terms or keywords, use the `q` query parameter instead.
- name: is_disabled - name: is_disabled
in: query in: query
description: The sales channel's is disabled. description: Filter by whether the sales channel is disabled.
required: false required: false
schema: schema:
type: boolean type: boolean
title: is_disabled title: is_disabled
description: The sales channel's is disabled. description: Filter by whether the sales channel is disabled.
- name: created_at - name: created_at
in: query in: query
description: The sales channel's created at. description: Filter by a sales channel's creation date.
required: false required: false
schema: schema:
type: object type: object
description: The sales channel's created at. description: Filter by a sales channel's creation date.
properties: properties:
$and: $and:
type: array type: array
@@ -177,150 +179,6 @@ get:
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
parameter. parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array - type: array
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
@@ -398,11 +256,11 @@ get:
description: Filter by whether a value for this parameter exists (not `null`). description: Filter by whether a value for this parameter exists (not `null`).
- name: updated_at - name: updated_at
in: query in: query
description: The sales channel's updated at. description: Filter by a sales channel's update date.
required: false required: false
schema: schema:
type: object type: object
description: The sales channel's updated at. description: Filter by a sales channel's update date.
properties: properties:
$and: $and:
type: array type: array
@@ -460,150 +318,6 @@ get:
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
parameter. parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array - type: array
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
@@ -681,11 +395,11 @@ get:
description: Filter by whether a value for this parameter exists (not `null`). description: Filter by whether a value for this parameter exists (not `null`).
- name: deleted_at - name: deleted_at
in: query in: query
description: The sales channel's deleted at. description: Filter by a sales channel's deletion date.
required: false required: false
schema: schema:
type: object type: object
description: The sales channel's deleted at. description: Filter by a sales channel's deletion date.
properties: properties:
$and: $and:
type: array type: array
@@ -743,150 +457,6 @@ get:
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
parameter. parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array - type: array
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
@@ -969,13 +539,15 @@ get:
oneOf: oneOf:
- type: string - type: string
title: location_id title: location_id
description: The sales channel's location id. description: Filter by a location ID to retrieve its associated sales channels.
- type: array - type: array
description: The sales channel's location id. description: >-
Filter by location IDs to retrieve their associated sales
channels.
items: items:
type: string type: string
title: location_id title: location_id
description: The location id's details. description: A location ID.
- name: publishable_key_id - name: publishable_key_id
in: query in: query
required: false required: false
@@ -983,19 +555,25 @@ get:
oneOf: oneOf:
- type: string - type: string
title: publishable_key_id title: publishable_key_id
description: The sales channel's publishable key id. description: >-
Filter by a publishable API key's ID to retrieve its associated
sales channels.
- type: array - type: array
description: The sales channel's publishable key id. description: >-
Filter by publishable API key IDs to retrieve their associated
sales channels.
items: items:
type: string type: string
title: publishable_key_id title: publishable_key_id
description: The publishable key id's details. description: A publishable API key ID.
- name: $and - name: $and
in: query in: query
required: false required: false
schema: schema:
type: array type: array
description: The sales channel's $and. description: >-
Join query parameters with an AND condition. Each object's content is
the same type as the expected query parameters.
items: items:
type: object type: object
title: $and title: $and
@@ -1004,7 +582,9 @@ get:
required: false required: false
schema: schema:
type: array type: array
description: The sales channel's $or. description: >-
Join query parameters with an OR condition. Each object's content is
the same type as the expected query parameters.
items: items:
type: object type: object
title: $or title: $or
@@ -1027,7 +607,7 @@ get:
schema: schema:
allOf: allOf:
- type: object - type: object
description: SUMMARY description: The paginated list of sales channels.
required: required:
- limit - limit
- offset - offset
@@ -1036,23 +616,25 @@ get:
limit: limit:
type: number type: number
title: limit title: limit
description: The sales channel's limit. description: The maximum number of items returned.
offset: offset:
type: number type: number
title: offset title: offset
description: The sales channel's offset. description: >-
The number of items skipped before retrieving the returned
items.
count: count:
type: number type: number
title: count title: count
description: The sales channel's count. description: The total number of items.
- type: object - type: object
description: SUMMARY description: The paginated list of sales channels.
required: required:
- sales_channels - sales_channels
properties: properties:
sales_channels: sales_channels:
type: array type: array
description: The sales channel's sales channels. description: The list of sales channels.
items: items:
$ref: ../components/schemas/AdminSalesChannel.yaml $ref: ../components/schemas/AdminSalesChannel.yaml
'400': '400':
www/apps/api-reference/specs/admin/paths/admin_shipping-options.yaml
+54 -464
View File
@@ -68,21 +68,21 @@ get:
oneOf: oneOf:
- type: string - type: string
title: id title: id
description: The shipping option's ID. description: Filter by a shipping option ID.
- type: array - type: array
description: The shipping option's ID. description: Filter by shipping option IDs.
items: items:
type: string type: string
title: id title: id
description: The id's ID. description: A shipping option's ID.
- name: q - name: q
in: query in: query
description: The shipping option's q. description: Search term to filter the shipping option's searchable properties.
required: false required: false
schema: schema:
type: string type: string
title: q title: q
description: The shipping option's q. description: Search term to filter the shipping option's searchable properties.
- name: service_zone_id - name: service_zone_id
in: query in: query
required: false required: false
@@ -90,13 +90,17 @@ get:
oneOf: oneOf:
- type: string - type: string
title: service_zone_id title: service_zone_id
description: The shipping option's service zone id. description: >-
Filter by a service zone's ID to retrieve its associated shipping
options.
- type: array - type: array
description: The shipping option's service zone id. description: >-
Filter by service zone IDs to retrieve their associated shipping
options.
items: items:
type: string type: string
title: service_zone_id title: service_zone_id
description: The service zone id's details. description: A service zone ID.
- name: shipping_profile_id - name: shipping_profile_id
in: query in: query
required: false required: false
@@ -104,13 +108,17 @@ get:
oneOf: oneOf:
- type: string - type: string
title: shipping_profile_id title: shipping_profile_id
description: The shipping option's shipping profile id. description: >-
Filter by a shipping profile's ID to retrieve its associated
shipping options.
- type: array - type: array
description: The shipping option's shipping profile id. description: >-
Filter by shipping profile IDs to retrieve their associated
shipping options.
items: items:
type: string type: string
title: shipping_profile_id title: shipping_profile_id
description: The shipping profile id's details. description: A shipping profile ID.
- name: provider_id - name: provider_id
in: query in: query
required: false required: false
@@ -118,13 +126,17 @@ get:
oneOf: oneOf:
- type: string - type: string
title: provider_id title: provider_id
description: The shipping option's provider id. description: >-
Filter by a fulfillment provider's ID to retrieve its associated
shipping options.
- type: array - type: array
description: The shipping option's provider id. description: >-
Filter by fulfillment provider IDs to retrieve their associated
shipping options.
items: items:
type: string type: string
title: provider_id title: provider_id
description: The provider id's details. description: A fulfillment provider ID.
- name: shipping_option_type_id - name: shipping_option_type_id
in: query in: query
required: false required: false
@@ -132,20 +144,24 @@ get:
oneOf: oneOf:
- type: string - type: string
title: shipping_option_type_id title: shipping_option_type_id
description: The shipping option's shipping option type id. description: >-
Filter by a shipping option type's ID to retrieve its associated
shipping options.
- type: array - type: array
description: The shipping option's shipping option type id. description: >-
Filter by shipping option type IDs to retrieve its associated
shipping options.
items: items:
type: string type: string
title: shipping_option_type_id title: shipping_option_type_id
description: The shipping option type id's details. description: A shipping option type ID.
- name: created_at - name: created_at
in: query in: query
description: The shipping option's created at. description: Filter by a shipping option's creation date.
required: false required: false
schema: schema:
type: object type: object
description: The shipping option's created at. description: Filter by a shipping option's creation date.
properties: properties:
$and: $and:
type: array type: array
@@ -203,150 +219,6 @@ get:
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
parameter. parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array - type: array
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
@@ -424,11 +296,11 @@ get:
description: Filter by whether a value for this parameter exists (not `null`). description: Filter by whether a value for this parameter exists (not `null`).
- name: updated_at - name: updated_at
in: query in: query
description: The shipping option's updated at. description: Filter by a shipping option's update date.
required: false required: false
schema: schema:
type: object type: object
description: The shipping option's updated at. description: Filter by a shipping option's update date.
properties: properties:
$and: $and:
type: array type: array
@@ -486,150 +358,6 @@ get:
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
parameter. parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array - type: array
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
@@ -707,11 +435,11 @@ get:
description: Filter by whether a value for this parameter exists (not `null`). description: Filter by whether a value for this parameter exists (not `null`).
- name: deleted_at - name: deleted_at
in: query in: query
description: The shipping option's deleted at. description: Filter by a shipping option's deletion date.
required: false required: false
schema: schema:
type: object type: object
description: The shipping option's deleted at. description: Filter by a shipping option's deletion date.
properties: properties:
$and: $and:
type: array type: array
@@ -769,150 +497,6 @@ get:
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
parameter. parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array - type: array
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
@@ -995,13 +579,17 @@ get:
oneOf: oneOf:
- type: string - type: string
title: stock_location_id title: stock_location_id
description: The shipping option's stock location id. description: >-
Filter by a location ID to retrieve its associated shipping
option.
- type: array - type: array
description: The shipping option's stock location id. description: >-
Filter by location IDs to retrieve their associated shipping
option.
items: items:
type: string type: string
title: stock_location_id title: stock_location_id
description: The stock location id's details. description: A stock location's ID.
- name: is_return - name: is_return
in: query in: query
description: The shipping option's is return. description: The shipping option's is return.
@@ -1037,7 +625,7 @@ get:
schema: schema:
allOf: allOf:
- type: object - type: object
description: SUMMARY description: The paginated list of shipping options.
required: required:
- limit - limit
- offset - offset
@@ -1046,23 +634,25 @@ get:
limit: limit:
type: number type: number
title: limit title: limit
description: The shipping option's limit. description: The maximum number of items returned.
offset: offset:
type: number type: number
title: offset title: offset
description: The shipping option's offset. description: >-
The number of items skipped before retrieving the returned
items.
count: count:
type: number type: number
title: count title: count
description: The shipping option's count. description: The total number of items.
- type: object - type: object
description: SUMMARY description: The paginated list of shipping options.
required: required:
- shipping_options - shipping_options
properties: properties:
shipping_options: shipping_options:
type: array type: array
description: The shipping option's shipping options. description: The list of shipping options.
items: items:
type: object type: object
'400': '400':
www/apps/api-reference/specs/admin/paths/admin_shipping-profiles.yaml
+432 -41
View File
@@ -69,58 +69,462 @@ get:
oneOf: oneOf:
- type: string - type: string
title: id title: id
description: The shipping profile's ID. description: Filter by a shipping profile's ID.
- type: array - type: array
description: The shipping profile's ID. description: Filter by shipping profile IDs.
items: items:
type: string type: string
title: id title: id
description: The id's ID. description: A shipping profile ID.
- name: q - name: q
in: query in: query
description: The shipping profile's q. description: Search term to filter the shipping profile's searchable properties.
required: false required: false
schema: schema:
type: string type: string
title: q title: q
description: The shipping profile's q. description: Search term to filter the shipping profile's searchable properties.
- name: type - name: type
in: query in: query
description: The shipping profile's type. description: Filter by a shipping profile's type.
required: false required: false
schema: schema:
type: string type: string
title: type title: type
description: The shipping profile's type. description: Filter by a shipping profile's type.
- name: name - name: name
in: query in: query
description: The shipping profile's name. description: Filter by a shipping profile's name.
required: false required: false
schema: schema:
type: string type: string
title: name title: name
description: The shipping profile's name. description: Filter by a shipping profile's name.
- name: created_at - name: created_at
in: query in: query
description: The shipping profile's created at. description: Filter by a shipping profile's creation date.
required: false required: false
schema: {} schema:
type: object
description: Filter by a shipping profile's creation date.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's content
is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's content
is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for numbers
and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter. Useful
for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for numbers and
dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter. Useful for
numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: Apply a case-insensitive `like` filter. Useful for strings only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: Filter arrays that have overlapping values with this parameter.
items:
type: string
title: $overlap
description: Filter arrays that have overlapping values with this parameter.
$contains:
type: array
description: Filter arrays that contain some of the values of this parameter.
items:
type: string
title: $contains
description: Filter arrays that contain some of the values of this parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
- name: updated_at - name: updated_at
in: query in: query
description: The shipping profile's updated at. description: Filter by a shipping profile's update date.
required: false required: false
schema: {} schema:
type: object
description: Filter by a shipping profile's update date.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's content
is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's content
is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for numbers
and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter. Useful
for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for numbers and
dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter. Useful for
numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: Apply a case-insensitive `like` filter. Useful for strings only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: Filter arrays that have overlapping values with this parameter.
items:
type: string
title: $overlap
description: Filter arrays that have overlapping values with this parameter.
$contains:
type: array
description: Filter arrays that contain some of the values of this parameter.
items:
type: string
title: $contains
description: Filter arrays that contain some of the values of this parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
- name: deleted_at - name: deleted_at
in: query in: query
description: The shipping profile's deleted at. description: Filter by a shipping profile's deletion date.
required: false required: false
schema: {} schema:
type: object
description: Filter by a shipping profile's deletion date.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's content
is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's content
is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for numbers
and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter. Useful
for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for numbers and
dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter. Useful for
numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: Apply a case-insensitive `like` filter. Useful for strings only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: Filter arrays that have overlapping values with this parameter.
items:
type: string
title: $overlap
description: Filter arrays that have overlapping values with this parameter.
$contains:
type: array
description: Filter arrays that contain some of the values of this parameter.
items:
type: string
title: $contains
description: Filter arrays that contain some of the values of this parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
- name: $and - name: $and
in: query in: query
required: false required: false
schema: schema:
type: array type: array
description: The shipping profile's $and. description: >-
Join query parameters with an AND condition. Each object's content is
the same type as the expected query parameters.
items: items:
type: object type: object
title: $and title: $and
@@ -129,7 +533,9 @@ get:
required: false required: false
schema: schema:
type: array type: array
description: The shipping profile's $or. description: >-
Join query parameters with an OR condition. Each object's content is
the same type as the expected query parameters.
items: items:
type: object type: object
title: $or title: $or
@@ -152,7 +558,7 @@ get:
schema: schema:
allOf: allOf:
- type: object - type: object
description: SUMMARY description: The paginated list of shipping profiles.
required: required:
- limit - limit
- offset - offset
@@ -161,23 +567,25 @@ get:
limit: limit:
type: number type: number
title: limit title: limit
description: The shipping profile's limit. description: The maximum number of items returned.
offset: offset:
type: number type: number
title: offset title: offset
description: The shipping profile's offset. description: >-
The number of items skipped before retrieving the returned
items.
count: count:
type: number type: number
title: count title: count
description: The shipping profile's count. description: The total number of items.
- type: object - type: object
description: SUMMARY description: The paginated list of shipping profiles.
required: required:
- shipping_profiles - shipping_profiles
properties: properties:
shipping_profiles: shipping_profiles:
type: array type: array
description: The shipping profile's shipping profiles. description: The list of shipping profiles.
items: items:
$ref: ../components/schemas/AdminShippingProfile.yaml $ref: ../components/schemas/AdminShippingProfile.yaml
'400': '400':
@@ -261,24 +669,7 @@ post:
content: content:
application/json: application/json:
schema: schema:
type: object $ref: ../components/schemas/AdminCreateShippingProfile.yaml
description: SUMMARY
required:
- name
- type
- metadata
properties:
name:
type: string
title: name
description: The shipping profile's name.
type:
type: string
title: type
description: The shipping profile's type.
metadata:
type: object
description: The shipping profile's metadata.
x-codeSamples: x-codeSamples:
- lang: Shell - lang: Shell
label: cURL label: cURL
www/apps/api-reference/specs/admin/paths/admin_stock-locations.yaml
+28 -454
View File
@@ -63,12 +63,12 @@ get:
with `-`. with `-`.
- name: q - name: q
in: query in: query
description: The stock location's q. description: Search term to filter the stock location's searchable properties.
required: false required: false
schema: schema:
type: string type: string
title: q title: q
description: The stock location's q. description: Search term to filter the stock location's searchable properties.
- name: id - name: id
in: query in: query
required: false required: false
@@ -76,13 +76,13 @@ get:
oneOf: oneOf:
- type: string - type: string
title: id title: id
description: The stock location's ID. description: Filter by a stock location ID.
- type: array - type: array
description: The stock location's ID. description: Filter by stock location IDs.
items: items:
type: string type: string
title: id title: id
description: The id's ID. description: A stock location ID.
- name: name - name: name
in: query in: query
required: false required: false
@@ -90,13 +90,13 @@ get:
oneOf: oneOf:
- type: string - type: string
title: name title: name
description: The stock location's name. description: Filter by a stock location name.
- type: array - type: array
description: The stock location's name. description: Filter by stock location names.
items: items:
type: string type: string
title: name title: name
description: The name's details. description: A stock location name.
- name: address_id - name: address_id
in: query in: query
required: false required: false
@@ -104,13 +104,13 @@ get:
oneOf: oneOf:
- type: string - type: string
title: address_id title: address_id
description: The stock location's address id. description: Filter by an address ID to retrieve its associated locations.
- type: array - type: array
description: The stock location's address id. description: Filter by address IDs to retrieve their associated locations.
items: items:
type: string type: string
title: address_id title: address_id
description: The address id's details. description: An address ID.
- name: sales_channel_id - name: sales_channel_id
in: query in: query
required: false required: false
@@ -118,20 +118,22 @@ get:
oneOf: oneOf:
- type: string - type: string
title: sales_channel_id title: sales_channel_id
description: The stock location's sales channel id. description: Filter by a sales channel ID to retrieve its associated locations.
- type: array - type: array
description: The stock location's sales channel id. description: >-
Filter by sales channel IDs to retrieve their associated
locations.
items: items:
type: string type: string
title: sales_channel_id title: sales_channel_id
description: The sales channel id's details. description: A sales channel ID
- name: created_at - name: created_at
in: query in: query
description: The stock location's created at. description: Filter by a stock location's creation date.
required: false required: false
schema: schema:
type: object type: object
description: The stock location's created at. description: Filter by a stock location's creation date.
properties: properties:
$and: $and:
type: array type: array
@@ -189,150 +191,6 @@ get:
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
parameter. parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array - type: array
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
@@ -410,11 +268,11 @@ get:
description: Filter by whether a value for this parameter exists (not `null`). description: Filter by whether a value for this parameter exists (not `null`).
- name: updated_at - name: updated_at
in: query in: query
description: The stock location's updated at. description: Filter by a stock location's update date.
required: false required: false
schema: schema:
type: object type: object
description: The stock location's updated at. description: Filter by a stock location's update date.
properties: properties:
$and: $and:
type: array type: array
@@ -472,150 +330,6 @@ get:
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
parameter. parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array - type: array
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
@@ -693,11 +407,11 @@ get:
description: Filter by whether a value for this parameter exists (not `null`). description: Filter by whether a value for this parameter exists (not `null`).
- name: deleted_at - name: deleted_at
in: query in: query
description: The stock location's deleted at. description: Filter by a stock location's deletion date.
required: false required: false
schema: schema:
type: object type: object
description: The stock location's deleted at. description: Filter by a stock location's deletion date.
properties: properties:
$and: $and:
type: array type: array
@@ -755,150 +469,6 @@ get:
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
parameter. parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array - type: array
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
@@ -979,7 +549,9 @@ get:
required: false required: false
schema: schema:
type: array type: array
description: The stock location's $and. description: >-
Join query parameters with an AND condition. Each object's content is
the same type as the expected query parameters.
items: items:
type: object type: object
title: $and title: $and
@@ -988,7 +560,9 @@ get:
required: false required: false
schema: schema:
type: array type: array
description: The stock location's $or. description: >-
Join query parameters with an OR condition. Each object's content is
the same type as the expected query parameters.
items: items:
type: object type: object
title: $or title: $or
www/apps/api-reference/specs/admin/paths/admin_stores.yaml
+14 -10
View File
@@ -63,12 +63,12 @@ get:
with `-`. with `-`.
- name: q - name: q
in: query in: query
description: The store's q. description: Search term to filter the store's searchable properties.
required: false required: false
schema: schema:
type: string type: string
title: q title: q
description: The store's q. description: Search term to filter the store's searchable properties.
- name: id - name: id
in: query in: query
required: false required: false
@@ -76,13 +76,13 @@ get:
oneOf: oneOf:
- type: string - type: string
title: id title: id
description: The store's ID. description: Filter by a store ID.
- type: array - type: array
description: The store's ID. description: Filter by store IDs.
items: items:
type: string type: string
title: id title: id
description: The id's ID. description: A store ID.
- name: name - name: name
in: query in: query
required: false required: false
@@ -90,19 +90,21 @@ get:
oneOf: oneOf:
- type: string - type: string
title: name title: name
description: The store's name. description: Filter by a store name.
- type: array - type: array
description: The store's name. description: Filter by store names.
items: items:
type: string type: string
title: name title: name
description: The name's details. description: A store name.
- name: $and - name: $and
in: query in: query
required: false required: false
schema: schema:
type: array type: array
description: The store's $and. description: >-
Join query parameters with an AND condition. Each object's content is
the same type as the expected query parameters.
items: items:
type: object type: object
title: $and title: $and
@@ -111,7 +113,9 @@ get:
required: false required: false
schema: schema:
type: array type: array
description: The store's $or. description: >-
Join query parameters with an OR condition. Each object's content is
the same type as the expected query parameters.
items: items:
type: object type: object
title: $or title: $or
www/apps/api-reference/specs/admin/paths/admin_tax-rates.yaml
+100 -485
View File
@@ -63,12 +63,12 @@ get:
with `-`. with `-`.
- name: q - name: q
in: query in: query
description: The tax rate's q. description: Search terms to filter the tax rate's searchable properties.
required: false required: false
schema: schema:
type: string type: string
title: q title: q
description: The tax rate's q. description: Search terms to filter the tax rate's searchable properties.
- name: tax_region_id - name: tax_region_id
in: query in: query
required: false required: false
@@ -76,57 +76,88 @@ get:
oneOf: oneOf:
- type: string - type: string
title: tax_region_id title: tax_region_id
description: The tax rate's tax region id. description: Filter by a tax region ID to retrieve its associated rates.
- type: array - type: array
description: The tax rate's tax region id. description: Filter by tax region IDs to retrieve their associated rates.
items: items:
type: string type: string
title: tax_region_id title: tax_region_id
description: The tax region id's details. description: A tax region ID.
- type: object - type: object
description: The tax rate's tax region id. description: >-
required: Apply filters on the tax region ID to retrieve the rates
- $eq associated with the matching tax regions.
- $ne
- $in
- $nin
- $like
- $ilike
- $re
- $contains
- $gt
- $gte
- $lt
- $lte
properties: properties:
$eq: {} $eq:
$ne: {} type: string
$in: {} description: Filter by an exact match.
$nin: {} $ne:
$like: {} type: string
$ilike: {} description: Filter by values not matching this parameter.
$re: {} $in:
$contains: {} type: array
$gt: {} description: Filter by values in this array's items.
$gte: {} items:
$lt: {} type: string
$lte: {} $nin:
type: array
description: Filter by values not in this array's items.
items:
type: string
$like:
type: string
description: Apply a `like` filter. Useful for strings only.
$ilike:
type: string
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$re:
type: string
description: Apply a regex filter. Useful for strings only.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
$gt:
type: string
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
description: >-
Filter by values less than this parameter. Useful for numbers
and dates only.
$lte:
type: string
description: >-
Filter by values less than or equal to this parameter. Useful
for numbers and dates only.
- name: is_default - name: is_default
in: query in: query
required: false required: false
description: Filter by whether the tax rate is a default in its tax region.
schema: schema:
type: string type: string
enum: enum:
- 'true' - 'true'
- 'false' - 'false'
title: is_default
- name: created_at - name: created_at
in: query in: query
description: The tax rate's created at. description: Filter by a tax rate's creation date.
required: false required: false
schema: schema:
type: object type: object
description: The tax rate's created at. description: Filter by a tax rate's creation date.
properties: properties:
$and: $and:
type: array type: array
@@ -184,150 +215,6 @@ get:
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
parameter. parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array - type: array
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
@@ -405,11 +292,11 @@ get:
description: Filter by whether a value for this parameter exists (not `null`). description: Filter by whether a value for this parameter exists (not `null`).
- name: updated_at - name: updated_at
in: query in: query
description: The tax rate's updated at. description: Filter by a tax rate's update date.
required: false required: false
schema: schema:
type: object type: object
description: The tax rate's updated at. description: Filter by a tax rate's update date.
properties: properties:
$and: $and:
type: array type: array
@@ -467,150 +354,6 @@ get:
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
parameter. parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array - type: array
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
@@ -688,11 +431,11 @@ get:
description: Filter by whether a value for this parameter exists (not `null`). description: Filter by whether a value for this parameter exists (not `null`).
- name: deleted_at - name: deleted_at
in: query in: query
description: The tax rate's deleted at. description: Filter by a tax rate's deletion date.
required: false required: false
schema: schema:
type: object type: object
description: The tax rate's deleted at. description: Filter by a tax rate's deletion date.
properties: properties:
$and: $and:
type: array type: array
@@ -750,150 +493,6 @@ get:
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
parameter. parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array - type: array
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
@@ -974,7 +573,9 @@ get:
required: false required: false
schema: schema:
type: array type: array
description: The tax rate's $and. description: >-
Join query parameters with an AND condition. Each object's content is
the same type as the expected query parameters.
items: items:
type: object type: object
title: $and title: $and
@@ -983,42 +584,54 @@ get:
required: false required: false
schema: schema:
type: array type: array
description: The tax rate's $or. description: >-
Join query parameters with an OR condition. Each object's content is
the same type as the expected query parameters.
items: items:
type: object type: object
title: $or title: $or
- name: service_zone_id - name: service_zone_id
in: query in: query
description: The tax rate's service zone id. description: Filter by a service zone's ID to retrieve its associated tax rates.
required: false required: false
schema: schema:
type: string type: string
title: service_zone_id title: service_zone_id
description: The tax rate's service zone id. description: Filter by a service zone's ID to retrieve its associated tax rates.
- name: shipping_profile_id - name: shipping_profile_id
in: query in: query
description: The tax rate's shipping profile id. description: Filter by a shipping profile's ID to retrieve its associated tax rates.
required: false required: false
schema: schema:
type: string type: string
title: shipping_profile_id title: shipping_profile_id
description: The tax rate's shipping profile id. description: >-
Filter by a shipping profile's ID to retrieve its associated tax
rates.
- name: provider_id - name: provider_id
in: query in: query
description: The tax rate's provider id. description: >-
Filter by a fulfillment provider's ID to retrieve its associated tax
rates.
required: false required: false
schema: schema:
type: string type: string
title: provider_id title: provider_id
description: The tax rate's provider id. description: >-
Filter by a fulfillment provider's ID to retrieve its associated tax
rates.
- name: shipping_option_type_id - name: shipping_option_type_id
in: query in: query
description: The tax rate's shipping option type id. description: >-
Filter by a shipping option type's ID to retrieve its associated tax
rates.
required: false required: false
schema: schema:
type: string type: string
title: shipping_option_type_id title: shipping_option_type_id
description: The tax rate's shipping option type id. description: >-
Filter by a shipping option type's ID to retrieve its associated tax
rates.
security: security:
- api_token: [] - api_token: []
- cookie_auth: [] - cookie_auth: []
@@ -1038,7 +651,7 @@ get:
schema: schema:
allOf: allOf:
- type: object - type: object
description: SUMMARY description: The paginated list of tax rates.
required: required:
- limit - limit
- offset - offset
@@ -1047,17 +660,19 @@ get:
limit: limit:
type: number type: number
title: limit title: limit
description: The tax rate's limit. description: The maximum number of items returned.
offset: offset:
type: number type: number
title: offset title: offset
description: The tax rate's offset. description: >-
The number of items skipped before retrieving the returned
items.
count: count:
type: number type: number
title: count title: count
description: The tax rate's count. description: The total number of items.
- type: object - type: object
description: SUMMARY description: The paginated list of tax rates.
required: required:
- tax_rates - tax_rates
properties: properties:
www/apps/api-reference/specs/admin/paths/admin_tax-regions.yaml
+1110 -109
View File
File diff suppressed because it is too large. Load diff
www/apps/api-reference/specs/admin/paths/admin_uploads_{id}.yaml
+3 -3
View File
@@ -1,9 +1,9 @@
get: get:
operationId: GetUploadsId operationId: GetUploadsId
summary: Get a Upload summary: Get a File
description: >- description: >-
Retrieve a upload by its ID. You can expand the upload's relations or select Retrieve an uploaded file by its ID. You can expand the file's relations or
the fields that should be returned. select the fields that should be returned.
x-authenticated: true x-authenticated: true
parameters: parameters:
- name: id - name: id
www/apps/api-reference/specs/admin/paths/admin_users.yaml
+17 -449
View File
@@ -63,12 +63,12 @@ get:
with `-`. with `-`.
- name: q - name: q
in: query in: query
description: The user's q. description: The search term to filter the user's searchable properties.
required: false required: false
schema: schema:
type: string type: string
title: q title: q
description: The user's q. description: The search term to filter the user's searchable properties.
- name: id - name: id
in: query in: query
required: false required: false
@@ -76,45 +76,45 @@ get:
oneOf: oneOf:
- type: string - type: string
title: id title: id
description: The user's ID. description: Filter by a user's ID.
- type: array - type: array
description: The user's ID. description: Filter by user IDs.
items: items:
type: string type: string
title: id title: id
description: The id's ID. description: A user's ID.
- name: email - name: email
in: query in: query
description: The user's email. description: Filter by an email.
required: false required: false
schema: schema:
type: string type: string
title: email title: email
description: The user's email. description: Filter by an email.
format: email format: email
- name: first_name - name: first_name
in: query in: query
description: The user's first name. description: Filter by a first name.
required: false required: false
schema: schema:
type: string type: string
title: first_name title: first_name
description: The user's first name. description: Filter by a first name.
- name: last_name - name: last_name
in: query in: query
description: The user's last name. description: Filter by a last name.
required: false required: false
schema: schema:
type: string type: string
title: last_name title: last_name
description: The user's last name. description: Filter by a last name.
- name: created_at - name: created_at
in: query in: query
description: The user's created at. description: Filter by a user's creation date.
required: false required: false
schema: schema:
type: object type: object
description: The user's created at. description: Filter by a user's creation date.
properties: properties:
$and: $and:
type: array type: array
@@ -172,150 +172,6 @@ get:
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
parameter. parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array - type: array
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
@@ -393,11 +249,11 @@ get:
description: Filter by whether a value for this parameter exists (not `null`). description: Filter by whether a value for this parameter exists (not `null`).
- name: updated_at - name: updated_at
in: query in: query
description: The user's updated at. description: Filter by a user's update date.
required: false required: false
schema: schema:
type: object type: object
description: The user's updated at. description: Filter by a user's update date.
properties: properties:
$and: $and:
type: array type: array
@@ -455,150 +311,6 @@ get:
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
parameter. parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array - type: array
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
@@ -676,11 +388,11 @@ get:
description: Filter by whether a value for this parameter exists (not `null`). description: Filter by whether a value for this parameter exists (not `null`).
- name: deleted_at - name: deleted_at
in: query in: query
description: The user's deleted at. description: Filter by a user's deletion date.
required: false required: false
schema: schema:
type: object type: object
description: The user's deleted at. description: Filter by a user's deletion date.
properties: properties:
$and: $and:
type: array type: array
@@ -738,150 +450,6 @@ get:
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
parameter. parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for
numbers and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter.
Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array - type: array
description: >- description: >-
Filter by values not matching the conditions in this Filter by values not matching the conditions in this
www/apps/api-reference/specs/admin/paths/admin_users_me.yaml
+2 -4
View File
@@ -1,9 +1,7 @@
get: get:
operationId: GetUsersMe operationId: GetUsersMe
summary: List Users summary: Get Logged-In User
description: >- description: Retrieve the logged-in user's details.
Retrieve a list of users. The users can be filtered by fields such as `id`.
The users can also be sorted or paginated.
x-authenticated: false x-authenticated: false
parameters: parameters:
- name: expand - name: expand
www/apps/api-reference/specs/admin/paths/admin_workflows-executions.yaml
+13 -11
View File
@@ -69,13 +69,13 @@ get:
oneOf: oneOf:
- type: string - type: string
title: transaction_id title: transaction_id
description: The workflows execution's transaction id. description: Filter by a transaction ID.
- type: array - type: array
description: The workflows execution's transaction id. description: Filter by transaction IDs.
items: items:
type: string type: string
title: transaction_id title: transaction_id
description: The transaction id's details. description: A transaction ID.
- name: workflow_id - name: workflow_id
in: query in: query
required: false required: false
@@ -83,13 +83,13 @@ get:
oneOf: oneOf:
- type: string - type: string
title: workflow_id title: workflow_id
description: The workflows execution's workflow id. description: Filter by a workflow ID.
- type: array - type: array
description: The workflows execution's workflow id. description: Filter by workflow IDs.
items: items:
type: string type: string
title: workflow_id title: workflow_id
description: The workflow id's details. description: A workflow ID.
security: security:
- api_token: [] - api_token: []
- cookie_auth: [] - cookie_auth: []
@@ -109,7 +109,7 @@ get:
schema: schema:
allOf: allOf:
- type: object - type: object
description: SUMMARY description: The paginated list of workflow executions.
required: required:
- limit - limit
- offset - offset
@@ -118,17 +118,19 @@ get:
limit: limit:
type: number type: number
title: limit title: limit
description: The workflows execution's limit. description: The maximum number of items returned.
offset: offset:
type: number type: number
title: offset title: offset
description: The workflows execution's offset. description: >-
The number of items skipped before retrieving the returned
items.
count: count:
type: number type: number
title: count title: count
description: The workflows execution's count. description: The total number of items.
- type: object - type: object
description: SUMMARY description: The paginated list of workflow executions.
required: required:
- workflow_executions - workflow_executions
properties: properties:
www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_subscribe.yaml
+19 -5
View File
@@ -1,10 +1,14 @@
get: get:
operationId: GetWorkflowsExecutionsWorkflow_idSubscribe operationId: GetWorkflowsExecutionsWorkflow_idSubscribe
summary: List Subscribes summary: Subscribe to a Workflow's Execution
description: >- x-sidebar-summary: Subscribe to Workflow
Retrieve a list of subscribes in a workflows execution. The subscribes can description: >
be filtered by fields like FILTER FIELDS. The subscribes can also be Subscribe to a workflow's execution to receive real-time information about
paginated. its steps, status, and data.
This route returns an event stream that you can consume using the
[EventSource
API](https://developer.mozilla.org/en-US/docs/Web/API/EventSource).
x-authenticated: true x-authenticated: true
parameters: parameters:
- name: workflow_id - name: workflow_id
@@ -26,6 +30,16 @@ get:
tags: tags:
- Workflows Executions - Workflows Executions
responses: responses:
'200':
description: Stream of the step's status.
content:
text/event-stream:
schema:
type: string
description: The step's status update and data changes.
example: |-
event: success
data: {}
'400': '400':
$ref: ../components/responses/400_error.yaml $ref: ../components/responses/400_error.yaml
'401': '401':
www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_{transaction_id}.yaml
+3 -4
View File
@@ -1,9 +1,8 @@
get: get:
operationId: GetWorkflowsExecutionsWorkflow_idTransaction_id operationId: GetWorkflowsExecutionsWorkflow_idTransaction_id
summary: 'List ' summary: Get Workflow Execution's Details
description: >- x-sidebar-summary: Get Exection
Retrieve a list of in a workflows execution. The can be filtered by fields description: Get the details of the workflow's execution.
like FILTER FIELDS. The can also be paginated.
x-authenticated: true x-authenticated: true
parameters: parameters:
- name: workflow_id - name: workflow_id
www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_{transaction_id}_{step_id}_subscribe.yaml
+19 -5
View File
@@ -1,10 +1,14 @@
get: get:
operationId: GetWorkflowsExecutionsWorkflow_idTransaction_idStep_idSubscribe operationId: GetWorkflowsExecutionsWorkflow_idTransaction_idStep_idSubscribe
summary: List Subscribes summary: Subscribe to Step of a Workflow's Execution
description: >- x-sidebar-summary: Subscribe to Step
Retrieve a list of subscribes in a workflows execution. The subscribes can description: >
be filtered by fields like FILTER FIELDS. The subscribes can also be Subscribe to a step in a workflow's execution to receive real-time
paginated. information about its status and data.
This route returns an event stream that you can consume using the
[EventSource
API](https://developer.mozilla.org/en-US/docs/Web/API/EventSource).
x-authenticated: true x-authenticated: true
parameters: parameters:
- name: workflow_id - name: workflow_id
@@ -38,6 +42,16 @@ get:
tags: tags:
- Workflows Executions - Workflows Executions
responses: responses:
'200':
description: Stream of the step's status.
content:
text/event-stream:
schema:
type: string
description: The step's status update and data changes.
example: |-
event: success
data: {}
'400': '400':
$ref: ../components/responses/400_error.yaml $ref: ../components/responses/400_error.yaml
'401': '401':
www/apps/api-reference/specs/store/components/schemas/AdminCreateInventoryItem.yaml
+1 -1
View File
@@ -1,5 +1,6 @@
type: object type: object
description: SUMMARY description: SUMMARY
x-schemaName: AdminCreateInventoryItem
properties: properties:
sku: sku:
type: string type: string
@@ -56,4 +57,3 @@ properties:
metadata: metadata:
type: object type: object
description: The inventory item's metadata. description: The inventory item's metadata.
x-schemaName: AdminCreateInventoryItem
www/apps/api-reference/specs/store/components/schemas/AdminCreateProductCategory.yaml
+4 -4
View File
@@ -1,5 +1,6 @@
type: object type: object
description: SUMMARY description: SUMMARY
x-schemaName: AdminCreateProductCategory
required: required:
- name - name
properties: properties:
@@ -27,11 +28,10 @@ properties:
type: string type: string
title: parent_category_id title: parent_category_id
description: The product category's parent category id. description: The product category's parent category id.
metadata:
type: object
description: The product category's metadata.
rank: rank:
type: number type: number
title: rank title: rank
description: The product category's rank. description: The product category's rank.
x-schemaName: AdminCreateProductCategory metadata:
type: object
description: The product category's metadata.
www/apps/api-reference/specs/store/components/schemas/AdminCreateProductTag.yaml
+1 -1
View File
@@ -1,5 +1,6 @@
type: object type: object
description: SUMMARY description: SUMMARY
x-schemaName: AdminCreateProductTag
required: required:
- value - value
properties: properties:
@@ -10,4 +11,3 @@ properties:
metadata: metadata:
type: object type: object
description: The product tag's metadata. description: The product tag's metadata.
x-schemaName: AdminCreateProductTag
www/apps/api-reference/specs/store/components/schemas/AdminCreateRefundReason.yaml
+1 -1
View File
@@ -1,5 +1,6 @@
type: object type: object
description: SUMMARY description: SUMMARY
x-schemaName: AdminCreateRefundReason
required: required:
- label - label
properties: properties:
@@ -11,4 +12,3 @@ properties:
type: string type: string
title: description title: description
description: The refund reason's description. description: The refund reason's description.
x-schemaName: AdminCreateRefundReason
www/apps/api-reference/specs/store/components/schemas/AdminCreateRegion.yaml
+5 -5
View File
@@ -1,5 +1,6 @@
type: object type: object
description: SUMMARY description: SUMMARY
x-schemaName: AdminCreateRegion
required: required:
- name - name
- currency_code - currency_code
@@ -23,6 +24,10 @@ properties:
type: boolean type: boolean
title: automatic_taxes title: automatic_taxes
description: The region's automatic taxes. description: The region's automatic taxes.
is_tax_inclusive:
type: boolean
title: is_tax_inclusive
description: The region's is tax inclusive.
payment_providers: payment_providers:
type: array type: array
description: The region's payment providers. description: The region's payment providers.
@@ -33,8 +38,3 @@ properties:
metadata: metadata:
type: object type: object
description: The region's metadata. description: The region's metadata.
is_tax_inclusive:
type: boolean
title: is_tax_inclusive
description: The region's is tax inclusive.
x-schemaName: AdminCreateRegion
www/apps/api-reference/specs/store/components/schemas/AdminCreateReservation.yaml
+1 -1
View File
@@ -1,5 +1,6 @@
type: object type: object
description: SUMMARY description: SUMMARY
x-schemaName: AdminCreateReservation
required: required:
- location_id - location_id
- inventory_item_id - inventory_item_id
@@ -28,4 +29,3 @@ properties:
metadata: metadata:
type: object type: object
description: The reservation's metadata. description: The reservation's metadata.
x-schemaName: AdminCreateReservation
www/apps/api-reference/specs/store/components/schemas/AdminCreateShippingOption.yaml
+5 -2
View File
@@ -1,5 +1,6 @@
type: object type: object
description: SUMMARY description: SUMMARY
x-schemaName: AdminCreateShippingOption
required: required:
- name - name
- service_zone_id - service_zone_id
@@ -26,9 +27,10 @@ properties:
description: The shipping option's data. description: The shipping option's data.
price_type: price_type:
type: string type: string
description: The shipping option's price type.
enum: enum:
- calculated
- flat - flat
- calculated
provider_id: provider_id:
type: string type: string
title: provider_id title: provider_id
@@ -42,6 +44,7 @@ properties:
oneOf: oneOf:
- type: object - type: object
description: The price's prices. description: The price's prices.
x-schemaName: AdminCreateShippingOptionPriceWithCurrency
required: required:
- currency_code - currency_code
- amount - amount
@@ -56,6 +59,7 @@ properties:
description: The price's amount. description: The price's amount.
- type: object - type: object
description: The price's prices. description: The price's prices.
x-schemaName: AdminCreateShippingOptionPriceWithRegion
required: required:
- region_id - region_id
- amount - amount
@@ -73,4 +77,3 @@ properties:
description: The shipping option's rules. description: The shipping option's rules.
items: items:
$ref: ./AdminCreateShippingOptionRule.yaml $ref: ./AdminCreateShippingOptionRule.yaml
x-schemaName: AdminCreateShippingOption
www/apps/api-reference/specs/store/components/schemas/AdminCreateShippingOptionRule.yaml
+6 -5
View File
@@ -1,5 +1,6 @@
type: object type: object
description: The rule's rules. description: The rule's rules.
x-schemaName: AdminCreateShippingOptionRule
required: required:
- operator - operator
- attribute - attribute
@@ -7,14 +8,15 @@ required:
properties: properties:
operator: operator:
type: string type: string
description: The rule's operator.
enum: enum:
- in - gt
- lt
- eq - eq
- ne - ne
- gt - in
- gte
- lt
- lte - lte
- gte
- nin - nin
attribute: attribute:
type: string type: string
@@ -31,4 +33,3 @@ properties:
type: string type: string
title: value title: value
description: The value's details. description: The value's details.
x-schemaName: AdminCreateShippingOptionRule
www/apps/api-reference/specs/store/components/schemas/AdminCreateShippingProfile.yaml
+18
View File
@@ -0,0 +1,18 @@
type: object
description: SUMMARY
required:
- name
- type
properties:
name:
type: string
title: name
description: The shipping profile's name.
type:
type: string
title: type
description: The shipping profile's type.
metadata:
type: object
description: The shipping profile's metadata.
x-schemaName: AdminCreateShippingProfile
www/apps/api-reference/specs/store/components/schemas/AdminDeletePaymentCollectionResponse.yaml
+3 -3
View File
@@ -1,5 +1,6 @@
type: object type: object
description: SUMMARY description: SUMMARY
x-schemaName: AdminDeletePaymentCollectionResponse
required: required:
- id - id
- object - object
@@ -12,10 +13,9 @@ properties:
object: object:
type: string type: string
title: object title: object
description: The name of the deleted object. description: SUMMARY
default: payment-collection default: payment-collection
deleted: deleted:
type: boolean type: boolean
title: deleted title: deleted
description: Whether the payment collection was deleted. description: SUMMARY
x-schemaName: AdminDeletePaymentCollectionResponse
www/apps/api-reference/specs/store/components/schemas/AdminExchangeDeleteResponse.yaml
+2 -2
View File
@@ -1,5 +1,6 @@
type: object type: object
description: SUMMARY description: SUMMARY
x-schemaName: AdminExchangeDeleteResponse
required: required:
- id - id
- object - object
@@ -17,5 +18,4 @@ properties:
deleted: deleted:
type: boolean type: boolean
title: deleted title: deleted
description: Whether the exchange was deleted. description: Whether the Exchange was deleted.
x-schemaName: AdminExchangeDeleteResponse
www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentSet.yaml
+11 -11
View File
@@ -1,5 +1,15 @@
type: object type: object
description: The fulfillment set that the service zone belongs to. description: The fulfillment set's parent.
x-schemaName: AdminFulfillmentSet
required:
- id
- name
- type
- location
- service_zones
- created_at
- updated_at
- deleted_at
properties: properties:
id: id:
type: string type: string
@@ -35,13 +45,3 @@ properties:
format: date-time format: date-time
title: deleted_at title: deleted_at
description: The parent's deleted at. description: The parent's deleted at.
required:
- id
- name
- type
- location
- service_zones
- created_at
- updated_at
- deleted_at
x-schemaName: AdminFulfillmentSet
www/apps/api-reference/specs/store/components/schemas/AdminProductVariantParams.yaml
+445 -13
View File
@@ -1,18 +1,18 @@
type: object type: object
description: The product's variants. description: SUMMARY
x-schemaName: AdminProductVariantParams x-schemaName: AdminProductVariantParams
properties: properties:
q: q:
type: string type: string
title: q title: q
description: The variant's q. description: The product's q.
id: id:
oneOf: oneOf:
- type: string - type: string
title: id title: id
description: The variant's ID. description: The product's ID.
- type: array - type: array
description: The variant's ID. description: The product's ID.
items: items:
type: string type: string
title: id title: id
@@ -20,14 +20,14 @@ properties:
manage_inventory: manage_inventory:
type: boolean type: boolean
title: manage_inventory title: manage_inventory
description: The variant's manage inventory. description: The product's manage inventory.
allow_backorder: allow_backorder:
type: boolean type: boolean
title: allow_backorder title: allow_backorder
description: The variant's allow backorder. description: The product's allow backorder.
created_at: created_at:
type: object type: object
description: The variant's created at. description: The product's created at.
properties: properties:
$and: $and:
type: array type: array
@@ -81,6 +81,150 @@ properties:
description: Filter by values not matching the conditions in this parameter. description: Filter by values not matching the conditions in this parameter.
- type: object - type: object
description: Filter by values not matching the conditions in this parameter. description: Filter by values not matching the conditions in this parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for numbers
and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter. Useful
for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array - type: array
description: Filter by values not matching the conditions in this parameter. description: Filter by values not matching the conditions in this parameter.
items: items:
@@ -154,7 +298,7 @@ properties:
description: Filter by whether a value for this parameter exists (not `null`). description: Filter by whether a value for this parameter exists (not `null`).
updated_at: updated_at:
type: object type: object
description: The variant's updated at. description: The product's updated at.
properties: properties:
$and: $and:
type: array type: array
@@ -208,6 +352,150 @@ properties:
description: Filter by values not matching the conditions in this parameter. description: Filter by values not matching the conditions in this parameter.
- type: object - type: object
description: Filter by values not matching the conditions in this parameter. description: Filter by values not matching the conditions in this parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for numbers
and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter. Useful
for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array - type: array
description: Filter by values not matching the conditions in this parameter. description: Filter by values not matching the conditions in this parameter.
items: items:
@@ -281,7 +569,7 @@ properties:
description: Filter by whether a value for this parameter exists (not `null`). description: Filter by whether a value for this parameter exists (not `null`).
deleted_at: deleted_at:
type: object type: object
description: The variant's deleted at. description: The product's deleted at.
properties: properties:
$and: $and:
type: array type: array
@@ -335,6 +623,150 @@ properties:
description: Filter by values not matching the conditions in this parameter. description: Filter by values not matching the conditions in this parameter.
- type: object - type: object
description: Filter by values not matching the conditions in this parameter. description: Filter by values not matching the conditions in this parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for numbers
and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter. Useful
for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array - type: array
description: Filter by values not matching the conditions in this parameter. description: Filter by values not matching the conditions in this parameter.
items: items:
@@ -409,19 +841,19 @@ properties:
limit: limit:
type: number type: number
title: limit title: limit
description: The variant's limit. description: The product's limit.
offset: offset:
type: number type: number
title: offset title: offset
description: The variant's offset. description: The product's offset.
order: order:
type: string type: string
title: order title: order
description: The variant's order. description: The product's order.
fields: fields:
type: string type: string
title: fields title: fields
description: The variant's fields. description: The product's fields.
$and: $and:
type: array type: array
description: >- description: >-
www/apps/api-reference/specs/store/components/schemas/AdminReturnReasonDeleteResponse.yaml
+2 -2
View File
@@ -1,5 +1,6 @@
type: object type: object
description: SUMMARY description: SUMMARY
x-schemaName: AdminReturnReasonDeleteResponse
required: required:
- id - id
- object - object
@@ -17,5 +18,4 @@ properties:
deleted: deleted:
type: boolean type: boolean
title: deleted title: deleted
description: Whether the return reason was deleted. description: Whether the Return Reason was deleted.
x-schemaName: AdminReturnReasonDeleteResponse
www/apps/api-reference/specs/store/components/schemas/AdminServiceZoneDeleteResponse.yaml
+3 -4
View File
@@ -1,5 +1,6 @@
type: object type: object
description: SUMMARY description: SUMMARY
x-schemaName: AdminServiceZoneDeleteResponse
required: required:
- id - id
- object - object
@@ -8,16 +9,14 @@ properties:
id: id:
type: string type: string
title: id title: id
description: The service zone's ID. description: The fulfillment set's ID.
object: object:
type: string type: string
title: object title: object
description: The name of the deleted object. description: The name of the deleted object.
default: service_zone
deleted: deleted:
type: boolean type: boolean
title: deleted title: deleted
description: Whether the service zone was deleted. description: Whether the Fulfillment Set was deleted.
parent: parent:
$ref: ./AdminFulfillmentSet.yaml $ref: ./AdminFulfillmentSet.yaml
x-schemaName: AdminServiceZoneDeleteResponse
www/apps/api-reference/specs/store/components/schemas/StoreCreatePaymentCollection.yaml
+1 -1
View File
@@ -1,5 +1,6 @@
type: object type: object
description: SUMMARY description: SUMMARY
x-schemaName: StoreCreatePaymentCollection
required: required:
- cart_id - cart_id
properties: properties:
@@ -7,4 +8,3 @@ properties:
type: string type: string
title: cart_id title: cart_id
description: The payment collection's cart id. description: The payment collection's cart id.
x-schemaName: StoreCreatePaymentCollection
www/apps/api-reference/specs/store/components/schemas/StoreCreateReturnItem.yaml
+1 -1
View File
@@ -1,5 +1,6 @@
type: object type: object
description: The item's items. description: The item's items.
x-schemaName: StoreCreateReturnItem
required: required:
- id - id
- quantity - quantity
@@ -20,4 +21,3 @@ properties:
type: string type: string
title: note title: note
description: The item's note. description: The item's note.
x-schemaName: StoreCreateReturnItem
www/apps/api-reference/specs/store/components/schemas/StoreCreateReturnShipping.yaml
+1 -1
View File
@@ -1,5 +1,6 @@
type: object type: object
description: The return's return shipping. description: The return's return shipping.
x-schemaName: StoreCreateReturnShipping
required: required:
- option_id - option_id
properties: properties:
@@ -11,4 +12,3 @@ properties:
type: number type: number
title: price title: price
description: The return shipping's price. description: The return shipping's price.
x-schemaName: StoreCreateReturnShipping
www/apps/api-reference/specs/store/openapi.full.yaml
+416 -58
View File
@@ -9110,6 +9110,7 @@ components:
AdminCreateInventoryItem: AdminCreateInventoryItem:
type: object type: object
description: SUMMARY description: SUMMARY
x-schemaName: AdminCreateInventoryItem
properties: properties:
sku: sku:
type: string type: string
@@ -9166,7 +9167,6 @@ components:
metadata: metadata:
type: object type: object
description: The inventory item's metadata. description: The inventory item's metadata.
x-schemaName: AdminCreateInventoryItem
AdminCreatePriceList: AdminCreatePriceList:
type: object type: object
description: SUMMARY description: SUMMARY
@@ -9412,6 +9412,7 @@ components:
AdminCreateProductCategory: AdminCreateProductCategory:
type: object type: object
description: SUMMARY description: SUMMARY
x-schemaName: AdminCreateProductCategory
required: required:
- name - name
properties: properties:
@@ -9439,14 +9440,13 @@ components:
type: string type: string
title: parent_category_id title: parent_category_id
description: The product category's parent category id. description: The product category's parent category id.
metadata:
type: object
description: The product category's metadata.
rank: rank:
type: number type: number
title: rank title: rank
description: The product category's rank. description: The product category's rank.
x-schemaName: AdminCreateProductCategory metadata:
type: object
description: The product category's metadata.
AdminCreateProductOption: AdminCreateProductOption:
type: object type: object
description: SUMMARY description: SUMMARY
@@ -9469,6 +9469,7 @@ components:
AdminCreateProductTag: AdminCreateProductTag:
type: object type: object
description: SUMMARY description: SUMMARY
x-schemaName: AdminCreateProductTag
required: required:
- value - value
properties: properties:
@@ -9479,7 +9480,6 @@ components:
metadata: metadata:
type: object type: object
description: The product tag's metadata. description: The product tag's metadata.
x-schemaName: AdminCreateProductTag
AdminCreateProductVariant: AdminCreateProductVariant:
type: object type: object
description: The create's details. description: The create's details.
@@ -9632,6 +9632,7 @@ components:
AdminCreateRefundReason: AdminCreateRefundReason:
type: object type: object
description: SUMMARY description: SUMMARY
x-schemaName: AdminCreateRefundReason
required: required:
- label - label
properties: properties:
@@ -9643,10 +9644,10 @@ components:
type: string type: string
title: description title: description
description: The refund reason's description. description: The refund reason's description.
x-schemaName: AdminCreateRefundReason
AdminCreateRegion: AdminCreateRegion:
type: object type: object
description: SUMMARY description: SUMMARY
x-schemaName: AdminCreateRegion
required: required:
- name - name
- currency_code - currency_code
@@ -9670,6 +9671,10 @@ components:
type: boolean type: boolean
title: automatic_taxes title: automatic_taxes
description: The region's automatic taxes. description: The region's automatic taxes.
is_tax_inclusive:
type: boolean
title: is_tax_inclusive
description: The region's is tax inclusive.
payment_providers: payment_providers:
type: array type: array
description: The region's payment providers. description: The region's payment providers.
@@ -9680,14 +9685,10 @@ components:
metadata: metadata:
type: object type: object
description: The region's metadata. description: The region's metadata.
is_tax_inclusive:
type: boolean
title: is_tax_inclusive
description: The region's is tax inclusive.
x-schemaName: AdminCreateRegion
AdminCreateReservation: AdminCreateReservation:
type: object type: object
description: SUMMARY description: SUMMARY
x-schemaName: AdminCreateReservation
required: required:
- location_id - location_id
- inventory_item_id - inventory_item_id
@@ -9716,7 +9717,6 @@ components:
metadata: metadata:
type: object type: object
description: The reservation's metadata. description: The reservation's metadata.
x-schemaName: AdminCreateReservation
AdminCreateSalesChannel: AdminCreateSalesChannel:
type: object type: object
description: SUMMARY description: SUMMARY
@@ -9772,6 +9772,7 @@ components:
AdminCreateShippingOption: AdminCreateShippingOption:
type: object type: object
description: SUMMARY description: SUMMARY
x-schemaName: AdminCreateShippingOption
required: required:
- name - name
- service_zone_id - service_zone_id
@@ -9798,9 +9799,10 @@ components:
description: The shipping option's data. description: The shipping option's data.
price_type: price_type:
type: string type: string
description: The shipping option's price type.
enum: enum:
- calculated
- flat - flat
- calculated
provider_id: provider_id:
type: string type: string
title: provider_id title: provider_id
@@ -9814,6 +9816,7 @@ components:
oneOf: oneOf:
- type: object - type: object
description: The price's prices. description: The price's prices.
x-schemaName: AdminCreateShippingOptionPriceWithCurrency
required: required:
- currency_code - currency_code
- amount - amount
@@ -9828,6 +9831,7 @@ components:
description: The price's amount. description: The price's amount.
- type: object - type: object
description: The price's prices. description: The price's prices.
x-schemaName: AdminCreateShippingOptionPriceWithRegion
required: required:
- region_id - region_id
- amount - amount
@@ -9845,10 +9849,10 @@ components:
description: The shipping option's rules. description: The shipping option's rules.
items: items:
$ref: '#/components/schemas/AdminCreateShippingOptionRule' $ref: '#/components/schemas/AdminCreateShippingOptionRule'
x-schemaName: AdminCreateShippingOption
AdminCreateShippingOptionRule: AdminCreateShippingOptionRule:
type: object type: object
description: The rule's rules. description: The rule's rules.
x-schemaName: AdminCreateShippingOptionRule
required: required:
- operator - operator
- attribute - attribute
@@ -9856,14 +9860,15 @@ components:
properties: properties:
operator: operator:
type: string type: string
description: The rule's operator.
enum: enum:
- in - gt
- lt
- eq - eq
- ne - ne
- gt - in
- gte
- lt
- lte - lte
- gte
- nin - nin
attribute: attribute:
type: string type: string
@@ -9880,7 +9885,25 @@ components:
type: string type: string
title: value title: value
description: The value's details. description: The value's details.
x-schemaName: AdminCreateShippingOptionRule AdminCreateShippingProfile:
type: object
description: SUMMARY
required:
- name
- type
properties:
name:
type: string
title: name
description: The shipping profile's name.
type:
type: string
title: type
description: The shipping profile's type.
metadata:
type: object
description: The shipping profile's metadata.
x-schemaName: AdminCreateShippingProfile
AdminCreateStockLocation: AdminCreateStockLocation:
type: object type: object
description: SUMMARY description: SUMMARY
@@ -10863,6 +10886,7 @@ components:
AdminDeletePaymentCollectionResponse: AdminDeletePaymentCollectionResponse:
type: object type: object
description: SUMMARY description: SUMMARY
x-schemaName: AdminDeletePaymentCollectionResponse
required: required:
- id - id
- object - object
@@ -10875,13 +10899,12 @@ components:
object: object:
type: string type: string
title: object title: object
description: The name of the deleted object. description: SUMMARY
default: payment-collection default: payment-collection
deleted: deleted:
type: boolean type: boolean
title: deleted title: deleted
description: Whether the payment collection was deleted. description: SUMMARY
x-schemaName: AdminDeletePaymentCollectionResponse
AdminDraftOrderResponse: AdminDraftOrderResponse:
type: object type: object
description: SUMMARY description: SUMMARY
@@ -11148,6 +11171,7 @@ components:
AdminExchangeDeleteResponse: AdminExchangeDeleteResponse:
type: object type: object
description: SUMMARY description: SUMMARY
x-schemaName: AdminExchangeDeleteResponse
required: required:
- id - id
- object - object
@@ -11165,8 +11189,7 @@ components:
deleted: deleted:
type: boolean type: boolean
title: deleted title: deleted
description: Whether the exchange was deleted. description: Whether the Exchange was deleted.
x-schemaName: AdminExchangeDeleteResponse
AdminExchangeOrderResponse: AdminExchangeOrderResponse:
type: object type: object
description: SUMMARY description: SUMMARY
@@ -11612,7 +11635,17 @@ components:
$ref: '#/components/schemas/AdminFulfillment' $ref: '#/components/schemas/AdminFulfillment'
AdminFulfillmentSet: AdminFulfillmentSet:
type: object type: object
description: The fulfillment set that the service zone belongs to. description: The fulfillment set's parent.
x-schemaName: AdminFulfillmentSet
required:
- id
- name
- type
- location
- service_zones
- created_at
- updated_at
- deleted_at
properties: properties:
id: id:
type: string type: string
@@ -11648,16 +11681,6 @@ components:
format: date-time format: date-time
title: deleted_at title: deleted_at
description: The parent's deleted at. description: The parent's deleted at.
required:
- id
- name
- type
- location
- service_zones
- created_at
- updated_at
- deleted_at
x-schemaName: AdminFulfillmentSet
AdminFulfillmentSetDeleteResponse: AdminFulfillmentSetDeleteResponse:
type: object type: object
description: SUMMARY description: SUMMARY
@@ -15394,20 +15417,20 @@ components:
$ref: '#/components/schemas/AdminProductVariant' $ref: '#/components/schemas/AdminProductVariant'
AdminProductVariantParams: AdminProductVariantParams:
type: object type: object
description: The product's variants. description: SUMMARY
x-schemaName: AdminProductVariantParams x-schemaName: AdminProductVariantParams
properties: properties:
q: q:
type: string type: string
title: q title: q
description: The variant's q. description: The product's q.
id: id:
oneOf: oneOf:
- type: string - type: string
title: id title: id
description: The variant's ID. description: The product's ID.
- type: array - type: array
description: The variant's ID. description: The product's ID.
items: items:
type: string type: string
title: id title: id
@@ -15415,14 +15438,14 @@ components:
manage_inventory: manage_inventory:
type: boolean type: boolean
title: manage_inventory title: manage_inventory
description: The variant's manage inventory. description: The product's manage inventory.
allow_backorder: allow_backorder:
type: boolean type: boolean
title: allow_backorder title: allow_backorder
description: The variant's allow backorder. description: The product's allow backorder.
created_at: created_at:
type: object type: object
description: The variant's created at. description: The product's created at.
properties: properties:
$and: $and:
type: array type: array
@@ -15472,6 +15495,118 @@ components:
description: Filter by values not matching the conditions in this parameter. description: Filter by values not matching the conditions in this parameter.
- type: object - type: object
description: Filter by values not matching the conditions in this parameter. description: Filter by values not matching the conditions in this parameter.
properties:
$and:
type: array
description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: Filter by values not matching the conditions in this parameter.
- type: object
description: Filter by values not matching the conditions in this parameter.
- type: array
description: Filter by values not matching the conditions in this parameter.
items:
type: string
title: $not
description: Filter by values not matching the conditions in this parameter.
$gt:
type: string
title: $gt
description: Filter by values greater than this parameter. Useful for numbers and dates only.
$gte:
type: string
title: $gte
description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: Filter by values less than this parameter. Useful for numbers and dates only.
$lte:
type: string
title: $lte
description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: Apply a case-insensitive `like` filter. Useful for strings only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: Filter arrays that have overlapping values with this parameter.
items:
type: string
title: $overlap
description: Filter arrays that have overlapping values with this parameter.
$contains:
type: array
description: Filter arrays that contain some of the values of this parameter.
items:
type: string
title: $contains
description: Filter arrays that contain some of the values of this parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
- type: array - type: array
description: Filter by values not matching the conditions in this parameter. description: Filter by values not matching the conditions in this parameter.
items: items:
@@ -15537,7 +15672,7 @@ components:
description: Filter by whether a value for this parameter exists (not `null`). description: Filter by whether a value for this parameter exists (not `null`).
updated_at: updated_at:
type: object type: object
description: The variant's updated at. description: The product's updated at.
properties: properties:
$and: $and:
type: array type: array
@@ -15587,6 +15722,118 @@ components:
description: Filter by values not matching the conditions in this parameter. description: Filter by values not matching the conditions in this parameter.
- type: object - type: object
description: Filter by values not matching the conditions in this parameter. description: Filter by values not matching the conditions in this parameter.
properties:
$and:
type: array
description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: Filter by values not matching the conditions in this parameter.
- type: object
description: Filter by values not matching the conditions in this parameter.
- type: array
description: Filter by values not matching the conditions in this parameter.
items:
type: string
title: $not
description: Filter by values not matching the conditions in this parameter.
$gt:
type: string
title: $gt
description: Filter by values greater than this parameter. Useful for numbers and dates only.
$gte:
type: string
title: $gte
description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: Filter by values less than this parameter. Useful for numbers and dates only.
$lte:
type: string
title: $lte
description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: Apply a case-insensitive `like` filter. Useful for strings only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: Filter arrays that have overlapping values with this parameter.
items:
type: string
title: $overlap
description: Filter arrays that have overlapping values with this parameter.
$contains:
type: array
description: Filter arrays that contain some of the values of this parameter.
items:
type: string
title: $contains
description: Filter arrays that contain some of the values of this parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
- type: array - type: array
description: Filter by values not matching the conditions in this parameter. description: Filter by values not matching the conditions in this parameter.
items: items:
@@ -15652,7 +15899,7 @@ components:
description: Filter by whether a value for this parameter exists (not `null`). description: Filter by whether a value for this parameter exists (not `null`).
deleted_at: deleted_at:
type: object type: object
description: The variant's deleted at. description: The product's deleted at.
properties: properties:
$and: $and:
type: array type: array
@@ -15702,6 +15949,118 @@ components:
description: Filter by values not matching the conditions in this parameter. description: Filter by values not matching the conditions in this parameter.
- type: object - type: object
description: Filter by values not matching the conditions in this parameter. description: Filter by values not matching the conditions in this parameter.
properties:
$and:
type: array
description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: Filter by values not matching the conditions in this parameter.
- type: object
description: Filter by values not matching the conditions in this parameter.
- type: array
description: Filter by values not matching the conditions in this parameter.
items:
type: string
title: $not
description: Filter by values not matching the conditions in this parameter.
$gt:
type: string
title: $gt
description: Filter by values greater than this parameter. Useful for numbers and dates only.
$gte:
type: string
title: $gte
description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: Filter by values less than this parameter. Useful for numbers and dates only.
$lte:
type: string
title: $lte
description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: Apply a case-insensitive `like` filter. Useful for strings only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: Filter arrays that have overlapping values with this parameter.
items:
type: string
title: $overlap
description: Filter arrays that have overlapping values with this parameter.
$contains:
type: array
description: Filter arrays that contain some of the values of this parameter.
items:
type: string
title: $contains
description: Filter arrays that contain some of the values of this parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
- type: array - type: array
description: Filter by values not matching the conditions in this parameter. description: Filter by values not matching the conditions in this parameter.
items: items:
@@ -15768,19 +16127,19 @@ components:
limit: limit:
type: number type: number
title: limit title: limit
description: The variant's limit. description: The product's limit.
offset: offset:
type: number type: number
title: offset title: offset
description: The variant's offset. description: The product's offset.
order: order:
type: string type: string
title: order title: order
description: The variant's order. description: The product's order.
fields: fields:
type: string type: string
title: fields title: fields
description: The variant's fields. description: The product's fields.
$and: $and:
type: array type: array
description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
@@ -16232,6 +16591,7 @@ components:
AdminReturnReasonDeleteResponse: AdminReturnReasonDeleteResponse:
type: object type: object
description: SUMMARY description: SUMMARY
x-schemaName: AdminReturnReasonDeleteResponse
required: required:
- id - id
- object - object
@@ -16249,8 +16609,7 @@ components:
deleted: deleted:
type: boolean type: boolean
title: deleted title: deleted
description: Whether the return reason was deleted. description: Whether the Return Reason was deleted.
x-schemaName: AdminReturnReasonDeleteResponse
AdminReturnReasonListResponse: AdminReturnReasonListResponse:
type: object type: object
description: SUMMARY description: SUMMARY
@@ -16504,6 +16863,7 @@ components:
AdminServiceZoneDeleteResponse: AdminServiceZoneDeleteResponse:
type: object type: object
description: SUMMARY description: SUMMARY
x-schemaName: AdminServiceZoneDeleteResponse
required: required:
- id - id
- object - object
@@ -16512,19 +16872,17 @@ components:
id: id:
type: string type: string
title: id title: id
description: The service zone's ID. description: The fulfillment set's ID.
object: object:
type: string type: string
title: object title: object
description: The name of the deleted object. description: The name of the deleted object.
default: service_zone
deleted: deleted:
type: boolean type: boolean
title: deleted title: deleted
description: Whether the service zone was deleted. description: Whether the Fulfillment Set was deleted.
parent: parent:
$ref: '#/components/schemas/AdminFulfillmentSet' $ref: '#/components/schemas/AdminFulfillmentSet'
x-schemaName: AdminServiceZoneDeleteResponse
AdminServiceZoneResponse: AdminServiceZoneResponse:
type: object type: object
description: SUMMARY description: SUMMARY
@@ -24024,6 +24382,7 @@ components:
StoreCreatePaymentCollection: StoreCreatePaymentCollection:
type: object type: object
description: SUMMARY description: SUMMARY
x-schemaName: StoreCreatePaymentCollection
required: required:
- cart_id - cart_id
properties: properties:
@@ -24031,7 +24390,6 @@ components:
type: string type: string
title: cart_id title: cart_id
description: The payment collection's cart id. description: The payment collection's cart id.
x-schemaName: StoreCreatePaymentCollection
StoreCreateReturn: StoreCreateReturn:
type: object type: object
description: SUMMARY description: SUMMARY
@@ -24067,6 +24425,7 @@ components:
StoreCreateReturnItem: StoreCreateReturnItem:
type: object type: object
description: The item's items. description: The item's items.
x-schemaName: StoreCreateReturnItem
required: required:
- id - id
- quantity - quantity
@@ -24087,10 +24446,10 @@ components:
type: string type: string
title: note title: note
description: The item's note. description: The item's note.
x-schemaName: StoreCreateReturnItem
StoreCreateReturnShipping: StoreCreateReturnShipping:
type: object type: object
description: The return's return shipping. description: The return's return shipping.
x-schemaName: StoreCreateReturnShipping
required: required:
- option_id - option_id
properties: properties:
@@ -24102,7 +24461,6 @@ components:
type: number type: number
title: price title: price
description: The return shipping's price. description: The return shipping's price.
x-schemaName: StoreCreateReturnShipping
StoreCurrency: StoreCurrency:
type: object type: object
description: The currency's details. description: The currency's details.
www/utils/generated/oas-output/operations/admin/get_admin_customers.ts
+9 -1
View File
@@ -49,7 +49,7 @@
* description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
* - name: groups * - name: groups
* in: query * in: query
* required: true * required: false
* schema: * schema:
* oneOf: * oneOf:
* - type: string * - type: string
@@ -3323,6 +3323,14 @@
* items: * items:
* type: object * type: object
* title: $or * title: $or
* - name: has_account
* in: query
* description: Filter by whether the customer is registered.
* required: false
* schema:
* type: boolean
* title: has_account
* description: Filter by whether the customer is registered.
* security: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses_[address_id].ts
+1 -2
View File
@@ -2,8 +2,7 @@
* @oas [get] /admin/customers/{id}/addresses/{address_id} * @oas [get] /admin/customers/{id}/addresses/{address_id}
* operationId: GetCustomersIdAddressesAddress_id * operationId: GetCustomersIdAddressesAddress_id
* summary: List Addresses * summary: List Addresses
* description: Retrieve a list of a customer's addresses. The addresses can be * description: Retrieve a list of a customer's addresses. The addresses can be filtered by fields like `company`. The addresses can also be paginated.
* filtered by fields like `company`. The addresses can also be paginated.
* x-authenticated: true * x-authenticated: true
* parameters: * parameters:
* - name: id * - name: id
www/utils/generated/oas-output/operations/admin/get_admin_draft-orders.ts
+20
View File
@@ -935,6 +935,15 @@
* type: string * type: string
* title: fulfillment_status * title: fulfillment_status
* description: The fulfillment status's details. * description: The fulfillment status's details.
* enum:
* - canceled
* - not_fulfilled
* - partially_fulfilled
* - fulfilled
* - partially_shipped
* - shipped
* - partially_delivered
* - delivered
* - name: payment_status * - name: payment_status
* in: query * in: query
* description: Filter by the payment status of the draft order. * description: Filter by the payment status of the draft order.
@@ -946,6 +955,17 @@
* type: string * type: string
* title: payment_status * title: payment_status
* description: The payment status's details. * description: The payment status's details.
* enum:
* - canceled
* - not_paid
* - awaiting
* - authorized
* - partially_authorized
* - captured
* - partially_captured
* - partially_refunded
* - refunded
* - requires_action
* - name: region_id * - name: region_id
* in: query * in: query
* description: Filter by region IDs to retrieve their associated draft orders. * description: Filter by region IDs to retrieve their associated draft orders.
www/utils/generated/oas-output/operations/admin/get_admin_draft-orders_[id].ts
+1 -2
View File
@@ -2,8 +2,7 @@
* @oas [get] /admin/draft-orders/{id} * @oas [get] /admin/draft-orders/{id}
* operationId: GetDraftOrdersId * operationId: GetDraftOrdersId
* summary: Get a Draft Order * summary: Get a Draft Order
* description: Retrieve a draft order by its ID. You can expand the draft order's * description: Retrieve a draft order by its ID. You can expand the draft order's relations or select the fields that should be returned using the query parameters.
* relations or select the fields that should be returned using the query parameters.
* x-authenticated: true * x-authenticated: true
* parameters: * parameters:
* - name: id * - name: id
www/utils/generated/oas-output/operations/admin/get_admin_exchanges_[id].ts
+1 -2
View File
@@ -2,8 +2,7 @@
* @oas [get] /admin/exchanges/{id} * @oas [get] /admin/exchanges/{id}
* operationId: GetExchangesId * operationId: GetExchangesId
* summary: Get an Exchange * summary: Get an Exchange
* description: Retrieve an exchange by its ID. You can expand the exchange's * description: Retrieve an exchange by its ID. You can expand the exchange's relations or select the fields that should be returned using query parameters.
* relations or select the fields that should be returned using query parameters.
* x-authenticated: true * x-authenticated: true
* parameters: * parameters:
* - name: id * - name: id
www/utils/generated/oas-output/operations/admin/get_admin_fulfillment-providers.ts
+1 -1
View File
@@ -64,7 +64,7 @@
* - name: is_enabled * - name: is_enabled
* in: query * in: query
* description: Filter by whether the fulfillment provider is enabled. * description: Filter by whether the fulfillment provider is enabled.
* required: true * required: false
* schema: * schema:
* type: boolean * type: boolean
* title: is_enabled * title: is_enabled
Loaded 100 of 151 files, more files were not shown because too many files have changed in this diff. Show more