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

Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action
This commit is contained in:
github-actions[bot] authored and GitHub committed 2024-09-02 07:45:24 +00:00
1 parent 2c034774f0
commit d6dcda5b8f
355 files changed
+66808 -5101

No files matched your search

@@ -96,7 +96,7 @@
* description: The claim's email.
* format: email
* display_id:
* type: string
* type: number
* title: display_id
* description: The claim's display id.
* shipping_address:
@@ -21,9 +21,6 @@
* type: boolean
* title: deleted
* description: Whether the Claim was deleted.
* parent:
* type: object
* description: The claim's parent.
*
*/
@@ -21,9 +21,6 @@
* type: boolean
* title: deleted
* description: Whether the Collection was deleted.
* parent:
* type: object
* description: The collection's parent.
*
*/
@@ -0,0 +1,66 @@
/**
* @schema AdminCreateApplicationMethod
* type: object
* description: The promotion's application method.
* x-schemaName: AdminCreateApplicationMethod
* required:
* - value
* - type
* - target_type
* properties:
* description:
* type: string
* title: description
* description: The application method's description.
* value:
* type: number
* title: value
* description: The application method's value.
* currency_code:
* type: string
* title: currency_code
* description: The application method's currency code.
* max_quantity:
* type: number
* title: max_quantity
* description: The application method's max quantity.
* type:
* type: string
* description: The application method's type.
* enum:
* - fixed
* - percentage
* target_type:
* type: string
* description: The application method's target type.
* enum:
* - items
* - shipping_methods
* - order
* allocation:
* type: string
* description: The application method's allocation.
* enum:
* - each
* - across
* target_rules:
* type: array
* description: The application method's target rules.
* items:
* $ref: "#/components/schemas/AdminCreatePromotionRule"
* buy_rules:
* type: array
* description: The application method's buy rules.
* items:
* $ref: "#/components/schemas/AdminCreatePromotionRule"
* apply_to_quantity:
* type: number
* title: apply_to_quantity
* description: The application method's apply to quantity.
* buy_rules_min_quantity:
* type: number
* title: buy_rules_min_quantity
* description: The application method's buy rules min quantity.
*
*/
@@ -0,0 +1,53 @@
/**
* @schema AdminCreateCampaign
* type: object
* description: The promotion's campaign.
* x-schemaName: AdminCreateCampaign
* properties:
* name:
* type: string
* title: name
* description: The campaign's name.
* description:
* type: string
* title: description
* description: The campaign's description.
* currency:
* type: string
* title: currency
* description: The campaign's currency.
* campaign_identifier:
* type: string
* title: campaign_identifier
* description: The campaign's campaign identifier.
* starts_at:
* type: string
* title: starts_at
* description: The campaign's starts at.
* format: date-time
* ends_at:
* type: string
* title: ends_at
* description: The campaign's ends at.
* format: date-time
* budget:
* type: object
* description: The campaign's budget.
* properties:
* type:
* type: string
* description: The budget's type.
* enum:
* - spend
* - usage
* currency_code:
* type: string
* title: currency_code
* description: The budget's currency code.
* limit:
* type: number
* title: limit
* description: The budget's limit.
*
*/
@@ -0,0 +1,64 @@
/**
* @schema AdminCreateInventoryItem
* type: object
* description: SUMMARY
* properties:
* sku:
* type: string
* title: sku
* description: The inventory item's sku.
* hs_code:
* type: string
* title: hs_code
* description: The inventory item's hs code.
* weight:
* type: number
* title: weight
* description: The inventory item's weight.
* length:
* type: number
* title: length
* description: The inventory item's length.
* height:
* type: number
* title: height
* description: The inventory item's height.
* width:
* type: number
* title: width
* description: The inventory item's width.
* origin_country:
* type: string
* title: origin_country
* description: The inventory item's origin country.
* mid_code:
* type: string
* title: mid_code
* description: The inventory item's mid code.
* material:
* type: string
* title: material
* description: The inventory item's material.
* title:
* type: string
* title: title
* description: The inventory item's title.
* description:
* type: string
* title: description
* description: The inventory item's description.
* requires_shipping:
* type: boolean
* title: requires_shipping
* description: The inventory item's requires shipping.
* thumbnail:
* type: string
* title: thumbnail
* description: The inventory item's thumbnail.
* metadata:
* type: object
* description: The inventory item's metadata.
* x-schemaName: AdminCreateInventoryItem
*
*/
@@ -0,0 +1,42 @@
/**
* @schema AdminCreateProductCategory
* type: object
* description: SUMMARY
* required:
* - name
* properties:
* name:
* type: string
* title: name
* description: The product category's name.
* description:
* type: string
* title: description
* description: The product category's description.
* handle:
* type: string
* title: handle
* description: The product category's handle.
* is_internal:
* type: boolean
* title: is_internal
* description: The product category's is internal.
* is_active:
* type: boolean
* title: is_active
* description: The product category's is active.
* parent_category_id:
* 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
*
*/
@@ -0,0 +1,18 @@
/**
* @schema AdminCreateProductTag
* type: object
* description: SUMMARY
* required:
* - value
* properties:
* value:
* type: string
* title: value
* description: The product tag's value.
* metadata:
* type: object
* description: The product tag's metadata.
* x-schemaName: AdminCreateProductTag
*
*/
@@ -0,0 +1,43 @@
/**
* @schema AdminCreatePromotionRule
* type: object
* description: The rule's rules.
* x-schemaName: AdminCreatePromotionRule
* required:
* - operator
* - attribute
* - values
* properties:
* operator:
* type: string
* description: The rule's operator.
* enum:
* - gt
* - lt
* - eq
* - ne
* - in
* - lte
* - gte
* description:
* type: string
* title: description
* description: The rule's description.
* attribute:
* type: string
* title: attribute
* description: The rule's attribute.
* values:
* oneOf:
* - type: string
* title: values
* description: The rule's values.
* - type: array
* description: The rule's values.
* items:
* type: string
* title: values
* description: The value's values.
*
*/
@@ -0,0 +1,45 @@
/**
* @schema AdminCreateRegion
* type: object
* description: SUMMARY
* required:
* - name
* - currency_code
* properties:
* name:
* type: string
* title: name
* description: The region's name.
* currency_code:
* type: string
* title: currency_code
* description: The region's currency code.
* countries:
* type: array
* description: The region's countries.
* items:
* type: string
* title: countries
* description: The country's countries.
* automatic_taxes:
* type: boolean
* title: automatic_taxes
* description: The region's automatic taxes.
* payment_providers:
* type: array
* description: The region's payment providers.
* items:
* type: string
* title: payment_providers
* description: The payment provider's payment providers.
* 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
*
*/
@@ -0,0 +1,36 @@
/**
* @schema AdminCreateReservation
* type: object
* description: SUMMARY
* required:
* - location_id
* - inventory_item_id
* - quantity
* properties:
* line_item_id:
* type: string
* title: line_item_id
* description: The reservation's line item id.
* location_id:
* type: string
* title: location_id
* description: The reservation's location id.
* inventory_item_id:
* type: string
* title: inventory_item_id
* description: The reservation's inventory item id.
* quantity:
* type: number
* title: quantity
* description: The reservation's quantity.
* description:
* type: string
* title: description
* description: The reservation's description.
* metadata:
* type: object
* description: The reservation's metadata.
* x-schemaName: AdminCreateReservation
*
*/
@@ -5,8 +5,6 @@
* x-schemaName: AdminCreateSalesChannel
* required:
* - name
* - description
* - metadata
* properties:
* name:
* type: string
@@ -0,0 +1,81 @@
/**
* @schema AdminCreateShippingOption
* type: object
* description: SUMMARY
* required:
* - name
* - service_zone_id
* - shipping_profile_id
* - price_type
* - provider_id
* - type
* - prices
* properties:
* name:
* type: string
* title: name
* description: The shipping option's name.
* service_zone_id:
* type: string
* title: service_zone_id
* description: The shipping option's service zone id.
* shipping_profile_id:
* type: string
* title: shipping_profile_id
* description: The shipping option's shipping profile id.
* data:
* type: object
* description: The shipping option's data.
* price_type:
* type: string
* enum:
* - calculated
* - flat
* provider_id:
* type: string
* title: provider_id
* description: The shipping option's provider id.
* type:
* $ref: "#/components/schemas/AdminCreateShippingOption"
* prices:
* type: array
* description: The shipping option's prices.
* items:
* oneOf:
* - type: object
* description: The price's prices.
* required:
* - currency_code
* - amount
* properties:
* currency_code:
* type: string
* title: currency_code
* description: The price's currency code.
* amount:
* type: number
* title: amount
* description: The price's amount.
* - type: object
* description: The price's prices.
* required:
* - region_id
* - amount
* properties:
* region_id:
* type: string
* title: region_id
* description: The price's region id.
* amount:
* type: number
* title: amount
* description: The price's amount.
* rules:
* type: array
* description: The shipping option's rules.
* items:
* $ref: "#/components/schemas/AdminCreateShippingOptionRule"
* x-schemaName: AdminCreateShippingOption
*
*/
@@ -0,0 +1,39 @@
/**
* @schema AdminCreateShippingOptionRule
* type: object
* description: The rule's rules.
* required:
* - operator
* - attribute
* - value
* properties:
* operator:
* type: string
* enum:
* - in
* - eq
* - ne
* - gt
* - gte
* - lt
* - lte
* - nin
* attribute:
* type: string
* title: attribute
* description: The rule's attribute.
* value:
* oneOf:
* - type: string
* title: value
* description: The rule's value.
* - type: array
* description: The rule's value.
* items:
* type: string
* title: value
* description: The value's details.
* x-schemaName: AdminCreateShippingOptionRule
*
*/
@@ -5,62 +5,17 @@
* x-schemaName: AdminCreateStockLocation
* required:
* - name
* - address_id
* - metadata
* properties:
* name:
* type: string
* title: name
* description: The stock location's name.
* address:
* type: object
* description: The stock location's address.
* required:
* - address_1
* - address_2
* - company
* - city
* - country_code
* - phone
* - postal_code
* - province
* properties:
* address_1:
* type: string
* title: address_1
* description: The address's address 1.
* address_2:
* type: string
* title: address_2
* description: The address's address 2.
* company:
* type: string
* title: company
* description: The address's company.
* city:
* type: string
* title: city
* description: The address's city.
* country_code:
* type: string
* title: country_code
* description: The address's country code.
* phone:
* type: string
* title: phone
* description: The address's phone.
* postal_code:
* type: string
* title: postal_code
* description: The address's postal code.
* province:
* type: string
* title: province
* description: The address's province.
* address_id:
* type: string
* title: address_id
* description: The stock location's address id.
* address:
* $ref: "#/components/schemas/AdminUpsertStockLocationAddress"
* metadata:
* type: object
* description: The stock location's metadata.
@@ -6,8 +6,15 @@
* required:
* - name
* - tax_region_id
* - metadata
* properties:
* name:
* type: string
* title: name
* description: The tax rate's name.
* tax_region_id:
* type: string
* title: tax_region_id
* description: The tax rate's tax region id.
* rate:
* type: number
* title: rate
@@ -20,24 +27,7 @@
* type: array
* description: The tax rate's rules.
* items:
* type: object
* description: The rule's rules.
* required:
* - reference
* - reference_id
* properties:
* reference:
* type: string
* title: reference
* description: The rule's reference.
* reference_id:
* type: string
* title: reference_id
* description: The rule's reference id.
* name:
* type: string
* title: name
* description: The tax rate's name.
* $ref: "#/components/schemas/AdminCreateTaxRateRule"
* is_default:
* type: boolean
* title: is_default
@@ -46,10 +36,6 @@
* type: boolean
* title: is_combinable
* description: The tax rate's is combinable.
* tax_region_id:
* type: string
* title: tax_region_id
* description: The tax rate's tax region id.
* metadata:
* type: object
* description: The tax rate's metadata.
@@ -5,9 +5,6 @@
* x-schemaName: AdminCreateTaxRegion
* required:
* - country_code
* - province_code
* - parent_id
* - metadata
* properties:
* country_code:
* type: string
@@ -26,7 +23,6 @@
* description: The tax region's default tax rate.
* required:
* - name
* - metadata
* properties:
* rate:
* type: number
@@ -1,74 +1,8 @@
/**
* @schema AdminCurrency
* type: object
* description: The currency's currencies.
* description: The supported currency's currency.
* x-schemaName: AdminCurrency
* required:
* - code
* - symbol
* - symbol_native
* - name
* - decimal_digits
* - rounding
* - raw_rounding
* - created_at
* - updated_at
* - deleted_at
* properties:
* code:
* type: string
* title: code
* description: The currency's code.
* symbol:
* type: string
* title: symbol
* description: The currency's symbol.
* symbol_native:
* type: string
* title: symbol_native
* description: The currency's symbol native.
* name:
* type: string
* title: name
* description: The currency's name.
* decimal_digits:
* type: number
* title: decimal_digits
* description: The currency's decimal digits.
* rounding:
* type: number
* title: rounding
* description: The currency's rounding.
* raw_rounding:
* type: object
* description: The currency's raw rounding.
* required:
* - value
* - precision
* properties:
* value:
* type: string
* title: value
* description: The raw rounding's value.
* precision:
* type: number
* title: precision
* description: The raw rounding's precision.
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The currency's created at.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The currency's updated at.
* deleted_at:
* type: string
* format: date-time
* title: deleted_at
* description: The currency's deleted at.
*
*/
@@ -1,52 +0,0 @@
/**
* @schema AdminCurrencyListParams
* type: object
* description: SUMMARY
* x-schemaName: AdminCurrencyListParams
* properties:
* q:
* type: string
* title: q
* description: The currency's q.
* code:
* oneOf:
* - type: string
* title: code
* description: The currency's code.
* - type: array
* description: The currency's code.
* items:
* type: string
* title: code
* description: The code's details.
* limit:
* type: number
* title: limit
* description: The currency's limit.
* offset:
* type: number
* title: offset
* description: The currency's offset.
* order:
* type: string
* title: order
* description: The currency's order.
* fields:
* type: string
* title: fields
* description: The currency's fields.
* $and:
* type: array
* description: The currency's $and.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: The currency's $or.
* items:
* type: object
* title: $or
*
*/
@@ -1,13 +0,0 @@
/**
* @schema AdminCurrencyParams
* type: object
* description: SUMMARY
* x-schemaName: AdminCurrencyParams
* properties:
* fields:
* type: string
* title: fields
* description: The currency's fields.
*
*/
@@ -1,7 +1,7 @@
/**
* @schema AdminCustomer
* type: object
* description: The customer's details.
* description: The order's customer.
* x-schemaName: AdminCustomer
* required:
* - has_account
@@ -3,40 +3,6 @@
* type: object
* description: The group's groups.
* x-schemaName: AdminCustomerGroup
* required:
* - id
* - name
* - customers
* - metadata
* - created_at
* - updated_at
* properties:
* id:
* type: string
* title: id
* description: The group's ID.
* name:
* type: string
* title: name
* description: The group's name.
* customers:
* type: array
* description: The group's customers.
* items:
* $ref: "#/components/schemas/BaseCustomer"
* metadata:
* type: object
* description: The group's metadata.
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The group's created at.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The group's updated at.
*
*/
@@ -0,0 +1,26 @@
/**
* @schema AdminDeletePaymentCollectionResponse
* type: object
* description: SUMMARY
* required:
* - id
* - object
* - deleted
* properties:
* id:
* type: string
* title: id
* description: The payment collection's ID.
* object:
* type: string
* title: object
* description: The name of the deleted object.
* default: payment-collection
* deleted:
* type: boolean
* title: deleted
* description: Whether the payment collection was deleted.
* x-schemaName: AdminDeletePaymentCollectionResponse
*
*/
@@ -97,7 +97,7 @@
* description: The exchange's email.
* format: email
* display_id:
* type: string
* type: number
* title: display_id
* description: The exchange's display id.
* shipping_address:
@@ -0,0 +1,26 @@
/**
* @schema AdminExchangeDeleteResponse
* type: object
* description: SUMMARY
* required:
* - id
* - object
* - deleted
* properties:
* id:
* type: string
* title: id
* description: The exchange's ID.
* object:
* type: string
* title: object
* description: The name of the deleted object.
* default: exchange
* deleted:
* type: boolean
* title: deleted
* description: Whether the exchange was deleted.
* x-schemaName: AdminExchangeDeleteResponse
*
*/
@@ -1,8 +1,42 @@
/**
* @schema AdminFulfillmentSet
* type: object
* description: The fulfillment set's details.
* x-schemaName: AdminFulfillmentSet
* description: The fulfillment set that the service zone belongs to.
* properties:
* id:
* type: string
* title: id
* description: The parent's ID.
* name:
* type: string
* title: name
* description: The parent's name.
* type:
* type: string
* title: type
* description: The parent's type.
* location:
* $ref: "#/components/schemas/AdminStockLocation"
* service_zones:
* type: array
* description: The parent's service zones.
* items:
* $ref: "#/components/schemas/AdminServiceZone"
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The parent's created at.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The parent's updated at.
* deleted_at:
* type: string
* format: date-time
* title: deleted_at
* description: The parent's deleted at.
* required:
* - id
* - name
@@ -12,41 +46,7 @@
* - created_at
* - updated_at
* - deleted_at
* properties:
* id:
* type: string
* title: id
* description: The fulfillment set's ID.
* name:
* type: string
* title: name
* description: The fulfillment set's name.
* type:
* type: string
* title: type
* description: The fulfillment set's type.
* location:
* $ref: "#/components/schemas/AdminStockLocation"
* service_zones:
* type: array
* description: The fulfillment set's service zones.
* items:
* $ref: "#/components/schemas/AdminServiceZone"
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The fulfillment set's created at.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The fulfillment set's updated at.
* deleted_at:
* type: string
* format: date-time
* title: deleted_at
* description: The fulfillment set's deleted at.
* x-schemaName: AdminFulfillmentSet
*
*/
@@ -21,9 +21,6 @@
* type: boolean
* title: deleted
* description: Whether the Fulfillment Set was deleted.
* parent:
* type: object
* description: The fulfillment set's parent.
*
*/
@@ -1,13 +0,0 @@
/**
* @schema AdminGetUploadParams
* type: object
* description: SUMMARY
* x-schemaName: AdminGetUploadParams
* properties:
* fields:
* type: string
* title: fields
* description: The upload's fields.
*
*/
@@ -66,6 +66,11 @@
* metadata:
* type: object
* description: The inventory item's metadata.
* location_levels:
* type: array
* description: The inventory item's location levels.
* items:
* $ref: "#/components/schemas/AdminInventoryLevel"
*
*/
@@ -0,0 +1,81 @@
/**
* @schema AdminInventoryLevel
* type: object
* description: The location level's location levels.
* x-schemaName: AdminInventoryLevel
* required:
* - id
* - created_at
* - updated_at
* - deleted_at
* - inventory_item_id
* - location_id
* - stocked_quantity
* - raw_stocked_quantity
* - reserved_quantity
* - raw_reserved_quantity
* - incoming_quantity
* - raw_incoming_quantity
* - metadata
* - available_quantity
* properties:
* id:
* type: string
* title: id
* description: The location level's ID.
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The location level's created at.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The location level's updated at.
* deleted_at:
* type: string
* format: date-time
* title: deleted_at
* description: The location level's deleted at.
* inventory_item_id:
* type: string
* title: inventory_item_id
* description: The location level's inventory item id.
* location_id:
* type: string
* title: location_id
* description: The location level's location id.
* stocked_quantity:
* type: number
* title: stocked_quantity
* description: The location level's stocked quantity.
* raw_stocked_quantity:
* type: object
* description: The location level's raw stocked quantity.
* reserved_quantity:
* type: number
* title: reserved_quantity
* description: The location level's reserved quantity.
* raw_reserved_quantity:
* type: object
* description: The location level's raw reserved quantity.
* incoming_quantity:
* type: number
* title: incoming_quantity
* description: The location level's incoming quantity.
* raw_incoming_quantity:
* type: object
* description: The location level's raw incoming quantity.
* metadata:
* type: object
* description: The location level's metadata.
* inventory_item:
* $ref: "#/components/schemas/AdminInventoryItem"
* available_quantity:
* type: number
* title: available_quantity
* description: The location level's available quantity.
*
*/
@@ -53,6 +53,14 @@
* description: The order's fulfillments.
* items:
* $ref: "#/components/schemas/BaseOrderFulfillment"
* sales_channel:
* $ref: "#/components/schemas/AdminSalesChannel"
* customer:
* $ref: "#/components/schemas/AdminCustomer"
* shipping_address:
* $ref: "#/components/schemas/AdminOrderAddress"
* billing_address:
* $ref: "#/components/schemas/AdminOrderAddress"
* id:
* type: string
* title: id
@@ -83,13 +91,9 @@
* title: currency_code
* description: The order's currency code.
* display_id:
* type: string
* type: number
* title: display_id
* description: The order's display id.
* shipping_address:
* $ref: "#/components/schemas/BaseOrderAddress"
* billing_address:
* $ref: "#/components/schemas/BaseOrderAddress"
* items:
* type: array
* description: The order's items.
@@ -0,0 +1,77 @@
/**
* @schema AdminOrderAddress
* type: object
* description: The order's billing address.
* x-schemaName: AdminOrderAddress
* required:
* - id
* - metadata
* - created_at
* - updated_at
* properties:
* country:
* $ref: "#/components/schemas/AdminRegionCountry"
* id:
* type: string
* title: id
* description: The billing address's ID.
* customer_id:
* type: string
* title: customer_id
* description: The billing address's customer id.
* first_name:
* type: string
* title: first_name
* description: The billing address's first name.
* last_name:
* type: string
* title: last_name
* description: The billing address's last name.
* phone:
* type: string
* title: phone
* description: The billing address's phone.
* company:
* type: string
* title: company
* description: The billing address's company.
* address_1:
* type: string
* title: address_1
* description: The billing address's address 1.
* address_2:
* type: string
* title: address_2
* description: The billing address's address 2.
* city:
* type: string
* title: city
* description: The billing address's city.
* country_code:
* type: string
* title: country_code
* description: The billing address's country code.
* province:
* type: string
* title: province
* description: The billing address's province.
* postal_code:
* type: string
* title: postal_code
* description: The billing address's postal code.
* metadata:
* type: object
* description: The billing address's metadata.
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The billing address's created at.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The billing address's updated at.
*
*/
@@ -493,13 +493,13 @@
* description: The order preview's email.
* format: email
* display_id:
* type: string
* type: number
* title: display_id
* description: The order preview's display id.
* shipping_address:
* $ref: "#/components/schemas/BaseOrderAddress"
* $ref: "#/components/schemas/AdminOrderAddress"
* billing_address:
* $ref: "#/components/schemas/BaseOrderAddress"
* $ref: "#/components/schemas/AdminOrderAddress"
* payment_collections:
* type: array
* description: The order preview's payment collections.
@@ -644,6 +644,10 @@
* type: number
* title: original_shipping_tax_total
* description: The order preview's original shipping tax total.
* customer:
* $ref: "#/components/schemas/AdminCustomer"
* sales_channel:
* $ref: "#/components/schemas/AdminSalesChannel"
*
*/
@@ -21,9 +21,6 @@
* type: boolean
* title: deleted
* description: Whether the Price List was deleted.
* parent:
* type: object
* description: The price list's parent.
*
*/
@@ -21,9 +21,6 @@
* type: boolean
* title: deleted
* description: Whether the Price Preference was deleted.
* parent:
* type: object
* description: The price preference's parent.
*
*/
@@ -5,9 +5,9 @@
* x-schemaName: AdminProduct
* required:
* - type
* - length
* - title
* - status
* - length
* - options
* - description
* - id
@@ -55,6 +55,10 @@
* description: The parent's tags.
* items:
* $ref: "#/components/schemas/AdminProductTag"
* length:
* type: number
* title: length
* description: The parent's length.
* title:
* type: string
* title: title
@@ -67,10 +71,6 @@
* - proposed
* - published
* - rejected
* length:
* type: number
* title: length
* description: The parent's length.
* options:
* type: array
* description: The parent's options.
@@ -21,9 +21,6 @@
* type: boolean
* title: deleted
* description: Whether the Product Category was deleted.
* parent:
* type: object
* description: The product category's parent.
*
*/
@@ -21,9 +21,6 @@
* type: boolean
* title: deleted
* description: Whether the Product was deleted.
* parent:
* type: object
* description: The product's parent.
*
*/
@@ -16,7 +16,6 @@
* type: string
* title: object
* description: The name of the deleted object.
* default: product_option
* deleted:
* type: boolean
* title: deleted
@@ -21,9 +21,6 @@
* type: boolean
* title: deleted
* description: Whether the Product Tag was deleted.
* parent:
* type: object
* description: The product tag's parent.
*
*/
@@ -21,9 +21,6 @@
* type: boolean
* title: deleted
* description: Whether the Product Type was deleted.
* parent:
* type: object
* description: The product type's parent.
*
*/
@@ -16,7 +16,6 @@
* type: string
* title: object
* description: The name of the deleted object.
* default: variant
* deleted:
* type: boolean
* title: deleted
@@ -19,31 +19,359 @@
* type: string
* title: id
* description: The id's ID.
* sku:
* oneOf:
* - type: string
* title: sku
* description: The variant's sku.
* - type: array
* description: The variant's sku.
* items:
* type: string
* title: sku
* description: The sku's details.
* product_id:
* oneOf:
* - type: string
* title: product_id
* description: The variant's product id.
* - type: array
* description: The variant's product id.
* items:
* type: string
* title: product_id
* description: The product id's details.
* options:
* manage_inventory:
* type: boolean
* title: manage_inventory
* description: The variant's manage inventory.
* allow_backorder:
* type: boolean
* title: allow_backorder
* description: The variant's allow backorder.
* created_at:
* type: object
* description: The variant's options.
* description: The variant's created at.
* 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`).
* updated_at:
* type: object
* description: The variant's updated at.
* 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`).
* deleted_at:
* type: object
* description: The variant's deleted at.
* 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`).
* limit:
* type: number
* title: limit
@@ -62,13 +390,13 @@
* description: The variant's fields.
* $and:
* type: array
* description: The variant'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 variant'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
@@ -0,0 +1,8 @@
/**
* @schema AdminRegionCountry
* type: object
* description: The billing address's country.
* x-schemaName: AdminRegionCountry
*
*/
@@ -26,7 +26,7 @@
* title: location_id
* description: The reservation's location id.
* quantity:
* type: string
* type: number
* title: quantity
* description: The reservation's quantity.
* external_id:
@@ -0,0 +1,26 @@
/**
* @schema AdminReturnReasonDeleteResponse
* type: object
* description: SUMMARY
* required:
* - id
* - object
* - deleted
* properties:
* id:
* type: string
* title: id
* description: The return reason's ID.
* object:
* type: string
* title: object
* description: The name of the deleted object.
* default: return_reason
* deleted:
* type: boolean
* title: deleted
* description: Whether the return reason was deleted.
* x-schemaName: AdminReturnReasonDeleteResponse
*
*/
@@ -1,7 +1,7 @@
/**
* @schema AdminSalesChannel
* type: object
* description: The sales channel's sales channels.
* description: The order's sales channel.
* x-schemaName: AdminSalesChannel
* required:
* - id
@@ -21,9 +21,6 @@
* type: boolean
* title: deleted
* description: Whether the Sales Channel was deleted.
* parent:
* type: object
* description: The sales channel's parent.
*
*/
@@ -0,0 +1,28 @@
/**
* @schema AdminServiceZoneDeleteResponse
* type: object
* description: SUMMARY
* required:
* - id
* - object
* - deleted
* properties:
* id:
* type: string
* title: id
* description: The service zone'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.
* parent:
* $ref: "#/components/schemas/AdminFulfillmentSet"
* x-schemaName: AdminServiceZoneDeleteResponse
*
*/
@@ -21,9 +21,6 @@
* type: boolean
* title: deleted
* description: Whether the Shipping Option was deleted.
* parent:
* type: object
* description: The shipping option's parent.
*
*/
@@ -21,9 +21,6 @@
* type: boolean
* title: deleted
* description: Whether the Shipping Profile was deleted.
* parent:
* type: object
* description: The shipping profile's parent.
*
*/
@@ -1,7 +1,7 @@
/**
* @schema AdminStockLocation
* type: object
* description: The fulfillment set's location.
* description: The parent's location.
* x-schemaName: AdminStockLocation
* required:
* - id
@@ -21,9 +21,6 @@
* type: boolean
* title: deleted
* description: Whether the Stock Location was deleted.
* parent:
* type: object
* description: The stock location's parent.
*
*/
@@ -1,7 +1,7 @@
/**
* @schema AdminTaxRate
* type: object
* description: The tax rate's details.
* description: The tax rate's parent.
* x-schemaName: AdminTaxRate
* required:
* - id
@@ -22,58 +22,58 @@
* id:
* type: string
* title: id
* description: The tax rate's ID.
* description: The parent's ID.
* rate:
* type: number
* title: rate
* description: The tax rate's rate.
* description: The parent's rate.
* code:
* type: string
* title: code
* description: The tax rate's code.
* description: The parent's code.
* name:
* type: string
* title: name
* description: The tax rate's name.
* description: The parent's name.
* metadata:
* type: object
* description: The tax rate's metadata.
* description: The parent's metadata.
* tax_region_id:
* type: string
* title: tax_region_id
* description: The tax rate's tax region id.
* description: The parent's tax region id.
* is_combinable:
* type: boolean
* title: is_combinable
* description: The tax rate's is combinable.
* description: The parent's is combinable.
* is_default:
* type: boolean
* title: is_default
* description: The tax rate's is default.
* description: The parent's is default.
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The tax rate's created at.
* description: The parent's created at.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The tax rate's updated at.
* description: The parent's updated at.
* deleted_at:
* type: string
* format: date-time
* title: deleted_at
* description: The tax rate's deleted at.
* description: The parent's deleted at.
* created_by:
* type: string
* title: created_by
* description: The tax rate's created by.
* description: The parent's created by.
* tax_region:
* $ref: "#/components/schemas/AdminTaxRegion"
* rules:
* type: array
* description: The tax rate's rules.
* description: The parent's rules.
* items:
* $ref: "#/components/schemas/AdminTaxRateRule"
*
@@ -21,9 +21,6 @@
* type: boolean
* title: deleted
* description: Whether the Tax Rate was deleted.
* parent:
* type: object
* description: The tax rate's parent.
*
*/
@@ -1,7 +1,7 @@
/**
* @schema AdminTaxRegion
* type: object
* description: The tax rate's tax region.
* description: The parent's tax region.
* x-schemaName: AdminTaxRegion
* required:
* - id
@@ -21,9 +21,6 @@
* type: boolean
* title: deleted
* description: Whether the Tax Region was deleted.
* parent:
* type: object
* description: The tax region's parent.
*
*/
@@ -0,0 +1,44 @@
/**
* @schema AdminUpsertStockLocationAddress
* type: object
* description: The stock location's address.
* x-schemaName: AdminUpsertStockLocationAddress
* required:
* - address_1
* - country_code
* properties:
* address_1:
* type: string
* title: address_1
* description: The address's address 1.
* address_2:
* type: string
* title: address_2
* description: The address's address 2.
* company:
* type: string
* title: company
* description: The address's company.
* country_code:
* type: string
* title: country_code
* description: The address's country code.
* city:
* type: string
* title: city
* description: The address's city.
* phone:
* type: string
* title: phone
* description: The address's phone.
* postal_code:
* type: string
* title: postal_code
* description: The address's postal code.
* province:
* type: string
* title: province
* description: The address's province.
*
*/
@@ -21,9 +21,6 @@
* type: boolean
* title: deleted
* description: Whether the User was deleted.
* parent:
* type: object
* description: The user's parent.
*
*/
@@ -1,7 +1,7 @@
/**
* @schema BaseCartAddress
* type: object
* description: The cart's billing address.
* description: The parent's billing address.
* x-schemaName: BaseCartAddress
* required:
* - id
@@ -1,8 +0,0 @@
/**
* @schema BaseCustomer
* type: object
* description: The customer's customers.
* x-schemaName: BaseCustomer
*
*/
@@ -3,99 +3,6 @@
* type: object
* description: The address's addresses.
* x-schemaName: BaseCustomerAddress
* required:
* - id
* - address_name
* - is_default_shipping
* - is_default_billing
* - customer_id
* - company
* - first_name
* - last_name
* - address_1
* - address_2
* - city
* - country_code
* - province
* - postal_code
* - phone
* - metadata
* - created_at
* - updated_at
* properties:
* id:
* type: string
* title: id
* description: The address's ID.
* address_name:
* type: string
* title: address_name
* description: The address's address name.
* is_default_shipping:
* type: boolean
* title: is_default_shipping
* description: The address's is default shipping.
* is_default_billing:
* type: boolean
* title: is_default_billing
* description: The address's is default billing.
* customer_id:
* type: string
* title: customer_id
* description: The address's customer id.
* company:
* type: string
* title: company
* description: The address's company.
* first_name:
* type: string
* title: first_name
* description: The address's first name.
* last_name:
* type: string
* title: last_name
* description: The address's last name.
* address_1:
* type: string
* title: address_1
* description: The address's address 1.
* address_2:
* type: string
* title: address_2
* description: The address's address 2.
* city:
* type: string
* title: city
* description: The address's city.
* country_code:
* type: string
* title: country_code
* description: The address's country code.
* province:
* type: string
* title: province
* description: The address's province.
* postal_code:
* type: string
* title: postal_code
* description: The address's postal code.
* phone:
* type: string
* title: phone
* description: The address's phone.
* metadata:
* type: object
* description: The address's metadata.
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The address's created at.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The address's updated at.
*
*/
@@ -1,7 +1,7 @@
/**
* @schema BaseOrderAddress
* type: object
* description: The order's billing address.
* description: The exchange's billing address.
* x-schemaName: BaseOrderAddress
* required:
* - id
@@ -1,7 +1,7 @@
/**
* @schema BaseRegion
* type: object
* description: The cart's region.
* description: The parent's region.
* x-schemaName: BaseRegion
* required:
* - id
@@ -0,0 +1,23 @@
/**
* @schema FileList
* type: object
* description: SUMMARY
* x-schemaName: FileList
* required:
* - length
* - item
* - __@iterator@258
* properties:
* length:
* type: number
* title: length
* description: The upload's length.
* item:
* type: object
* description: The upload's item.
* __@iterator@258:
* type: object
* description: The upload's @iterator@258.
*
*/
@@ -1,7 +1,7 @@
/**
* @schema StoreCart
* type: object
* description: The cart's details.
* description: The cart's parent.
* x-schemaName: StoreCart
* required:
* - id
@@ -32,322 +32,322 @@
* id:
* type: string
* title: id
* description: The cart's ID.
* description: The parent's ID.
* region:
* $ref: "#/components/schemas/BaseRegion"
* region_id:
* type: string
* title: region_id
* description: The cart's region id.
* description: The parent's region id.
* customer_id:
* type: string
* title: customer_id
* description: The cart's customer id.
* description: The parent's customer id.
* sales_channel_id:
* type: string
* title: sales_channel_id
* description: The cart's sales channel id.
* description: The parent's sales channel id.
* email:
* type: string
* title: email
* description: The cart's email.
* description: The parent's email.
* format: email
* currency_code:
* type: string
* title: currency_code
* description: The cart's currency code.
* description: The parent's currency code.
* shipping_address:
* $ref: "#/components/schemas/BaseCartAddress"
* billing_address:
* $ref: "#/components/schemas/BaseCartAddress"
* items:
* type: array
* description: The cart's items.
* description: The parent's items.
* items:
* $ref: "#/components/schemas/BaseCartLineItem"
* shipping_methods:
* type: array
* description: The cart's shipping methods.
* description: The parent's shipping methods.
* items:
* $ref: "#/components/schemas/BaseCartShippingMethod"
* payment_collection:
* $ref: "#/components/schemas/BasePaymentCollection"
* metadata:
* type: object
* description: The cart's metadata.
* description: The parent's metadata.
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The cart's created at.
* description: The parent's created at.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The cart's updated at.
* description: The parent's updated at.
* original_item_total:
* oneOf:
* - type: string
* title: original_item_total
* description: The cart's original item total.
* description: The parent's original item total.
* - type: number
* title: original_item_total
* description: The cart's original item total.
* description: The parent's original item total.
* - type: string
* title: original_item_total
* description: The cart's original item total.
* description: The parent's original item total.
* - $ref: "#/components/schemas/IBigNumber"
* original_item_subtotal:
* oneOf:
* - type: string
* title: original_item_subtotal
* description: The cart's original item subtotal.
* description: The parent's original item subtotal.
* - type: number
* title: original_item_subtotal
* description: The cart's original item subtotal.
* description: The parent's original item subtotal.
* - type: string
* title: original_item_subtotal
* description: The cart's original item subtotal.
* description: The parent's original item subtotal.
* - $ref: "#/components/schemas/IBigNumber"
* original_item_tax_total:
* oneOf:
* - type: string
* title: original_item_tax_total
* description: The cart's original item tax total.
* description: The parent's original item tax total.
* - type: number
* title: original_item_tax_total
* description: The cart's original item tax total.
* description: The parent's original item tax total.
* - type: string
* title: original_item_tax_total
* description: The cart's original item tax total.
* description: The parent's original item tax total.
* - $ref: "#/components/schemas/IBigNumber"
* item_total:
* oneOf:
* - type: string
* title: item_total
* description: The cart's item total.
* description: The parent's item total.
* - type: number
* title: item_total
* description: The cart's item total.
* description: The parent's item total.
* - type: string
* title: item_total
* description: The cart's item total.
* description: The parent's item total.
* - $ref: "#/components/schemas/IBigNumber"
* item_subtotal:
* oneOf:
* - type: string
* title: item_subtotal
* description: The cart's item subtotal.
* description: The parent's item subtotal.
* - type: number
* title: item_subtotal
* description: The cart's item subtotal.
* description: The parent's item subtotal.
* - type: string
* title: item_subtotal
* description: The cart's item subtotal.
* description: The parent's item subtotal.
* - $ref: "#/components/schemas/IBigNumber"
* item_tax_total:
* oneOf:
* - type: string
* title: item_tax_total
* description: The cart's item tax total.
* description: The parent's item tax total.
* - type: number
* title: item_tax_total
* description: The cart's item tax total.
* description: The parent's item tax total.
* - type: string
* title: item_tax_total
* description: The cart's item tax total.
* description: The parent's item tax total.
* - $ref: "#/components/schemas/IBigNumber"
* original_total:
* oneOf:
* - type: string
* title: original_total
* description: The cart's original total.
* description: The parent's original total.
* - type: number
* title: original_total
* description: The cart's original total.
* description: The parent's original total.
* - type: string
* title: original_total
* description: The cart's original total.
* description: The parent's original total.
* - $ref: "#/components/schemas/IBigNumber"
* original_subtotal:
* oneOf:
* - type: string
* title: original_subtotal
* description: The cart's original subtotal.
* description: The parent's original subtotal.
* - type: number
* title: original_subtotal
* description: The cart's original subtotal.
* description: The parent's original subtotal.
* - type: string
* title: original_subtotal
* description: The cart's original subtotal.
* description: The parent's original subtotal.
* - $ref: "#/components/schemas/IBigNumber"
* original_tax_total:
* oneOf:
* - type: string
* title: original_tax_total
* description: The cart's original tax total.
* description: The parent's original tax total.
* - type: number
* title: original_tax_total
* description: The cart's original tax total.
* description: The parent's original tax total.
* - type: string
* title: original_tax_total
* description: The cart's original tax total.
* description: The parent's original tax total.
* - $ref: "#/components/schemas/IBigNumber"
* total:
* oneOf:
* - type: string
* title: total
* description: The cart's total.
* description: The parent's total.
* - type: number
* title: total
* description: The cart's total.
* description: The parent's total.
* - type: string
* title: total
* description: The cart's total.
* description: The parent's total.
* - $ref: "#/components/schemas/IBigNumber"
* subtotal:
* oneOf:
* - type: string
* title: subtotal
* description: The cart's subtotal.
* description: The parent's subtotal.
* - type: number
* title: subtotal
* description: The cart's subtotal.
* description: The parent's subtotal.
* - type: string
* title: subtotal
* description: The cart's subtotal.
* description: The parent's subtotal.
* - $ref: "#/components/schemas/IBigNumber"
* tax_total:
* oneOf:
* - type: string
* title: tax_total
* description: The cart's tax total.
* description: The parent's tax total.
* - type: number
* title: tax_total
* description: The cart's tax total.
* description: The parent's tax total.
* - type: string
* title: tax_total
* description: The cart's tax total.
* description: The parent's tax total.
* - $ref: "#/components/schemas/IBigNumber"
* discount_total:
* oneOf:
* - type: string
* title: discount_total
* description: The cart's discount total.
* description: The parent's discount total.
* - type: number
* title: discount_total
* description: The cart's discount total.
* description: The parent's discount total.
* - type: string
* title: discount_total
* description: The cart's discount total.
* description: The parent's discount total.
* - $ref: "#/components/schemas/IBigNumber"
* discount_tax_total:
* oneOf:
* - type: string
* title: discount_tax_total
* description: The cart's discount tax total.
* description: The parent's discount tax total.
* - type: number
* title: discount_tax_total
* description: The cart's discount tax total.
* description: The parent's discount tax total.
* - type: string
* title: discount_tax_total
* description: The cart's discount tax total.
* description: The parent's discount tax total.
* - $ref: "#/components/schemas/IBigNumber"
* gift_card_total:
* oneOf:
* - type: string
* title: gift_card_total
* description: The cart's gift card total.
* description: The parent's gift card total.
* - type: number
* title: gift_card_total
* description: The cart's gift card total.
* description: The parent's gift card total.
* - type: string
* title: gift_card_total
* description: The cart's gift card total.
* description: The parent's gift card total.
* - $ref: "#/components/schemas/IBigNumber"
* gift_card_tax_total:
* oneOf:
* - type: string
* title: gift_card_tax_total
* description: The cart's gift card tax total.
* description: The parent's gift card tax total.
* - type: number
* title: gift_card_tax_total
* description: The cart's gift card tax total.
* description: The parent's gift card tax total.
* - type: string
* title: gift_card_tax_total
* description: The cart's gift card tax total.
* description: The parent's gift card tax total.
* - $ref: "#/components/schemas/IBigNumber"
* shipping_total:
* oneOf:
* - type: string
* title: shipping_total
* description: The cart's shipping total.
* description: The parent's shipping total.
* - type: number
* title: shipping_total
* description: The cart's shipping total.
* description: The parent's shipping total.
* - type: string
* title: shipping_total
* description: The cart's shipping total.
* description: The parent's shipping total.
* - $ref: "#/components/schemas/IBigNumber"
* shipping_subtotal:
* oneOf:
* - type: string
* title: shipping_subtotal
* description: The cart's shipping subtotal.
* description: The parent's shipping subtotal.
* - type: number
* title: shipping_subtotal
* description: The cart's shipping subtotal.
* description: The parent's shipping subtotal.
* - type: string
* title: shipping_subtotal
* description: The cart's shipping subtotal.
* description: The parent's shipping subtotal.
* - $ref: "#/components/schemas/IBigNumber"
* shipping_tax_total:
* oneOf:
* - type: string
* title: shipping_tax_total
* description: The cart's shipping tax total.
* description: The parent's shipping tax total.
* - type: number
* title: shipping_tax_total
* description: The cart's shipping tax total.
* description: The parent's shipping tax total.
* - type: string
* title: shipping_tax_total
* description: The cart's shipping tax total.
* description: The parent's shipping tax total.
* - $ref: "#/components/schemas/IBigNumber"
* original_shipping_total:
* oneOf:
* - type: string
* title: original_shipping_total
* description: The cart's original shipping total.
* description: The parent's original shipping total.
* - type: number
* title: original_shipping_total
* description: The cart's original shipping total.
* description: The parent's original shipping total.
* - type: string
* title: original_shipping_total
* description: The cart's original shipping total.
* description: The parent's original shipping total.
* - $ref: "#/components/schemas/IBigNumber"
* original_shipping_subtotal:
* oneOf:
* - type: string
* title: original_shipping_subtotal
* description: The cart's original shipping subtotal.
* description: The parent's original shipping subtotal.
* - type: number
* title: original_shipping_subtotal
* description: The cart's original shipping subtotal.
* description: The parent's original shipping subtotal.
* - type: string
* title: original_shipping_subtotal
* description: The cart's original shipping subtotal.
* description: The parent's original shipping subtotal.
* - $ref: "#/components/schemas/IBigNumber"
* original_shipping_tax_total:
* oneOf:
* - type: string
* title: original_shipping_tax_total
* description: The cart's original shipping tax total.
* description: The parent's original shipping tax total.
* - type: number
* title: original_shipping_tax_total
* description: The cart's original shipping tax total.
* description: The parent's original shipping tax total.
* - type: string
* title: original_shipping_tax_total
* description: The cart's original shipping tax total.
* description: The parent's original shipping tax total.
* - $ref: "#/components/schemas/IBigNumber"
*
*/
@@ -5,10 +5,6 @@
* x-schemaName: StoreCreateCustomer
* required:
* - email
* - company_name
* - first_name
* - last_name
* - phone
* properties:
* email:
* type: string
@@ -31,6 +27,9 @@
* type: string
* title: phone
* description: The customer's phone.
* metadata:
* type: object
* description: The customer's metadata.
*
*/
@@ -0,0 +1,15 @@
/**
* @schema StoreCreatePaymentCollection
* type: object
* description: SUMMARY
* required:
* - cart_id
* properties:
* cart_id:
* type: string
* title: cart_id
* description: The payment collection's cart id.
* x-schemaName: StoreCreatePaymentCollection
*
*/
@@ -0,0 +1,36 @@
/**
* @schema StoreCreateReturn
* type: object
* description: SUMMARY
* x-schemaName: StoreCreateReturn
* required:
* - order_id
* - items
* - return_shipping
* properties:
* order_id:
* type: string
* title: order_id
* description: The return's order id.
* items:
* type: array
* description: The return's items.
* items:
* $ref: "#/components/schemas/StoreCreateReturnItem"
* return_shipping:
* $ref: "#/components/schemas/StoreCreateReturnShipping"
* note:
* type: string
* title: note
* description: The return's note.
* receive_now:
* type: boolean
* title: receive_now
* description: The return's receive now.
* location_id:
* type: string
* title: location_id
* description: The return's location id.
*
*/
@@ -0,0 +1,28 @@
/**
* @schema StoreCreateReturnItem
* type: object
* description: The item's items.
* required:
* - id
* - quantity
* properties:
* id:
* type: string
* title: id
* description: The item's ID.
* quantity:
* type: number
* title: quantity
* description: The item's quantity.
* reason_id:
* type: string
* title: reason_id
* description: The item's reason id.
* note:
* type: string
* title: note
* description: The item's note.
* x-schemaName: StoreCreateReturnItem
*
*/
@@ -0,0 +1,19 @@
/**
* @schema StoreCreateReturnShipping
* type: object
* description: The return's return shipping.
* required:
* - option_id
* properties:
* option_id:
* type: string
* title: option_id
* description: The return shipping's option id.
* price:
* type: number
* title: price
* description: The return shipping's price.
* x-schemaName: StoreCreateReturnShipping
*
*/
@@ -1,7 +1,7 @@
/**
* @schema StoreCustomer
* type: object
* description: The customer's details.
* description: The customer's parent.
* x-schemaName: StoreCustomer
* required:
* - id
@@ -16,63 +16,63 @@
* id:
* type: string
* title: id
* description: The customer's ID.
* description: The parent's ID.
* email:
* type: string
* title: email
* description: The customer's email.
* description: The parent's email.
* format: email
* default_billing_address_id:
* type: string
* title: default_billing_address_id
* description: The customer's default billing address id.
* description: The parent's default billing address id.
* default_shipping_address_id:
* type: string
* title: default_shipping_address_id
* description: The customer's default shipping address id.
* description: The parent's default shipping address id.
* company_name:
* type: string
* title: company_name
* description: The customer's company name.
* description: The parent's company name.
* first_name:
* type: string
* title: first_name
* description: The customer's first name.
* description: The parent's first name.
* last_name:
* type: string
* title: last_name
* description: The customer's last name.
* description: The parent's last name.
* addresses:
* type: array
* description: The customer's addresses.
* description: The parent's addresses.
* items:
* $ref: "#/components/schemas/BaseCustomerAddress"
* phone:
* type: string
* title: phone
* description: The customer's phone.
* description: The parent's phone.
* metadata:
* type: object
* description: The customer's metadata.
* description: The parent's metadata.
* created_by:
* type: string
* title: created_by
* description: The customer's created by.
* description: The parent's created by.
* deleted_at:
* type: string
* format: date-time
* title: deleted_at
* description: The customer's deleted at.
* description: The parent's deleted at.
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The customer's created at.
* description: The parent's created at.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The customer's updated at.
* description: The parent's updated at.
*
*/
@@ -72,7 +72,7 @@
* title: currency_code
* description: The order's currency code.
* display_id:
* type: string
* type: number
* title: display_id
* description: The order's display id.
* shipping_address:
@@ -1,73 +0,0 @@
/**
* @schema StorePostReturnsReqSchema
* type: object
* description: SUMMARY
* x-schemaName: StorePostReturnsReqSchema
* required:
* - order_id
* - items
* - return_shipping
* - note
* - location_id
* properties:
* order_id:
* type: string
* title: order_id
* description: The return's order id.
* items:
* type: array
* description: The return's items.
* items:
* type: object
* description: The item's items.
* required:
* - id
* - quantity
* - reason_id
* - note
* properties:
* id:
* type: string
* title: id
* description: The item's ID.
* quantity:
* type: number
* title: quantity
* description: The item's quantity.
* reason_id:
* type: string
* title: reason_id
* description: The item's reason id.
* note:
* type: string
* title: note
* description: The item's note.
* return_shipping:
* type: object
* description: The return's return shipping.
* required:
* - option_id
* properties:
* option_id:
* type: string
* title: option_id
* description: The return shipping's option id.
* price:
* type: number
* title: price
* description: The return shipping's price.
* note:
* type: string
* title: note
* description: The return's note.
* receive_now:
* type: boolean
* title: receive_now
* description: The return's receive now.
* location_id:
* type: string
* title: location_id
* description: The return's location id.
*
*/
@@ -4,9 +4,9 @@
* description: The product's details.
* x-schemaName: StoreProduct
* required:
* - length
* - title
* - status
* - length
* - options
* - description
* - id
@@ -38,6 +38,10 @@
* $ref: "#/components/schemas/StoreProductCategory"
* type:
* $ref: "#/components/schemas/StoreProduct"
* length:
* type: number
* title: length
* description: The product's length.
* title:
* type: string
* title: title
@@ -50,10 +54,6 @@
* - proposed
* - published
* - rejected
* length:
* type: number
* title: length
* description: The product's length.
* options:
* type: array
* description: The product's options.
@@ -0,0 +1,77 @@
/**
* @schema StoreProductVariantParams
* type: object
* description: The product's variants.
* x-schemaName: StoreProductVariantParams
* properties:
* q:
* type: string
* title: q
* description: The variant's q.
* id:
* oneOf:
* - type: string
* title: id
* description: The variant's ID.
* - type: array
* description: The variant's ID.
* items:
* type: string
* title: id
* description: The id's ID.
* sku:
* oneOf:
* - type: string
* title: sku
* description: The variant's sku.
* - type: array
* description: The variant's sku.
* items:
* type: string
* title: sku
* description: The sku's details.
* product_id:
* oneOf:
* - type: string
* title: product_id
* description: The variant's product id.
* - type: array
* description: The variant's product id.
* items:
* type: string
* title: product_id
* description: The product id's details.
* options:
* type: object
* description: The variant's options.
* limit:
* type: number
* title: limit
* description: The variant's limit.
* offset:
* type: number
* title: offset
* description: The variant's offset.
* order:
* type: string
* title: order
* description: The variant's order.
* fields:
* type: string
* title: fields
* description: The variant'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.
* 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
*
*/