docs: generate OAS for v2 (#7883)

This commit is contained in:
Shahed Nasser authored and GitHub committed 2024-07-01 15:35:45 +03:00
1 parent 8fde57263f
commit b9036eca1a
1103 files changed
+125727 -22463

No files matched your search

@@ -0,0 +1,15 @@
/**
* @schema AdminArchiveOrder
* type: object
* description: SUMMARY
* x-schemaName: AdminArchiveOrder
* required:
* - order_id
* properties:
* order_id:
* type: string
* title: order_id
* description: The order's order id.
*
*/
@@ -0,0 +1,26 @@
/**
* @schema AdminBatchProductRequest
* type: object
* description: SUMMARY
* x-schemaName: AdminBatchProductRequest
* properties:
* create:
* type: array
* description: The product's create.
* items:
* $ref: "#/components/schemas/AdminCreateProduct"
* update:
* type: array
* description: The product's update.
* items:
* $ref: "#/components/schemas/AdminUpdateProduct"
* delete:
* type: array
* description: The product's delete.
* items:
* type: string
* title: delete
* description: The delete's details.
*
*/
@@ -0,0 +1,46 @@
/**
* @schema AdminBatchProductResponse
* type: object
* description: SUMMARY
* x-schemaName: AdminBatchProductResponse
* required:
* - created
* - updated
* - deleted
* properties:
* created:
* type: array
* description: The product's created.
* items:
* $ref: "#/components/schemas/AdminProduct"
* updated:
* type: array
* description: The product's updated.
* items:
* $ref: "#/components/schemas/AdminProduct"
* deleted:
* type: object
* description: The product's deleted.
* required:
* - ids
* - object
* - deleted
* properties:
* ids:
* type: array
* description: The deleted's ids.
* items:
* type: string
* title: ids
* description: The id's ids.
* object:
* type: string
* title: object
* description: The deleted's object.
* deleted:
* type: boolean
* title: deleted
* description: The deleted's details.
*
*/
@@ -0,0 +1,26 @@
/**
* @schema AdminBatchProductVariantRequest
* type: object
* description: SUMMARY
* x-schemaName: AdminBatchProductVariantRequest
* properties:
* create:
* type: array
* description: The product's create.
* items:
* $ref: "#/components/schemas/AdminCreateProductVariant"
* update:
* type: array
* description: The product's update.
* items:
* $ref: "#/components/schemas/AdminUpdateProductVariant"
* delete:
* type: array
* description: The product's delete.
* items:
* type: string
* title: delete
* description: The delete's details.
*
*/
@@ -0,0 +1,46 @@
/**
* @schema AdminBatchProductVariantResponse
* type: object
* description: SUMMARY
* x-schemaName: AdminBatchProductVariantResponse
* required:
* - created
* - updated
* - deleted
* properties:
* created:
* type: array
* description: The product's created.
* items:
* $ref: "#/components/schemas/AdminProductVariant"
* updated:
* type: array
* description: The product's updated.
* items:
* $ref: "#/components/schemas/AdminProductVariant"
* deleted:
* type: object
* description: The product's deleted.
* required:
* - ids
* - object
* - deleted
* properties:
* ids:
* type: array
* description: The deleted's ids.
* items:
* type: string
* title: ids
* description: The id's ids.
* object:
* type: string
* title: object
* description: The deleted's object.
* deleted:
* type: boolean
* title: deleted
* description: The deleted's details.
*
*/
@@ -0,0 +1,8 @@
/**
* @schema AdminCancelFulfillment
* type: object
* description: SUMMARY
* x-schemaName: AdminCancelFulfillment
*
*/
@@ -0,0 +1,44 @@
/**
* @schema AdminCollection
* type: object
* description: The parent's collection.
* x-schemaName: AdminCollection
* properties:
* id:
* type: string
* title: id
* description: The collection's ID.
* title:
* type: string
* title: title
* description: The collection's title.
* handle:
* type: string
* title: handle
* description: The collection's handle.
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The collection's created at.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The collection's updated at.
* deleted_at:
* type: string
* format: date-time
* title: deleted_at
* description: The collection's deleted at.
* products:
* type: array
* description: The collection's products.
* items:
* $ref: "#/components/schemas/AdminProduct"
* metadata:
* type: object
* description: The collection's metadata.
*
*/
@@ -0,0 +1,15 @@
/**
* @schema AdminCompleteOrder
* type: object
* description: SUMMARY
* x-schemaName: AdminCompleteOrder
* required:
* - order_id
* properties:
* order_id:
* type: string
* title: order_id
* description: The order's order id.
*
*/
@@ -0,0 +1,21 @@
/**
* @schema AdminCreateApiKey
* type: object
* description: SUMMARY
* x-schemaName: AdminCreateApiKey
* required:
* - title
* - type
* properties:
* title:
* type: string
* title: title
* description: The api key's title.
* type:
* type: string
* enum:
* - publishable
* - secret
*
*/
@@ -0,0 +1,23 @@
/**
* @schema AdminCreateCollection
* type: object
* description: SUMMARY
* x-schemaName: AdminCreateCollection
* required:
* - title
* - metadata
* properties:
* title:
* type: string
* title: title
* description: The collection's title.
* handle:
* type: string
* title: handle
* description: The collection's handle.
* metadata:
* type: object
* description: The collection's metadata.
*
*/
@@ -0,0 +1,40 @@
/**
* @schema AdminCreateCustomer
* type: object
* description: SUMMARY
* x-schemaName: AdminCreateCustomer
* required:
* - email
* - company_name
* - first_name
* - last_name
* - phone
* - metadata
* properties:
* email:
* type: string
* title: email
* description: The customer's email.
* format: email
* company_name:
* type: string
* title: company_name
* description: The customer's company name.
* first_name:
* type: string
* title: first_name
* description: The customer's first name.
* last_name:
* type: string
* title: last_name
* description: The customer's last name.
* phone:
* type: string
* title: phone
* description: The customer's phone.
* metadata:
* type: object
* description: The customer's metadata.
*
*/
@@ -0,0 +1,77 @@
/**
* @schema AdminCreateCustomerAddress
* type: object
* description: SUMMARY
* x-schemaName: AdminCreateCustomerAddress
* required:
* - address_name
* - company
* - first_name
* - last_name
* - address_1
* - address_2
* - city
* - country_code
* - province
* - postal_code
* - phone
* - metadata
* properties:
* address_name:
* type: string
* title: address_name
* description: The customer's address name.
* is_default_shipping:
* type: boolean
* title: is_default_shipping
* description: The customer's is default shipping.
* is_default_billing:
* type: boolean
* title: is_default_billing
* description: The customer's is default billing.
* company:
* type: string
* title: company
* description: The customer's company.
* first_name:
* type: string
* title: first_name
* description: The customer's first name.
* last_name:
* type: string
* title: last_name
* description: The customer's last name.
* address_1:
* type: string
* title: address_1
* description: The customer's address 1.
* address_2:
* type: string
* title: address_2
* description: The customer's address 2.
* city:
* type: string
* title: city
* description: The customer's city.
* country_code:
* type: string
* title: country_code
* description: The customer's country code.
* province:
* type: string
* title: province
* description: The customer's province.
* postal_code:
* type: string
* title: postal_code
* description: The customer's postal code.
* phone:
* type: string
* title: phone
* description: The customer's phone.
* metadata:
* type: object
* description: The customer's metadata.
*
*/
@@ -0,0 +1,19 @@
/**
* @schema AdminCreateCustomerGroup
* type: object
* description: SUMMARY
* x-schemaName: AdminCreateCustomerGroup
* required:
* - name
* - metadata
* properties:
* name:
* type: string
* title: name
* description: The customer group's name.
* metadata:
* type: object
* description: The customer group's metadata.
*
*/
@@ -0,0 +1,189 @@
/**
* @schema AdminCreateFulfillment
* type: object
* description: SUMMARY
* x-schemaName: AdminCreateFulfillment
* required:
* - location_id
* - provider_id
* - delivery_address
* - items
* - labels
* - order
* - order_id
* - shipping_option_id
* - data
* - packed_at
* - shipped_at
* - delivered_at
* - canceled_at
* - metadata
* properties:
* location_id:
* type: string
* title: location_id
* description: The fulfillment's location id.
* provider_id:
* type: string
* title: provider_id
* description: The fulfillment's provider id.
* delivery_address:
* type: object
* description: The fulfillment's delivery address.
* required:
* - first_name
* - last_name
* - phone
* - company
* - address_1
* - address_2
* - city
* - country_code
* - province
* - postal_code
* - metadata
* properties:
* first_name:
* type: string
* title: first_name
* description: The delivery address's first name.
* last_name:
* type: string
* title: last_name
* description: The delivery address's last name.
* phone:
* type: string
* title: phone
* description: The delivery address's phone.
* company:
* type: string
* title: company
* description: The delivery address's company.
* address_1:
* type: string
* title: address_1
* description: The delivery address's address 1.
* address_2:
* type: string
* title: address_2
* description: The delivery address's address 2.
* city:
* type: string
* title: city
* description: The delivery address's city.
* country_code:
* type: string
* title: country_code
* description: The delivery address's country code.
* province:
* type: string
* title: province
* description: The delivery address's province.
* postal_code:
* type: string
* title: postal_code
* description: The delivery address's postal code.
* metadata:
* type: object
* description: The delivery address's metadata.
* items:
* type: array
* description: The fulfillment's items.
* items:
* type: object
* description: The item's items.
* required:
* - title
* - sku
* - quantity
* - barcode
* - line_item_id
* - inventory_item_id
* properties:
* title:
* type: string
* title: title
* description: The item's title.
* sku:
* type: string
* title: sku
* description: The item's sku.
* quantity:
* type: number
* title: quantity
* description: The item's quantity.
* barcode:
* type: string
* title: barcode
* description: The item's barcode.
* line_item_id:
* type: string
* title: line_item_id
* description: The item's line item id.
* inventory_item_id:
* type: string
* title: inventory_item_id
* description: The item's inventory item id.
* labels:
* type: array
* description: The fulfillment's labels.
* items:
* type: object
* description: The label's labels.
* required:
* - tracking_number
* - tracking_url
* - label_url
* properties:
* tracking_number:
* type: string
* title: tracking_number
* description: The label's tracking number.
* tracking_url:
* type: string
* title: tracking_url
* description: The label's tracking url.
* label_url:
* type: string
* title: label_url
* description: The label's label url.
* order:
* type: object
* description: The fulfillment's order.
* order_id:
* type: string
* title: order_id
* description: The fulfillment's order id.
* shipping_option_id:
* type: string
* title: shipping_option_id
* description: The fulfillment's shipping option id.
* data:
* type: object
* description: The fulfillment's data.
* packed_at:
* type: string
* title: packed_at
* description: The fulfillment's packed at.
* format: date-time
* shipped_at:
* type: string
* title: shipped_at
* description: The fulfillment's shipped at.
* format: date-time
* delivered_at:
* type: string
* title: delivered_at
* description: The fulfillment's delivered at.
* format: date-time
* canceled_at:
* type: string
* title: canceled_at
* description: The fulfillment's canceled at.
* format: date-time
* metadata:
* type: object
* description: The fulfillment's metadata.
*
*/
@@ -0,0 +1,79 @@
/**
* @schema AdminCreatePriceList
* type: object
* description: SUMMARY
* x-schemaName: AdminCreatePriceList
* required:
* - title
* - description
* - starts_at
* - ends_at
* properties:
* title:
* type: string
* title: title
* description: The price list's title.
* description:
* type: string
* title: description
* description: The price list's description.
* starts_at:
* type: string
* title: starts_at
* description: The price list's starts at.
* ends_at:
* type: string
* title: ends_at
* description: The price list's ends at.
* status:
* type: string
* enum:
* - active
* - draft
* type:
* type: string
* enum:
* - sale
* - override
* rules:
* type: object
* description: The price list's rules.
* prices:
* type: array
* description: The price list's prices.
* items:
* type: object
* description: The price's prices.
* required:
* - currency_code
* - amount
* - variant_id
* - min_quantity
* - max_quantity
* properties:
* currency_code:
* type: string
* title: currency_code
* description: The price's currency code.
* amount:
* type: number
* title: amount
* description: The price's amount.
* variant_id:
* type: string
* title: variant_id
* description: The price's variant id.
* min_quantity:
* type: number
* title: min_quantity
* description: The price's min quantity.
* max_quantity:
* type: number
* title: max_quantity
* description: The price's max quantity.
* rules:
* type: object
* description: The price's rules.
*
*/
@@ -0,0 +1,153 @@
/**
* @schema AdminCreateProduct
* type: object
* description: The create's details.
* x-schemaName: AdminCreateProduct
* required:
* - title
* properties:
* title:
* type: string
* title: title
* description: The create's title.
* subtitle:
* type: string
* title: subtitle
* description: The create's subtitle.
* description:
* type: string
* title: description
* description: The create's description.
* is_giftcard:
* type: boolean
* title: is_giftcard
* description: The create's is giftcard.
* discountable:
* type: boolean
* title: discountable
* description: The create's discountable.
* images:
* type: array
* description: The create's images.
* items:
* type: object
* description: The image's images.
* required:
* - url
* properties:
* url:
* type: string
* title: url
* description: The image's url.
* thumbnail:
* type: string
* title: thumbnail
* description: The create's thumbnail.
* handle:
* type: string
* title: handle
* description: The create's handle.
* status:
* type: string
* enum:
* - draft
* - proposed
* - published
* - rejected
* type_id:
* type: string
* title: type_id
* description: The create's type id.
* collection_id:
* type: string
* title: collection_id
* description: The create's collection id.
* categories:
* type: array
* description: The create's categories.
* items:
* type: object
* description: The category's categories.
* required:
* - id
* properties:
* id:
* type: string
* title: id
* description: The category's ID.
* tags:
* type: array
* description: The create's tags.
* items:
* type: object
* description: The tag's tags.
* properties:
* id:
* type: string
* title: id
* description: The tag's ID.
* value:
* type: string
* title: value
* description: The tag's value.
* options:
* type: array
* description: The create's options.
* items:
* $ref: "#/components/schemas/AdminCreateProductOption"
* variants:
* type: array
* description: The create's variants.
* items:
* $ref: "#/components/schemas/AdminCreateProductVariant"
* sales_channels:
* type: array
* description: The create's sales channels.
* items:
* type: object
* description: The sales channel's sales channels.
* required:
* - id
* properties:
* id:
* type: string
* title: id
* description: The sales channel's ID.
* weight:
* type: number
* title: weight
* description: The create's weight.
* length:
* type: number
* title: length
* description: The create's length.
* height:
* type: number
* title: height
* description: The create's height.
* width:
* type: number
* title: width
* description: The create's width.
* hs_code:
* type: string
* title: hs_code
* description: The create's hs code.
* mid_code:
* type: string
* title: mid_code
* description: The create's mid code.
* origin_country:
* type: string
* title: origin_country
* description: The create's origin country.
* material:
* type: string
* title: material
* description: The create's material.
* metadata:
* type: object
* description: The create's metadata.
*
*/
@@ -0,0 +1,23 @@
/**
* @schema AdminCreateProductOption
* type: object
* description: SUMMARY
* x-schemaName: AdminCreateProductOption
* required:
* - title
* - values
* properties:
* title:
* type: string
* title: title
* description: The product's title.
* values:
* type: array
* description: The product's values.
* items:
* type: string
* title: values
* description: The value's values.
*
*/
@@ -0,0 +1,87 @@
/**
* @schema AdminCreateProductVariant
* type: object
* description: The create's details.
* x-schemaName: AdminCreateProductVariant
* required:
* - title
* - prices
* properties:
* title:
* type: string
* title: title
* description: The create's title.
* sku:
* type: string
* title: sku
* description: The create's sku.
* ean:
* type: string
* title: ean
* description: The create's ean.
* upc:
* type: string
* title: upc
* description: The create's upc.
* barcode:
* type: string
* title: barcode
* description: The create's barcode.
* hs_code:
* type: string
* title: hs_code
* description: The create's hs code.
* mid_code:
* type: string
* title: mid_code
* description: The create's mid code.
* allow_backorder:
* type: boolean
* title: allow_backorder
* description: The create's allow backorder.
* manage_inventory:
* type: boolean
* title: manage_inventory
* description: The create's manage inventory.
* variant_rank:
* type: number
* title: variant_rank
* description: The create's variant rank.
* weight:
* type: number
* title: weight
* description: The create's weight.
* length:
* type: number
* title: length
* description: The create's length.
* height:
* type: number
* title: height
* description: The create's height.
* width:
* type: number
* title: width
* description: The create's width.
* origin_country:
* type: string
* title: origin_country
* description: The create's origin country.
* material:
* type: string
* title: material
* description: The create's material.
* metadata:
* type: object
* description: The create's metadata.
* prices:
* type: array
* description: The create's prices.
* items:
* $ref: "#/components/schemas/AdminCreateProductVariantPrice"
* options:
* type: object
* description: The create's options.
*
*/
@@ -0,0 +1,28 @@
/**
* @schema AdminCreateProductVariantPrice
* type: object
* description: The price's prices.
* x-schemaName: AdminCreateProductVariantPrice
* 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.
* min_quantity:
* type: number
* title: min_quantity
* description: The price's min quantity.
* max_quantity:
* type: number
* title: max_quantity
* description: The price's max quantity.
*
*/
@@ -0,0 +1,28 @@
/**
* @schema AdminCreateSalesChannel
* type: object
* description: SUMMARY
* x-schemaName: AdminCreateSalesChannel
* required:
* - name
* - description
* - metadata
* properties:
* name:
* type: string
* title: name
* description: The sales channel's name.
* description:
* type: string
* title: description
* description: The sales channel's description.
* is_disabled:
* type: boolean
* title: is_disabled
* description: The sales channel's is disabled.
* metadata:
* type: object
* description: The sales channel's metadata.
*
*/
@@ -0,0 +1,34 @@
/**
* @schema AdminCreateShipment
* type: object
* description: SUMMARY
* x-schemaName: AdminCreateShipment
* required:
* - labels
* properties:
* labels:
* type: array
* description: The fulfillment's labels.
* items:
* type: object
* description: The label's labels.
* required:
* - tracking_number
* - tracking_url
* - label_url
* properties:
* tracking_number:
* type: string
* title: tracking_number
* description: The label's tracking number.
* tracking_url:
* type: string
* title: tracking_url
* description: The label's tracking url.
* label_url:
* type: string
* title: label_url
* description: The label's label url.
*
*/
@@ -0,0 +1,69 @@
/**
* @schema AdminCreateStockLocation
* type: object
* description: SUMMARY
* 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.
* metadata:
* type: object
* description: The stock location's metadata.
*
*/
@@ -0,0 +1,58 @@
/**
* @schema AdminCreateTaxRate
* type: object
* description: SUMMARY
* x-schemaName: AdminCreateTaxRate
* required:
* - name
* - tax_region_id
* - metadata
* properties:
* rate:
* type: number
* title: rate
* description: The tax rate's rate.
* code:
* type: string
* title: code
* description: The tax rate's code.
* rules:
* 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.
* is_default:
* type: boolean
* title: is_default
* description: The tax rate's is default.
* is_combinable:
* 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.
*
*/
@@ -0,0 +1,20 @@
/**
* @schema AdminCreateTaxRateRule
* type: object
* description: SUMMARY
* x-schemaName: AdminCreateTaxRateRule
* required:
* - reference
* - reference_id
* properties:
* reference:
* type: string
* title: reference
* description: The tax rate's reference.
* reference_id:
* type: string
* title: reference_id
* description: The tax rate's reference id.
*
*/
@@ -0,0 +1,56 @@
/**
* @schema AdminCreateTaxRegion
* type: object
* description: SUMMARY
* x-schemaName: AdminCreateTaxRegion
* required:
* - country_code
* - province_code
* - parent_id
* - metadata
* properties:
* country_code:
* type: string
* title: country_code
* description: The tax region's country code.
* province_code:
* type: string
* title: province_code
* description: The tax region's province code.
* parent_id:
* type: string
* title: parent_id
* description: The tax region's parent id.
* default_tax_rate:
* type: object
* description: The tax region's default tax rate.
* required:
* - name
* - metadata
* properties:
* rate:
* type: number
* title: rate
* description: The default tax rate's rate.
* code:
* type: string
* title: code
* description: The default tax rate's code.
* name:
* type: string
* title: name
* description: The default tax rate's name.
* is_combinable:
* type: string
* enum:
* - "true"
* - "false"
* metadata:
* type: object
* description: The default tax rate's metadata.
* metadata:
* type: object
* description: The tax region's metadata.
*
*/
@@ -0,0 +1,20 @@
/**
* @schema AdminCreateVariantInventoryItem
* type: object
* description: SUMMARY
* x-schemaName: AdminCreateVariantInventoryItem
* required:
* - required_quantity
* - inventory_item_id
* properties:
* required_quantity:
* type: number
* title: required_quantity
* description: The product's required quantity.
* inventory_item_id:
* type: string
* title: inventory_item_id
* description: The product's inventory item id.
*
*/
@@ -0,0 +1,27 @@
/**
* @schema AdminCreateWorkflowsAsyncResponse
* type: object
* description: SUMMARY
* x-schemaName: AdminCreateWorkflowsAsyncResponse
* required:
* - transaction_id
* - step_id
* properties:
* transaction_id:
* type: string
* title: transaction_id
* description: The workflows execution's transaction id.
* step_id:
* type: string
* title: step_id
* description: The workflows execution's step id.
* response: {}
* compensate_input: {}
* action:
* type: string
* enum:
* - invoke
* - compensate
*
*/
@@ -0,0 +1,14 @@
/**
* @schema AdminCreateWorkflowsRun
* type: object
* description: SUMMARY
* x-schemaName: AdminCreateWorkflowsRun
* properties:
* input: {}
* transaction_id:
* type: string
* title: transaction_id
* description: The workflows execution's transaction id.
*
*/
@@ -1,9 +1,10 @@
/**
* @schema CustomerResponse
* @schema AdminCustomer
* type: object
* description: The customer's details.
* x-schemaName: CustomerResponse
* x-schemaName: AdminCustomer
* required:
* - has_account
* - id
* - email
* - default_billing_address_id
@@ -11,9 +12,17 @@
* - company_name
* - first_name
* - last_name
* - has_account
* - addresses
* properties:
* has_account:
* type: boolean
* title: has_account
* description: The customer's has account.
* groups:
* type: array
* description: The customer's groups.
* items:
* $ref: "#/components/schemas/AdminCustomerGroup"
* id:
* type: string
* title: id
@@ -43,59 +52,37 @@
* type: string
* title: last_name
* description: The customer's last name.
* has_account:
* type: boolean
* title: has_account
* description: The customer's has account.
* addresses:
* type: array
* description: The customer's addresses.
* items:
* $ref: "#/components/schemas/CustomerAddressResponse"
* $ref: "#/components/schemas/BaseCustomerAddress"
* phone:
* type: string
* title: phone
* description: The customer's phone.
* groups:
* type: array
* description: The customer's groups.
* items:
* $ref: "#/components/schemas/CustomerGroupResponse"
* metadata:
* type: object
* description: The customer's metadata.
* properties: {}
* created_by:
* type: string
* title: created_by
* description: The customer's created by.
* deleted_at:
* oneOf:
* - type: string
* title: deleted_at
* description: The customer's deleted at.
* - type: string
* title: deleted_at
* description: The customer's deleted at.
* format: date-time
* type: string
* format: date-time
* title: deleted_at
* description: The customer's deleted at.
* created_at:
* oneOf:
* - type: string
* title: created_at
* description: The customer's created at.
* - type: string
* title: created_at
* description: The customer's created at.
* format: date-time
* type: string
* format: date-time
* title: created_at
* description: The customer's created at.
* updated_at:
* oneOf:
* - type: string
* title: updated_at
* description: The customer's updated at.
* - type: string
* title: updated_at
* description: The customer's updated at.
* format: date-time
* type: string
* format: date-time
* title: updated_at
* description: The customer's updated at.
*
*/
@@ -1,8 +1,8 @@
/**
* @schema CustomerGroupResponse
* @schema AdminCustomerGroup
* type: object
* description: The group's groups.
* x-schemaName: CustomerGroupResponse
* x-schemaName: AdminCustomerGroup
* required:
* - id
* - name
@@ -23,17 +23,18 @@
* type: array
* description: The group's customers.
* items:
* $ref: "#/components/schemas/CustomerResponse"
* $ref: "#/components/schemas/BaseCustomer"
* metadata:
* type: object
* description: The group's metadata.
* properties: {}
* 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.
*
@@ -1,31 +0,0 @@
/**
* @schema AdminCustomerListResponse
* type: object
* description: SUMMARY
* x-schemaName: AdminCustomerListResponse
* required:
* - customers
* - limit
* - offset
* - count
* properties:
* customers:
* type: array
* description: The customer's customers.
* items:
* $ref: "#/components/schemas/CustomerResponse"
* limit:
* type: number
* title: limit
* description: The customer's limit.
* offset:
* type: number
* title: offset
* description: The customer's offset.
* count:
* type: number
* title: count
* description: The customer's count.
*
*/
@@ -1,13 +0,0 @@
/**
* @schema AdminCustomerResponse
* type: object
* description: SUMMARY
* x-schemaName: AdminCustomerResponse
* required:
* - customer
* properties:
* customer:
* $ref: "#/components/schemas/CustomerResponse"
*
*/
@@ -0,0 +1,8 @@
/**
* @schema AdminFulfillmentProvider
* type: object
* description: The shipping option's provider.
* x-schemaName: AdminFulfillmentProvider
*
*/
@@ -1,43 +0,0 @@
/**
* @schema AdminFulfillmentProviderResponse
* type: object
* description: The shipping option's provider.
* x-schemaName: AdminFulfillmentProviderResponse
* required:
* - id
* - name
* - metadata
* - created_at
* - updated_at
* - deleted_at
* properties:
* id:
* type: string
* title: id
* description: The provider's ID.
* name:
* type: string
* title: name
* description: The provider's name.
* metadata:
* type: object
* description: The provider's metadata.
* properties: {}
* created_at:
* type: string
* title: created_at
* description: The provider's created at.
* format: date-time
* updated_at:
* type: string
* title: updated_at
* description: The provider's updated at.
* format: date-time
* deleted_at:
* type: string
* title: deleted_at
* description: The provider's deleted at.
* format: date-time
*
*/
@@ -1,13 +1,12 @@
/**
* @schema FulfillmentSetResponse
* @schema AdminFulfillmentSet
* type: object
* description: The fulfillment set's parent.
* x-schemaName: FulfillmentSetResponse
* description: The fulfillment set's details.
* x-schemaName: AdminFulfillmentSet
* required:
* - id
* - name
* - type
* - metadata
* - service_zones
* - created_at
* - updated_at
@@ -16,39 +15,35 @@
* id:
* type: string
* title: id
* description: The parent's ID.
* description: The fulfillment set's ID.
* name:
* type: string
* title: name
* description: The parent's name.
* description: The fulfillment set's name.
* type:
* type: string
* title: type
* description: The parent's type.
* metadata:
* type: object
* description: The parent's metadata.
* properties: {}
* description: The fulfillment set's type.
* service_zones:
* type: array
* description: The parent's service zones.
* description: The fulfillment set's service zones.
* items:
* $ref: "#/components/schemas/ServiceZoneResponse"
* $ref: "#/components/schemas/AdminServiceZone"
* created_at:
* type: string
* title: created_at
* description: The parent's created at.
* format: date-time
* title: created_at
* description: The fulfillment set's created at.
* updated_at:
* type: string
* title: updated_at
* description: The parent's updated at.
* format: date-time
* title: updated_at
* description: The fulfillment set's updated at.
* deleted_at:
* type: string
* title: deleted_at
* description: The parent's deleted at.
* format: date-time
* title: deleted_at
* description: The fulfillment set's deleted at.
*
*/
@@ -1,13 +1,12 @@
/**
* @schema AdminServiceZoneDeleteResponse
* @schema AdminFulfillmentSetDeleteResponse
* type: object
* description: SUMMARY
* x-schemaName: AdminServiceZoneDeleteResponse
* x-schemaName: AdminFulfillmentSetDeleteResponse
* required:
* - id
* - object
* - deleted
* - parent
* properties:
* id:
* type: string
@@ -17,12 +16,14 @@
* type: string
* title: object
* description: The fulfillment set's object.
* default: fulfillment_set
* deleted:
* type: boolean
* title: deleted
* description: The fulfillment set's deleted.
* parent:
* $ref: "#/components/schemas/FulfillmentSetResponse"
* type: object
* description: The fulfillment set's parent.
*
*/
@@ -7,7 +7,7 @@
* - fulfillment_set
* properties:
* fulfillment_set:
* $ref: "#/components/schemas/FulfillmentSetResponse"
* $ref: "#/components/schemas/AdminFulfillmentSet"
*
*/
@@ -1,25 +0,0 @@
/**
* @schema AdminFulfillmentSetsDeleteResponse
* type: object
* description: SUMMARY
* x-schemaName: AdminFulfillmentSetsDeleteResponse
* required:
* - id
* - object
* - deleted
* properties:
* id:
* type: string
* title: id
* description: The fulfillment set's ID.
* object:
* type: string
* title: object
* description: The fulfillment set's object.
* deleted:
* type: boolean
* title: deleted
* description: The fulfillment set's deleted.
*
*/
@@ -0,0 +1,8 @@
/**
* @schema AdminGeoZone
* type: object
* description: The geo zone's geo zones.
* x-schemaName: AdminGeoZone
*
*/
@@ -1,9 +0,0 @@
/**
* @schema AdminGeoZoneResponse
* type: object
* description: The geo zone's geo zones.
* x-schemaName: AdminGeoZoneResponse
* properties: {}
*
*/
@@ -0,0 +1,13 @@
/**
* @schema AdminGetUploadParams
* type: object
* description: SUMMARY
* x-schemaName: AdminGetUploadParams
* properties:
* fields:
* type: string
* title: fields
* description: The upload's fields.
*
*/
@@ -0,0 +1,13 @@
/**
* @schema AdminOrderCancelFulfillment
* type: object
* description: SUMMARY
* x-schemaName: AdminOrderCancelFulfillment
* properties:
* no_notification:
* type: boolean
* title: no_notification
* description: The order's no notification.
*
*/
@@ -0,0 +1,42 @@
/**
* @schema AdminOrderCreateFulfillment
* type: object
* description: SUMMARY
* x-schemaName: AdminOrderCreateFulfillment
* required:
* - items
* - location_id
* - metadata
* properties:
* items:
* type: array
* description: The order's items.
* items:
* 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.
* location_id:
* type: string
* title: location_id
* description: The order's location id.
* no_notification:
* type: boolean
* title: no_notification
* description: The order's no notification.
* metadata:
* type: object
* description: The order's metadata.
*
*/
@@ -0,0 +1,60 @@
/**
* @schema AdminOrderCreateShipment
* type: object
* description: SUMMARY
* x-schemaName: AdminOrderCreateShipment
* required:
* - items
* - metadata
* properties:
* items:
* type: array
* description: The order's items.
* items:
* 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.
* labels:
* type: array
* description: The order's labels.
* items:
* type: object
* description: The label's labels.
* required:
* - tracking_number
* - tracking_url
* - label_url
* properties:
* tracking_number:
* type: string
* title: tracking_number
* description: The label's tracking number.
* tracking_url:
* type: string
* title: tracking_url
* description: The label's tracking url.
* label_url:
* type: string
* title: label_url
* description: The label's label url.
* no_notification:
* type: boolean
* title: no_notification
* description: The order's no notification.
* metadata:
* type: object
* description: The order's metadata.
*
*/
@@ -0,0 +1,49 @@
/**
* @schema AdminPostReceiveReturnsReqSchema
* type: object
* description: SUMMARY
* x-schemaName: AdminPostReceiveReturnsReqSchema
* required:
* - return_id
* - items
* - internal_note
* properties:
* return_id:
* type: string
* title: return_id
* description: The return's return 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.
* internal_note:
* type: string
* title: internal_note
* description: The return's internal note.
*
*/
@@ -0,0 +1,77 @@
/**
* @schema AdminPostReturnsReqSchema
* type: object
* description: SUMMARY
* x-schemaName: AdminPostReturnsReqSchema
* required:
* - order_id
* - items
* - return_shipping
* - internal_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.
* internal_note:
* type: string
* title: internal_note
* description: The return's internal note.
* receive_now:
* type: boolean
* title: receive_now
* description: The return's receive now.
* refund_amount:
* type: number
* title: refund_amount
* description: The return's refund amount.
* location_id:
* type: string
* title: location_id
* description: The return's location id.
*
*/
@@ -0,0 +1,67 @@
/**
* @schema AdminPrice
* type: object
* description: The price's prices.
* x-schemaName: AdminPrice
* required:
* - id
* - title
* - currency_code
* - amount
* - raw_amount
* - min_quantity
* - max_quantity
* - price_set_id
* - created_at
* - updated_at
* - deleted_at
* properties:
* id:
* type: string
* title: id
* description: The price's ID.
* title:
* type: string
* title: title
* description: The price's title.
* currency_code:
* type: string
* title: currency_code
* description: The price's currency code.
* amount:
* type: number
* title: amount
* description: The price's amount.
* raw_amount:
* type: object
* description: The price's raw amount.
* min_quantity:
* type: number
* title: min_quantity
* description: The price's min quantity.
* max_quantity:
* type: number
* title: max_quantity
* description: The price's max quantity.
* price_set_id:
* type: string
* title: price_set_id
* description: The price's price set id.
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The price's created at.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The price's updated at.
* deleted_at:
* type: string
* format: date-time
* title: deleted_at
* description: The price's deleted at.
*
*/
@@ -1,35 +0,0 @@
/**
* @schema AdminPriceSetPriceResponse
* type: object
* description: The price's prices.
* x-schemaName: AdminPriceSetPriceResponse
* required:
* - id
* - amount
* - currency_code
* - created_at
* - updated_at
* properties:
* id:
* type: string
* title: id
* description: The price's ID.
* amount:
* type: number
* title: amount
* description: The price's amount.
* currency_code:
* type: string
* title: currency_code
* description: The price's currency code.
* created_at:
* type: string
* title: created_at
* description: The price's created at.
* updated_at:
* type: string
* title: updated_at
* description: The price's updated at.
*
*/
@@ -0,0 +1,172 @@
/**
* @schema AdminProduct
* type: object
* description: The product's parent.
* x-schemaName: AdminProduct
* required:
* - type
* - title
* - status
* - length
* - options
* - description
* - id
* - handle
* - hs_code
* - weight
* - height
* - width
* - origin_country
* - mid_code
* - material
* - thumbnail
* - created_at
* - updated_at
* - deleted_at
* - subtitle
* - is_giftcard
* - collection_id
* - type_id
* - tags
* - images
* - discountable
* - external_id
* properties:
* collection:
* $ref: "#/components/schemas/AdminCollection"
* categories:
* type: array
* description: The parent's categories.
* items:
* $ref: "#/components/schemas/AdminProductCategory"
* sales_channels:
* type: array
* description: The parent's sales channels.
* items:
* $ref: "#/components/schemas/AdminSalesChannel"
* variants:
* type: array
* description: The parent's variants.
* items:
* $ref: "#/components/schemas/AdminProductVariant"
* type:
* $ref: "#/components/schemas/AdminProduct"
* title:
* type: string
* title: title
* description: The parent's title.
* status:
* type: string
* enum:
* - draft
* - proposed
* - published
* - rejected
* length:
* type: number
* title: length
* description: The parent's length.
* options:
* type: array
* description: The parent's options.
* items:
* $ref: "#/components/schemas/BaseProductOption"
* description:
* type: string
* title: description
* description: The parent's description.
* id:
* type: string
* title: id
* description: The parent's ID.
* handle:
* type: string
* title: handle
* description: The parent's handle.
* metadata:
* type: object
* description: The parent's metadata.
* hs_code:
* type: string
* title: hs_code
* description: The parent's hs code.
* weight:
* type: number
* title: weight
* description: The parent's weight.
* height:
* type: number
* title: height
* description: The parent's height.
* width:
* type: number
* title: width
* description: The parent's width.
* origin_country:
* type: string
* title: origin_country
* description: The parent's origin country.
* mid_code:
* type: string
* title: mid_code
* description: The parent's mid code.
* material:
* type: string
* title: material
* description: The parent's material.
* thumbnail:
* type: string
* title: thumbnail
* description: The parent's thumbnail.
* 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.
* subtitle:
* type: string
* title: subtitle
* description: The parent's subtitle.
* is_giftcard:
* type: boolean
* title: is_giftcard
* description: The parent's is giftcard.
* collection_id:
* type: string
* title: collection_id
* description: The parent's collection id.
* type_id:
* type: string
* title: type_id
* description: The parent's type id.
* tags:
* type: array
* description: The parent's tags.
* items:
* $ref: "#/components/schemas/BaseProductTag"
* images:
* type: array
* description: The parent's images.
* items:
* $ref: "#/components/schemas/BaseProductImage"
* discountable:
* type: boolean
* title: discountable
* description: The parent's discountable.
* external_id:
* type: string
* title: external_id
* description: The parent's external id.
*
*/
@@ -0,0 +1,82 @@
/**
* @schema AdminProductCategory
* type: object
* description: The category's categories.
* x-schemaName: AdminProductCategory
* required:
* - category_children
* - parent_category
* - name
* - description
* - id
* - handle
* - created_at
* - updated_at
* - deleted_at
* - parent_category_id
* - is_internal
* - is_active
* - rank
* properties:
* category_children:
* type: array
* description: The category's category children.
* items:
* $ref: "#/components/schemas/AdminProductCategory"
* parent_category:
* $ref: "#/components/schemas/AdminProductCategory"
* products:
* type: array
* description: The category's products.
* items:
* $ref: "#/components/schemas/AdminProduct"
* name:
* type: string
* title: name
* description: The category's name.
* description:
* type: string
* title: description
* description: The category's description.
* id:
* type: string
* title: id
* description: The category's ID.
* handle:
* type: string
* title: handle
* description: The category's handle.
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The category's created at.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The category's updated at.
* deleted_at:
* type: string
* format: date-time
* title: deleted_at
* description: The category's deleted at.
* parent_category_id:
* type: string
* title: parent_category_id
* description: The category's parent category id.
* is_internal:
* type: boolean
* title: is_internal
* description: The category's is internal.
* is_active:
* type: boolean
* title: is_active
* description: The category's is active.
* rank:
* type: number
* title: rank
* description: The category's rank.
*
*/
@@ -4,16 +4,11 @@
* description: SUMMARY
* x-schemaName: AdminProductCategoryListResponse
* required:
* - product_categories
* - limit
* - offset
* - count
* - product_categories
* properties:
* product_categories:
* type: array
* description: The product category's product categories.
* items:
* $ref: "#/components/schemas/ProductCategoryResponse"
* limit:
* type: number
* title: limit
@@ -26,6 +21,11 @@
* type: number
* title: count
* description: The product category's count.
* product_categories:
* type: array
* description: The product category's product categories.
* items:
* $ref: "#/components/schemas/AdminProductCategory"
*
*/
@@ -7,7 +7,7 @@
* - product_category
* properties:
* product_category:
* $ref: "#/components/schemas/ProductCategoryResponse"
* $ref: "#/components/schemas/AdminProductCategory"
*
*/
@@ -0,0 +1,29 @@
/**
* @schema AdminProductDeleteResponse
* type: object
* description: SUMMARY
* x-schemaName: AdminProductDeleteResponse
* required:
* - id
* - object
* - deleted
* properties:
* id:
* type: string
* title: id
* description: The product's ID.
* object:
* type: string
* title: object
* description: The product's object.
* default: product
* deleted:
* type: boolean
* title: deleted
* description: The product's deleted.
* parent:
* type: object
* description: The product's parent.
*
*/
@@ -0,0 +1,49 @@
/**
* @schema AdminProductOption
* type: object
* description: The product's product option.
* x-schemaName: AdminProductOption
* required:
* - id
* - title
* properties:
* id:
* type: string
* title: id
* description: The product option's ID.
* title:
* type: string
* title: title
* description: The product option's title.
* product:
* $ref: "#/components/schemas/BaseProduct"
* product_id:
* type: string
* title: product_id
* description: The product option's product id.
* values:
* type: array
* description: The product option's values.
* items:
* $ref: "#/components/schemas/BaseProductOptionValue"
* metadata:
* type: object
* description: The product option's metadata.
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The product option's created at.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The product option's updated at.
* deleted_at:
* type: string
* format: date-time
* title: deleted_at
* description: The product option's deleted at.
*
*/
@@ -0,0 +1,28 @@
/**
* @schema AdminProductOptionDeleteResponse
* type: object
* description: SUMMARY
* x-schemaName: AdminProductOptionDeleteResponse
* required:
* - id
* - object
* - deleted
* properties:
* id:
* type: string
* title: id
* description: The product's ID.
* object:
* type: string
* title: object
* description: The product's object.
* default: product_option
* deleted:
* type: boolean
* title: deleted
* description: The product's deleted.
* parent:
* $ref: "#/components/schemas/AdminProduct"
*
*/
@@ -0,0 +1,13 @@
/**
* @schema AdminProductOptionResponse
* type: object
* description: SUMMARY
* x-schemaName: AdminProductOptionResponse
* required:
* - product_option
* properties:
* product_option:
* $ref: "#/components/schemas/AdminProductOption"
*
*/
@@ -0,0 +1,13 @@
/**
* @schema AdminProductResponse
* type: object
* description: SUMMARY
* x-schemaName: AdminProductResponse
* required:
* - product
* properties:
* product:
* $ref: "#/components/schemas/AdminProduct"
*
*/
@@ -0,0 +1,133 @@
/**
* @schema AdminProductVariant
* type: object
* description: The updated's details.
* x-schemaName: AdminProductVariant
* required:
* - prices
* - id
* - title
* - sku
* - barcode
* - ean
* - upc
* - allow_backorder
* - manage_inventory
* - hs_code
* - origin_country
* - mid_code
* - material
* - weight
* - length
* - height
* - width
* - options
* - created_at
* - updated_at
* - deleted_at
* properties:
* prices:
* type: array
* description: The updated's prices.
* items:
* $ref: "#/components/schemas/AdminPrice"
* id:
* type: string
* title: id
* description: The updated's ID.
* title:
* type: string
* title: title
* description: The updated's title.
* sku:
* type: string
* title: sku
* description: The updated's sku.
* barcode:
* type: string
* title: barcode
* description: The updated's barcode.
* ean:
* type: string
* title: ean
* description: The updated's ean.
* upc:
* type: string
* title: upc
* description: The updated's upc.
* allow_backorder:
* type: boolean
* title: allow_backorder
* description: The updated's allow backorder.
* manage_inventory:
* type: boolean
* title: manage_inventory
* description: The updated's manage inventory.
* hs_code:
* type: string
* title: hs_code
* description: The updated's hs code.
* origin_country:
* type: string
* title: origin_country
* description: The updated's origin country.
* mid_code:
* type: string
* title: mid_code
* description: The updated's mid code.
* material:
* type: string
* title: material
* description: The updated's material.
* weight:
* type: number
* title: weight
* description: The updated's weight.
* length:
* type: number
* title: length
* description: The updated's length.
* height:
* type: number
* title: height
* description: The updated's height.
* width:
* type: number
* title: width
* description: The updated's width.
* options:
* type: array
* description: The updated's options.
* items:
* $ref: "#/components/schemas/BaseProductOptionValue"
* product:
* $ref: "#/components/schemas/BaseProduct"
* product_id:
* type: string
* title: product_id
* description: The updated's product id.
* variant_rank:
* type: number
* title: variant_rank
* description: The updated's variant rank.
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The updated's created at.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The updated's updated at.
* deleted_at:
* type: string
* format: date-time
* title: deleted_at
* description: The updated's deleted at.
* metadata:
* type: object
* description: The updated's metadata.
*
*/
@@ -0,0 +1,28 @@
/**
* @schema AdminProductVariantDeleteResponse
* type: object
* description: SUMMARY
* x-schemaName: AdminProductVariantDeleteResponse
* required:
* - id
* - object
* - deleted
* properties:
* id:
* type: string
* title: id
* description: The product's ID.
* object:
* type: string
* title: object
* description: The product's object.
* default: variant
* deleted:
* type: boolean
* title: deleted
* description: The product's deleted.
* parent:
* $ref: "#/components/schemas/AdminProduct"
*
*/
@@ -0,0 +1,281 @@
/**
* @schema AdminProductVariantParams
* type: object
* description: The product's variants.
* x-schemaName: AdminProductVariantParams
* 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: The variant's $and.
* items:
* oneOf:
* - type: object
* description: The $and's details.
* x-schemaName: BaseProductVariantParams
* properties:
* q:
* type: string
* title: q
* description: The $and's q.
* id:
* oneOf:
* - type: string
* title: id
* description: The $and's ID.
* - type: array
* description: The $and's ID.
* items:
* type: string
* title: id
* description: The id's ID.
* sku:
* oneOf:
* - type: string
* title: sku
* description: The $and's sku.
* - type: array
* description: The $and's sku.
* items:
* type: string
* title: sku
* description: The sku's details.
* product_id:
* oneOf:
* - type: string
* title: product_id
* description: The $and's product id.
* - type: array
* description: The $and's product id.
* items:
* type: string
* title: product_id
* description: The product id's details.
* options:
* type: object
* description: The $and's options.
* limit:
* type: number
* title: limit
* description: The $and's limit.
* offset:
* type: number
* title: offset
* description: The $and's offset.
* order:
* type: string
* title: order
* description: The $and's order.
* fields:
* type: string
* title: fields
* description: The $and's fields.
* $and:
* type: array
* description: The $and's details.
* items:
* oneOf:
* - type: object
* description: The $and's details.
* x-schemaName: BaseProductVariantParams
* - type: object
* description: The $and's details.
* $or:
* type: array
* description: The $and's $or.
* items:
* oneOf:
* - type: object
* description: The $or's details.
* x-schemaName: BaseProductVariantParams
* - type: object
* description: The $or's details.
* - type: object
* description: The $and's details.
* properties:
* $and:
* type: array
* description: The $and's details.
* items:
* oneOf:
* - type: object
* description: The $and's details.
* x-schemaName: BaseProductVariantParams
* - type: object
* description: The $and's details.
* $or:
* type: array
* description: The $and's $or.
* items:
* oneOf:
* - type: object
* description: The $or's details.
* x-schemaName: BaseProductVariantParams
* - type: object
* description: The $or's details.
* $or:
* type: array
* description: The variant's $or.
* items:
* oneOf:
* - type: object
* description: The $or's details.
* x-schemaName: BaseProductVariantParams
* properties:
* q:
* type: string
* title: q
* description: The $or's q.
* id:
* oneOf:
* - type: string
* title: id
* description: The $or's ID.
* - type: array
* description: The $or's ID.
* items:
* type: string
* title: id
* description: The id's ID.
* sku:
* oneOf:
* - type: string
* title: sku
* description: The $or's sku.
* - type: array
* description: The $or's sku.
* items:
* type: string
* title: sku
* description: The sku's details.
* product_id:
* oneOf:
* - type: string
* title: product_id
* description: The $or's product id.
* - type: array
* description: The $or's product id.
* items:
* type: string
* title: product_id
* description: The product id's details.
* options:
* type: object
* description: The $or's options.
* limit:
* type: number
* title: limit
* description: The $or's limit.
* offset:
* type: number
* title: offset
* description: The $or's offset.
* order:
* type: string
* title: order
* description: The $or's order.
* fields:
* type: string
* title: fields
* description: The $or's fields.
* $and:
* type: array
* description: The $or's $and.
* items:
* oneOf:
* - type: object
* description: The $and's details.
* x-schemaName: BaseProductVariantParams
* - type: object
* description: The $and's details.
* $or:
* type: array
* description: The $or's details.
* items:
* oneOf:
* - type: object
* description: The $or's details.
* x-schemaName: BaseProductVariantParams
* - type: object
* description: The $or's details.
* - type: object
* description: The $or's details.
* properties:
* $and:
* type: array
* description: The $or's $and.
* items:
* oneOf:
* - type: object
* description: The $and's details.
* x-schemaName: BaseProductVariantParams
* - type: object
* description: The $and's details.
* $or:
* type: array
* description: The $or's details.
* items:
* oneOf:
* - type: object
* description: The $or's details.
* x-schemaName: BaseProductVariantParams
* - type: object
* description: The $or's details.
*
*/
@@ -0,0 +1,13 @@
/**
* @schema AdminProductVariantResponse
* type: object
* description: SUMMARY
* x-schemaName: AdminProductVariantResponse
* required:
* - variant
* properties:
* variant:
* $ref: "#/components/schemas/AdminProductVariant"
*
*/
@@ -0,0 +1,13 @@
/**
* @schema AdminRevokeApiKey
* type: object
* description: SUMMARY
* x-schemaName: AdminRevokeApiKey
* properties:
* revoke_in:
* type: number
* title: revoke_in
* description: The api key's revoke in.
*
*/
@@ -0,0 +1,52 @@
/**
* @schema AdminSalesChannel
* type: object
* description: The sales channel's sales channels.
* x-schemaName: AdminSalesChannel
* required:
* - id
* - name
* - description
* - is_disabled
* - metadata
* - created_at
* - updated_at
* - deleted_at
* properties:
* id:
* type: string
* title: id
* description: The sales channel's ID.
* name:
* type: string
* title: name
* description: The sales channel's name.
* description:
* type: string
* title: description
* description: The sales channel's description.
* is_disabled:
* type: boolean
* title: is_disabled
* description: The sales channel's is disabled.
* metadata:
* type: object
* description: The sales channel's metadata.
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The sales channel's created at.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The sales channel's updated at.
* deleted_at:
* type: string
* format: date-time
* title: deleted_at
* description: The sales channel's deleted at.
*
*/
@@ -1,13 +1,14 @@
/**
* @schema ServiceZoneResponse
* @schema AdminServiceZone
* type: object
* description: The service zone's service zones.
* x-schemaName: ServiceZoneResponse
* x-schemaName: AdminServiceZone
* required:
* - id
* - name
* - metadata
* - fulfillment_set_id
* - geo_zones
* - shipping_options
* - created_at
* - updated_at
* - deleted_at
@@ -20,30 +21,35 @@
* type: string
* title: name
* description: The service zone's name.
* metadata:
* type: object
* description: The service zone's metadata.
* properties: {}
* fulfillment_set_id:
* type: string
* title: fulfillment_set_id
* description: The service zone's fulfillment set id.
* geo_zones:
* type: array
* description: The service zone's geo zones.
* items:
* $ref: "#/components/schemas/AdminGeoZoneResponse"
* $ref: "#/components/schemas/AdminGeoZone"
* shipping_options:
* type: array
* description: The service zone's shipping options.
* items:
* $ref: "#/components/schemas/AdminShippingOption"
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The service zone's created at.
* format: date-time
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The service zone's updated at.
* format: date-time
* deleted_at:
* type: string
* format: date-time
* title: deleted_at
* description: The service zone's deleted at.
* format: date-time
*
*/
@@ -7,7 +7,7 @@
* - service_zone
* properties:
* service_zone:
* $ref: "#/components/schemas/ServiceZoneResponse"
* $ref: "#/components/schemas/AdminServiceZone"
*
*/
@@ -0,0 +1,8 @@
/**
* @schema AdminShippingOption
* type: object
* description: The shipping option's shipping options.
* x-schemaName: AdminShippingOption
*
*/
@@ -16,10 +16,14 @@
* type: string
* title: object
* description: The shipping option's object.
* default: shipping_option
* deleted:
* type: boolean
* title: deleted
* description: The shipping option's deleted.
* parent:
* type: object
* description: The shipping option's parent.
*
*/
@@ -1,31 +0,0 @@
/**
* @schema AdminShippingOptionListResponse
* type: object
* description: SUMMARY
* x-schemaName: AdminShippingOptionListResponse
* required:
* - shipping_options
* - limit
* - offset
* - count
* properties:
* shipping_options:
* type: array
* description: The shipping option's shipping options.
* items:
* $ref: "#/components/schemas/AdminShippingOptionResponse"
* limit:
* type: number
* title: limit
* description: The shipping option's limit.
* offset:
* type: number
* title: offset
* description: The shipping option's offset.
* count:
* type: number
* title: count
* description: The shipping option's count.
*
*/
@@ -1,98 +1,13 @@
/**
* @schema AdminShippingOptionResponse
* type: object
* description: The shipping option's details.
* description: SUMMARY
* x-schemaName: AdminShippingOptionResponse
* required:
* - id
* - name
* - price_type
* - service_zone_id
* - shipping_profile_id
* - provider_id
* - shipping_option_type_id
* - data
* - metadata
* - service_zone
* - shipping_profile
* - provider
* - type
* - rules
* - prices
* - created_at
* - updated_at
* - deleted_at
* - shipping_option
* properties:
* id:
* type: string
* title: id
* description: The shipping option's ID.
* name:
* type: string
* title: name
* description: The shipping option's name.
* price_type:
* type: string
* enum:
* - flat
* - calculated
* 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.
* provider_id:
* type: string
* title: provider_id
* description: The shipping option's provider id.
* shipping_option_type_id:
* type: string
* title: shipping_option_type_id
* description: The shipping option's shipping option type id.
* data:
* type: object
* description: The shipping option's data.
* properties: {}
* metadata:
* type: object
* description: The shipping option's metadata.
* properties: {}
* service_zone:
* $ref: "#/components/schemas/AdminServiceZoneResponse"
* shipping_profile:
* $ref: "#/components/schemas/AdminShippingProfileResponse"
* provider:
* $ref: "#/components/schemas/AdminFulfillmentProviderResponse"
* type:
* $ref: "#/components/schemas/AdminShippingOptionTypeResponse"
* rules:
* type: array
* description: The shipping option's rules.
* items:
* $ref: "#/components/schemas/AdminShippingOptionRuleResponse"
* prices:
* type: array
* description: The shipping option's prices.
* items:
* $ref: "#/components/schemas/AdminPriceSetPriceResponse"
* created_at:
* type: string
* title: created_at
* description: The shipping option's created at.
* format: date-time
* updated_at:
* type: string
* title: updated_at
* description: The shipping option's updated at.
* format: date-time
* deleted_at:
* type: string
* title: deleted_at
* description: The shipping option's deleted at.
* format: date-time
* shipping_option:
* $ref: "#/components/schemas/AdminShippingOption"
*
*/
@@ -1,13 +0,0 @@
/**
* @schema AdminShippingOptionRetrieveResponse
* type: object
* description: SUMMARY
* x-schemaName: AdminShippingOptionRetrieveResponse
* required:
* - shipping_option
* properties:
* shipping_option:
* $ref: "#/components/schemas/AdminShippingOptionResponse"
*
*/
@@ -1,53 +0,0 @@
/**
* @schema AdminShippingOptionRuleResponse
* type: object
* description: The rule's rules.
* x-schemaName: AdminShippingOptionRuleResponse
* required:
* - id
* - attribute
* - operator
* - value
* - shipping_option_id
* - created_at
* - updated_at
* - deleted_at
* properties:
* id:
* type: string
* title: id
* description: The rule's ID.
* attribute:
* type: string
* title: attribute
* description: The rule's attribute.
* operator:
* type: string
* title: operator
* description: The rule's operator.
* value:
* type: object
* description: The rule's value.
* properties: {}
* shipping_option_id:
* type: string
* title: shipping_option_id
* description: The rule's shipping option id.
* created_at:
* type: string
* title: created_at
* description: The rule's created at.
* format: date-time
* updated_at:
* type: string
* title: updated_at
* description: The rule's updated at.
* format: date-time
* deleted_at:
* type: string
* title: deleted_at
* description: The rule's deleted at.
* format: date-time
*
*/
@@ -1,53 +0,0 @@
/**
* @schema AdminShippingOptionTypeResponse
* type: object
* description: The shipping option's type.
* x-schemaName: AdminShippingOptionTypeResponse
* required:
* - id
* - label
* - description
* - code
* - shipping_option_id
* - created_at
* - updated_at
* - deleted_at
* properties:
* id:
* type: string
* title: id
* description: The type's ID.
* label:
* type: string
* title: label
* description: The type's label.
* description:
* type: string
* title: description
* description: The type's description.
* code:
* type: string
* title: code
* description: The type's code.
* shipping_option_id:
* type: string
* title: shipping_option_id
* description: The type's shipping option id.
* created_at:
* type: string
* title: created_at
* description: The type's created at.
* format: date-time
* updated_at:
* type: string
* title: updated_at
* description: The type's updated at.
* format: date-time
* deleted_at:
* type: string
* title: deleted_at
* description: The type's deleted at.
* format: date-time
*
*/
@@ -0,0 +1,8 @@
/**
* @schema AdminShippingProfile
* type: object
* description: The shipping option's shipping profile.
* x-schemaName: AdminShippingProfile
*
*/
@@ -16,10 +16,14 @@
* type: string
* title: object
* description: The shipping profile's object.
* default: shipping_profile
* deleted:
* type: boolean
* title: deleted
* description: The shipping profile's deleted.
* parent:
* type: object
* description: The shipping profile's parent.
*
*/
@@ -7,7 +7,7 @@
* - shipping_profile
* properties:
* shipping_profile:
* $ref: "#/components/schemas/ShippingProfileResponse"
* $ref: "#/components/schemas/AdminShippingProfile"
*
*/
@@ -1,31 +0,0 @@
/**
* @schema AdminShippingProfilesResponse
* type: object
* description: SUMMARY
* x-schemaName: AdminShippingProfilesResponse
* required:
* - shipping_profiles
* - limit
* - offset
* - count
* properties:
* shipping_profiles:
* type: array
* description: The shipping profile's shipping profiles.
* items:
* $ref: "#/components/schemas/ShippingProfileResponse"
* limit:
* type: number
* title: limit
* description: The shipping profile's limit.
* offset:
* type: number
* title: offset
* description: The shipping profile's offset.
* count:
* type: number
* title: count
* description: The shipping profile's count.
*
*/
@@ -0,0 +1,15 @@
/**
* @schema AdminUpdateApiKey
* type: object
* description: SUMMARY
* x-schemaName: AdminUpdateApiKey
* required:
* - title
* properties:
* title:
* type: string
* title: title
* description: The api key's title.
*
*/
@@ -1,11 +1,10 @@
/**
* @schema CreateCampaign
* @schema AdminUpdateCampaign
* type: object
* description: The promotion's campaign.
* x-schemaName: CreateCampaign
* description: SUMMARY
* x-schemaName: AdminUpdateCampaign
* required:
* - name
* - campaign_identifier
* - description
* - starts_at
* - ends_at
* properties:
@@ -13,18 +12,22 @@
* 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.
* description:
* type: string
* title: description
* description: The campaign's description.
* budget:
* type: object
* description: The campaign's budget.
* properties:
* limit:
* type: number
* title: limit
* description: The budget's limit.
* starts_at:
* type: string
* title: starts_at
@@ -35,15 +38,12 @@
* title: ends_at
* description: The campaign's ends at.
* format: date-time
* budget:
* $ref: "#/components/schemas/CreateCampaignBudget"
* promotions:
* type: array
* description: The campaign's promotions.
* items:
* type: object
* description: The promotion's promotions.
* x-schemaName: Promotion
* required:
* - id
* properties:
@@ -0,0 +1,22 @@
/**
* @schema AdminUpdateCollection
* type: object
* description: SUMMARY
* x-schemaName: AdminUpdateCollection
* required:
* - metadata
* properties:
* title:
* type: string
* title: title
* description: The collection's title.
* handle:
* type: string
* title: handle
* description: The collection's handle.
* metadata:
* type: object
* description: The collection's metadata.
*
*/
@@ -0,0 +1,40 @@
/**
* @schema AdminUpdateCustomer
* type: object
* description: SUMMARY
* x-schemaName: AdminUpdateCustomer
* required:
* - email
* - company_name
* - first_name
* - last_name
* - phone
* - metadata
* properties:
* email:
* type: string
* title: email
* description: The customer's email.
* format: email
* company_name:
* type: string
* title: company_name
* description: The customer's company name.
* first_name:
* type: string
* title: first_name
* description: The customer's first name.
* last_name:
* type: string
* title: last_name
* description: The customer's last name.
* phone:
* type: string
* title: phone
* description: The customer's phone.
* metadata:
* type: object
* description: The customer's metadata.
*
*/
@@ -0,0 +1,19 @@
/**
* @schema AdminUpdateCustomerGroup
* type: object
* description: SUMMARY
* x-schemaName: AdminUpdateCustomerGroup
* required:
* - name
* - metadata
* properties:
* name:
* type: string
* title: name
* description: The customer group's name.
* metadata:
* type: object
* description: The customer group's metadata.
*
*/
@@ -0,0 +1,42 @@
/**
* @schema AdminUpdatePriceList
* type: object
* description: SUMMARY
* x-schemaName: AdminUpdatePriceList
* required:
* - description
* - starts_at
* - ends_at
* properties:
* title:
* type: string
* title: title
* description: The price list's title.
* description:
* type: string
* title: description
* description: The price list's description.
* starts_at:
* type: string
* title: starts_at
* description: The price list's starts at.
* ends_at:
* type: string
* title: ends_at
* description: The price list's ends at.
* status:
* type: string
* enum:
* - active
* - draft
* type:
* type: string
* enum:
* - sale
* - override
* rules:
* type: object
* description: The price list's rules.
*
*/
@@ -0,0 +1,151 @@
/**
* @schema AdminUpdateProduct
* type: object
* description: The update's details.
* x-schemaName: AdminUpdateProduct
* properties:
* title:
* type: string
* title: title
* description: The update's title.
* subtitle:
* type: string
* title: subtitle
* description: The update's subtitle.
* description:
* type: string
* title: description
* description: The update's description.
* is_giftcard:
* type: boolean
* title: is_giftcard
* description: The update's is giftcard.
* discountable:
* type: boolean
* title: discountable
* description: The update's discountable.
* images:
* type: array
* description: The update's images.
* items:
* type: object
* description: The image's images.
* required:
* - url
* properties:
* url:
* type: string
* title: url
* description: The image's url.
* thumbnail:
* type: string
* title: thumbnail
* description: The update's thumbnail.
* handle:
* type: string
* title: handle
* description: The update's handle.
* status:
* type: string
* enum:
* - draft
* - proposed
* - published
* - rejected
* type_id:
* type: string
* title: type_id
* description: The update's type id.
* collection_id:
* type: string
* title: collection_id
* description: The update's collection id.
* categories:
* type: array
* description: The update's categories.
* items:
* type: object
* description: The category's categories.
* required:
* - id
* properties:
* id:
* type: string
* title: id
* description: The category's ID.
* tags:
* type: array
* description: The update's tags.
* items:
* type: object
* description: The tag's tags.
* properties:
* id:
* type: string
* title: id
* description: The tag's ID.
* value:
* type: string
* title: value
* description: The tag's value.
* options:
* type: array
* description: The update's options.
* items:
* $ref: "#/components/schemas/AdminUpdateProductOption"
* variants:
* type: array
* description: The update's variants.
* items:
* $ref: "#/components/schemas/AdminCreateProductVariant"
* sales_channels:
* type: array
* description: The update's sales channels.
* items:
* type: object
* description: The sales channel's sales channels.
* required:
* - id
* properties:
* id:
* type: string
* title: id
* description: The sales channel's ID.
* weight:
* type: number
* title: weight
* description: The update's weight.
* length:
* type: number
* title: length
* description: The update's length.
* height:
* type: number
* title: height
* description: The update's height.
* width:
* type: number
* title: width
* description: The update's width.
* hs_code:
* type: string
* title: hs_code
* description: The update's hs code.
* mid_code:
* type: string
* title: mid_code
* description: The update's mid code.
* origin_country:
* type: string
* title: origin_country
* description: The update's origin country.
* material:
* type: string
* title: material
* description: The update's material.
* metadata:
* type: object
* description: The update's metadata.
*
*/
@@ -0,0 +1,20 @@
/**
* @schema AdminUpdateProductOption
* type: object
* description: SUMMARY
* x-schemaName: AdminUpdateProductOption
* properties:
* title:
* type: string
* title: title
* description: The product's title.
* values:
* type: array
* description: The product's values.
* items:
* type: string
* title: values
* description: The value's values.
*
*/
@@ -0,0 +1,84 @@
/**
* @schema AdminUpdateProductVariant
* type: object
* description: The update's details.
* x-schemaName: AdminUpdateProductVariant
* properties:
* title:
* type: string
* title: title
* description: The update's title.
* sku:
* type: string
* title: sku
* description: The update's sku.
* ean:
* type: string
* title: ean
* description: The update's ean.
* upc:
* type: string
* title: upc
* description: The update's upc.
* barcode:
* type: string
* title: barcode
* description: The update's barcode.
* hs_code:
* type: string
* title: hs_code
* description: The update's hs code.
* mid_code:
* type: string
* title: mid_code
* description: The update's mid code.
* allow_backorder:
* type: boolean
* title: allow_backorder
* description: The update's allow backorder.
* manage_inventory:
* type: boolean
* title: manage_inventory
* description: The update's manage inventory.
* variant_rank:
* type: number
* title: variant_rank
* description: The update's variant rank.
* weight:
* type: number
* title: weight
* description: The update's weight.
* length:
* type: number
* title: length
* description: The update's length.
* height:
* type: number
* title: height
* description: The update's height.
* width:
* type: number
* title: width
* description: The update's width.
* origin_country:
* type: string
* title: origin_country
* description: The update's origin country.
* material:
* type: string
* title: material
* description: The update's material.
* metadata:
* type: object
* description: The update's metadata.
* prices:
* type: array
* description: The update's prices.
* items:
* $ref: "#/components/schemas/AdminCreateProductVariantPrice"
* options:
* type: object
* description: The update's options.
*
*/
@@ -0,0 +1,27 @@
/**
* @schema AdminUpdateSalesChannel
* type: object
* description: SUMMARY
* x-schemaName: AdminUpdateSalesChannel
* required:
* - description
* - metadata
* properties:
* name:
* type: string
* title: name
* description: The sales channel's name.
* description:
* type: string
* title: description
* description: The sales channel's description.
* is_disabled:
* type: boolean
* title: is_disabled
* description: The sales channel's is disabled.
* metadata:
* type: object
* description: The sales channel's metadata.
*
*/
@@ -0,0 +1,68 @@
/**
* @schema AdminUpdateStockLocation
* type: object
* description: SUMMARY
* x-schemaName: AdminUpdateStockLocation
* required:
* - 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.
* metadata:
* type: object
* description: The stock location's metadata.
*
*/
@@ -0,0 +1,51 @@
/**
* @schema AdminUpdateStore
* type: object
* description: SUMMARY
* x-schemaName: AdminUpdateStore
* required:
* - name
* - default_sales_channel_id
* - default_region_id
* - default_location_id
* - metadata
* properties:
* name:
* type: string
* title: name
* description: The store's name.
* supported_currencies:
* type: array
* description: The store's supported currencies.
* items:
* type: object
* description: The supported currency's supported currencies.
* required:
* - currency_code
* properties:
* currency_code:
* type: string
* title: currency_code
* description: The supported currency's currency code.
* is_default:
* type: boolean
* title: is_default
* description: The supported currency's is default.
* default_sales_channel_id:
* type: string
* title: default_sales_channel_id
* description: The store's default sales channel id.
* default_region_id:
* type: string
* title: default_region_id
* description: The store's default region id.
* default_location_id:
* type: string
* title: default_location_id
* description: The store's default location id.
* metadata:
* type: object
* description: The store's metadata.
*
*/
@@ -0,0 +1,52 @@
/**
* @schema AdminUpdateTaxRate
* type: object
* description: SUMMARY
* x-schemaName: AdminUpdateTaxRate
* required:
* - metadata
* properties:
* rate:
* type: number
* title: rate
* description: The tax rate's rate.
* code:
* type: string
* title: code
* description: The tax rate's code.
* rules:
* 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.
* is_default:
* type: boolean
* title: is_default
* description: The tax rate's is default.
* is_combinable:
* type: boolean
* title: is_combinable
* description: The tax rate's is combinable.
* metadata:
* type: object
* description: The tax rate's metadata.
*
*/
@@ -0,0 +1,25 @@
/**
* @schema AdminUpdateUser
* type: object
* description: SUMMARY
* x-schemaName: AdminUpdateUser
* required:
* - first_name
* - last_name
* - avatar_url
* properties:
* first_name:
* type: string
* title: first_name
* description: The user's first name.
* last_name:
* type: string
* title: last_name
* description: The user's last name.
* avatar_url:
* type: string
* title: avatar_url
* description: The user's avatar url.
*
*/
@@ -0,0 +1,15 @@
/**
* @schema AdminUpdateVariantInventoryItem
* type: object
* description: SUMMARY
* x-schemaName: AdminUpdateVariantInventoryItem
* required:
* - required_quantity
* properties:
* required_quantity:
* type: number
* title: required_quantity
* description: The product's required quantity.
*
*/
@@ -1,9 +0,0 @@
/**
* @schema ApplicationMethod
* type: object
* description: The promotion's application method.
* x-schemaName: ApplicationMethod
* properties: {}
*
*/
@@ -0,0 +1,8 @@
/**
* @schema BaseCollection
* type: object
* description: The product's collection.
* x-schemaName: BaseCollection
*
*/
@@ -0,0 +1,8 @@
/**
* @schema BaseCustomer
* type: object
* description: The customer's customers.
* x-schemaName: BaseCustomer
*
*/
@@ -1,8 +1,8 @@
/**
* @schema CustomerAddressResponse
* @schema BaseCustomerAddress
* type: object
* description: The address's addresses.
* x-schemaName: CustomerAddressResponse
* x-schemaName: BaseCustomerAddress
* required:
* - id
* - address_name
@@ -86,13 +86,14 @@
* metadata:
* type: object
* description: The address's metadata.
* properties: {}
* 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.
*
@@ -0,0 +1,167 @@
/**
* @schema BaseProduct
* type: object
* description: The updated's product.
* x-schemaName: BaseProduct
* required:
* - id
* - title
* - handle
* - subtitle
* - description
* - is_giftcard
* - status
* - thumbnail
* - width
* - weight
* - length
* - height
* - origin_country
* - hs_code
* - mid_code
* - material
* - collection_id
* - type_id
* - tags
* - variants
* - options
* - images
* - discountable
* - external_id
* - created_at
* - updated_at
* - deleted_at
* properties:
* id:
* type: string
* title: id
* description: The product's ID.
* title:
* type: string
* title: title
* description: The product's title.
* handle:
* type: string
* title: handle
* description: The product's handle.
* subtitle:
* type: string
* title: subtitle
* description: The product's subtitle.
* description:
* type: string
* title: description
* description: The product's description.
* is_giftcard:
* type: boolean
* title: is_giftcard
* description: The product's is giftcard.
* status:
* type: string
* enum:
* - draft
* - proposed
* - published
* - rejected
* thumbnail:
* type: string
* title: thumbnail
* description: The product's thumbnail.
* width:
* type: number
* title: width
* description: The product's width.
* weight:
* type: number
* title: weight
* description: The product's weight.
* length:
* type: number
* title: length
* description: The product's length.
* height:
* type: number
* title: height
* description: The product's height.
* origin_country:
* type: string
* title: origin_country
* description: The product's origin country.
* hs_code:
* type: string
* title: hs_code
* description: The product's hs code.
* mid_code:
* type: string
* title: mid_code
* description: The product's mid code.
* material:
* type: string
* title: material
* description: The product's material.
* collection:
* $ref: "#/components/schemas/BaseCollection"
* collection_id:
* type: string
* title: collection_id
* description: The product's collection id.
* categories:
* type: array
* description: The product's categories.
* items:
* $ref: "#/components/schemas/BaseProductCategory"
* type:
* $ref: "#/components/schemas/BaseProduct"
* type_id:
* type: string
* title: type_id
* description: The product's type id.
* tags:
* type: array
* description: The product's tags.
* items:
* $ref: "#/components/schemas/BaseProductTag"
* variants:
* type: array
* description: The product's variants.
* items:
* $ref: "#/components/schemas/BaseProductVariant"
* options:
* type: array
* description: The product's options.
* items:
* $ref: "#/components/schemas/BaseProductOption"
* images:
* type: array
* description: The product's images.
* items:
* $ref: "#/components/schemas/BaseProductImage"
* discountable:
* type: boolean
* title: discountable
* description: The product's discountable.
* external_id:
* type: string
* title: external_id
* description: The product's external id.
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The product's created at.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The product's updated at.
* deleted_at:
* type: string
* format: date-time
* title: deleted_at
* description: The product's deleted at.
* metadata:
* type: object
* description: The product's metadata.
*
*/
@@ -0,0 +1,8 @@
/**
* @schema BaseProductCategory
* type: object
* description: The category's categories.
* x-schemaName: BaseProductCategory
*
*/
@@ -0,0 +1,8 @@
/**
* @schema BaseProductImage
* type: object
* description: The image's images.
* x-schemaName: BaseProductImage
*
*/
@@ -0,0 +1,8 @@
/**
* @schema BaseProductOption
* type: object
* description: The option's options.
* x-schemaName: BaseProductOption
*
*/
@@ -0,0 +1,44 @@
/**
* @schema BaseProductOptionValue
* type: object
* description: The option's options.
* x-schemaName: BaseProductOptionValue
* required:
* - id
* - value
* properties:
* id:
* type: string
* title: id
* description: The option's ID.
* value:
* type: string
* title: value
* description: The option's value.
* option:
* $ref: "#/components/schemas/BaseProductOption"
* option_id:
* type: string
* title: option_id
* description: The option's option id.
* metadata:
* type: object
* description: The option's metadata.
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The option's created at.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The option's updated at.
* deleted_at:
* type: string
* format: date-time
* title: deleted_at
* description: The option's deleted at.
*
*/
Loaded 100 of 1103 files, more files were not shown because too many files have changed in this diff. Show more