chore(docs): Fix docblock-generator OAS tool's max-stack error (#7246)
* regenerate oas to fix duplicate keys * fix clean:oas script * fix max-stack errors * fix max-level condition
This commit is contained in:
Shahed Nasser
@@ -0,0 +1,31 @@
|
||||
/**
|
||||
* @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.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
/**
|
||||
* @schema AdminCustomerResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminCustomerResponse
|
||||
* required:
|
||||
* - customer
|
||||
* properties:
|
||||
* customer:
|
||||
* $ref: "#/components/schemas/CustomerResponse"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,43 @@
|
||||
/**
|
||||
* @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
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
/**
|
||||
* @schema AdminFulfillmentSetResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminFulfillmentSetResponse
|
||||
* required:
|
||||
* - fulfillment_set
|
||||
* properties:
|
||||
* fulfillment_set:
|
||||
* $ref: "#/components/schemas/FulfillmentSetResponse"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,25 @@
|
||||
/**
|
||||
* @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,9 @@
|
||||
/**
|
||||
* @schema AdminGeoZoneResponse
|
||||
* type: object
|
||||
* description: The geo zone's geo zones.
|
||||
* x-schemaName: AdminGeoZoneResponse
|
||||
* properties: {}
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -1,51 +0,0 @@
|
||||
/**
|
||||
* @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,35 @@
|
||||
/**
|
||||
* @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,31 @@
|
||||
/**
|
||||
* @schema AdminProductCategoryListResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminProductCategoryListResponse
|
||||
* required:
|
||||
* - product_categories
|
||||
* - limit
|
||||
* - offset
|
||||
* - count
|
||||
* properties:
|
||||
* product_categories:
|
||||
* type: array
|
||||
* description: The product category's product categories.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/ProductCategoryResponse"
|
||||
* limit:
|
||||
* type: number
|
||||
* title: limit
|
||||
* description: The product category's limit.
|
||||
* offset:
|
||||
* type: number
|
||||
* title: offset
|
||||
* description: The product category's offset.
|
||||
* count:
|
||||
* type: number
|
||||
* title: count
|
||||
* description: The product category's count.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
/**
|
||||
* @schema AdminProductCategoryResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminProductCategoryResponse
|
||||
* required:
|
||||
* - product_category
|
||||
* properties:
|
||||
* product_category:
|
||||
* $ref: "#/components/schemas/ProductCategoryResponse"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,28 @@
|
||||
/**
|
||||
* @schema AdminServiceZoneDeleteResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminServiceZoneDeleteResponse
|
||||
* required:
|
||||
* - id
|
||||
* - object
|
||||
* - deleted
|
||||
* - parent
|
||||
* 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.
|
||||
* parent:
|
||||
* $ref: "#/components/schemas/FulfillmentSetResponse"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
/**
|
||||
* @schema AdminServiceZoneResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminServiceZoneResponse
|
||||
* required:
|
||||
* - service_zone
|
||||
* properties:
|
||||
* service_zone:
|
||||
* $ref: "#/components/schemas/ServiceZoneResponse"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,25 @@
|
||||
/**
|
||||
* @schema AdminShippingOptionDeleteResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminShippingOptionDeleteResponse
|
||||
* required:
|
||||
* - id
|
||||
* - object
|
||||
* - deleted
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The shipping option's ID.
|
||||
* object:
|
||||
* type: string
|
||||
* title: object
|
||||
* description: The shipping option's object.
|
||||
* deleted:
|
||||
* type: boolean
|
||||
* title: deleted
|
||||
* description: The shipping option's deleted.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,31 @@
|
||||
/**
|
||||
* @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.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,98 @@
|
||||
/**
|
||||
* @schema AdminShippingOptionResponse
|
||||
* type: object
|
||||
* description: The shipping option's details.
|
||||
* 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
|
||||
* 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
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
/**
|
||||
* @schema AdminShippingOptionRetrieveResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminShippingOptionRetrieveResponse
|
||||
* required:
|
||||
* - shipping_option
|
||||
* properties:
|
||||
* shipping_option:
|
||||
* $ref: "#/components/schemas/AdminShippingOptionResponse"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,53 @@
|
||||
/**
|
||||
* @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
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,53 @@
|
||||
/**
|
||||
* @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,25 @@
|
||||
/**
|
||||
* @schema AdminShippingProfileDeleteResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminShippingProfileDeleteResponse
|
||||
* required:
|
||||
* - id
|
||||
* - object
|
||||
* - deleted
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The shipping profile's ID.
|
||||
* object:
|
||||
* type: string
|
||||
* title: object
|
||||
* description: The shipping profile's object.
|
||||
* deleted:
|
||||
* type: boolean
|
||||
* title: deleted
|
||||
* description: The shipping profile's deleted.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
/**
|
||||
* @schema AdminShippingProfileResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: AdminShippingProfileResponse
|
||||
* required:
|
||||
* - shipping_profile
|
||||
* properties:
|
||||
* shipping_profile:
|
||||
* $ref: "#/components/schemas/ShippingProfileResponse"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,31 @@
|
||||
/**
|
||||
* @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.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -1,119 +0,0 @@
|
||||
/**
|
||||
* @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,57 @@
|
||||
/**
|
||||
* @schema CreateAddress
|
||||
* 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: {}
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -1,21 +0,0 @@
|
||||
/**
|
||||
* @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,53 @@
|
||||
/**
|
||||
* @schema CreateCartAddress
|
||||
* 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: {}
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,104 @@
|
||||
/**
|
||||
* @schema CreateCartCreateLineItem
|
||||
* type: object
|
||||
* description: The item's items.
|
||||
* x-schemaName: CreateCartCreateLineItem
|
||||
* required:
|
||||
* - quantity
|
||||
* - variant_id
|
||||
* properties:
|
||||
* quantity:
|
||||
* type: string
|
||||
* 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: string
|
||||
* title: compare_at_unit_price
|
||||
* description: The item's compare at unit price.
|
||||
* unit_price:
|
||||
* type: string
|
||||
* title: unit_price
|
||||
* description: The item's unit price.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The item's metadata.
|
||||
* properties: {}
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -38,107 +38,13 @@
|
||||
* - 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: {}
|
||||
* - $ref: "#/components/schemas/CreateCartAddress"
|
||||
* 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: {}
|
||||
* - $ref: "#/components/schemas/CreateCartAddress"
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The cart's metadata.
|
||||
@@ -147,109 +53,7 @@
|
||||
* 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: {}
|
||||
* $ref: "#/components/schemas/CreateCartCreateLineItem"
|
||||
* promo_codes:
|
||||
* type: array
|
||||
* description: The cart's promo codes.
|
||||
|
||||
@@ -1,102 +0,0 @@
|
||||
/**
|
||||
* @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: {}
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -1,71 +0,0 @@
|
||||
/**
|
||||
* @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: {}
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -1,23 +0,0 @@
|
||||
/**
|
||||
* @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.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -1,27 +0,0 @@
|
||||
/**
|
||||
* @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: {}
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -1,24 +0,0 @@
|
||||
/**
|
||||
* @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: {}
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -9,55 +9,31 @@
|
||||
* title:
|
||||
* type: string
|
||||
* title: title
|
||||
* description: The product's title.
|
||||
* description: The upload's title.
|
||||
* subtitle:
|
||||
* type: string
|
||||
* title: subtitle
|
||||
* description: The product's subtitle.
|
||||
* description: The upload's subtitle.
|
||||
* description:
|
||||
* type: string
|
||||
* title: description
|
||||
* description: The product's description.
|
||||
* description: The upload's description.
|
||||
* is_giftcard:
|
||||
* type: boolean
|
||||
* title: is_giftcard
|
||||
* description: The product's is giftcard.
|
||||
* description: The upload'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.
|
||||
* description: The upload's discountable.
|
||||
* thumbnail:
|
||||
* type: string
|
||||
* title: thumbnail
|
||||
* description: The product's thumbnail.
|
||||
* description: The upload's thumbnail.
|
||||
* handle:
|
||||
* type: string
|
||||
* title: handle
|
||||
* description: The product's handle.
|
||||
* description: The upload's handle.
|
||||
* status:
|
||||
* type: string
|
||||
* enum:
|
||||
@@ -65,203 +41,76 @@
|
||||
* - proposed
|
||||
* - published
|
||||
* - rejected
|
||||
* type:
|
||||
* $ref: "#/components/schemas/CreateProductType"
|
||||
* images:
|
||||
* type: array
|
||||
* description: The upload's images.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/UpsertProductImage"
|
||||
* type_id:
|
||||
* type: string
|
||||
* title: type_id
|
||||
* description: The product's type id.
|
||||
* description: The upload's type id.
|
||||
* collection_id:
|
||||
* type: string
|
||||
* title: collection_id
|
||||
* description: The product's collection id.
|
||||
* description: The upload's collection id.
|
||||
* tags:
|
||||
* type: array
|
||||
* description: The product's tags.
|
||||
* description: The upload'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:
|
||||
* $ref: "#/components/schemas/UpsertProductTag"
|
||||
* category_ids:
|
||||
* type: array
|
||||
* description: The product's categories.
|
||||
* description: The upload's category ids.
|
||||
* items:
|
||||
* type: object
|
||||
* description: The category's categories.
|
||||
* required:
|
||||
* - id
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The category's ID.
|
||||
* type: string
|
||||
* title: category_ids
|
||||
* description: The category id's category ids.
|
||||
* options:
|
||||
* type: array
|
||||
* description: The product's options.
|
||||
* description: The upload'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.
|
||||
* $ref: "#/components/schemas/CreateProductOption"
|
||||
* variants:
|
||||
* type: array
|
||||
* description: The product's variants.
|
||||
* description: The upload'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: {}
|
||||
* $ref: "#/components/schemas/CreateProductVariant"
|
||||
* width:
|
||||
* type: number
|
||||
* title: width
|
||||
* description: The product's width.
|
||||
* description: The upload's width.
|
||||
* height:
|
||||
* type: number
|
||||
* title: height
|
||||
* description: The product's height.
|
||||
* description: The upload's height.
|
||||
* length:
|
||||
* type: number
|
||||
* title: length
|
||||
* description: The product's length.
|
||||
* description: The upload's length.
|
||||
* weight:
|
||||
* type: number
|
||||
* title: weight
|
||||
* description: The product's weight.
|
||||
* description: The upload's weight.
|
||||
* origin_country:
|
||||
* type: string
|
||||
* title: origin_country
|
||||
* description: The product's origin country.
|
||||
* description: The upload's origin country.
|
||||
* hs_code:
|
||||
* type: string
|
||||
* title: hs_code
|
||||
* description: The product's hs code.
|
||||
* description: The upload's hs code.
|
||||
* material:
|
||||
* type: string
|
||||
* title: material
|
||||
* description: The product's material.
|
||||
* description: The upload's material.
|
||||
* mid_code:
|
||||
* type: string
|
||||
* title: mid_code
|
||||
* description: The product's mid code.
|
||||
* description: The upload's mid code.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The product's metadata.
|
||||
* description: The upload's metadata.
|
||||
* properties: {}
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -1,30 +0,0 @@
|
||||
/**
|
||||
* @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: {}
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
/**
|
||||
* @schema CreateProductOption
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* description: The option's options.
|
||||
* x-schemaName: CreateProductOption
|
||||
* required:
|
||||
* - title
|
||||
@@ -10,31 +10,18 @@
|
||||
* title:
|
||||
* type: string
|
||||
* title: title
|
||||
* description: The product's title.
|
||||
* description: The option'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.
|
||||
* type: array
|
||||
* description: The option's values.
|
||||
* items:
|
||||
* type: string
|
||||
* title: values
|
||||
* description: The value's values.
|
||||
* product_id:
|
||||
* type: string
|
||||
* title: product_id
|
||||
* description: The product's product id.
|
||||
* description: The option's product id.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
/**
|
||||
* @schema CreateProductVariant
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* description: The variant's variants.
|
||||
* x-schemaName: CreateProductVariant
|
||||
* required:
|
||||
* - title
|
||||
@@ -9,78 +9,78 @@
|
||||
* product_id:
|
||||
* type: string
|
||||
* title: product_id
|
||||
* description: The product's product id.
|
||||
* description: The variant's product id.
|
||||
* title:
|
||||
* type: string
|
||||
* title: title
|
||||
* description: The product's title.
|
||||
* description: The variant's title.
|
||||
* sku:
|
||||
* type: string
|
||||
* title: sku
|
||||
* description: The product's sku.
|
||||
* description: The variant's sku.
|
||||
* barcode:
|
||||
* type: string
|
||||
* title: barcode
|
||||
* description: The product's barcode.
|
||||
* description: The variant's barcode.
|
||||
* ean:
|
||||
* type: string
|
||||
* title: ean
|
||||
* description: The product's ean.
|
||||
* description: The variant's ean.
|
||||
* upc:
|
||||
* type: string
|
||||
* title: upc
|
||||
* description: The product's upc.
|
||||
* description: The variant's upc.
|
||||
* allow_backorder:
|
||||
* type: boolean
|
||||
* title: allow_backorder
|
||||
* description: The product's allow backorder.
|
||||
* description: The variant's allow backorder.
|
||||
* inventory_quantity:
|
||||
* type: number
|
||||
* title: inventory_quantity
|
||||
* description: The product's inventory quantity.
|
||||
* description: The variant's inventory quantity.
|
||||
* manage_inventory:
|
||||
* type: boolean
|
||||
* title: manage_inventory
|
||||
* description: The product's manage inventory.
|
||||
* description: The variant's manage inventory.
|
||||
* hs_code:
|
||||
* type: string
|
||||
* title: hs_code
|
||||
* description: The product's hs code.
|
||||
* description: The variant's hs code.
|
||||
* origin_country:
|
||||
* type: string
|
||||
* title: origin_country
|
||||
* description: The product's origin country.
|
||||
* description: The variant's origin country.
|
||||
* mid_code:
|
||||
* type: string
|
||||
* title: mid_code
|
||||
* description: The product's mid code.
|
||||
* description: The variant's mid code.
|
||||
* material:
|
||||
* type: string
|
||||
* title: material
|
||||
* description: The product's material.
|
||||
* description: The variant's material.
|
||||
* weight:
|
||||
* type: number
|
||||
* title: weight
|
||||
* description: The product's weight.
|
||||
* description: The variant's weight.
|
||||
* length:
|
||||
* type: number
|
||||
* title: length
|
||||
* description: The product's length.
|
||||
* description: The variant's length.
|
||||
* height:
|
||||
* type: number
|
||||
* title: height
|
||||
* description: The product's height.
|
||||
* description: The variant's height.
|
||||
* width:
|
||||
* type: number
|
||||
* title: width
|
||||
* description: The product's width.
|
||||
* description: The variant's width.
|
||||
* options:
|
||||
* type: object
|
||||
* description: The product's options.
|
||||
* description: The variant's options.
|
||||
* properties: {}
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The product's metadata.
|
||||
* description: The variant's metadata.
|
||||
* properties: {}
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -1,74 +0,0 @@
|
||||
/**
|
||||
* @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.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -1,35 +0,0 @@
|
||||
/**
|
||||
* @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: {}
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -1,23 +0,0 @@
|
||||
/**
|
||||
* @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,93 @@
|
||||
/**
|
||||
* @schema 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
|
||||
* has_account:
|
||||
* type: boolean
|
||||
* title: has_account
|
||||
* description: The customer's has account.
|
||||
* 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:
|
||||
* $ref: "#/components/schemas/CustomerAddress"
|
||||
* 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
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -1,81 +1,9 @@
|
||||
/**
|
||||
* @schema CustomerAddress
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* description: The address's addresses.
|
||||
* 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.
|
||||
* properties: {}
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -0,0 +1,100 @@
|
||||
/**
|
||||
* @schema CustomerAddressResponse
|
||||
* type: object
|
||||
* description: The address's addresses.
|
||||
* x-schemaName: CustomerAddressResponse
|
||||
* required:
|
||||
* - id
|
||||
* - address_name
|
||||
* - is_default_shipping
|
||||
* - is_default_billing
|
||||
* - customer_id
|
||||
* - company
|
||||
* - first_name
|
||||
* - last_name
|
||||
* - address_1
|
||||
* - address_2
|
||||
* - city
|
||||
* - country_code
|
||||
* - province
|
||||
* - postal_code
|
||||
* - phone
|
||||
* - metadata
|
||||
* - created_at
|
||||
* - updated_at
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The address's ID.
|
||||
* address_name:
|
||||
* type: string
|
||||
* title: address_name
|
||||
* description: The address's address name.
|
||||
* is_default_shipping:
|
||||
* type: boolean
|
||||
* title: is_default_shipping
|
||||
* description: The address's is default shipping.
|
||||
* is_default_billing:
|
||||
* type: boolean
|
||||
* title: is_default_billing
|
||||
* description: The address's is default billing.
|
||||
* customer_id:
|
||||
* type: string
|
||||
* title: customer_id
|
||||
* description: The address's customer id.
|
||||
* company:
|
||||
* type: string
|
||||
* title: company
|
||||
* description: The address's company.
|
||||
* first_name:
|
||||
* type: string
|
||||
* title: first_name
|
||||
* description: The address's first name.
|
||||
* last_name:
|
||||
* type: string
|
||||
* title: last_name
|
||||
* description: The address's last name.
|
||||
* address_1:
|
||||
* type: string
|
||||
* title: address_1
|
||||
* description: The address's address 1.
|
||||
* address_2:
|
||||
* type: string
|
||||
* title: address_2
|
||||
* description: The address's address 2.
|
||||
* city:
|
||||
* type: string
|
||||
* title: city
|
||||
* description: The address's city.
|
||||
* country_code:
|
||||
* type: string
|
||||
* title: country_code
|
||||
* description: The address's country code.
|
||||
* province:
|
||||
* type: string
|
||||
* title: province
|
||||
* description: The address's province.
|
||||
* postal_code:
|
||||
* type: string
|
||||
* title: postal_code
|
||||
* description: The address's postal code.
|
||||
* phone:
|
||||
* type: string
|
||||
* title: phone
|
||||
* description: The address's phone.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The address's metadata.
|
||||
* properties: {}
|
||||
* created_at:
|
||||
* type: string
|
||||
* title: created_at
|
||||
* description: The address's created at.
|
||||
* updated_at:
|
||||
* type: string
|
||||
* title: updated_at
|
||||
* description: The address's updated at.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,41 @@
|
||||
/**
|
||||
* @schema CustomerGroupResponse
|
||||
* type: object
|
||||
* description: The group's groups.
|
||||
* x-schemaName: CustomerGroupResponse
|
||||
* required:
|
||||
* - id
|
||||
* - name
|
||||
* - customers
|
||||
* - metadata
|
||||
* - created_at
|
||||
* - updated_at
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The group's ID.
|
||||
* name:
|
||||
* type: string
|
||||
* title: name
|
||||
* description: The group's name.
|
||||
* customers:
|
||||
* type: array
|
||||
* description: The group's customers.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/CustomerResponse"
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The group's metadata.
|
||||
* properties: {}
|
||||
* created_at:
|
||||
* type: string
|
||||
* title: created_at
|
||||
* description: The group's created at.
|
||||
* updated_at:
|
||||
* type: string
|
||||
* title: updated_at
|
||||
* description: The group's updated at.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -1,17 +0,0 @@
|
||||
/**
|
||||
* @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,101 @@
|
||||
/**
|
||||
* @schema CustomerResponse
|
||||
* type: object
|
||||
* description: The customer's details.
|
||||
* x-schemaName: CustomerResponse
|
||||
* required:
|
||||
* - id
|
||||
* - email
|
||||
* - default_billing_address_id
|
||||
* - default_shipping_address_id
|
||||
* - company_name
|
||||
* - first_name
|
||||
* - last_name
|
||||
* - has_account
|
||||
* - addresses
|
||||
* 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.
|
||||
* 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"
|
||||
* 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
|
||||
* 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
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -1,34 +0,0 @@
|
||||
/**
|
||||
* @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,54 @@
|
||||
/**
|
||||
* @schema FulfillmentSetResponse
|
||||
* type: object
|
||||
* description: The fulfillment set's parent.
|
||||
* x-schemaName: FulfillmentSetResponse
|
||||
* required:
|
||||
* - id
|
||||
* - name
|
||||
* - type
|
||||
* - metadata
|
||||
* - service_zones
|
||||
* - created_at
|
||||
* - updated_at
|
||||
* - deleted_at
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The parent's ID.
|
||||
* name:
|
||||
* type: string
|
||||
* title: name
|
||||
* description: The parent's name.
|
||||
* type:
|
||||
* type: string
|
||||
* title: type
|
||||
* description: The parent's type.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The parent's metadata.
|
||||
* properties: {}
|
||||
* service_zones:
|
||||
* type: array
|
||||
* description: The parent's service zones.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/ServiceZoneResponse"
|
||||
* created_at:
|
||||
* type: string
|
||||
* title: created_at
|
||||
* description: The parent's created at.
|
||||
* format: date-time
|
||||
* updated_at:
|
||||
* type: string
|
||||
* title: updated_at
|
||||
* description: The parent's updated at.
|
||||
* format: date-time
|
||||
* deleted_at:
|
||||
* type: string
|
||||
* title: deleted_at
|
||||
* description: The parent's deleted at.
|
||||
* format: date-time
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,79 @@
|
||||
/**
|
||||
* @schema ProductCategoryResponse
|
||||
* type: object
|
||||
* description: The product category's details.
|
||||
* x-schemaName: ProductCategoryResponse
|
||||
* required:
|
||||
* - id
|
||||
* - name
|
||||
* - description
|
||||
* - handle
|
||||
* - is_active
|
||||
* - is_internal
|
||||
* - rank
|
||||
* - parent_category_id
|
||||
* - created_at
|
||||
* - updated_at
|
||||
* - parent_category
|
||||
* - category_children
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The product category's ID.
|
||||
* name:
|
||||
* type: string
|
||||
* title: name
|
||||
* description: The product category's name.
|
||||
* description:
|
||||
* type: string
|
||||
* title: description
|
||||
* description: The product category's description.
|
||||
* handle:
|
||||
* type: string
|
||||
* title: handle
|
||||
* description: The product category's handle.
|
||||
* is_active:
|
||||
* type: boolean
|
||||
* title: is_active
|
||||
* description: The product category's is active.
|
||||
* is_internal:
|
||||
* type: boolean
|
||||
* title: is_internal
|
||||
* description: The product category's is internal.
|
||||
* rank:
|
||||
* type: number
|
||||
* title: rank
|
||||
* description: The product category's rank.
|
||||
* parent_category_id:
|
||||
* type: string
|
||||
* title: parent_category_id
|
||||
* description: The product category's parent category id.
|
||||
* created_at:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: created_at
|
||||
* description: The product category's created at.
|
||||
* - type: string
|
||||
* title: created_at
|
||||
* description: The product category's created at.
|
||||
* format: date-time
|
||||
* updated_at:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: updated_at
|
||||
* description: The product category's updated at.
|
||||
* - type: string
|
||||
* title: updated_at
|
||||
* description: The product category's updated at.
|
||||
* format: date-time
|
||||
* parent_category:
|
||||
* $ref: "#/components/schemas/ProductCategoryResponse"
|
||||
* category_children:
|
||||
* type: array
|
||||
* description: The product category's category children.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/ProductCategoryResponse"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,49 @@
|
||||
/**
|
||||
* @schema ServiceZoneResponse
|
||||
* type: object
|
||||
* description: The service zone's service zones.
|
||||
* x-schemaName: ServiceZoneResponse
|
||||
* required:
|
||||
* - id
|
||||
* - name
|
||||
* - metadata
|
||||
* - geo_zones
|
||||
* - created_at
|
||||
* - updated_at
|
||||
* - deleted_at
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The service zone's ID.
|
||||
* name:
|
||||
* type: string
|
||||
* title: name
|
||||
* description: The service zone's name.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The service zone's metadata.
|
||||
* properties: {}
|
||||
* geo_zones:
|
||||
* type: array
|
||||
* description: The service zone's geo zones.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/AdminGeoZoneResponse"
|
||||
* created_at:
|
||||
* type: string
|
||||
* title: created_at
|
||||
* description: The service zone's created at.
|
||||
* format: date-time
|
||||
* updated_at:
|
||||
* type: string
|
||||
* title: updated_at
|
||||
* description: The service zone's updated at.
|
||||
* format: date-time
|
||||
* deleted_at:
|
||||
* type: string
|
||||
* title: deleted_at
|
||||
* description: The service zone's deleted at.
|
||||
* format: date-time
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,48 @@
|
||||
/**
|
||||
* @schema ShippingProfileResponse
|
||||
* type: object
|
||||
* description: The shipping profile's details.
|
||||
* x-schemaName: ShippingProfileResponse
|
||||
* required:
|
||||
* - id
|
||||
* - name
|
||||
* - type
|
||||
* - metadata
|
||||
* - created_at
|
||||
* - updated_at
|
||||
* - deleted_at
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The shipping profile's ID.
|
||||
* name:
|
||||
* type: string
|
||||
* title: name
|
||||
* description: The shipping profile's name.
|
||||
* type:
|
||||
* type: string
|
||||
* title: type
|
||||
* description: The shipping profile's type.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The shipping profile's metadata.
|
||||
* properties: {}
|
||||
* created_at:
|
||||
* type: string
|
||||
* title: created_at
|
||||
* description: The shipping profile's created at.
|
||||
* format: date-time
|
||||
* updated_at:
|
||||
* type: string
|
||||
* title: updated_at
|
||||
* description: The shipping profile's updated at.
|
||||
* format: date-time
|
||||
* deleted_at:
|
||||
* type: string
|
||||
* title: deleted_at
|
||||
* description: The shipping profile's deleted at.
|
||||
* format: date-time
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -1,44 +0,0 @@
|
||||
/**
|
||||
* @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.
|
||||
*
|
||||
*/
|
||||
|
||||
+5
-4
@@ -108,6 +108,10 @@
|
||||
* title: email
|
||||
* description: The customer's email.
|
||||
* format: email
|
||||
* has_account:
|
||||
* type: boolean
|
||||
* title: has_account
|
||||
* description: The customer's has account.
|
||||
* default_billing_address_id:
|
||||
* type: string
|
||||
* title: default_billing_address_id
|
||||
@@ -132,10 +136,7 @@
|
||||
* type: array
|
||||
* description: The customer's addresses.
|
||||
* items:
|
||||
* type: object
|
||||
* description: The address's addresses.
|
||||
* x-schemaName: CustomerAddress
|
||||
* properties: {}
|
||||
* $ref: "#/components/schemas/CustomerAddress"
|
||||
* phone:
|
||||
* type: string
|
||||
* title: phone
|
||||
|
||||
@@ -0,0 +1,31 @@
|
||||
/**
|
||||
* @schema StoreProductCategoryListResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: StoreProductCategoryListResponse
|
||||
* required:
|
||||
* - product_categories
|
||||
* - limit
|
||||
* - offset
|
||||
* - count
|
||||
* properties:
|
||||
* product_categories:
|
||||
* type: array
|
||||
* description: The product category's product categories.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/ProductCategoryResponse"
|
||||
* limit:
|
||||
* type: number
|
||||
* title: limit
|
||||
* description: The product category's limit.
|
||||
* offset:
|
||||
* type: number
|
||||
* title: offset
|
||||
* description: The product category's offset.
|
||||
* count:
|
||||
* type: number
|
||||
* title: count
|
||||
* description: The product category's count.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
/**
|
||||
* @schema StoreProductCategoryResponse
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: StoreProductCategoryResponse
|
||||
* required:
|
||||
* - product_category
|
||||
* properties:
|
||||
* product_category:
|
||||
* $ref: "#/components/schemas/ProductCategoryResponse"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,63 @@
|
||||
/**
|
||||
* @schema UpdateAddress
|
||||
* 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: {}
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -1,13 +0,0 @@
|
||||
/**
|
||||
* @schema UpdateApiKey
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* x-schemaName: UpdateApiKey
|
||||
* properties:
|
||||
* title:
|
||||
* type: string
|
||||
* title: title
|
||||
* description: The api key's title.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -35,228 +35,12 @@
|
||||
* 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: {}
|
||||
* - $ref: "#/components/schemas/CreateAddress"
|
||||
* - $ref: "#/components/schemas/UpdateAddress"
|
||||
* 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: {}
|
||||
* - $ref: "#/components/schemas/CreateAddress"
|
||||
* - $ref: "#/components/schemas/UpdateAddress"
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The cart's metadata.
|
||||
|
||||
@@ -1,264 +0,0 @@
|
||||
/**
|
||||
* @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: {}
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -1,32 +0,0 @@
|
||||
/**
|
||||
* @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: {}
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -1,37 +0,0 @@
|
||||
/**
|
||||
* @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.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -1,81 +0,0 @@
|
||||
/**
|
||||
* @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: {}
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -1,32 +0,0 @@
|
||||
/**
|
||||
* @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: {}
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,21 @@
|
||||
/**
|
||||
* @schema UpsertProductImage
|
||||
* type: object
|
||||
* description: The image's images.
|
||||
* x-schemaName: UpsertProductImage
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The image's ID.
|
||||
* url:
|
||||
* type: string
|
||||
* title: url
|
||||
* description: The image's url.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The image's metadata.
|
||||
* properties: {}
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,17 @@
|
||||
/**
|
||||
* @schema UpsertProductTag
|
||||
* type: object
|
||||
* description: The tag's tags.
|
||||
* x-schemaName: UpsertProductTag
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The tag's ID.
|
||||
* value:
|
||||
* type: string
|
||||
* title: value
|
||||
* description: The tag's value.
|
||||
*
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user