chore: move docs-util to www (#7232)
* reorganize docs apps * add README * fix directory * add condition for old docs * move docs-util to www * remove remaining docs-util * fixes of paths * fix scripts * path fixes * fix github actions * add build packages script
This commit is contained in:
Shahed Nasser
@@ -0,0 +1,51 @@
|
||||
/**
|
||||
* @schema AdminPostCampaignsReq
|
||||
* type: object
|
||||
* description: The promotion's campaign.
|
||||
* x-schemaName: AdminPostCampaignsReq
|
||||
* required:
|
||||
* - name
|
||||
* properties:
|
||||
* name:
|
||||
* type: string
|
||||
* title: name
|
||||
* description: The campaign's name.
|
||||
* campaign_identifier:
|
||||
* type: string
|
||||
* title: campaign_identifier
|
||||
* description: The campaign's campaign identifier.
|
||||
* description:
|
||||
* type: string
|
||||
* title: description
|
||||
* description: The campaign's description.
|
||||
* currency:
|
||||
* type: string
|
||||
* title: currency
|
||||
* description: The campaign's currency.
|
||||
* budget:
|
||||
* $ref: "#/components/schemas/CampaignBudget"
|
||||
* starts_at:
|
||||
* type: string
|
||||
* title: starts_at
|
||||
* description: The campaign's starts at.
|
||||
* ends_at:
|
||||
* type: string
|
||||
* title: ends_at
|
||||
* description: The campaign's ends at.
|
||||
* promotions:
|
||||
* type: array
|
||||
* description: The campaign's promotions.
|
||||
* items:
|
||||
* type: object
|
||||
* description: The promotion's promotions.
|
||||
* x-schemaName: IdObject
|
||||
* required:
|
||||
* - id
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The promotion's ID.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
/**
|
||||
* @schema ApplicationMethod
|
||||
* type: object
|
||||
* description: The promotion's application method.
|
||||
* x-schemaName: ApplicationMethod
|
||||
* properties: {}
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,119 @@
|
||||
/**
|
||||
* @schema ApplicationMethodsMethodPostReq
|
||||
* type: object
|
||||
* description: The promotion's application method.
|
||||
* x-schemaName: ApplicationMethodsMethodPostReq
|
||||
* properties:
|
||||
* description:
|
||||
* type: string
|
||||
* title: description
|
||||
* description: The application method's description.
|
||||
* value:
|
||||
* type: string
|
||||
* title: value
|
||||
* description: The application method's value.
|
||||
* max_quantity:
|
||||
* type: number
|
||||
* title: max_quantity
|
||||
* description: The application method's max quantity.
|
||||
* type:
|
||||
* type: string
|
||||
* enum:
|
||||
* - fixed
|
||||
* - percentage
|
||||
* target_type:
|
||||
* type: string
|
||||
* enum:
|
||||
* - order
|
||||
* - shipping_methods
|
||||
* - items
|
||||
* allocation:
|
||||
* type: string
|
||||
* enum:
|
||||
* - each
|
||||
* - across
|
||||
* target_rules:
|
||||
* type: array
|
||||
* description: The application method's target rules.
|
||||
* items:
|
||||
* type: object
|
||||
* description: The target rule's target rules.
|
||||
* x-schemaName: PromotionRule
|
||||
* required:
|
||||
* - operator
|
||||
* - attribute
|
||||
* - values
|
||||
* properties:
|
||||
* operator:
|
||||
* type: string
|
||||
* enum:
|
||||
* - gte
|
||||
* - lte
|
||||
* - gt
|
||||
* - lt
|
||||
* - eq
|
||||
* - ne
|
||||
* - in
|
||||
* description:
|
||||
* type: string
|
||||
* title: description
|
||||
* description: The target rule's description.
|
||||
* attribute:
|
||||
* type: string
|
||||
* title: attribute
|
||||
* description: The target rule's attribute.
|
||||
* values:
|
||||
* type: array
|
||||
* description: The target rule's values.
|
||||
* items:
|
||||
* type: string
|
||||
* title: values
|
||||
* description: The value's values.
|
||||
* buy_rules:
|
||||
* type: array
|
||||
* description: The application method's buy rules.
|
||||
* items:
|
||||
* type: object
|
||||
* description: The buy rule's buy rules.
|
||||
* x-schemaName: PromotionRule
|
||||
* required:
|
||||
* - operator
|
||||
* - attribute
|
||||
* - values
|
||||
* properties:
|
||||
* operator:
|
||||
* type: string
|
||||
* enum:
|
||||
* - gte
|
||||
* - lte
|
||||
* - gt
|
||||
* - lt
|
||||
* - eq
|
||||
* - ne
|
||||
* - in
|
||||
* description:
|
||||
* type: string
|
||||
* title: description
|
||||
* description: The buy rule's description.
|
||||
* attribute:
|
||||
* type: string
|
||||
* title: attribute
|
||||
* description: The buy rule's attribute.
|
||||
* values:
|
||||
* type: array
|
||||
* description: The buy rule's values.
|
||||
* items:
|
||||
* type: string
|
||||
* title: values
|
||||
* description: The value's values.
|
||||
* 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,9 @@
|
||||
/**
|
||||
* @schema Campaign
|
||||
* type: object
|
||||
* description: The promotion's campaign.
|
||||
* x-schemaName: Campaign
|
||||
* properties: {}
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,18 @@
|
||||
/**
|
||||
* @schema CampaignBudget
|
||||
* type: object
|
||||
* description: The campaign's budget.
|
||||
* x-schemaName: CampaignBudget
|
||||
* properties:
|
||||
* type:
|
||||
* type: string
|
||||
* enum:
|
||||
* - spend
|
||||
* - usage
|
||||
* limit:
|
||||
* type: number
|
||||
* title: limit
|
||||
* description: The budget's limit.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,21 @@
|
||||
/**
|
||||
* @schema CreateApiKey
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: CreateApiKey
|
||||
* required:
|
||||
* - title
|
||||
* - type
|
||||
* properties:
|
||||
* title:
|
||||
* type: string
|
||||
* title: title
|
||||
* description: The api key's title.
|
||||
* type:
|
||||
* type: string
|
||||
* enum:
|
||||
* - secret
|
||||
* - publishable
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,166 @@
|
||||
/**
|
||||
* @schema CreateApplicationMethod
|
||||
* type: object
|
||||
* description: The promotion's application method.
|
||||
* x-schemaName: CreateApplicationMethod
|
||||
* required:
|
||||
* - type
|
||||
* - target_type
|
||||
* properties:
|
||||
* type:
|
||||
* type: string
|
||||
* enum:
|
||||
* - fixed
|
||||
* - percentage
|
||||
* target_type:
|
||||
* type: string
|
||||
* enum:
|
||||
* - order
|
||||
* - shipping_methods
|
||||
* - items
|
||||
* allocation:
|
||||
* type: string
|
||||
* enum:
|
||||
* - each
|
||||
* - across
|
||||
* value:
|
||||
* type: number
|
||||
* title: value
|
||||
* description: The application method's value.
|
||||
* max_quantity:
|
||||
* type: number
|
||||
* title: max_quantity
|
||||
* description: The application method's max quantity.
|
||||
* buy_rules_min_quantity:
|
||||
* type: number
|
||||
* title: buy_rules_min_quantity
|
||||
* description: The application method's buy rules min quantity.
|
||||
* apply_to_quantity:
|
||||
* type: number
|
||||
* title: apply_to_quantity
|
||||
* description: The application method's apply to quantity.
|
||||
* promotion:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: promotion
|
||||
* description: The application method's promotion.
|
||||
* - type: object
|
||||
* description: The application method's promotion.
|
||||
* x-schemaName: Promotion
|
||||
* required:
|
||||
* - id
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The promotion's ID.
|
||||
* code:
|
||||
* type: string
|
||||
* title: code
|
||||
* description: The promotion's code.
|
||||
* type:
|
||||
* type: string
|
||||
* enum:
|
||||
* - standard
|
||||
* - buyget
|
||||
* is_automatic:
|
||||
* type: boolean
|
||||
* title: is_automatic
|
||||
* description: The promotion's is automatic.
|
||||
* application_method:
|
||||
* $ref: "#/components/schemas/ApplicationMethod"
|
||||
* rules:
|
||||
* type: array
|
||||
* description: The promotion's rules.
|
||||
* items:
|
||||
* type: object
|
||||
* description: The rule's rules.
|
||||
* x-schemaName: PromotionRule
|
||||
* properties: {}
|
||||
* campaign:
|
||||
* $ref: "#/components/schemas/Campaign"
|
||||
* target_rules:
|
||||
* type: array
|
||||
* description: The application method's target rules.
|
||||
* items:
|
||||
* type: object
|
||||
* description: The target rule's target rules.
|
||||
* x-schemaName: CreatePromotionRule
|
||||
* required:
|
||||
* - attribute
|
||||
* - operator
|
||||
* - values
|
||||
* properties:
|
||||
* description:
|
||||
* type: string
|
||||
* title: description
|
||||
* description: The target rule's description.
|
||||
* attribute:
|
||||
* type: string
|
||||
* title: attribute
|
||||
* description: The target rule's attribute.
|
||||
* operator:
|
||||
* type: string
|
||||
* enum:
|
||||
* - gt
|
||||
* - lt
|
||||
* - eq
|
||||
* - ne
|
||||
* - in
|
||||
* - lte
|
||||
* - gte
|
||||
* values:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: values
|
||||
* description: The target rule's values.
|
||||
* - type: array
|
||||
* description: The target rule's values.
|
||||
* items:
|
||||
* type: string
|
||||
* title: values
|
||||
* description: The value's values.
|
||||
* buy_rules:
|
||||
* type: array
|
||||
* description: The application method's buy rules.
|
||||
* items:
|
||||
* type: object
|
||||
* description: The buy rule's buy rules.
|
||||
* x-schemaName: CreatePromotionRule
|
||||
* required:
|
||||
* - attribute
|
||||
* - operator
|
||||
* - values
|
||||
* properties:
|
||||
* description:
|
||||
* type: string
|
||||
* title: description
|
||||
* description: The buy rule's description.
|
||||
* attribute:
|
||||
* type: string
|
||||
* title: attribute
|
||||
* description: The buy rule's attribute.
|
||||
* operator:
|
||||
* type: string
|
||||
* enum:
|
||||
* - gt
|
||||
* - lt
|
||||
* - eq
|
||||
* - ne
|
||||
* - in
|
||||
* - lte
|
||||
* - gte
|
||||
* values:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: values
|
||||
* description: The buy rule's values.
|
||||
* - type: array
|
||||
* description: The buy rule's values.
|
||||
* items:
|
||||
* type: string
|
||||
* title: values
|
||||
* description: The value's values.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,56 @@
|
||||
/**
|
||||
* @schema CreateCampaign
|
||||
* type: object
|
||||
* description: The promotion's campaign.
|
||||
* x-schemaName: CreateCampaign
|
||||
* required:
|
||||
* - name
|
||||
* - campaign_identifier
|
||||
* - starts_at
|
||||
* - ends_at
|
||||
* 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:
|
||||
* $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:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The promotion's ID.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,25 @@
|
||||
/**
|
||||
* @schema CreateCampaignBudget
|
||||
* type: object
|
||||
* description: The campaign's budget.
|
||||
* x-schemaName: CreateCampaignBudget
|
||||
* required:
|
||||
* - type
|
||||
* - limit
|
||||
* properties:
|
||||
* type:
|
||||
* type: string
|
||||
* enum:
|
||||
* - spend
|
||||
* - usage
|
||||
* limit:
|
||||
* type: number
|
||||
* title: limit
|
||||
* description: The budget's limit.
|
||||
* used:
|
||||
* type: number
|
||||
* title: used
|
||||
* description: The budget's used.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,262 @@
|
||||
/**
|
||||
* @schema CreateCartWorkflowInput
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: CreateCartWorkflowInput
|
||||
* properties:
|
||||
* region_id:
|
||||
* type: string
|
||||
* title: region_id
|
||||
* description: The cart's region id.
|
||||
* customer_id:
|
||||
* type: string
|
||||
* title: customer_id
|
||||
* description: The cart's customer id.
|
||||
* sales_channel_id:
|
||||
* type: string
|
||||
* title: sales_channel_id
|
||||
* description: The cart's sales channel id.
|
||||
* email:
|
||||
* type: string
|
||||
* title: email
|
||||
* description: The cart's email.
|
||||
* format: email
|
||||
* currency_code:
|
||||
* type: string
|
||||
* title: currency_code
|
||||
* description: The cart's currency code.
|
||||
* shipping_address_id:
|
||||
* type: string
|
||||
* title: shipping_address_id
|
||||
* description: The cart's shipping address id.
|
||||
* billing_address_id:
|
||||
* type: string
|
||||
* title: billing_address_id
|
||||
* description: The cart's billing address id.
|
||||
* shipping_address:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: shipping_address
|
||||
* description: The cart's shipping address.
|
||||
* - type: object
|
||||
* description: The cart's shipping address.
|
||||
* x-schemaName: CreateCartAddress
|
||||
* properties:
|
||||
* first_name:
|
||||
* type: string
|
||||
* title: first_name
|
||||
* description: The shipping address's first name.
|
||||
* last_name:
|
||||
* type: string
|
||||
* title: last_name
|
||||
* description: The shipping address's last name.
|
||||
* phone:
|
||||
* type: string
|
||||
* title: phone
|
||||
* description: The shipping address's phone.
|
||||
* company:
|
||||
* type: string
|
||||
* title: company
|
||||
* description: The shipping address's company.
|
||||
* address_1:
|
||||
* type: string
|
||||
* title: address_1
|
||||
* description: The shipping address's address 1.
|
||||
* address_2:
|
||||
* type: string
|
||||
* title: address_2
|
||||
* description: The shipping address's address 2.
|
||||
* city:
|
||||
* type: string
|
||||
* title: city
|
||||
* description: The shipping address's city.
|
||||
* country_code:
|
||||
* type: string
|
||||
* title: country_code
|
||||
* description: The shipping address's country code.
|
||||
* province:
|
||||
* type: string
|
||||
* title: province
|
||||
* description: The shipping address's province.
|
||||
* postal_code:
|
||||
* type: string
|
||||
* title: postal_code
|
||||
* description: The shipping address's postal code.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The shipping address's metadata.
|
||||
* properties: {}
|
||||
* billing_address:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: billing_address
|
||||
* description: The cart's billing address.
|
||||
* - type: object
|
||||
* description: The cart's billing address.
|
||||
* x-schemaName: CreateCartAddress
|
||||
* properties:
|
||||
* 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.
|
||||
* properties: {}
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The cart's metadata.
|
||||
* properties: {}
|
||||
* items:
|
||||
* type: array
|
||||
* description: The cart's items.
|
||||
* items:
|
||||
* type: object
|
||||
* description: The item's items.
|
||||
* x-schemaName: CreateCartCreateLineItem
|
||||
* required:
|
||||
* - quantity
|
||||
* - variant_id
|
||||
* properties:
|
||||
* quantity:
|
||||
* type: number
|
||||
* title: quantity
|
||||
* description: The item's quantity.
|
||||
* variant_id:
|
||||
* type: string
|
||||
* title: variant_id
|
||||
* description: The item's variant id.
|
||||
* title:
|
||||
* type: string
|
||||
* title: title
|
||||
* description: The item's title.
|
||||
* subtitle:
|
||||
* type: string
|
||||
* title: subtitle
|
||||
* description: The item's subtitle.
|
||||
* thumbnail:
|
||||
* type: string
|
||||
* title: thumbnail
|
||||
* description: The item's thumbnail.
|
||||
* product_id:
|
||||
* type: string
|
||||
* title: product_id
|
||||
* description: The item's product id.
|
||||
* product_title:
|
||||
* type: string
|
||||
* title: product_title
|
||||
* description: The item's product title.
|
||||
* product_description:
|
||||
* type: string
|
||||
* title: product_description
|
||||
* description: The item's product description.
|
||||
* product_subtitle:
|
||||
* type: string
|
||||
* title: product_subtitle
|
||||
* description: The item's product subtitle.
|
||||
* product_type:
|
||||
* type: string
|
||||
* title: product_type
|
||||
* description: The item's product type.
|
||||
* product_collection:
|
||||
* type: string
|
||||
* title: product_collection
|
||||
* description: The item's product collection.
|
||||
* product_handle:
|
||||
* type: string
|
||||
* title: product_handle
|
||||
* description: The item's product handle.
|
||||
* variant_sku:
|
||||
* type: string
|
||||
* title: variant_sku
|
||||
* description: The item's variant sku.
|
||||
* variant_barcode:
|
||||
* type: string
|
||||
* title: variant_barcode
|
||||
* description: The item's variant barcode.
|
||||
* variant_title:
|
||||
* type: string
|
||||
* title: variant_title
|
||||
* description: The item's variant title.
|
||||
* variant_option_values:
|
||||
* type: object
|
||||
* description: The item's variant option values.
|
||||
* properties: {}
|
||||
* requires_shipping:
|
||||
* type: boolean
|
||||
* title: requires_shipping
|
||||
* description: The item's requires shipping.
|
||||
* is_discountable:
|
||||
* type: boolean
|
||||
* title: is_discountable
|
||||
* description: The item's is discountable.
|
||||
* is_tax_inclusive:
|
||||
* type: boolean
|
||||
* title: is_tax_inclusive
|
||||
* description: The item's is tax inclusive.
|
||||
* is_giftcard:
|
||||
* type: boolean
|
||||
* title: is_giftcard
|
||||
* description: The item's is giftcard.
|
||||
* compare_at_unit_price:
|
||||
* type: number
|
||||
* title: compare_at_unit_price
|
||||
* description: The item's compare at unit price.
|
||||
* unit_price:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: unit_price
|
||||
* description: The item's unit price.
|
||||
* - type: number
|
||||
* title: unit_price
|
||||
* description: The item's unit price.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The item's metadata.
|
||||
* properties: {}
|
||||
* promo_codes:
|
||||
* type: array
|
||||
* description: The cart's promo codes.
|
||||
* items:
|
||||
* type: string
|
||||
* title: promo_codes
|
||||
* description: The promo code's promo codes.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,102 @@
|
||||
/**
|
||||
* @schema CreateCustomer
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: CreateCustomer
|
||||
* properties:
|
||||
* 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.
|
||||
* email:
|
||||
* type: string
|
||||
* title: email
|
||||
* description: The customer's email.
|
||||
* format: email
|
||||
* phone:
|
||||
* type: string
|
||||
* title: phone
|
||||
* description: The customer's phone.
|
||||
* created_by:
|
||||
* type: string
|
||||
* title: created_by
|
||||
* description: The customer's created by.
|
||||
* addresses:
|
||||
* type: array
|
||||
* description: The customer's addresses.
|
||||
* items:
|
||||
* type: object
|
||||
* description: The address's addresses.
|
||||
* x-schemaName: CreateCustomerAddress
|
||||
* properties:
|
||||
* 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.
|
||||
* 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.
|
||||
* properties: {}
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The customer's metadata.
|
||||
* properties: {}
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,71 @@
|
||||
/**
|
||||
* @schema CreateCustomerAddress
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: CreateCustomerAddress
|
||||
* required:
|
||||
* - customer_id
|
||||
* 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.
|
||||
* customer_id:
|
||||
* type: string
|
||||
* title: customer_id
|
||||
* description: The customer's customer id.
|
||||
* 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.
|
||||
* properties: {}
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,23 @@
|
||||
/**
|
||||
* @schema CreateCustomerGroup
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: CreateCustomerGroup
|
||||
* required:
|
||||
* - name
|
||||
* properties:
|
||||
* name:
|
||||
* type: string
|
||||
* title: name
|
||||
* description: The customer group's name.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The customer group's metadata.
|
||||
* properties: {}
|
||||
* created_by:
|
||||
* type: string
|
||||
* title: created_by
|
||||
* description: The customer group's created by.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,27 @@
|
||||
/**
|
||||
* @schema CreateDefaultTaxRate
|
||||
* type: object
|
||||
* description: The tax region's default tax rate.
|
||||
* x-schemaName: CreateDefaultTaxRate
|
||||
* required:
|
||||
* - name
|
||||
* 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.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The default tax rate's metadata.
|
||||
* properties: {}
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,24 @@
|
||||
/**
|
||||
* @schema CreateInvite
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: CreateInvite
|
||||
* required:
|
||||
* - email
|
||||
* properties:
|
||||
* email:
|
||||
* type: string
|
||||
* title: email
|
||||
* description: The invite's email.
|
||||
* format: email
|
||||
* accepted:
|
||||
* type: boolean
|
||||
* title: accepted
|
||||
* description: The invite's accepted.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The invite's metadata.
|
||||
* properties: {}
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,268 @@
|
||||
/**
|
||||
* @schema CreateProduct
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: CreateProduct
|
||||
* required:
|
||||
* - title
|
||||
* properties:
|
||||
* title:
|
||||
* type: string
|
||||
* title: title
|
||||
* description: The product's title.
|
||||
* 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.
|
||||
* discountable:
|
||||
* type: boolean
|
||||
* title: discountable
|
||||
* description: The product's discountable.
|
||||
* images:
|
||||
* oneOf:
|
||||
* - type: array
|
||||
* description: The product's images.
|
||||
* items:
|
||||
* type: string
|
||||
* title: images
|
||||
* description: The image's images.
|
||||
* - type: array
|
||||
* description: The product's images.
|
||||
* items:
|
||||
* type: object
|
||||
* description: The image's images.
|
||||
* required:
|
||||
* - url
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The image's ID.
|
||||
* url:
|
||||
* type: string
|
||||
* title: url
|
||||
* description: The image's url.
|
||||
* thumbnail:
|
||||
* type: string
|
||||
* title: thumbnail
|
||||
* description: The product's thumbnail.
|
||||
* handle:
|
||||
* type: string
|
||||
* title: handle
|
||||
* description: The product's handle.
|
||||
* status:
|
||||
* type: string
|
||||
* enum:
|
||||
* - draft
|
||||
* - proposed
|
||||
* - published
|
||||
* - rejected
|
||||
* type:
|
||||
* $ref: "#/components/schemas/CreateProductType"
|
||||
* type_id:
|
||||
* type: string
|
||||
* title: type_id
|
||||
* description: The product's type id.
|
||||
* collection_id:
|
||||
* type: string
|
||||
* title: collection_id
|
||||
* description: The product's collection id.
|
||||
* tags:
|
||||
* type: array
|
||||
* description: The product's tags.
|
||||
* items:
|
||||
* type: object
|
||||
* description: The tag's tags.
|
||||
* x-schemaName: CreateProductTag
|
||||
* required:
|
||||
* - value
|
||||
* properties:
|
||||
* value:
|
||||
* type: string
|
||||
* title: value
|
||||
* description: The tag's value.
|
||||
* categories:
|
||||
* type: array
|
||||
* description: The product's categories.
|
||||
* items:
|
||||
* type: object
|
||||
* description: The category's categories.
|
||||
* required:
|
||||
* - id
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The category's ID.
|
||||
* options:
|
||||
* type: array
|
||||
* description: The product's options.
|
||||
* items:
|
||||
* type: object
|
||||
* description: The option's options.
|
||||
* x-schemaName: CreateProductOption
|
||||
* required:
|
||||
* - title
|
||||
* - values
|
||||
* properties:
|
||||
* title:
|
||||
* type: string
|
||||
* title: title
|
||||
* description: The option's title.
|
||||
* values:
|
||||
* oneOf:
|
||||
* - type: array
|
||||
* description: The option's values.
|
||||
* items:
|
||||
* type: string
|
||||
* title: values
|
||||
* description: The value's values.
|
||||
* - type: array
|
||||
* description: The option's values.
|
||||
* items:
|
||||
* type: object
|
||||
* description: The value's values.
|
||||
* required:
|
||||
* - value
|
||||
* properties:
|
||||
* value:
|
||||
* type: string
|
||||
* title: value
|
||||
* description: The value's details.
|
||||
* product_id:
|
||||
* type: string
|
||||
* title: product_id
|
||||
* description: The option's product id.
|
||||
* variants:
|
||||
* type: array
|
||||
* description: The product's variants.
|
||||
* items:
|
||||
* type: object
|
||||
* description: The variant's variants.
|
||||
* x-schemaName: CreateProductVariant
|
||||
* required:
|
||||
* - title
|
||||
* properties:
|
||||
* product_id:
|
||||
* type: string
|
||||
* title: product_id
|
||||
* description: The variant's product id.
|
||||
* title:
|
||||
* type: string
|
||||
* title: title
|
||||
* description: The variant's title.
|
||||
* sku:
|
||||
* type: string
|
||||
* title: sku
|
||||
* description: The variant's sku.
|
||||
* barcode:
|
||||
* type: string
|
||||
* title: barcode
|
||||
* description: The variant's barcode.
|
||||
* ean:
|
||||
* type: string
|
||||
* title: ean
|
||||
* description: The variant's ean.
|
||||
* upc:
|
||||
* type: string
|
||||
* title: upc
|
||||
* description: The variant's upc.
|
||||
* allow_backorder:
|
||||
* type: boolean
|
||||
* title: allow_backorder
|
||||
* description: The variant's allow backorder.
|
||||
* inventory_quantity:
|
||||
* type: number
|
||||
* title: inventory_quantity
|
||||
* description: The variant's inventory quantity.
|
||||
* manage_inventory:
|
||||
* type: boolean
|
||||
* title: manage_inventory
|
||||
* description: The variant's manage inventory.
|
||||
* hs_code:
|
||||
* type: string
|
||||
* title: hs_code
|
||||
* description: The variant's hs code.
|
||||
* origin_country:
|
||||
* type: string
|
||||
* title: origin_country
|
||||
* description: The variant's origin country.
|
||||
* mid_code:
|
||||
* type: string
|
||||
* title: mid_code
|
||||
* description: The variant's mid code.
|
||||
* material:
|
||||
* type: string
|
||||
* title: material
|
||||
* description: The variant's material.
|
||||
* weight:
|
||||
* type: number
|
||||
* title: weight
|
||||
* description: The variant's weight.
|
||||
* length:
|
||||
* type: number
|
||||
* title: length
|
||||
* description: The variant's length.
|
||||
* height:
|
||||
* type: number
|
||||
* title: height
|
||||
* description: The variant's height.
|
||||
* width:
|
||||
* type: number
|
||||
* title: width
|
||||
* description: The variant's width.
|
||||
* options:
|
||||
* type: object
|
||||
* description: The variant's options.
|
||||
* properties: {}
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The variant's metadata.
|
||||
* properties: {}
|
||||
* width:
|
||||
* type: number
|
||||
* title: width
|
||||
* description: The product's width.
|
||||
* height:
|
||||
* type: number
|
||||
* title: height
|
||||
* description: The product's height.
|
||||
* length:
|
||||
* type: number
|
||||
* title: length
|
||||
* description: The product's length.
|
||||
* weight:
|
||||
* type: number
|
||||
* title: weight
|
||||
* description: The product's weight.
|
||||
* 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.
|
||||
* material:
|
||||
* type: string
|
||||
* title: material
|
||||
* description: The product's material.
|
||||
* mid_code:
|
||||
* type: string
|
||||
* title: mid_code
|
||||
* description: The product's mid code.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The product's metadata.
|
||||
* properties: {}
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,30 @@
|
||||
/**
|
||||
* @schema CreateProductCollection
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: CreateProductCollection
|
||||
* required:
|
||||
* - title
|
||||
* properties:
|
||||
* title:
|
||||
* type: string
|
||||
* title: title
|
||||
* description: The collection's title.
|
||||
* handle:
|
||||
* type: string
|
||||
* title: handle
|
||||
* description: The collection's handle.
|
||||
* product_ids:
|
||||
* type: array
|
||||
* description: The collection's product ids.
|
||||
* items:
|
||||
* type: string
|
||||
* title: product_ids
|
||||
* description: The product id's product ids.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The collection's metadata.
|
||||
* properties: {}
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,40 @@
|
||||
/**
|
||||
* @schema CreateProductOption
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: CreateProductOption
|
||||
* required:
|
||||
* - title
|
||||
* - values
|
||||
* properties:
|
||||
* title:
|
||||
* type: string
|
||||
* title: title
|
||||
* description: The product's title.
|
||||
* values:
|
||||
* oneOf:
|
||||
* - type: array
|
||||
* description: The product's values.
|
||||
* items:
|
||||
* type: string
|
||||
* title: values
|
||||
* description: The value's values.
|
||||
* - type: array
|
||||
* description: The product's values.
|
||||
* items:
|
||||
* type: object
|
||||
* description: The value's values.
|
||||
* required:
|
||||
* - value
|
||||
* properties:
|
||||
* value:
|
||||
* type: string
|
||||
* title: value
|
||||
* description: The value's details.
|
||||
* product_id:
|
||||
* type: string
|
||||
* title: product_id
|
||||
* description: The product's product id.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,23 @@
|
||||
/**
|
||||
* @schema CreateProductType
|
||||
* type: object
|
||||
* description: The product's type.
|
||||
* x-schemaName: CreateProductType
|
||||
* required:
|
||||
* - value
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The type's ID.
|
||||
* value:
|
||||
* type: string
|
||||
* title: value
|
||||
* description: The type's value.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The type's metadata.
|
||||
* properties: {}
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,87 @@
|
||||
/**
|
||||
* @schema CreateProductVariant
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: CreateProductVariant
|
||||
* required:
|
||||
* - title
|
||||
* properties:
|
||||
* product_id:
|
||||
* type: string
|
||||
* title: product_id
|
||||
* description: The product's product id.
|
||||
* title:
|
||||
* type: string
|
||||
* title: title
|
||||
* description: The product's title.
|
||||
* sku:
|
||||
* type: string
|
||||
* title: sku
|
||||
* description: The product's sku.
|
||||
* barcode:
|
||||
* type: string
|
||||
* title: barcode
|
||||
* description: The product's barcode.
|
||||
* ean:
|
||||
* type: string
|
||||
* title: ean
|
||||
* description: The product's ean.
|
||||
* upc:
|
||||
* type: string
|
||||
* title: upc
|
||||
* description: The product's upc.
|
||||
* allow_backorder:
|
||||
* type: boolean
|
||||
* title: allow_backorder
|
||||
* description: The product's allow backorder.
|
||||
* inventory_quantity:
|
||||
* type: number
|
||||
* title: inventory_quantity
|
||||
* description: The product's inventory quantity.
|
||||
* manage_inventory:
|
||||
* type: boolean
|
||||
* title: manage_inventory
|
||||
* description: The product's manage inventory.
|
||||
* hs_code:
|
||||
* type: string
|
||||
* title: hs_code
|
||||
* description: The product's hs code.
|
||||
* origin_country:
|
||||
* type: string
|
||||
* title: origin_country
|
||||
* description: The product's origin country.
|
||||
* mid_code:
|
||||
* type: string
|
||||
* title: mid_code
|
||||
* description: The product's mid code.
|
||||
* material:
|
||||
* type: string
|
||||
* title: material
|
||||
* description: The product's material.
|
||||
* 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.
|
||||
* width:
|
||||
* type: number
|
||||
* title: width
|
||||
* description: The product's width.
|
||||
* options:
|
||||
* type: object
|
||||
* description: The product's options.
|
||||
* properties: {}
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The product's metadata.
|
||||
* properties: {}
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,74 @@
|
||||
/**
|
||||
* @schema CreatePromotion
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: CreatePromotion
|
||||
* required:
|
||||
* - code
|
||||
* - type
|
||||
* properties:
|
||||
* code:
|
||||
* type: string
|
||||
* title: code
|
||||
* description: The promotion's code.
|
||||
* type:
|
||||
* type: string
|
||||
* enum:
|
||||
* - standard
|
||||
* - buyget
|
||||
* is_automatic:
|
||||
* type: boolean
|
||||
* title: is_automatic
|
||||
* description: The promotion's is automatic.
|
||||
* application_method:
|
||||
* $ref: "#/components/schemas/CreateApplicationMethod"
|
||||
* rules:
|
||||
* type: array
|
||||
* description: The promotion's rules.
|
||||
* items:
|
||||
* type: object
|
||||
* description: The rule's rules.
|
||||
* x-schemaName: CreatePromotionRule
|
||||
* required:
|
||||
* - attribute
|
||||
* - operator
|
||||
* - values
|
||||
* properties:
|
||||
* description:
|
||||
* type: string
|
||||
* title: description
|
||||
* description: The rule's description.
|
||||
* attribute:
|
||||
* type: string
|
||||
* title: attribute
|
||||
* description: The rule's attribute.
|
||||
* operator:
|
||||
* type: string
|
||||
* enum:
|
||||
* - gt
|
||||
* - lt
|
||||
* - eq
|
||||
* - ne
|
||||
* - in
|
||||
* - lte
|
||||
* - gte
|
||||
* 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.
|
||||
* campaign:
|
||||
* $ref: "#/components/schemas/CreateCampaign"
|
||||
* campaign_id:
|
||||
* type: string
|
||||
* title: campaign_id
|
||||
* description: The promotion's campaign id.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,35 @@
|
||||
/**
|
||||
* @schema CreateRegion
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: CreateRegion
|
||||
* 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.
|
||||
* automatic_taxes:
|
||||
* type: boolean
|
||||
* title: automatic_taxes
|
||||
* description: The region's automatic taxes.
|
||||
* countries:
|
||||
* type: array
|
||||
* description: The region's countries.
|
||||
* items:
|
||||
* type: string
|
||||
* title: countries
|
||||
* description: The country's countries.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The region's metadata.
|
||||
* properties: {}
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,23 @@
|
||||
/**
|
||||
* @schema CreateSalesChannel
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: CreateSalesChannel
|
||||
* required:
|
||||
* - name
|
||||
* 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.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,32 @@
|
||||
/**
|
||||
* @schema CreateUser
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: CreateUser
|
||||
* required:
|
||||
* - email
|
||||
* properties:
|
||||
* email:
|
||||
* type: string
|
||||
* title: email
|
||||
* description: The user's email.
|
||||
* format: email
|
||||
* first_name:
|
||||
* type: string
|
||||
* title: first_name
|
||||
* description: The user's first name.
|
||||
* last_name:
|
||||
* type: string
|
||||
* title: last_name
|
||||
* description: The user's last name.
|
||||
* avatar_url:
|
||||
* type: string
|
||||
* title: avatar_url
|
||||
* description: The user's avatar url.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The user's metadata.
|
||||
* properties: {}
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,81 @@
|
||||
/**
|
||||
* @schema CustomerAddress
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: CustomerAddress
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The customer's ID.
|
||||
* 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.
|
||||
* customer_id:
|
||||
* type: string
|
||||
* title: customer_id
|
||||
* description: The customer's customer id.
|
||||
* 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.
|
||||
* properties: {}
|
||||
* created_at:
|
||||
* type: string
|
||||
* title: created_at
|
||||
* description: The customer's created at.
|
||||
* updated_at:
|
||||
* type: string
|
||||
* title: updated_at
|
||||
* description: The customer's updated at.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,17 @@
|
||||
/**
|
||||
* @schema CustomerGroupUpdatableFields
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: CustomerGroupUpdatableFields
|
||||
* properties:
|
||||
* name:
|
||||
* type: string
|
||||
* title: name
|
||||
* description: The customer group's name.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The customer group's metadata.
|
||||
* properties: {}
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,34 @@
|
||||
/**
|
||||
* @schema CustomerUpdatableFields
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: CustomerUpdatableFields
|
||||
* properties:
|
||||
* 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.
|
||||
* email:
|
||||
* type: string
|
||||
* title: email
|
||||
* description: The customer's email.
|
||||
* format: email
|
||||
* phone:
|
||||
* type: string
|
||||
* title: phone
|
||||
* description: The customer's phone.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The customer's metadata.
|
||||
* properties: {}
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,15 @@
|
||||
/**
|
||||
* @schema Promotion
|
||||
* type: object
|
||||
* description: The promotion's promotions.
|
||||
* x-schemaName: Promotion
|
||||
* required:
|
||||
* - id
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The promotion's ID.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,44 @@
|
||||
/**
|
||||
* @schema StockLocationAddress
|
||||
* type: object
|
||||
* description: The stock location's address.
|
||||
* x-schemaName: StockLocationAddress
|
||||
* 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.
|
||||
* 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.
|
||||
*
|
||||
*/
|
||||
|
||||
+195
@@ -0,0 +1,195 @@
|
||||
/**
|
||||
* @schema StorePostPaymentCollectionsPaymentSessionReq
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: StorePostPaymentCollectionsPaymentSessionReq
|
||||
* required:
|
||||
* - provider_id
|
||||
* properties:
|
||||
* provider_id:
|
||||
* type: string
|
||||
* title: provider_id
|
||||
* description: The payment collection's provider id.
|
||||
* context:
|
||||
* type: object
|
||||
* description: The payment collection's context.
|
||||
* properties:
|
||||
* billing_address:
|
||||
* type: object
|
||||
* description: The context's billing address.
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The billing address's ID.
|
||||
* 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.
|
||||
* company:
|
||||
* type: string
|
||||
* title: company
|
||||
* description: The billing address's company.
|
||||
* country_code:
|
||||
* type: string
|
||||
* title: country_code
|
||||
* description: The billing address's country code.
|
||||
* city:
|
||||
* type: string
|
||||
* title: city
|
||||
* description: The billing address's city.
|
||||
* phone:
|
||||
* type: string
|
||||
* title: phone
|
||||
* description: The billing address's phone.
|
||||
* postal_code:
|
||||
* type: string
|
||||
* title: postal_code
|
||||
* description: The billing address's postal code.
|
||||
* province:
|
||||
* type: string
|
||||
* title: province
|
||||
* description: The billing address's province.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The billing address's metadata.
|
||||
* properties: {}
|
||||
* created_at:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: created_at
|
||||
* description: The billing address's created at.
|
||||
* - type: string
|
||||
* title: created_at
|
||||
* description: The billing address's created at.
|
||||
* format: date-time
|
||||
* updated_at:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: updated_at
|
||||
* description: The billing address's updated at.
|
||||
* - type: string
|
||||
* title: updated_at
|
||||
* description: The billing address's updated at.
|
||||
* format: date-time
|
||||
* deleted_at:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: deleted_at
|
||||
* description: The billing address's deleted at.
|
||||
* - type: string
|
||||
* title: deleted_at
|
||||
* description: The billing address's deleted at.
|
||||
* format: date-time
|
||||
* email:
|
||||
* type: string
|
||||
* title: email
|
||||
* description: The context's email.
|
||||
* format: email
|
||||
* resource_id:
|
||||
* type: string
|
||||
* title: resource_id
|
||||
* description: The context's resource id.
|
||||
* customer:
|
||||
* type: object
|
||||
* description: The context's customer.
|
||||
* x-schemaName: Customer
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The customer's ID.
|
||||
* email:
|
||||
* type: string
|
||||
* title: email
|
||||
* description: The customer's email.
|
||||
* format: email
|
||||
* default_billing_address_id:
|
||||
* type: string
|
||||
* title: default_billing_address_id
|
||||
* description: The customer's default billing address id.
|
||||
* default_shipping_address_id:
|
||||
* type: string
|
||||
* title: default_shipping_address_id
|
||||
* description: The customer's default shipping address id.
|
||||
* 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.
|
||||
* addresses:
|
||||
* type: array
|
||||
* description: The customer's addresses.
|
||||
* items:
|
||||
* type: object
|
||||
* description: The address's addresses.
|
||||
* x-schemaName: CustomerAddress
|
||||
* properties: {}
|
||||
* phone:
|
||||
* type: string
|
||||
* title: phone
|
||||
* description: The customer's phone.
|
||||
* groups:
|
||||
* type: array
|
||||
* description: The customer's groups.
|
||||
* items:
|
||||
* type: object
|
||||
* description: The group's groups.
|
||||
* properties: {}
|
||||
* 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
|
||||
* 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
|
||||
* 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
|
||||
* extra:
|
||||
* type: object
|
||||
* description: The context's extra.
|
||||
* properties: {}
|
||||
* data:
|
||||
* type: object
|
||||
* description: The payment collection's data.
|
||||
* properties: {}
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
/**
|
||||
* @schema UpdateApiKey
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: UpdateApiKey
|
||||
* properties:
|
||||
* title:
|
||||
* type: string
|
||||
* title: title
|
||||
* description: The api key's title.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,266 @@
|
||||
/**
|
||||
* @schema UpdateCartData
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: UpdateCartData
|
||||
* properties:
|
||||
* region_id:
|
||||
* type: string
|
||||
* title: region_id
|
||||
* description: The cart's region id.
|
||||
* customer_id:
|
||||
* type: string
|
||||
* title: customer_id
|
||||
* description: The cart's customer id.
|
||||
* sales_channel_id:
|
||||
* type: string
|
||||
* title: sales_channel_id
|
||||
* description: The cart's sales channel id.
|
||||
* email:
|
||||
* type: string
|
||||
* title: email
|
||||
* description: The cart's email.
|
||||
* format: email
|
||||
* currency_code:
|
||||
* type: string
|
||||
* title: currency_code
|
||||
* description: The cart's currency code.
|
||||
* shipping_address_id:
|
||||
* type: string
|
||||
* title: shipping_address_id
|
||||
* description: The cart's shipping address id.
|
||||
* billing_address_id:
|
||||
* type: string
|
||||
* title: billing_address_id
|
||||
* description: The cart's billing address id.
|
||||
* billing_address:
|
||||
* oneOf:
|
||||
* - type: object
|
||||
* description: The cart's billing address.
|
||||
* x-schemaName: CreateAddress
|
||||
* properties:
|
||||
* customer_id:
|
||||
* type: string
|
||||
* title: customer_id
|
||||
* description: The billing address's customer id.
|
||||
* company:
|
||||
* type: string
|
||||
* title: company
|
||||
* description: The billing address's company.
|
||||
* 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.
|
||||
* 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.
|
||||
* phone:
|
||||
* type: string
|
||||
* title: phone
|
||||
* description: The billing address's phone.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The billing address's metadata.
|
||||
* properties: {}
|
||||
* - type: object
|
||||
* description: The cart's billing address.
|
||||
* x-schemaName: UpdateAddress
|
||||
* required:
|
||||
* - id
|
||||
* properties:
|
||||
* 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.
|
||||
* company:
|
||||
* type: string
|
||||
* title: company
|
||||
* description: The billing address's company.
|
||||
* 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.
|
||||
* 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.
|
||||
* phone:
|
||||
* type: string
|
||||
* title: phone
|
||||
* description: The billing address's phone.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The billing address's metadata.
|
||||
* properties: {}
|
||||
* shipping_address:
|
||||
* oneOf:
|
||||
* - type: object
|
||||
* description: The cart's shipping address.
|
||||
* x-schemaName: CreateAddress
|
||||
* properties:
|
||||
* customer_id:
|
||||
* type: string
|
||||
* title: customer_id
|
||||
* description: The shipping address's customer id.
|
||||
* company:
|
||||
* type: string
|
||||
* title: company
|
||||
* description: The shipping address's company.
|
||||
* first_name:
|
||||
* type: string
|
||||
* title: first_name
|
||||
* description: The shipping address's first name.
|
||||
* last_name:
|
||||
* type: string
|
||||
* title: last_name
|
||||
* description: The shipping address's last name.
|
||||
* address_1:
|
||||
* type: string
|
||||
* title: address_1
|
||||
* description: The shipping address's address 1.
|
||||
* address_2:
|
||||
* type: string
|
||||
* title: address_2
|
||||
* description: The shipping address's address 2.
|
||||
* city:
|
||||
* type: string
|
||||
* title: city
|
||||
* description: The shipping address's city.
|
||||
* country_code:
|
||||
* type: string
|
||||
* title: country_code
|
||||
* description: The shipping address's country code.
|
||||
* province:
|
||||
* type: string
|
||||
* title: province
|
||||
* description: The shipping address's province.
|
||||
* postal_code:
|
||||
* type: string
|
||||
* title: postal_code
|
||||
* description: The shipping address's postal code.
|
||||
* phone:
|
||||
* type: string
|
||||
* title: phone
|
||||
* description: The shipping address's phone.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The shipping address's metadata.
|
||||
* properties: {}
|
||||
* - type: object
|
||||
* description: The cart's shipping address.
|
||||
* x-schemaName: UpdateAddress
|
||||
* required:
|
||||
* - id
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The shipping address's ID.
|
||||
* customer_id:
|
||||
* type: string
|
||||
* title: customer_id
|
||||
* description: The shipping address's customer id.
|
||||
* company:
|
||||
* type: string
|
||||
* title: company
|
||||
* description: The shipping address's company.
|
||||
* first_name:
|
||||
* type: string
|
||||
* title: first_name
|
||||
* description: The shipping address's first name.
|
||||
* last_name:
|
||||
* type: string
|
||||
* title: last_name
|
||||
* description: The shipping address's last name.
|
||||
* address_1:
|
||||
* type: string
|
||||
* title: address_1
|
||||
* description: The shipping address's address 1.
|
||||
* address_2:
|
||||
* type: string
|
||||
* title: address_2
|
||||
* description: The shipping address's address 2.
|
||||
* city:
|
||||
* type: string
|
||||
* title: city
|
||||
* description: The shipping address's city.
|
||||
* country_code:
|
||||
* type: string
|
||||
* title: country_code
|
||||
* description: The shipping address's country code.
|
||||
* province:
|
||||
* type: string
|
||||
* title: province
|
||||
* description: The shipping address's province.
|
||||
* postal_code:
|
||||
* type: string
|
||||
* title: postal_code
|
||||
* description: The shipping address's postal code.
|
||||
* phone:
|
||||
* type: string
|
||||
* title: phone
|
||||
* description: The shipping address's phone.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The shipping address's metadata.
|
||||
* properties: {}
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The cart's metadata.
|
||||
* properties: {}
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,264 @@
|
||||
/**
|
||||
* @schema UpdateProduct
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: UpdateProduct
|
||||
* properties:
|
||||
* title:
|
||||
* type: string
|
||||
* title: title
|
||||
* description: The product's title.
|
||||
* 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.
|
||||
* discountable:
|
||||
* type: boolean
|
||||
* title: discountable
|
||||
* description: The product's discountable.
|
||||
* images:
|
||||
* oneOf:
|
||||
* - type: array
|
||||
* description: The product's images.
|
||||
* items:
|
||||
* type: string
|
||||
* title: images
|
||||
* description: The image's images.
|
||||
* - type: array
|
||||
* description: The product's images.
|
||||
* items:
|
||||
* type: object
|
||||
* description: The image's images.
|
||||
* required:
|
||||
* - url
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The image's ID.
|
||||
* url:
|
||||
* type: string
|
||||
* title: url
|
||||
* description: The image's url.
|
||||
* thumbnail:
|
||||
* type: string
|
||||
* title: thumbnail
|
||||
* description: The product's thumbnail.
|
||||
* handle:
|
||||
* type: string
|
||||
* title: handle
|
||||
* description: The product's handle.
|
||||
* status:
|
||||
* type: string
|
||||
* enum:
|
||||
* - draft
|
||||
* - proposed
|
||||
* - published
|
||||
* - rejected
|
||||
* type:
|
||||
* $ref: "#/components/schemas/CreateProductType"
|
||||
* type_id:
|
||||
* type: string
|
||||
* title: type_id
|
||||
* description: The product's type id.
|
||||
* collection_id:
|
||||
* type: string
|
||||
* title: collection_id
|
||||
* description: The product's collection id.
|
||||
* tags:
|
||||
* type: array
|
||||
* description: The product's tags.
|
||||
* items:
|
||||
* type: object
|
||||
* description: The tag's tags.
|
||||
* x-schemaName: CreateProductTag
|
||||
* required:
|
||||
* - value
|
||||
* properties:
|
||||
* value:
|
||||
* type: string
|
||||
* title: value
|
||||
* description: The tag's value.
|
||||
* categories:
|
||||
* type: array
|
||||
* description: The product's categories.
|
||||
* items:
|
||||
* type: object
|
||||
* description: The category's categories.
|
||||
* required:
|
||||
* - id
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The category's ID.
|
||||
* options:
|
||||
* type: array
|
||||
* description: The product's options.
|
||||
* items:
|
||||
* type: object
|
||||
* description: The option's options.
|
||||
* x-schemaName: CreateProductOption
|
||||
* required:
|
||||
* - title
|
||||
* - values
|
||||
* properties:
|
||||
* title:
|
||||
* type: string
|
||||
* title: title
|
||||
* description: The option's title.
|
||||
* values:
|
||||
* oneOf:
|
||||
* - type: array
|
||||
* description: The option's values.
|
||||
* items:
|
||||
* type: string
|
||||
* title: values
|
||||
* description: The value's values.
|
||||
* - type: array
|
||||
* description: The option's values.
|
||||
* items:
|
||||
* type: object
|
||||
* description: The value's values.
|
||||
* required:
|
||||
* - value
|
||||
* properties:
|
||||
* value:
|
||||
* type: string
|
||||
* title: value
|
||||
* description: The value's details.
|
||||
* product_id:
|
||||
* type: string
|
||||
* title: product_id
|
||||
* description: The option's product id.
|
||||
* variants:
|
||||
* type: array
|
||||
* description: The product's variants.
|
||||
* items:
|
||||
* type: object
|
||||
* description: The variant's variants.
|
||||
* x-schemaName: UpsertProductVariant
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The variant's ID.
|
||||
* title:
|
||||
* type: string
|
||||
* title: title
|
||||
* description: The variant's title.
|
||||
* sku:
|
||||
* type: string
|
||||
* title: sku
|
||||
* description: The variant's sku.
|
||||
* barcode:
|
||||
* type: string
|
||||
* title: barcode
|
||||
* description: The variant's barcode.
|
||||
* ean:
|
||||
* type: string
|
||||
* title: ean
|
||||
* description: The variant's ean.
|
||||
* upc:
|
||||
* type: string
|
||||
* title: upc
|
||||
* description: The variant's upc.
|
||||
* allow_backorder:
|
||||
* type: boolean
|
||||
* title: allow_backorder
|
||||
* description: The variant's allow backorder.
|
||||
* inventory_quantity:
|
||||
* type: number
|
||||
* title: inventory_quantity
|
||||
* description: The variant's inventory quantity.
|
||||
* manage_inventory:
|
||||
* type: boolean
|
||||
* title: manage_inventory
|
||||
* description: The variant's manage inventory.
|
||||
* hs_code:
|
||||
* type: string
|
||||
* title: hs_code
|
||||
* description: The variant's hs code.
|
||||
* origin_country:
|
||||
* type: string
|
||||
* title: origin_country
|
||||
* description: The variant's origin country.
|
||||
* mid_code:
|
||||
* type: string
|
||||
* title: mid_code
|
||||
* description: The variant's mid code.
|
||||
* material:
|
||||
* type: string
|
||||
* title: material
|
||||
* description: The variant's material.
|
||||
* weight:
|
||||
* type: number
|
||||
* title: weight
|
||||
* description: The variant's weight.
|
||||
* length:
|
||||
* type: number
|
||||
* title: length
|
||||
* description: The variant's length.
|
||||
* height:
|
||||
* type: number
|
||||
* title: height
|
||||
* description: The variant's height.
|
||||
* width:
|
||||
* type: number
|
||||
* title: width
|
||||
* description: The variant's width.
|
||||
* options:
|
||||
* type: object
|
||||
* description: The variant's options.
|
||||
* properties: {}
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The variant's metadata.
|
||||
* properties: {}
|
||||
* width:
|
||||
* type: number
|
||||
* title: width
|
||||
* description: The product's width.
|
||||
* height:
|
||||
* type: number
|
||||
* title: height
|
||||
* description: The product's height.
|
||||
* length:
|
||||
* type: number
|
||||
* title: length
|
||||
* description: The product's length.
|
||||
* weight:
|
||||
* type: number
|
||||
* title: weight
|
||||
* description: The product's weight.
|
||||
* 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.
|
||||
* material:
|
||||
* type: string
|
||||
* title: material
|
||||
* description: The product's material.
|
||||
* mid_code:
|
||||
* type: string
|
||||
* title: mid_code
|
||||
* description: The product's mid code.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The product's metadata.
|
||||
* properties: {}
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,32 @@
|
||||
/**
|
||||
* @schema UpdateProductCollection
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: UpdateProductCollection
|
||||
* properties:
|
||||
* value:
|
||||
* type: string
|
||||
* title: value
|
||||
* description: The collection's value.
|
||||
* title:
|
||||
* type: string
|
||||
* title: title
|
||||
* description: The collection's title.
|
||||
* handle:
|
||||
* type: string
|
||||
* title: handle
|
||||
* description: The collection's handle.
|
||||
* product_ids:
|
||||
* type: array
|
||||
* description: The collection's product ids.
|
||||
* items:
|
||||
* type: string
|
||||
* title: product_ids
|
||||
* description: The product id's product ids.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The collection's metadata.
|
||||
* properties: {}
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
/**
|
||||
* @schema UpdateProductOption
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: UpdateProductOption
|
||||
* properties:
|
||||
* title:
|
||||
* type: string
|
||||
* title: title
|
||||
* description: The product's title.
|
||||
* values:
|
||||
* oneOf:
|
||||
* - type: array
|
||||
* description: The product's values.
|
||||
* items:
|
||||
* type: string
|
||||
* title: values
|
||||
* description: The value's values.
|
||||
* - type: array
|
||||
* description: The product's values.
|
||||
* items:
|
||||
* type: object
|
||||
* description: The value's values.
|
||||
* required:
|
||||
* - value
|
||||
* properties:
|
||||
* value:
|
||||
* type: string
|
||||
* title: value
|
||||
* description: The value's details.
|
||||
* product_id:
|
||||
* type: string
|
||||
* title: product_id
|
||||
* description: The product's product id.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,81 @@
|
||||
/**
|
||||
* @schema UpdateProductVariant
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: UpdateProductVariant
|
||||
* properties:
|
||||
* title:
|
||||
* type: string
|
||||
* title: title
|
||||
* description: The product's title.
|
||||
* sku:
|
||||
* type: string
|
||||
* title: sku
|
||||
* description: The product's sku.
|
||||
* barcode:
|
||||
* type: string
|
||||
* title: barcode
|
||||
* description: The product's barcode.
|
||||
* ean:
|
||||
* type: string
|
||||
* title: ean
|
||||
* description: The product's ean.
|
||||
* upc:
|
||||
* type: string
|
||||
* title: upc
|
||||
* description: The product's upc.
|
||||
* allow_backorder:
|
||||
* type: boolean
|
||||
* title: allow_backorder
|
||||
* description: The product's allow backorder.
|
||||
* inventory_quantity:
|
||||
* type: number
|
||||
* title: inventory_quantity
|
||||
* description: The product's inventory quantity.
|
||||
* manage_inventory:
|
||||
* type: boolean
|
||||
* title: manage_inventory
|
||||
* description: The product's manage inventory.
|
||||
* hs_code:
|
||||
* type: string
|
||||
* title: hs_code
|
||||
* description: The product's hs code.
|
||||
* origin_country:
|
||||
* type: string
|
||||
* title: origin_country
|
||||
* description: The product's origin country.
|
||||
* mid_code:
|
||||
* type: string
|
||||
* title: mid_code
|
||||
* description: The product's mid code.
|
||||
* material:
|
||||
* type: string
|
||||
* title: material
|
||||
* description: The product's material.
|
||||
* 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.
|
||||
* width:
|
||||
* type: number
|
||||
* title: width
|
||||
* description: The product's width.
|
||||
* options:
|
||||
* type: object
|
||||
* description: The product's options.
|
||||
* properties: {}
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The product's metadata.
|
||||
* properties: {}
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,32 @@
|
||||
/**
|
||||
* @schema UpdateRegion
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: UpdateRegion
|
||||
* properties:
|
||||
* name:
|
||||
* type: string
|
||||
* title: name
|
||||
* description: The region's name.
|
||||
* currency_code:
|
||||
* type: string
|
||||
* title: currency_code
|
||||
* description: The region's currency code.
|
||||
* automatic_taxes:
|
||||
* type: boolean
|
||||
* title: automatic_taxes
|
||||
* description: The region's automatic taxes.
|
||||
* countries:
|
||||
* type: array
|
||||
* description: The region's countries.
|
||||
* items:
|
||||
* type: string
|
||||
* title: countries
|
||||
* description: The country's countries.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The region's metadata.
|
||||
* properties: {}
|
||||
*
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user