chore(docs): Updated API Reference (v2) (#8954)
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:
co-authored by
Shahed Nasser
parent
6652db45ef
commit
edc19e748b
@@ -2,6 +2,7 @@
|
||||
* @schema AdminCreateInventoryItem
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminCreateInventoryItem
|
||||
* properties:
|
||||
* sku:
|
||||
* type: string
|
||||
@@ -58,7 +59,6 @@
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The inventory item's metadata.
|
||||
* x-schemaName: AdminCreateInventoryItem
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
* @schema AdminCreateProductCategory
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminCreateProductCategory
|
||||
* required:
|
||||
* - name
|
||||
* properties:
|
||||
@@ -29,14 +30,13 @@
|
||||
* type: string
|
||||
* title: parent_category_id
|
||||
* description: The product category's parent category id.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The product category's metadata.
|
||||
* rank:
|
||||
* type: number
|
||||
* title: rank
|
||||
* description: The product category's rank.
|
||||
* x-schemaName: AdminCreateProductCategory
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The product category's metadata.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
* @schema AdminCreateProductTag
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminCreateProductTag
|
||||
* required:
|
||||
* - value
|
||||
* properties:
|
||||
@@ -12,7 +13,6 @@
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The product tag's metadata.
|
||||
* x-schemaName: AdminCreateProductTag
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
* @schema AdminCreateRefundReason
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminCreateRefundReason
|
||||
* required:
|
||||
* - label
|
||||
* properties:
|
||||
@@ -13,7 +14,6 @@
|
||||
* type: string
|
||||
* title: description
|
||||
* description: The refund reason's description.
|
||||
* x-schemaName: AdminCreateRefundReason
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
* @schema AdminCreateRegion
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminCreateRegion
|
||||
* required:
|
||||
* - name
|
||||
* - currency_code
|
||||
@@ -25,6 +26,10 @@
|
||||
* type: boolean
|
||||
* title: 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:
|
||||
* type: array
|
||||
* description: The region's payment providers.
|
||||
@@ -35,11 +40,6 @@
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The region's metadata.
|
||||
* is_tax_inclusive:
|
||||
* type: boolean
|
||||
* title: is_tax_inclusive
|
||||
* description: The region's is tax inclusive.
|
||||
* x-schemaName: AdminCreateRegion
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
* @schema AdminCreateReservation
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminCreateReservation
|
||||
* required:
|
||||
* - location_id
|
||||
* - inventory_item_id
|
||||
@@ -30,7 +31,6 @@
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The reservation's metadata.
|
||||
* x-schemaName: AdminCreateReservation
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
* @schema AdminCreateShippingOption
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminCreateShippingOption
|
||||
* required:
|
||||
* - name
|
||||
* - service_zone_id
|
||||
@@ -28,9 +29,10 @@
|
||||
* description: The shipping option's data.
|
||||
* price_type:
|
||||
* type: string
|
||||
* description: The shipping option's price type.
|
||||
* enum:
|
||||
* - calculated
|
||||
* - flat
|
||||
* - calculated
|
||||
* provider_id:
|
||||
* type: string
|
||||
* title: provider_id
|
||||
@@ -44,6 +46,7 @@
|
||||
* oneOf:
|
||||
* - type: object
|
||||
* description: The price's prices.
|
||||
* x-schemaName: AdminCreateShippingOptionPriceWithCurrency
|
||||
* required:
|
||||
* - currency_code
|
||||
* - amount
|
||||
@@ -58,6 +61,7 @@
|
||||
* description: The price's amount.
|
||||
* - type: object
|
||||
* description: The price's prices.
|
||||
* x-schemaName: AdminCreateShippingOptionPriceWithRegion
|
||||
* required:
|
||||
* - region_id
|
||||
* - amount
|
||||
@@ -75,7 +79,6 @@
|
||||
* description: The shipping option's rules.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/AdminCreateShippingOptionRule"
|
||||
* x-schemaName: AdminCreateShippingOption
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
* @schema AdminCreateShippingOptionRule
|
||||
* type: object
|
||||
* description: The rule's rules.
|
||||
* x-schemaName: AdminCreateShippingOptionRule
|
||||
* required:
|
||||
* - operator
|
||||
* - attribute
|
||||
@@ -9,14 +10,15 @@
|
||||
* properties:
|
||||
* operator:
|
||||
* type: string
|
||||
* description: The rule's operator.
|
||||
* enum:
|
||||
* - in
|
||||
* - gt
|
||||
* - lt
|
||||
* - eq
|
||||
* - ne
|
||||
* - gt
|
||||
* - gte
|
||||
* - lt
|
||||
* - in
|
||||
* - lte
|
||||
* - gte
|
||||
* - nin
|
||||
* attribute:
|
||||
* type: string
|
||||
@@ -33,7 +35,6 @@
|
||||
* type: string
|
||||
* title: value
|
||||
* description: The value's details.
|
||||
* x-schemaName: AdminCreateShippingOptionRule
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -0,0 +1,23 @@
|
||||
/**
|
||||
* @schema 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
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -1,80 +0,0 @@
|
||||
/**
|
||||
* @schema AdminCustomerAddressFilters
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminCustomerAddressFilters
|
||||
* properties:
|
||||
* q:
|
||||
* type: string
|
||||
* title: q
|
||||
* description: The customer's q.
|
||||
* company:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: company
|
||||
* description: The customer's company.
|
||||
* - type: array
|
||||
* description: The customer's company.
|
||||
* items:
|
||||
* type: string
|
||||
* title: company
|
||||
* description: The company's details.
|
||||
* city:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: city
|
||||
* description: The customer's city.
|
||||
* - type: array
|
||||
* description: The customer's city.
|
||||
* items:
|
||||
* type: string
|
||||
* title: city
|
||||
* description: The city's details.
|
||||
* country_code:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: country_code
|
||||
* description: The customer's country code.
|
||||
* - type: array
|
||||
* description: The customer's country code.
|
||||
* items:
|
||||
* type: string
|
||||
* title: country_code
|
||||
* description: The country code's details.
|
||||
* province:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: province
|
||||
* description: The customer's province.
|
||||
* - type: array
|
||||
* description: The customer's province.
|
||||
* items:
|
||||
* type: string
|
||||
* title: province
|
||||
* description: The province's details.
|
||||
* postal_code:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: postal_code
|
||||
* description: The customer's postal code.
|
||||
* - type: array
|
||||
* description: The customer's postal code.
|
||||
* items:
|
||||
* type: string
|
||||
* title: postal_code
|
||||
* description: The postal code's details.
|
||||
* $and:
|
||||
* type: array
|
||||
* description: The customer's $and.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $and
|
||||
* $or:
|
||||
* type: array
|
||||
* description: The customer's $or.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $or
|
||||
*
|
||||
*/
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -33,13 +33,13 @@
|
||||
* properties:
|
||||
* $and:
|
||||
* type: array
|
||||
* description: The email's $and.
|
||||
* 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: The email's $or.
|
||||
* 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
|
||||
@@ -214,13 +214,13 @@
|
||||
* properties:
|
||||
* $and:
|
||||
* type: array
|
||||
* description: The created at's $and.
|
||||
* 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: The created at's $or.
|
||||
* 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
|
||||
@@ -329,13 +329,13 @@
|
||||
* properties:
|
||||
* $and:
|
||||
* type: array
|
||||
* description: The updated at's $and.
|
||||
* 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: The updated at's $or.
|
||||
* 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
|
||||
@@ -444,13 +444,13 @@
|
||||
* properties:
|
||||
* $and:
|
||||
* type: array
|
||||
* description: The deleted at's $and.
|
||||
* 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: The deleted at's $or.
|
||||
* 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
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
* @schema AdminDeletePaymentCollectionResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminDeletePaymentCollectionResponse
|
||||
* required:
|
||||
* - id
|
||||
* - object
|
||||
@@ -14,13 +15,12 @@
|
||||
* object:
|
||||
* type: string
|
||||
* title: object
|
||||
* description: The name of the deleted object.
|
||||
* description: SUMMARY
|
||||
* default: payment-collection
|
||||
* deleted:
|
||||
* type: boolean
|
||||
* title: deleted
|
||||
* description: Whether the payment collection was deleted.
|
||||
* x-schemaName: AdminDeletePaymentCollectionResponse
|
||||
* description: SUMMARY
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
* @schema AdminExchangeDeleteResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminExchangeDeleteResponse
|
||||
* required:
|
||||
* - id
|
||||
* - object
|
||||
@@ -19,8 +20,7 @@
|
||||
* deleted:
|
||||
* type: boolean
|
||||
* title: deleted
|
||||
* description: Whether the exchange was deleted.
|
||||
* x-schemaName: AdminExchangeDeleteResponse
|
||||
* description: Whether the Exchange was deleted.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -1,755 +0,0 @@
|
||||
/**
|
||||
* @schema AdminExchangeListParams
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminExchangeListParams
|
||||
* properties:
|
||||
* deleted_at:
|
||||
* type: object
|
||||
* description: The exchange's deleted at.
|
||||
* properties:
|
||||
* $and:
|
||||
* type: array
|
||||
* description: The deleted at's $and.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $and
|
||||
* $or:
|
||||
* type: array
|
||||
* description: The deleted at's $or.
|
||||
* 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.
|
||||
* properties:
|
||||
* $and:
|
||||
* type: array
|
||||
* description: The $not's $and.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $and
|
||||
* $or:
|
||||
* type: array
|
||||
* description: The $not's $or.
|
||||
* 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.
|
||||
* $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`).
|
||||
* q:
|
||||
* type: string
|
||||
* title: q
|
||||
* description: The exchange's q.
|
||||
* id:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: id
|
||||
* description: The exchange's ID.
|
||||
* - type: array
|
||||
* description: The exchange's ID.
|
||||
* items:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The id's ID.
|
||||
* order_id:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: order_id
|
||||
* description: The exchange's order id.
|
||||
* - type: array
|
||||
* description: The exchange's order id.
|
||||
* items:
|
||||
* type: string
|
||||
* title: order_id
|
||||
* description: The order id's details.
|
||||
* status:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: status
|
||||
* description: The exchange's status.
|
||||
* - type: array
|
||||
* description: The exchange's status.
|
||||
* items:
|
||||
* type: string
|
||||
* title: status
|
||||
* description: The status's details.
|
||||
* created_at:
|
||||
* type: object
|
||||
* description: The exchange's created at.
|
||||
* properties:
|
||||
* $and:
|
||||
* type: array
|
||||
* description: The created at's $and.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $and
|
||||
* $or:
|
||||
* type: array
|
||||
* description: The created at's $or.
|
||||
* 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.
|
||||
* properties:
|
||||
* $and:
|
||||
* type: array
|
||||
* description: The $not's $and.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $and
|
||||
* $or:
|
||||
* type: array
|
||||
* description: The $not's $or.
|
||||
* 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.
|
||||
* $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`).
|
||||
* updated_at:
|
||||
* type: object
|
||||
* description: The exchange's updated at.
|
||||
* properties:
|
||||
* $and:
|
||||
* type: array
|
||||
* description: The updated at's $and.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $and
|
||||
* $or:
|
||||
* type: array
|
||||
* description: The updated at's $or.
|
||||
* 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.
|
||||
* properties:
|
||||
* $and:
|
||||
* type: array
|
||||
* description: The $not's $and.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $and
|
||||
* $or:
|
||||
* type: array
|
||||
* description: The $not's $or.
|
||||
* 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.
|
||||
* $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`).
|
||||
* limit:
|
||||
* type: number
|
||||
* title: limit
|
||||
* description: The exchange's limit.
|
||||
* offset:
|
||||
* type: number
|
||||
* title: offset
|
||||
* description: The exchange's offset.
|
||||
* order:
|
||||
* type: string
|
||||
* title: order
|
||||
* description: The exchange's order.
|
||||
* fields:
|
||||
* type: string
|
||||
* title: fields
|
||||
* description: The exchange's fields.
|
||||
* $and:
|
||||
* type: array
|
||||
* description: The exchange's $and.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $and
|
||||
* $or:
|
||||
* type: array
|
||||
* description: The exchange's $or.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $or
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -1,7 +1,17 @@
|
||||
/**
|
||||
* @schema AdminFulfillmentSet
|
||||
* 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:
|
||||
* id:
|
||||
* type: string
|
||||
@@ -37,16 +47,6 @@
|
||||
* format: date-time
|
||||
* title: deleted_at
|
||||
* description: The parent's deleted at.
|
||||
* required:
|
||||
* - id
|
||||
* - name
|
||||
* - type
|
||||
* - location
|
||||
* - service_zones
|
||||
* - created_at
|
||||
* - updated_at
|
||||
* - deleted_at
|
||||
* x-schemaName: AdminFulfillmentSet
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -1,759 +0,0 @@
|
||||
/**
|
||||
* @schema AdminGetCustomerGroupsParams
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminGetCustomerGroupsParams
|
||||
* properties:
|
||||
* limit:
|
||||
* type: number
|
||||
* title: limit
|
||||
* description: The customer group's limit.
|
||||
* offset:
|
||||
* type: number
|
||||
* title: offset
|
||||
* description: The customer group's offset.
|
||||
* q:
|
||||
* type: string
|
||||
* title: q
|
||||
* description: The customer group's q.
|
||||
* id:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: id
|
||||
* description: The customer group's ID.
|
||||
* - type: array
|
||||
* description: The customer group's ID.
|
||||
* items:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The id's ID.
|
||||
* name:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: name
|
||||
* description: The customer group's name.
|
||||
* - type: array
|
||||
* description: The customer group's name.
|
||||
* items:
|
||||
* type: string
|
||||
* title: name
|
||||
* description: The name's details.
|
||||
* customers:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: customers
|
||||
* description: The customer group's customers.
|
||||
* - type: array
|
||||
* description: The customer group's customers.
|
||||
* items:
|
||||
* type: string
|
||||
* title: customers
|
||||
* description: The customer's customers.
|
||||
* - $ref: "#/components/schemas/AdminCustomerInGroupFilters"
|
||||
* created_by:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: created_by
|
||||
* description: The customer group's created by.
|
||||
* - type: array
|
||||
* description: The customer group's created by.
|
||||
* items:
|
||||
* type: string
|
||||
* title: created_by
|
||||
* description: The created by's details.
|
||||
* created_at:
|
||||
* type: object
|
||||
* description: The customer group's created at.
|
||||
* properties:
|
||||
* $and:
|
||||
* type: array
|
||||
* description: The created at's $and.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $and
|
||||
* $or:
|
||||
* type: array
|
||||
* description: The created at's $or.
|
||||
* 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.
|
||||
* properties:
|
||||
* $and:
|
||||
* type: array
|
||||
* description: The $not's $and.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $and
|
||||
* $or:
|
||||
* type: array
|
||||
* description: The $not's $or.
|
||||
* 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.
|
||||
* $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`).
|
||||
* updated_at:
|
||||
* type: object
|
||||
* description: The customer group's updated at.
|
||||
* properties:
|
||||
* $and:
|
||||
* type: array
|
||||
* description: The updated at's $and.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $and
|
||||
* $or:
|
||||
* type: array
|
||||
* description: The updated at's $or.
|
||||
* 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.
|
||||
* properties:
|
||||
* $and:
|
||||
* type: array
|
||||
* description: The $not's $and.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $and
|
||||
* $or:
|
||||
* type: array
|
||||
* description: The $not's $or.
|
||||
* 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.
|
||||
* $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`).
|
||||
* deleted_at:
|
||||
* type: object
|
||||
* description: The customer group's deleted at.
|
||||
* properties:
|
||||
* $and:
|
||||
* type: array
|
||||
* description: The deleted at's $and.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $and
|
||||
* $or:
|
||||
* type: array
|
||||
* description: The deleted at's $or.
|
||||
* 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.
|
||||
* properties:
|
||||
* $and:
|
||||
* type: array
|
||||
* description: The $not's $and.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $and
|
||||
* $or:
|
||||
* type: array
|
||||
* description: The $not's $or.
|
||||
* 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.
|
||||
* $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`).
|
||||
* $and:
|
||||
* type: array
|
||||
* description: The customer group's $and.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $and
|
||||
* $or:
|
||||
* type: array
|
||||
* description: The customer group's $or.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $or
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -1,17 +0,0 @@
|
||||
/**
|
||||
* @schema AdminGetPromotionRuleParams
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminGetPromotionRuleParams
|
||||
* properties:
|
||||
* promotion_type:
|
||||
* type: string
|
||||
* title: promotion_type
|
||||
* description: The promotion's promotion type.
|
||||
* application_method_type:
|
||||
* type: string
|
||||
* title: application_method_type
|
||||
* description: The promotion's application method type.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -1,59 +0,0 @@
|
||||
/**
|
||||
* @schema AdminOrderFilters
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminOrderFilters
|
||||
* properties:
|
||||
* id:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: id
|
||||
* description: The return's ID.
|
||||
* - type: array
|
||||
* description: The return's ID.
|
||||
* items:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The id's ID.
|
||||
* name:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: name
|
||||
* description: The return's name.
|
||||
* - type: array
|
||||
* description: The return's name.
|
||||
* items:
|
||||
* type: string
|
||||
* title: name
|
||||
* description: The name's details.
|
||||
* limit:
|
||||
* type: number
|
||||
* title: limit
|
||||
* description: The return's limit.
|
||||
* offset:
|
||||
* type: number
|
||||
* title: offset
|
||||
* description: The return's offset.
|
||||
* order:
|
||||
* type: string
|
||||
* title: order
|
||||
* description: The return's order.
|
||||
* fields:
|
||||
* type: string
|
||||
* title: fields
|
||||
* description: The return's fields.
|
||||
* $and:
|
||||
* type: array
|
||||
* description: The return's $and.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $and
|
||||
* $or:
|
||||
* type: array
|
||||
* description: The return's $or.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $or
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -1,522 +0,0 @@
|
||||
/**
|
||||
* @schema AdminPriceListListParams
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminPriceListListParams
|
||||
* properties:
|
||||
* q:
|
||||
* type: string
|
||||
* title: q
|
||||
* description: The price list's q.
|
||||
* id:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: id
|
||||
* description: The price list's ID.
|
||||
* - type: array
|
||||
* description: The price list's ID.
|
||||
* items:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The id's ID.
|
||||
* starts_at:
|
||||
* type: object
|
||||
* description: The price list's starts at.
|
||||
* properties:
|
||||
* $and:
|
||||
* type: array
|
||||
* description: The starts at's $and.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $and
|
||||
* $or:
|
||||
* type: array
|
||||
* description: The starts at's $or.
|
||||
* 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.
|
||||
* properties:
|
||||
* $and:
|
||||
* type: array
|
||||
* description: The $not's $and.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $and
|
||||
* $or:
|
||||
* type: array
|
||||
* description: The $not's $or.
|
||||
* 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.
|
||||
* $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`).
|
||||
* ends_at:
|
||||
* type: object
|
||||
* description: The price list's ends at.
|
||||
* properties:
|
||||
* $and:
|
||||
* type: array
|
||||
* description: The ends at's $and.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $and
|
||||
* $or:
|
||||
* type: array
|
||||
* description: The ends at's $or.
|
||||
* 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.
|
||||
* properties:
|
||||
* $and:
|
||||
* type: array
|
||||
* description: The $not's $and.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $and
|
||||
* $or:
|
||||
* type: array
|
||||
* description: The $not's $or.
|
||||
* 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.
|
||||
* $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`).
|
||||
* status:
|
||||
* type: array
|
||||
* description: The price list's status.
|
||||
* items:
|
||||
* type: string
|
||||
* description: The status's details.
|
||||
* enum:
|
||||
* - active
|
||||
* - draft
|
||||
* rules_count:
|
||||
* type: array
|
||||
* description: The price list's rules count.
|
||||
* items:
|
||||
* type: number
|
||||
* title: rules_count
|
||||
* description: The rules count's details.
|
||||
* limit:
|
||||
* type: number
|
||||
* title: limit
|
||||
* description: The price list's limit.
|
||||
* offset:
|
||||
* type: number
|
||||
* title: offset
|
||||
* description: The price list's offset.
|
||||
* order:
|
||||
* type: string
|
||||
* title: order
|
||||
* description: The price list's order.
|
||||
* fields:
|
||||
* type: string
|
||||
* title: fields
|
||||
* description: The price list's fields.
|
||||
* $and:
|
||||
* type: array
|
||||
* description: The price list's $and.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $and
|
||||
* $or:
|
||||
* type: array
|
||||
* description: The price list's $or.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $or
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -1,74 +0,0 @@
|
||||
/**
|
||||
* @schema AdminPricePreferenceListParams
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminPricePreferenceListParams
|
||||
* properties:
|
||||
* id:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: id
|
||||
* description: The price preference's ID.
|
||||
* - type: array
|
||||
* description: The price preference's ID.
|
||||
* items:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The id's ID.
|
||||
* attribute:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: attribute
|
||||
* description: The price preference's attribute.
|
||||
* - type: array
|
||||
* description: The price preference's attribute.
|
||||
* items:
|
||||
* type: string
|
||||
* title: attribute
|
||||
* description: The attribute's details.
|
||||
* value:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: value
|
||||
* description: The price preference's value.
|
||||
* - type: array
|
||||
* description: The price preference's value.
|
||||
* items:
|
||||
* type: string
|
||||
* title: value
|
||||
* description: The value's details.
|
||||
* q:
|
||||
* type: string
|
||||
* title: q
|
||||
* description: The price preference's q.
|
||||
* limit:
|
||||
* type: number
|
||||
* title: limit
|
||||
* description: The price preference's limit.
|
||||
* offset:
|
||||
* type: number
|
||||
* title: offset
|
||||
* description: The price preference's offset.
|
||||
* order:
|
||||
* type: string
|
||||
* title: order
|
||||
* description: The price preference's order.
|
||||
* fields:
|
||||
* type: string
|
||||
* title: fields
|
||||
* description: The price preference's fields.
|
||||
* $and:
|
||||
* type: array
|
||||
* description: The price preference's $and.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $and
|
||||
* $or:
|
||||
* type: array
|
||||
* description: The price preference's $or.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $or
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -1,20 +1,20 @@
|
||||
/**
|
||||
* @schema AdminProductVariantParams
|
||||
* type: object
|
||||
* description: The product's variants.
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminProductVariantParams
|
||||
* properties:
|
||||
* q:
|
||||
* type: string
|
||||
* title: q
|
||||
* description: The variant's q.
|
||||
* description: The product's q.
|
||||
* id:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: id
|
||||
* description: The variant's ID.
|
||||
* description: The product's ID.
|
||||
* - type: array
|
||||
* description: The variant's ID.
|
||||
* description: The product's ID.
|
||||
* items:
|
||||
* type: string
|
||||
* title: id
|
||||
@@ -22,14 +22,14 @@
|
||||
* manage_inventory:
|
||||
* type: boolean
|
||||
* title: manage_inventory
|
||||
* description: The variant's manage inventory.
|
||||
* description: The product's manage inventory.
|
||||
* allow_backorder:
|
||||
* type: boolean
|
||||
* title: allow_backorder
|
||||
* description: The variant's allow backorder.
|
||||
* description: The product's allow backorder.
|
||||
* created_at:
|
||||
* type: object
|
||||
* description: The variant's created at.
|
||||
* description: The product's created at.
|
||||
* properties:
|
||||
* $and:
|
||||
* type: array
|
||||
@@ -79,6 +79,118 @@
|
||||
* 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:
|
||||
@@ -144,7 +256,7 @@
|
||||
* description: Filter by whether a value for this parameter exists (not `null`).
|
||||
* updated_at:
|
||||
* type: object
|
||||
* description: The variant's updated at.
|
||||
* description: The product's updated at.
|
||||
* properties:
|
||||
* $and:
|
||||
* type: array
|
||||
@@ -194,6 +306,118 @@
|
||||
* 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:
|
||||
@@ -259,7 +483,7 @@
|
||||
* description: Filter by whether a value for this parameter exists (not `null`).
|
||||
* deleted_at:
|
||||
* type: object
|
||||
* description: The variant's deleted at.
|
||||
* description: The product's deleted at.
|
||||
* properties:
|
||||
* $and:
|
||||
* type: array
|
||||
@@ -309,6 +533,118 @@
|
||||
* 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:
|
||||
@@ -375,19 +711,19 @@
|
||||
* limit:
|
||||
* type: number
|
||||
* title: limit
|
||||
* description: The variant's limit.
|
||||
* description: The product's limit.
|
||||
* offset:
|
||||
* type: number
|
||||
* title: offset
|
||||
* description: The variant's offset.
|
||||
* description: The product's offset.
|
||||
* order:
|
||||
* type: string
|
||||
* title: order
|
||||
* description: The variant's order.
|
||||
* description: The product's order.
|
||||
* fields:
|
||||
* type: string
|
||||
* title: fields
|
||||
* description: The variant's fields.
|
||||
* description: The product's fields.
|
||||
* $and:
|
||||
* type: array
|
||||
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
* @schema AdminReturnReasonDeleteResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminReturnReasonDeleteResponse
|
||||
* required:
|
||||
* - id
|
||||
* - object
|
||||
@@ -19,8 +20,7 @@
|
||||
* deleted:
|
||||
* type: boolean
|
||||
* title: deleted
|
||||
* description: Whether the return reason was deleted.
|
||||
* x-schemaName: AdminReturnReasonDeleteResponse
|
||||
* description: Whether the Return Reason was deleted.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
* @schema AdminServiceZoneDeleteResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminServiceZoneDeleteResponse
|
||||
* required:
|
||||
* - id
|
||||
* - object
|
||||
@@ -10,19 +11,17 @@
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The service zone's ID.
|
||||
* description: The fulfillment set's ID.
|
||||
* object:
|
||||
* type: string
|
||||
* title: object
|
||||
* description: The name of the deleted object.
|
||||
* default: service_zone
|
||||
* deleted:
|
||||
* type: boolean
|
||||
* title: deleted
|
||||
* description: Whether the service zone was deleted.
|
||||
* description: Whether the Fulfillment Set was deleted.
|
||||
* parent:
|
||||
* $ref: "#/components/schemas/AdminFulfillmentSet"
|
||||
* x-schemaName: AdminServiceZoneDeleteResponse
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,734 +0,0 @@
|
||||
/**
|
||||
* @schema AdminUserListParams
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminUserListParams
|
||||
* properties:
|
||||
* q:
|
||||
* type: string
|
||||
* title: q
|
||||
* description: The user's q.
|
||||
* id:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: id
|
||||
* description: The user's ID.
|
||||
* - type: array
|
||||
* description: The user's ID.
|
||||
* items:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The id's ID.
|
||||
* email:
|
||||
* type: string
|
||||
* title: email
|
||||
* description: The user's email.
|
||||
* format: email
|
||||
* first_name:
|
||||
* type: string
|
||||
* title: first_name
|
||||
* description: The user's first name.
|
||||
* last_name:
|
||||
* type: string
|
||||
* title: last_name
|
||||
* description: The user's last name.
|
||||
* created_at:
|
||||
* type: object
|
||||
* description: The user's created at.
|
||||
* properties:
|
||||
* $and:
|
||||
* type: array
|
||||
* description: The created at's $and.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $and
|
||||
* $or:
|
||||
* type: array
|
||||
* description: The created at's $or.
|
||||
* 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.
|
||||
* properties:
|
||||
* $and:
|
||||
* type: array
|
||||
* description: The $not's $and.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $and
|
||||
* $or:
|
||||
* type: array
|
||||
* description: The $not's $or.
|
||||
* 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.
|
||||
* $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`).
|
||||
* updated_at:
|
||||
* type: object
|
||||
* description: The user's updated at.
|
||||
* properties:
|
||||
* $and:
|
||||
* type: array
|
||||
* description: The updated at's $and.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $and
|
||||
* $or:
|
||||
* type: array
|
||||
* description: The updated at's $or.
|
||||
* 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.
|
||||
* properties:
|
||||
* $and:
|
||||
* type: array
|
||||
* description: The $not's $and.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $and
|
||||
* $or:
|
||||
* type: array
|
||||
* description: The $not's $or.
|
||||
* 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.
|
||||
* $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`).
|
||||
* deleted_at:
|
||||
* type: object
|
||||
* description: The user's deleted at.
|
||||
* properties:
|
||||
* $and:
|
||||
* type: array
|
||||
* description: The deleted at's $and.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $and
|
||||
* $or:
|
||||
* type: array
|
||||
* description: The deleted at's $or.
|
||||
* 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.
|
||||
* properties:
|
||||
* $and:
|
||||
* type: array
|
||||
* description: The $not's $and.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $and
|
||||
* $or:
|
||||
* type: array
|
||||
* description: The $not's $or.
|
||||
* 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.
|
||||
* $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`).
|
||||
* limit:
|
||||
* type: number
|
||||
* title: limit
|
||||
* description: The user's limit.
|
||||
* offset:
|
||||
* type: number
|
||||
* title: offset
|
||||
* description: The user's offset.
|
||||
* order:
|
||||
* type: string
|
||||
* title: order
|
||||
* description: The user's order.
|
||||
* fields:
|
||||
* type: string
|
||||
* title: fields
|
||||
* description: The user's fields.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -38,13 +38,13 @@
|
||||
* properties:
|
||||
* $and:
|
||||
* type: array
|
||||
* description: The created at's $and.
|
||||
* 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: The created at's $or.
|
||||
* 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
|
||||
@@ -153,13 +153,13 @@
|
||||
* properties:
|
||||
* $and:
|
||||
* type: array
|
||||
* description: The updated at's $and.
|
||||
* 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: The updated at's $or.
|
||||
* 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
|
||||
@@ -268,13 +268,13 @@
|
||||
* properties:
|
||||
* $and:
|
||||
* type: array
|
||||
* description: The deleted at's $and.
|
||||
* 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: The deleted at's $or.
|
||||
* 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
|
||||
|
||||
@@ -1,364 +0,0 @@
|
||||
/**
|
||||
* @schema OrderLineItem
|
||||
* type: object
|
||||
* description: The item's items.
|
||||
* x-schemaName: OrderLineItem
|
||||
* required:
|
||||
* - id
|
||||
* - title
|
||||
* - requires_shipping
|
||||
* - is_discountable
|
||||
* - is_tax_inclusive
|
||||
* - unit_price
|
||||
* - raw_unit_price
|
||||
* - quantity
|
||||
* - raw_quantity
|
||||
* - detail
|
||||
* - created_at
|
||||
* - updated_at
|
||||
* - original_total
|
||||
* - original_subtotal
|
||||
* - original_tax_total
|
||||
* - item_total
|
||||
* - item_subtotal
|
||||
* - item_tax_total
|
||||
* - total
|
||||
* - subtotal
|
||||
* - tax_total
|
||||
* - discount_total
|
||||
* - discount_tax_total
|
||||
* - refundable_total
|
||||
* - refundable_total_per_unit
|
||||
* - raw_original_total
|
||||
* - raw_original_subtotal
|
||||
* - raw_original_tax_total
|
||||
* - raw_item_total
|
||||
* - raw_item_subtotal
|
||||
* - raw_item_tax_total
|
||||
* - raw_total
|
||||
* - raw_subtotal
|
||||
* - raw_tax_total
|
||||
* - raw_discount_total
|
||||
* - raw_discount_tax_total
|
||||
* - raw_refundable_total
|
||||
* - raw_refundable_total_per_unit
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The item's ID.
|
||||
* title:
|
||||
* type: string
|
||||
* title: title
|
||||
* description: The item's title.
|
||||
* subtitle:
|
||||
* type: string
|
||||
* title: subtitle
|
||||
* description: The item's subtitle.
|
||||
* thumbnail:
|
||||
* type: string
|
||||
* title: thumbnail
|
||||
* description: The item's thumbnail.
|
||||
* variant_id:
|
||||
* type: string
|
||||
* title: variant_id
|
||||
* description: The item's variant id.
|
||||
* product_id:
|
||||
* type: string
|
||||
* title: product_id
|
||||
* description: The item's product id.
|
||||
* product_title:
|
||||
* type: string
|
||||
* title: product_title
|
||||
* description: The item's product title.
|
||||
* product_description:
|
||||
* type: string
|
||||
* title: product_description
|
||||
* description: The item's product description.
|
||||
* product_subtitle:
|
||||
* type: string
|
||||
* title: product_subtitle
|
||||
* description: The item's product subtitle.
|
||||
* product_type:
|
||||
* type: string
|
||||
* title: product_type
|
||||
* description: The item's product type.
|
||||
* product_collection:
|
||||
* type: string
|
||||
* title: product_collection
|
||||
* description: The item's product collection.
|
||||
* product_handle:
|
||||
* type: string
|
||||
* title: product_handle
|
||||
* description: The item's product handle.
|
||||
* variant_sku:
|
||||
* type: string
|
||||
* title: variant_sku
|
||||
* description: The item's variant sku.
|
||||
* variant_barcode:
|
||||
* type: string
|
||||
* title: variant_barcode
|
||||
* description: The item's variant barcode.
|
||||
* variant_title:
|
||||
* type: string
|
||||
* title: variant_title
|
||||
* description: The item's variant title.
|
||||
* variant_option_values:
|
||||
* type: object
|
||||
* description: The item's variant option values.
|
||||
* requires_shipping:
|
||||
* type: boolean
|
||||
* title: requires_shipping
|
||||
* description: The item's requires shipping.
|
||||
* is_discountable:
|
||||
* type: boolean
|
||||
* title: is_discountable
|
||||
* description: The item's is discountable.
|
||||
* is_tax_inclusive:
|
||||
* type: boolean
|
||||
* title: is_tax_inclusive
|
||||
* description: The item's is tax inclusive.
|
||||
* compare_at_unit_price:
|
||||
* type: number
|
||||
* title: compare_at_unit_price
|
||||
* description: The item's compare at unit price.
|
||||
* raw_compare_at_unit_price:
|
||||
* type: object
|
||||
* description: The item's raw compare at unit price.
|
||||
* unit_price:
|
||||
* type: number
|
||||
* title: unit_price
|
||||
* description: The item's unit price.
|
||||
* raw_unit_price:
|
||||
* type: object
|
||||
* description: The item's raw unit price.
|
||||
* quantity:
|
||||
* type: number
|
||||
* title: quantity
|
||||
* description: The item's quantity.
|
||||
* raw_quantity:
|
||||
* type: object
|
||||
* description: The item's raw quantity.
|
||||
* tax_lines:
|
||||
* type: array
|
||||
* description: The item's tax lines.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/OrderLineItemTaxLine"
|
||||
* adjustments:
|
||||
* type: array
|
||||
* description: The item's adjustments.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/OrderLineItemAdjustment"
|
||||
* detail:
|
||||
* $ref: "#/components/schemas/OrderItem"
|
||||
* created_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: created_at
|
||||
* description: The item's created at.
|
||||
* updated_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: updated_at
|
||||
* description: The item's updated at.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The item's metadata.
|
||||
* original_total:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: original_total
|
||||
* description: The item's original total.
|
||||
* - type: number
|
||||
* title: original_total
|
||||
* description: The item's original total.
|
||||
* - type: string
|
||||
* title: original_total
|
||||
* description: The item's original total.
|
||||
* - $ref: "#/components/schemas/IBigNumber"
|
||||
* original_subtotal:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: original_subtotal
|
||||
* description: The item's original subtotal.
|
||||
* - type: number
|
||||
* title: original_subtotal
|
||||
* description: The item's original subtotal.
|
||||
* - type: string
|
||||
* title: original_subtotal
|
||||
* description: The item's original subtotal.
|
||||
* - $ref: "#/components/schemas/IBigNumber"
|
||||
* original_tax_total:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: original_tax_total
|
||||
* description: The item's original tax total.
|
||||
* - type: number
|
||||
* title: original_tax_total
|
||||
* description: The item's original tax total.
|
||||
* - type: string
|
||||
* title: original_tax_total
|
||||
* description: The item's original tax total.
|
||||
* - $ref: "#/components/schemas/IBigNumber"
|
||||
* item_total:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: item_total
|
||||
* description: The item's item total.
|
||||
* - type: number
|
||||
* title: item_total
|
||||
* description: The item's item total.
|
||||
* - type: string
|
||||
* title: item_total
|
||||
* description: The item's item total.
|
||||
* - $ref: "#/components/schemas/IBigNumber"
|
||||
* item_subtotal:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: item_subtotal
|
||||
* description: The item's item subtotal.
|
||||
* - type: number
|
||||
* title: item_subtotal
|
||||
* description: The item's item subtotal.
|
||||
* - type: string
|
||||
* title: item_subtotal
|
||||
* description: The item's item subtotal.
|
||||
* - $ref: "#/components/schemas/IBigNumber"
|
||||
* item_tax_total:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: item_tax_total
|
||||
* description: The item's item tax total.
|
||||
* - type: number
|
||||
* title: item_tax_total
|
||||
* description: The item's item tax total.
|
||||
* - type: string
|
||||
* title: item_tax_total
|
||||
* description: The item's item tax total.
|
||||
* - $ref: "#/components/schemas/IBigNumber"
|
||||
* total:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: total
|
||||
* description: The item's total.
|
||||
* - type: number
|
||||
* title: total
|
||||
* description: The item's total.
|
||||
* - type: string
|
||||
* title: total
|
||||
* description: The item's total.
|
||||
* - $ref: "#/components/schemas/IBigNumber"
|
||||
* subtotal:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: subtotal
|
||||
* description: The item's subtotal.
|
||||
* - type: number
|
||||
* title: subtotal
|
||||
* description: The item's subtotal.
|
||||
* - type: string
|
||||
* title: subtotal
|
||||
* description: The item's subtotal.
|
||||
* - $ref: "#/components/schemas/IBigNumber"
|
||||
* tax_total:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: tax_total
|
||||
* description: The item's tax total.
|
||||
* - type: number
|
||||
* title: tax_total
|
||||
* description: The item's tax total.
|
||||
* - type: string
|
||||
* title: tax_total
|
||||
* description: The item's tax total.
|
||||
* - $ref: "#/components/schemas/IBigNumber"
|
||||
* discount_total:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: discount_total
|
||||
* description: The item's discount total.
|
||||
* - type: number
|
||||
* title: discount_total
|
||||
* description: The item's discount total.
|
||||
* - type: string
|
||||
* title: discount_total
|
||||
* description: The item's discount total.
|
||||
* - $ref: "#/components/schemas/IBigNumber"
|
||||
* discount_tax_total:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: discount_tax_total
|
||||
* description: The item's discount tax total.
|
||||
* - type: number
|
||||
* title: discount_tax_total
|
||||
* description: The item's discount tax total.
|
||||
* - type: string
|
||||
* title: discount_tax_total
|
||||
* description: The item's discount tax total.
|
||||
* - $ref: "#/components/schemas/IBigNumber"
|
||||
* refundable_total:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: refundable_total
|
||||
* description: The item's refundable total.
|
||||
* - type: number
|
||||
* title: refundable_total
|
||||
* description: The item's refundable total.
|
||||
* - type: string
|
||||
* title: refundable_total
|
||||
* description: The item's refundable total.
|
||||
* - $ref: "#/components/schemas/IBigNumber"
|
||||
* refundable_total_per_unit:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: refundable_total_per_unit
|
||||
* description: The item's refundable total per unit.
|
||||
* - type: number
|
||||
* title: refundable_total_per_unit
|
||||
* description: The item's refundable total per unit.
|
||||
* - type: string
|
||||
* title: refundable_total_per_unit
|
||||
* description: The item's refundable total per unit.
|
||||
* - $ref: "#/components/schemas/IBigNumber"
|
||||
* raw_original_total:
|
||||
* type: object
|
||||
* description: The item's raw original total.
|
||||
* raw_original_subtotal:
|
||||
* type: object
|
||||
* description: The item's raw original subtotal.
|
||||
* raw_original_tax_total:
|
||||
* type: object
|
||||
* description: The item's raw original tax total.
|
||||
* raw_item_total:
|
||||
* type: object
|
||||
* description: The item's raw item total.
|
||||
* raw_item_subtotal:
|
||||
* type: object
|
||||
* description: The item's raw item subtotal.
|
||||
* raw_item_tax_total:
|
||||
* type: object
|
||||
* description: The item's raw item tax total.
|
||||
* raw_total:
|
||||
* type: object
|
||||
* description: The item's raw total.
|
||||
* raw_subtotal:
|
||||
* type: object
|
||||
* description: The item's raw subtotal.
|
||||
* raw_tax_total:
|
||||
* type: object
|
||||
* description: The item's raw tax total.
|
||||
* raw_discount_total:
|
||||
* type: object
|
||||
* description: The item's raw discount total.
|
||||
* raw_discount_tax_total:
|
||||
* type: object
|
||||
* description: The item's raw discount tax total.
|
||||
* raw_refundable_total:
|
||||
* type: object
|
||||
* description: The item's raw refundable total.
|
||||
* raw_refundable_total_per_unit:
|
||||
* type: object
|
||||
* description: The item's raw refundable total per unit.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -1,219 +0,0 @@
|
||||
/**
|
||||
* @schema OrderShippingMethod
|
||||
* type: object
|
||||
* description: The shipping method's shipping methods.
|
||||
* x-schemaName: OrderShippingMethod
|
||||
* required:
|
||||
* - id
|
||||
* - order_id
|
||||
* - name
|
||||
* - amount
|
||||
* - raw_amount
|
||||
* - is_tax_inclusive
|
||||
* - created_at
|
||||
* - updated_at
|
||||
* - original_total
|
||||
* - original_subtotal
|
||||
* - original_tax_total
|
||||
* - total
|
||||
* - subtotal
|
||||
* - tax_total
|
||||
* - discount_total
|
||||
* - discount_tax_total
|
||||
* - raw_original_total
|
||||
* - raw_original_subtotal
|
||||
* - raw_original_tax_total
|
||||
* - raw_total
|
||||
* - raw_subtotal
|
||||
* - raw_tax_total
|
||||
* - raw_discount_total
|
||||
* - raw_discount_tax_total
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The shipping method's ID.
|
||||
* order_id:
|
||||
* type: string
|
||||
* title: order_id
|
||||
* description: The shipping method's order id.
|
||||
* name:
|
||||
* type: string
|
||||
* title: name
|
||||
* description: The shipping method's name.
|
||||
* description:
|
||||
* type: string
|
||||
* title: description
|
||||
* description: The shipping method's description.
|
||||
* amount:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: amount
|
||||
* description: The shipping method's amount.
|
||||
* - type: number
|
||||
* title: amount
|
||||
* description: The shipping method's amount.
|
||||
* - type: string
|
||||
* title: amount
|
||||
* description: The shipping method's amount.
|
||||
* - $ref: "#/components/schemas/IBigNumber"
|
||||
* raw_amount:
|
||||
* type: object
|
||||
* description: The shipping method's raw amount.
|
||||
* is_tax_inclusive:
|
||||
* type: boolean
|
||||
* title: is_tax_inclusive
|
||||
* description: The shipping method's is tax inclusive.
|
||||
* shipping_option_id:
|
||||
* type: string
|
||||
* title: shipping_option_id
|
||||
* description: The shipping method's shipping option id.
|
||||
* data:
|
||||
* type: object
|
||||
* description: The shipping method's data.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The shipping method's metadata.
|
||||
* tax_lines:
|
||||
* type: array
|
||||
* description: The shipping method's tax lines.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/OrderShippingMethodTaxLine"
|
||||
* adjustments:
|
||||
* type: array
|
||||
* description: The shipping method's adjustments.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/OrderShippingMethodAdjustment"
|
||||
* created_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: created_at
|
||||
* description: The shipping method's created at.
|
||||
* updated_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: updated_at
|
||||
* description: The shipping method's updated at.
|
||||
* original_total:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: original_total
|
||||
* description: The shipping method's original total.
|
||||
* - type: number
|
||||
* title: original_total
|
||||
* description: The shipping method's original total.
|
||||
* - type: string
|
||||
* title: original_total
|
||||
* description: The shipping method's original total.
|
||||
* - $ref: "#/components/schemas/IBigNumber"
|
||||
* original_subtotal:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: original_subtotal
|
||||
* description: The shipping method's original subtotal.
|
||||
* - type: number
|
||||
* title: original_subtotal
|
||||
* description: The shipping method's original subtotal.
|
||||
* - type: string
|
||||
* title: original_subtotal
|
||||
* description: The shipping method's original subtotal.
|
||||
* - $ref: "#/components/schemas/IBigNumber"
|
||||
* original_tax_total:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: original_tax_total
|
||||
* description: The shipping method's original tax total.
|
||||
* - type: number
|
||||
* title: original_tax_total
|
||||
* description: The shipping method's original tax total.
|
||||
* - type: string
|
||||
* title: original_tax_total
|
||||
* description: The shipping method's original tax total.
|
||||
* - $ref: "#/components/schemas/IBigNumber"
|
||||
* total:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: total
|
||||
* description: The shipping method's total.
|
||||
* - type: number
|
||||
* title: total
|
||||
* description: The shipping method's total.
|
||||
* - type: string
|
||||
* title: total
|
||||
* description: The shipping method's total.
|
||||
* - $ref: "#/components/schemas/IBigNumber"
|
||||
* subtotal:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: subtotal
|
||||
* description: The shipping method's subtotal.
|
||||
* - type: number
|
||||
* title: subtotal
|
||||
* description: The shipping method's subtotal.
|
||||
* - type: string
|
||||
* title: subtotal
|
||||
* description: The shipping method's subtotal.
|
||||
* - $ref: "#/components/schemas/IBigNumber"
|
||||
* tax_total:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: tax_total
|
||||
* description: The shipping method's tax total.
|
||||
* - type: number
|
||||
* title: tax_total
|
||||
* description: The shipping method's tax total.
|
||||
* - type: string
|
||||
* title: tax_total
|
||||
* description: The shipping method's tax total.
|
||||
* - $ref: "#/components/schemas/IBigNumber"
|
||||
* discount_total:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: discount_total
|
||||
* description: The shipping method's discount total.
|
||||
* - type: number
|
||||
* title: discount_total
|
||||
* description: The shipping method's discount total.
|
||||
* - type: string
|
||||
* title: discount_total
|
||||
* description: The shipping method's discount total.
|
||||
* - $ref: "#/components/schemas/IBigNumber"
|
||||
* discount_tax_total:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: discount_tax_total
|
||||
* description: The shipping method's discount tax total.
|
||||
* - type: number
|
||||
* title: discount_tax_total
|
||||
* description: The shipping method's discount tax total.
|
||||
* - type: string
|
||||
* title: discount_tax_total
|
||||
* description: The shipping method's discount tax total.
|
||||
* - $ref: "#/components/schemas/IBigNumber"
|
||||
* raw_original_total:
|
||||
* type: object
|
||||
* description: The shipping method's raw original total.
|
||||
* raw_original_subtotal:
|
||||
* type: object
|
||||
* description: The shipping method's raw original subtotal.
|
||||
* raw_original_tax_total:
|
||||
* type: object
|
||||
* description: The shipping method's raw original tax total.
|
||||
* raw_total:
|
||||
* type: object
|
||||
* description: The shipping method's raw total.
|
||||
* raw_subtotal:
|
||||
* type: object
|
||||
* description: The shipping method's raw subtotal.
|
||||
* raw_tax_total:
|
||||
* type: object
|
||||
* description: The shipping method's raw tax total.
|
||||
* raw_discount_total:
|
||||
* type: object
|
||||
* description: The shipping method's raw discount total.
|
||||
* raw_discount_tax_total:
|
||||
* type: object
|
||||
* description: The shipping method's raw discount tax total.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -1,52 +0,0 @@
|
||||
/**
|
||||
* @schema RefundReasonFilters
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: RefundReasonFilters
|
||||
* properties:
|
||||
* id:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: id
|
||||
* description: The refund reason's ID.
|
||||
* - type: array
|
||||
* description: The refund reason's ID.
|
||||
* items:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The id's ID.
|
||||
* q:
|
||||
* type: string
|
||||
* title: q
|
||||
* description: The refund reason's q.
|
||||
* limit:
|
||||
* type: number
|
||||
* title: limit
|
||||
* description: The refund reason's limit.
|
||||
* offset:
|
||||
* type: number
|
||||
* title: offset
|
||||
* description: The refund reason's offset.
|
||||
* order:
|
||||
* type: string
|
||||
* title: order
|
||||
* description: The refund reason's order.
|
||||
* fields:
|
||||
* type: string
|
||||
* title: fields
|
||||
* description: The refund reason's fields.
|
||||
* $and:
|
||||
* type: array
|
||||
* description: The refund reason's $and.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $and
|
||||
* $or:
|
||||
* type: array
|
||||
* description: The refund reason's $or.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $or
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
* @schema StoreCreatePaymentCollection
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: StoreCreatePaymentCollection
|
||||
* required:
|
||||
* - cart_id
|
||||
* properties:
|
||||
@@ -9,7 +10,6 @@
|
||||
* type: string
|
||||
* title: cart_id
|
||||
* description: The payment collection's cart id.
|
||||
* x-schemaName: StoreCreatePaymentCollection
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
* @schema StoreCreateReturnItem
|
||||
* type: object
|
||||
* description: The item's items.
|
||||
* x-schemaName: StoreCreateReturnItem
|
||||
* required:
|
||||
* - id
|
||||
* - quantity
|
||||
@@ -22,7 +23,6 @@
|
||||
* type: string
|
||||
* title: note
|
||||
* description: The item's note.
|
||||
* x-schemaName: StoreCreateReturnItem
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
* @schema StoreCreateReturnShipping
|
||||
* type: object
|
||||
* description: The return's return shipping.
|
||||
* x-schemaName: StoreCreateReturnShipping
|
||||
* required:
|
||||
* - option_id
|
||||
* properties:
|
||||
@@ -13,7 +14,6 @@
|
||||
* type: number
|
||||
* title: price
|
||||
* description: The return shipping's price.
|
||||
* x-schemaName: StoreCreateReturnShipping
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
Reference in New Issue
Block a user