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:
github-actions[bot]
committed by
GitHub
GitHub
parent
6652db45ef
commit
edc19e748b
@@ -9110,6 +9110,7 @@ components:
|
||||
AdminCreateInventoryItem:
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminCreateInventoryItem
|
||||
properties:
|
||||
sku:
|
||||
type: string
|
||||
@@ -9166,7 +9167,6 @@ components:
|
||||
metadata:
|
||||
type: object
|
||||
description: The inventory item's metadata.
|
||||
x-schemaName: AdminCreateInventoryItem
|
||||
AdminCreatePriceList:
|
||||
type: object
|
||||
description: SUMMARY
|
||||
@@ -9412,6 +9412,7 @@ components:
|
||||
AdminCreateProductCategory:
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminCreateProductCategory
|
||||
required:
|
||||
- name
|
||||
properties:
|
||||
@@ -9439,14 +9440,13 @@ components:
|
||||
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.
|
||||
AdminCreateProductOption:
|
||||
type: object
|
||||
description: SUMMARY
|
||||
@@ -9469,6 +9469,7 @@ components:
|
||||
AdminCreateProductTag:
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminCreateProductTag
|
||||
required:
|
||||
- value
|
||||
properties:
|
||||
@@ -9479,7 +9480,6 @@ components:
|
||||
metadata:
|
||||
type: object
|
||||
description: The product tag's metadata.
|
||||
x-schemaName: AdminCreateProductTag
|
||||
AdminCreateProductVariant:
|
||||
type: object
|
||||
description: The create's details.
|
||||
@@ -9632,6 +9632,7 @@ components:
|
||||
AdminCreateRefundReason:
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminCreateRefundReason
|
||||
required:
|
||||
- label
|
||||
properties:
|
||||
@@ -9643,10 +9644,10 @@ components:
|
||||
type: string
|
||||
title: description
|
||||
description: The refund reason's description.
|
||||
x-schemaName: AdminCreateRefundReason
|
||||
AdminCreateRegion:
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminCreateRegion
|
||||
required:
|
||||
- name
|
||||
- currency_code
|
||||
@@ -9670,6 +9671,10 @@ components:
|
||||
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.
|
||||
@@ -9680,14 +9685,10 @@ components:
|
||||
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
|
||||
AdminCreateReservation:
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminCreateReservation
|
||||
required:
|
||||
- location_id
|
||||
- inventory_item_id
|
||||
@@ -9716,7 +9717,6 @@ components:
|
||||
metadata:
|
||||
type: object
|
||||
description: The reservation's metadata.
|
||||
x-schemaName: AdminCreateReservation
|
||||
AdminCreateSalesChannel:
|
||||
type: object
|
||||
description: SUMMARY
|
||||
@@ -9772,6 +9772,7 @@ components:
|
||||
AdminCreateShippingOption:
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminCreateShippingOption
|
||||
required:
|
||||
- name
|
||||
- service_zone_id
|
||||
@@ -9798,9 +9799,10 @@ components:
|
||||
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
|
||||
@@ -9814,6 +9816,7 @@ components:
|
||||
oneOf:
|
||||
- type: object
|
||||
description: The price's prices.
|
||||
x-schemaName: AdminCreateShippingOptionPriceWithCurrency
|
||||
required:
|
||||
- currency_code
|
||||
- amount
|
||||
@@ -9828,6 +9831,7 @@ components:
|
||||
description: The price's amount.
|
||||
- type: object
|
||||
description: The price's prices.
|
||||
x-schemaName: AdminCreateShippingOptionPriceWithRegion
|
||||
required:
|
||||
- region_id
|
||||
- amount
|
||||
@@ -9845,10 +9849,10 @@ components:
|
||||
description: The shipping option's rules.
|
||||
items:
|
||||
$ref: '#/components/schemas/AdminCreateShippingOptionRule'
|
||||
x-schemaName: AdminCreateShippingOption
|
||||
AdminCreateShippingOptionRule:
|
||||
type: object
|
||||
description: The rule's rules.
|
||||
x-schemaName: AdminCreateShippingOptionRule
|
||||
required:
|
||||
- operator
|
||||
- attribute
|
||||
@@ -9856,14 +9860,15 @@ components:
|
||||
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
|
||||
@@ -9880,7 +9885,25 @@ components:
|
||||
type: string
|
||||
title: value
|
||||
description: The value's details.
|
||||
x-schemaName: AdminCreateShippingOptionRule
|
||||
AdminCreateShippingProfile:
|
||||
type: object
|
||||
description: SUMMARY
|
||||
required:
|
||||
- name
|
||||
- type
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
title: name
|
||||
description: The shipping profile's name.
|
||||
type:
|
||||
type: string
|
||||
title: type
|
||||
description: The shipping profile's type.
|
||||
metadata:
|
||||
type: object
|
||||
description: The shipping profile's metadata.
|
||||
x-schemaName: AdminCreateShippingProfile
|
||||
AdminCreateStockLocation:
|
||||
type: object
|
||||
description: SUMMARY
|
||||
@@ -10863,6 +10886,7 @@ components:
|
||||
AdminDeletePaymentCollectionResponse:
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminDeletePaymentCollectionResponse
|
||||
required:
|
||||
- id
|
||||
- object
|
||||
@@ -10875,13 +10899,12 @@ components:
|
||||
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
|
||||
AdminDraftOrderResponse:
|
||||
type: object
|
||||
description: SUMMARY
|
||||
@@ -11148,6 +11171,7 @@ components:
|
||||
AdminExchangeDeleteResponse:
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminExchangeDeleteResponse
|
||||
required:
|
||||
- id
|
||||
- object
|
||||
@@ -11165,8 +11189,7 @@ components:
|
||||
deleted:
|
||||
type: boolean
|
||||
title: deleted
|
||||
description: Whether the exchange was deleted.
|
||||
x-schemaName: AdminExchangeDeleteResponse
|
||||
description: Whether the Exchange was deleted.
|
||||
AdminExchangeOrderResponse:
|
||||
type: object
|
||||
description: SUMMARY
|
||||
@@ -11612,7 +11635,17 @@ components:
|
||||
$ref: '#/components/schemas/AdminFulfillment'
|
||||
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
|
||||
@@ -11648,16 +11681,6 @@ components:
|
||||
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
|
||||
AdminFulfillmentSetDeleteResponse:
|
||||
type: object
|
||||
description: SUMMARY
|
||||
@@ -15394,20 +15417,20 @@ components:
|
||||
$ref: '#/components/schemas/AdminProductVariant'
|
||||
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
|
||||
@@ -15415,14 +15438,14 @@ components:
|
||||
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
|
||||
@@ -15472,6 +15495,118 @@ components:
|
||||
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:
|
||||
@@ -15537,7 +15672,7 @@ components:
|
||||
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
|
||||
@@ -15587,6 +15722,118 @@ components:
|
||||
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:
|
||||
@@ -15652,7 +15899,7 @@ components:
|
||||
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
|
||||
@@ -15702,6 +15949,118 @@ components:
|
||||
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:
|
||||
@@ -15768,19 +16127,19 @@ components:
|
||||
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.
|
||||
@@ -16232,6 +16591,7 @@ components:
|
||||
AdminReturnReasonDeleteResponse:
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminReturnReasonDeleteResponse
|
||||
required:
|
||||
- id
|
||||
- object
|
||||
@@ -16249,8 +16609,7 @@ components:
|
||||
deleted:
|
||||
type: boolean
|
||||
title: deleted
|
||||
description: Whether the return reason was deleted.
|
||||
x-schemaName: AdminReturnReasonDeleteResponse
|
||||
description: Whether the Return Reason was deleted.
|
||||
AdminReturnReasonListResponse:
|
||||
type: object
|
||||
description: SUMMARY
|
||||
@@ -16504,6 +16863,7 @@ components:
|
||||
AdminServiceZoneDeleteResponse:
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminServiceZoneDeleteResponse
|
||||
required:
|
||||
- id
|
||||
- object
|
||||
@@ -16512,19 +16872,17 @@ components:
|
||||
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
|
||||
AdminServiceZoneResponse:
|
||||
type: object
|
||||
description: SUMMARY
|
||||
@@ -24024,6 +24382,7 @@ components:
|
||||
StoreCreatePaymentCollection:
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: StoreCreatePaymentCollection
|
||||
required:
|
||||
- cart_id
|
||||
properties:
|
||||
@@ -24031,7 +24390,6 @@ components:
|
||||
type: string
|
||||
title: cart_id
|
||||
description: The payment collection's cart id.
|
||||
x-schemaName: StoreCreatePaymentCollection
|
||||
StoreCreateReturn:
|
||||
type: object
|
||||
description: SUMMARY
|
||||
@@ -24067,6 +24425,7 @@ components:
|
||||
StoreCreateReturnItem:
|
||||
type: object
|
||||
description: The item's items.
|
||||
x-schemaName: StoreCreateReturnItem
|
||||
required:
|
||||
- id
|
||||
- quantity
|
||||
@@ -24087,10 +24446,10 @@ components:
|
||||
type: string
|
||||
title: note
|
||||
description: The item's note.
|
||||
x-schemaName: StoreCreateReturnItem
|
||||
StoreCreateReturnShipping:
|
||||
type: object
|
||||
description: The return's return shipping.
|
||||
x-schemaName: StoreCreateReturnShipping
|
||||
required:
|
||||
- option_id
|
||||
properties:
|
||||
@@ -24102,7 +24461,6 @@ components:
|
||||
type: number
|
||||
title: price
|
||||
description: The return shipping's price.
|
||||
x-schemaName: StoreCreateReturnShipping
|
||||
StoreCurrency:
|
||||
type: object
|
||||
description: The currency's details.
|
||||
|
||||
Reference in New Issue
Block a user