chore: reorganize docs apps (#7228)
* reorganize docs apps * add README * fix directory * add condition for old docs
This commit is contained in:
Shahed Nasser
@@ -0,0 +1,5 @@
|
||||
summary: Database Error
|
||||
value:
|
||||
code: api_error
|
||||
message: An error occured while hashing password
|
||||
type: database_error
|
||||
@@ -0,0 +1,5 @@
|
||||
summary: Default Error
|
||||
value:
|
||||
code: unknown_error
|
||||
message: An unknown error occurred.
|
||||
type: unknown_error
|
||||
@@ -0,0 +1,4 @@
|
||||
summary: Invalid Argument Error
|
||||
value:
|
||||
message: cart.total must be defined
|
||||
type: unexpected_state
|
||||
@@ -0,0 +1,4 @@
|
||||
summary: Invalid Data Error
|
||||
value:
|
||||
message: first_name must be a string
|
||||
type: invalid_data
|
||||
@@ -0,0 +1,10 @@
|
||||
summary: Multiple Errors
|
||||
value:
|
||||
message: >-
|
||||
Provided request body contains errors. Please check the data and retry the
|
||||
request
|
||||
errors:
|
||||
- message: first_name must be a string
|
||||
type: invalid_data
|
||||
- message: Discount must be set to dynamic
|
||||
type: not_allowed
|
||||
@@ -0,0 +1,4 @@
|
||||
summary: Not Allowed Error
|
||||
value:
|
||||
message: Discount must be set to dynamic
|
||||
type: not_allowed
|
||||
@@ -0,0 +1,4 @@
|
||||
summary: Unexpected State Error
|
||||
value:
|
||||
message: cart.total must be defined
|
||||
type: unexpected_state
|
||||
@@ -0,0 +1,14 @@
|
||||
description: Client Error or Multiple Errors
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: ../schemas/Error.yaml
|
||||
- $ref: ../schemas/MultipleErrors.yaml
|
||||
examples:
|
||||
not_allowed:
|
||||
$ref: ../examples/not_allowed_error.yaml
|
||||
invalid_data:
|
||||
$ref: ../examples/invalid_data_error.yaml
|
||||
MultipleErrors:
|
||||
$ref: ../examples/multiple_errors.yaml
|
||||
@@ -0,0 +1,14 @@
|
||||
description: Server Error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../schemas/Error.yaml
|
||||
examples:
|
||||
database:
|
||||
$ref: ../examples/database_error.yaml
|
||||
unexpected_state:
|
||||
$ref: ../examples/unexpected_state_error.yaml
|
||||
invalid_argument:
|
||||
$ref: ../examples/invalid_argument_error.yaml
|
||||
default_error:
|
||||
$ref: ../examples/default_error.yaml
|
||||
@@ -0,0 +1,9 @@
|
||||
description: Default Error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../schemas/Error.yaml
|
||||
example:
|
||||
code: unknown_error
|
||||
message: An unknown error occurred.
|
||||
type: unknown_error
|
||||
@@ -0,0 +1,7 @@
|
||||
description: User does not exist or incorrect credentials
|
||||
content:
|
||||
text/plain:
|
||||
schema:
|
||||
type: string
|
||||
default: Unauthorized
|
||||
example: Unauthorized
|
||||
@@ -0,0 +1,9 @@
|
||||
description: Invalid Request Error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../schemas/Error.yaml
|
||||
example:
|
||||
code: invalid_request_error
|
||||
message: Discount with code TEST already exists.
|
||||
type: duplicate_error
|
||||
@@ -0,0 +1,11 @@
|
||||
description: Invalid State Error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../schemas/Error.yaml
|
||||
example:
|
||||
code: unknown_error
|
||||
message: >-
|
||||
The request conflicted with another request. You may retry the request
|
||||
with the provided Idempotency-Key.
|
||||
type: QueryRunnerAlreadyReleasedError
|
||||
@@ -0,0 +1,8 @@
|
||||
description: Not Found Error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../schemas/Error.yaml
|
||||
example:
|
||||
message: Entity with id 1 was not found
|
||||
type: not_found
|
||||
@@ -0,0 +1,7 @@
|
||||
description: User is not authorized. Must log in first
|
||||
content:
|
||||
text/plain:
|
||||
schema:
|
||||
type: string
|
||||
default: Unauthorized
|
||||
example: Unauthorized
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminDeletePricingRuleTypesRuleTypeReq
|
||||
properties: {}
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminGetPricingRuleTypesParams
|
||||
properties:
|
||||
rule_attribute:
|
||||
type: array
|
||||
description: The pricing's rule attribute.
|
||||
items:
|
||||
type: string
|
||||
title: rule_attribute
|
||||
description: The rule attribute's details.
|
||||
expand:
|
||||
type: string
|
||||
title: expand
|
||||
description: The pricing's expand.
|
||||
fields:
|
||||
type: string
|
||||
title: fields
|
||||
description: The pricing's fields.
|
||||
offset:
|
||||
type: number
|
||||
title: offset
|
||||
description: The pricing's offset.
|
||||
limit:
|
||||
type: number
|
||||
title: limit
|
||||
description: The pricing's limit.
|
||||
order:
|
||||
type: string
|
||||
title: order
|
||||
description: The pricing's order.
|
||||
+12
@@ -0,0 +1,12 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminGetPricingRuleTypesRuleTypeParams
|
||||
properties:
|
||||
expand:
|
||||
type: string
|
||||
title: expand
|
||||
description: The pricing's expand.
|
||||
fields:
|
||||
type: string
|
||||
title: fields
|
||||
description: The pricing's fields.
|
||||
@@ -0,0 +1,767 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminGetProductsParams
|
||||
properties:
|
||||
q:
|
||||
type: string
|
||||
title: q
|
||||
description: The product's q.
|
||||
id:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: id
|
||||
description: The product's ID.
|
||||
- type: array
|
||||
description: The product's ID.
|
||||
items:
|
||||
type: string
|
||||
title: id
|
||||
description: The id's ID.
|
||||
status:
|
||||
type: array
|
||||
description: The product's status.
|
||||
items: {}
|
||||
title:
|
||||
type: string
|
||||
title: title
|
||||
description: The product's title.
|
||||
handle:
|
||||
type: string
|
||||
title: handle
|
||||
description: The product's handle.
|
||||
is_giftcard:
|
||||
type: boolean
|
||||
title: is_giftcard
|
||||
description: The product's is giftcard.
|
||||
price_list_id:
|
||||
type: array
|
||||
description: The product's price list id.
|
||||
items:
|
||||
type: string
|
||||
title: price_list_id
|
||||
description: The price list id's details.
|
||||
sales_channel_id:
|
||||
type: array
|
||||
description: The product's sales channel id.
|
||||
items:
|
||||
type: string
|
||||
title: sales_channel_id
|
||||
description: The sales channel id's details.
|
||||
collection_id:
|
||||
type: array
|
||||
description: The product's collection id.
|
||||
items:
|
||||
type: string
|
||||
title: collection_id
|
||||
description: The collection id's details.
|
||||
tags:
|
||||
type: array
|
||||
description: The product's tags.
|
||||
items:
|
||||
type: string
|
||||
title: tags
|
||||
description: The tag's tags.
|
||||
type_id:
|
||||
type: array
|
||||
description: The product's type id.
|
||||
items:
|
||||
type: string
|
||||
title: type_id
|
||||
description: The type id's details.
|
||||
variants:
|
||||
type: object
|
||||
description: The product's variants.
|
||||
properties: {}
|
||||
created_at: {}
|
||||
updated_at: {}
|
||||
deleted_at: {}
|
||||
$and:
|
||||
type: array
|
||||
description: The product's $and.
|
||||
items:
|
||||
type: object
|
||||
description: The $and's details.
|
||||
x-schemaName: AdminGetProductsParams
|
||||
properties:
|
||||
q:
|
||||
type: string
|
||||
title: q
|
||||
description: The $and's q.
|
||||
id:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: id
|
||||
description: The $and's ID.
|
||||
- type: array
|
||||
description: The $and's ID.
|
||||
items:
|
||||
type: string
|
||||
title: id
|
||||
description: The id's ID.
|
||||
status:
|
||||
type: array
|
||||
description: The $and's status.
|
||||
items: {}
|
||||
title:
|
||||
type: string
|
||||
title: title
|
||||
description: The $and's title.
|
||||
handle:
|
||||
type: string
|
||||
title: handle
|
||||
description: The $and's handle.
|
||||
is_giftcard:
|
||||
type: boolean
|
||||
title: is_giftcard
|
||||
description: The $and's is giftcard.
|
||||
price_list_id:
|
||||
type: array
|
||||
description: The $and's price list id.
|
||||
items:
|
||||
type: string
|
||||
title: price_list_id
|
||||
description: The price list id's details.
|
||||
sales_channel_id:
|
||||
type: array
|
||||
description: The $and's sales channel id.
|
||||
items:
|
||||
type: string
|
||||
title: sales_channel_id
|
||||
description: The sales channel id's details.
|
||||
collection_id:
|
||||
type: array
|
||||
description: The $and's collection id.
|
||||
items:
|
||||
type: string
|
||||
title: collection_id
|
||||
description: The collection id's details.
|
||||
tags:
|
||||
type: array
|
||||
description: The $and's tags.
|
||||
items:
|
||||
type: string
|
||||
title: tags
|
||||
description: The tag's tags.
|
||||
type_id:
|
||||
type: array
|
||||
description: The $and's type id.
|
||||
items:
|
||||
type: string
|
||||
title: type_id
|
||||
description: The type id's details.
|
||||
variants:
|
||||
type: object
|
||||
description: The $and's variants.
|
||||
properties: {}
|
||||
created_at: {}
|
||||
updated_at: {}
|
||||
deleted_at: {}
|
||||
$and:
|
||||
type: array
|
||||
description: The $and's details.
|
||||
items:
|
||||
type: object
|
||||
description: The $and's details.
|
||||
x-schemaName: AdminGetProductsParams
|
||||
properties:
|
||||
q:
|
||||
type: string
|
||||
title: q
|
||||
description: The $and's q.
|
||||
id:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: id
|
||||
description: The $and's ID.
|
||||
- type: array
|
||||
description: The $and's ID.
|
||||
items:
|
||||
type: string
|
||||
title: id
|
||||
description: The id's ID.
|
||||
status:
|
||||
type: array
|
||||
description: The $and's status.
|
||||
items: {}
|
||||
title:
|
||||
type: string
|
||||
title: title
|
||||
description: The $and's title.
|
||||
handle:
|
||||
type: string
|
||||
title: handle
|
||||
description: The $and's handle.
|
||||
is_giftcard:
|
||||
type: boolean
|
||||
title: is_giftcard
|
||||
description: The $and's is giftcard.
|
||||
price_list_id:
|
||||
type: array
|
||||
description: The $and's price list id.
|
||||
items:
|
||||
type: string
|
||||
title: price_list_id
|
||||
description: The price list id's details.
|
||||
sales_channel_id:
|
||||
type: array
|
||||
description: The $and's sales channel id.
|
||||
items:
|
||||
type: string
|
||||
title: sales_channel_id
|
||||
description: The sales channel id's details.
|
||||
collection_id:
|
||||
type: array
|
||||
description: The $and's collection id.
|
||||
items:
|
||||
type: string
|
||||
title: collection_id
|
||||
description: The collection id's details.
|
||||
tags:
|
||||
type: array
|
||||
description: The $and's tags.
|
||||
items:
|
||||
type: string
|
||||
title: tags
|
||||
description: The tag's tags.
|
||||
type_id:
|
||||
type: array
|
||||
description: The $and's type id.
|
||||
items:
|
||||
type: string
|
||||
title: type_id
|
||||
description: The type id's details.
|
||||
variants:
|
||||
type: object
|
||||
description: The $and's variants.
|
||||
properties: {}
|
||||
created_at: {}
|
||||
updated_at: {}
|
||||
deleted_at: {}
|
||||
$and:
|
||||
type: array
|
||||
description: The $and's details.
|
||||
items:
|
||||
type: object
|
||||
description: The $and's details.
|
||||
x-schemaName: AdminGetProductsParams
|
||||
properties: {}
|
||||
$or:
|
||||
type: array
|
||||
description: The $and's $or.
|
||||
items:
|
||||
type: object
|
||||
description: The $or's details.
|
||||
x-schemaName: AdminGetProductsParams
|
||||
properties: {}
|
||||
expand:
|
||||
type: string
|
||||
title: expand
|
||||
description: The $and's expand.
|
||||
fields:
|
||||
type: string
|
||||
title: fields
|
||||
description: The $and's fields.
|
||||
offset:
|
||||
type: number
|
||||
title: offset
|
||||
description: The $and's offset.
|
||||
limit:
|
||||
type: number
|
||||
title: limit
|
||||
description: The $and's limit.
|
||||
order:
|
||||
type: string
|
||||
title: order
|
||||
description: The $and's order.
|
||||
$or:
|
||||
type: array
|
||||
description: The $and's $or.
|
||||
items:
|
||||
type: object
|
||||
description: The $or's details.
|
||||
x-schemaName: AdminGetProductsParams
|
||||
properties:
|
||||
q:
|
||||
type: string
|
||||
title: q
|
||||
description: The $or's q.
|
||||
id:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: id
|
||||
description: The $or's ID.
|
||||
- type: array
|
||||
description: The $or's ID.
|
||||
items:
|
||||
type: string
|
||||
title: id
|
||||
description: The id's ID.
|
||||
status:
|
||||
type: array
|
||||
description: The $or's status.
|
||||
items: {}
|
||||
title:
|
||||
type: string
|
||||
title: title
|
||||
description: The $or's title.
|
||||
handle:
|
||||
type: string
|
||||
title: handle
|
||||
description: The $or's handle.
|
||||
is_giftcard:
|
||||
type: boolean
|
||||
title: is_giftcard
|
||||
description: The $or's is giftcard.
|
||||
price_list_id:
|
||||
type: array
|
||||
description: The $or's price list id.
|
||||
items:
|
||||
type: string
|
||||
title: price_list_id
|
||||
description: The price list id's details.
|
||||
sales_channel_id:
|
||||
type: array
|
||||
description: The $or's sales channel id.
|
||||
items:
|
||||
type: string
|
||||
title: sales_channel_id
|
||||
description: The sales channel id's details.
|
||||
collection_id:
|
||||
type: array
|
||||
description: The $or's collection id.
|
||||
items:
|
||||
type: string
|
||||
title: collection_id
|
||||
description: The collection id's details.
|
||||
tags:
|
||||
type: array
|
||||
description: The $or's tags.
|
||||
items:
|
||||
type: string
|
||||
title: tags
|
||||
description: The tag's tags.
|
||||
type_id:
|
||||
type: array
|
||||
description: The $or's type id.
|
||||
items:
|
||||
type: string
|
||||
title: type_id
|
||||
description: The type id's details.
|
||||
variants:
|
||||
type: object
|
||||
description: The $or's variants.
|
||||
properties: {}
|
||||
created_at: {}
|
||||
updated_at: {}
|
||||
deleted_at: {}
|
||||
$and:
|
||||
type: array
|
||||
description: The $or's $and.
|
||||
items:
|
||||
type: object
|
||||
description: The $and's details.
|
||||
x-schemaName: AdminGetProductsParams
|
||||
properties: {}
|
||||
$or:
|
||||
type: array
|
||||
description: The $or's details.
|
||||
items:
|
||||
type: object
|
||||
description: The $or's details.
|
||||
x-schemaName: AdminGetProductsParams
|
||||
properties: {}
|
||||
expand:
|
||||
type: string
|
||||
title: expand
|
||||
description: The $or's expand.
|
||||
fields:
|
||||
type: string
|
||||
title: fields
|
||||
description: The $or's fields.
|
||||
offset:
|
||||
type: number
|
||||
title: offset
|
||||
description: The $or's offset.
|
||||
limit:
|
||||
type: number
|
||||
title: limit
|
||||
description: The $or's limit.
|
||||
order:
|
||||
type: string
|
||||
title: order
|
||||
description: The $or's order.
|
||||
expand:
|
||||
type: string
|
||||
title: expand
|
||||
description: The $and's expand.
|
||||
fields:
|
||||
type: string
|
||||
title: fields
|
||||
description: The $and's fields.
|
||||
offset:
|
||||
type: number
|
||||
title: offset
|
||||
description: The $and's offset.
|
||||
limit:
|
||||
type: number
|
||||
title: limit
|
||||
description: The $and's limit.
|
||||
order:
|
||||
type: string
|
||||
title: order
|
||||
description: The $and's order.
|
||||
$or:
|
||||
type: array
|
||||
description: The product's $or.
|
||||
items:
|
||||
type: object
|
||||
description: The $or's details.
|
||||
x-schemaName: AdminGetProductsParams
|
||||
properties:
|
||||
q:
|
||||
type: string
|
||||
title: q
|
||||
description: The $or's q.
|
||||
id:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: id
|
||||
description: The $or's ID.
|
||||
- type: array
|
||||
description: The $or's ID.
|
||||
items:
|
||||
type: string
|
||||
title: id
|
||||
description: The id's ID.
|
||||
status:
|
||||
type: array
|
||||
description: The $or's status.
|
||||
items: {}
|
||||
title:
|
||||
type: string
|
||||
title: title
|
||||
description: The $or's title.
|
||||
handle:
|
||||
type: string
|
||||
title: handle
|
||||
description: The $or's handle.
|
||||
is_giftcard:
|
||||
type: boolean
|
||||
title: is_giftcard
|
||||
description: The $or's is giftcard.
|
||||
price_list_id:
|
||||
type: array
|
||||
description: The $or's price list id.
|
||||
items:
|
||||
type: string
|
||||
title: price_list_id
|
||||
description: The price list id's details.
|
||||
sales_channel_id:
|
||||
type: array
|
||||
description: The $or's sales channel id.
|
||||
items:
|
||||
type: string
|
||||
title: sales_channel_id
|
||||
description: The sales channel id's details.
|
||||
collection_id:
|
||||
type: array
|
||||
description: The $or's collection id.
|
||||
items:
|
||||
type: string
|
||||
title: collection_id
|
||||
description: The collection id's details.
|
||||
tags:
|
||||
type: array
|
||||
description: The $or's tags.
|
||||
items:
|
||||
type: string
|
||||
title: tags
|
||||
description: The tag's tags.
|
||||
type_id:
|
||||
type: array
|
||||
description: The $or's type id.
|
||||
items:
|
||||
type: string
|
||||
title: type_id
|
||||
description: The type id's details.
|
||||
variants:
|
||||
type: object
|
||||
description: The $or's variants.
|
||||
properties: {}
|
||||
created_at: {}
|
||||
updated_at: {}
|
||||
deleted_at: {}
|
||||
$and:
|
||||
type: array
|
||||
description: The $or's $and.
|
||||
items:
|
||||
type: object
|
||||
description: The $and's details.
|
||||
x-schemaName: AdminGetProductsParams
|
||||
properties:
|
||||
q:
|
||||
type: string
|
||||
title: q
|
||||
description: The $and's q.
|
||||
id:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: id
|
||||
description: The $and's ID.
|
||||
- type: array
|
||||
description: The $and's ID.
|
||||
items:
|
||||
type: string
|
||||
title: id
|
||||
description: The id's ID.
|
||||
status:
|
||||
type: array
|
||||
description: The $and's status.
|
||||
items: {}
|
||||
title:
|
||||
type: string
|
||||
title: title
|
||||
description: The $and's title.
|
||||
handle:
|
||||
type: string
|
||||
title: handle
|
||||
description: The $and's handle.
|
||||
is_giftcard:
|
||||
type: boolean
|
||||
title: is_giftcard
|
||||
description: The $and's is giftcard.
|
||||
price_list_id:
|
||||
type: array
|
||||
description: The $and's price list id.
|
||||
items:
|
||||
type: string
|
||||
title: price_list_id
|
||||
description: The price list id's details.
|
||||
sales_channel_id:
|
||||
type: array
|
||||
description: The $and's sales channel id.
|
||||
items:
|
||||
type: string
|
||||
title: sales_channel_id
|
||||
description: The sales channel id's details.
|
||||
collection_id:
|
||||
type: array
|
||||
description: The $and's collection id.
|
||||
items:
|
||||
type: string
|
||||
title: collection_id
|
||||
description: The collection id's details.
|
||||
tags:
|
||||
type: array
|
||||
description: The $and's tags.
|
||||
items:
|
||||
type: string
|
||||
title: tags
|
||||
description: The tag's tags.
|
||||
type_id:
|
||||
type: array
|
||||
description: The $and's type id.
|
||||
items:
|
||||
type: string
|
||||
title: type_id
|
||||
description: The type id's details.
|
||||
variants:
|
||||
type: object
|
||||
description: The $and's variants.
|
||||
properties: {}
|
||||
created_at: {}
|
||||
updated_at: {}
|
||||
deleted_at: {}
|
||||
$and:
|
||||
type: array
|
||||
description: The $and's details.
|
||||
items:
|
||||
type: object
|
||||
description: The $and's details.
|
||||
x-schemaName: AdminGetProductsParams
|
||||
properties: {}
|
||||
$or:
|
||||
type: array
|
||||
description: The $and's $or.
|
||||
items:
|
||||
type: object
|
||||
description: The $or's details.
|
||||
x-schemaName: AdminGetProductsParams
|
||||
properties: {}
|
||||
expand:
|
||||
type: string
|
||||
title: expand
|
||||
description: The $and's expand.
|
||||
fields:
|
||||
type: string
|
||||
title: fields
|
||||
description: The $and's fields.
|
||||
offset:
|
||||
type: number
|
||||
title: offset
|
||||
description: The $and's offset.
|
||||
limit:
|
||||
type: number
|
||||
title: limit
|
||||
description: The $and's limit.
|
||||
order:
|
||||
type: string
|
||||
title: order
|
||||
description: The $and's order.
|
||||
$or:
|
||||
type: array
|
||||
description: The $or's details.
|
||||
items:
|
||||
type: object
|
||||
description: The $or's details.
|
||||
x-schemaName: AdminGetProductsParams
|
||||
properties:
|
||||
q:
|
||||
type: string
|
||||
title: q
|
||||
description: The $or's q.
|
||||
id:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: id
|
||||
description: The $or's ID.
|
||||
- type: array
|
||||
description: The $or's ID.
|
||||
items:
|
||||
type: string
|
||||
title: id
|
||||
description: The id's ID.
|
||||
status:
|
||||
type: array
|
||||
description: The $or's status.
|
||||
items: {}
|
||||
title:
|
||||
type: string
|
||||
title: title
|
||||
description: The $or's title.
|
||||
handle:
|
||||
type: string
|
||||
title: handle
|
||||
description: The $or's handle.
|
||||
is_giftcard:
|
||||
type: boolean
|
||||
title: is_giftcard
|
||||
description: The $or's is giftcard.
|
||||
price_list_id:
|
||||
type: array
|
||||
description: The $or's price list id.
|
||||
items:
|
||||
type: string
|
||||
title: price_list_id
|
||||
description: The price list id's details.
|
||||
sales_channel_id:
|
||||
type: array
|
||||
description: The $or's sales channel id.
|
||||
items:
|
||||
type: string
|
||||
title: sales_channel_id
|
||||
description: The sales channel id's details.
|
||||
collection_id:
|
||||
type: array
|
||||
description: The $or's collection id.
|
||||
items:
|
||||
type: string
|
||||
title: collection_id
|
||||
description: The collection id's details.
|
||||
tags:
|
||||
type: array
|
||||
description: The $or's tags.
|
||||
items:
|
||||
type: string
|
||||
title: tags
|
||||
description: The tag's tags.
|
||||
type_id:
|
||||
type: array
|
||||
description: The $or's type id.
|
||||
items:
|
||||
type: string
|
||||
title: type_id
|
||||
description: The type id's details.
|
||||
variants:
|
||||
type: object
|
||||
description: The $or's variants.
|
||||
properties: {}
|
||||
created_at: {}
|
||||
updated_at: {}
|
||||
deleted_at: {}
|
||||
$and:
|
||||
type: array
|
||||
description: The $or's $and.
|
||||
items:
|
||||
type: object
|
||||
description: The $and's details.
|
||||
x-schemaName: AdminGetProductsParams
|
||||
properties: {}
|
||||
$or:
|
||||
type: array
|
||||
description: The $or's details.
|
||||
items:
|
||||
type: object
|
||||
description: The $or's details.
|
||||
x-schemaName: AdminGetProductsParams
|
||||
properties: {}
|
||||
expand:
|
||||
type: string
|
||||
title: expand
|
||||
description: The $or's expand.
|
||||
fields:
|
||||
type: string
|
||||
title: fields
|
||||
description: The $or's fields.
|
||||
offset:
|
||||
type: number
|
||||
title: offset
|
||||
description: The $or's offset.
|
||||
limit:
|
||||
type: number
|
||||
title: limit
|
||||
description: The $or's limit.
|
||||
order:
|
||||
type: string
|
||||
title: order
|
||||
description: The $or's order.
|
||||
expand:
|
||||
type: string
|
||||
title: expand
|
||||
description: The $or's expand.
|
||||
fields:
|
||||
type: string
|
||||
title: fields
|
||||
description: The $or's fields.
|
||||
offset:
|
||||
type: number
|
||||
title: offset
|
||||
description: The $or's offset.
|
||||
limit:
|
||||
type: number
|
||||
title: limit
|
||||
description: The $or's limit.
|
||||
order:
|
||||
type: string
|
||||
title: order
|
||||
description: The $or's order.
|
||||
expand:
|
||||
type: string
|
||||
title: expand
|
||||
description: The product's expand.
|
||||
fields:
|
||||
type: string
|
||||
title: fields
|
||||
description: The product's fields.
|
||||
offset:
|
||||
type: number
|
||||
title: offset
|
||||
description: The product's offset.
|
||||
limit:
|
||||
type: number
|
||||
title: limit
|
||||
description: The product's limit.
|
||||
order:
|
||||
type: string
|
||||
title: order
|
||||
description: The product's order.
|
||||
+28
@@ -0,0 +1,28 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminGetPromotionsParams
|
||||
properties:
|
||||
code:
|
||||
type: string
|
||||
title: code
|
||||
description: The promotion's code.
|
||||
expand:
|
||||
type: string
|
||||
title: expand
|
||||
description: The promotion's expand.
|
||||
fields:
|
||||
type: string
|
||||
title: fields
|
||||
description: The promotion's fields.
|
||||
offset:
|
||||
type: number
|
||||
title: offset
|
||||
description: The promotion's offset.
|
||||
limit:
|
||||
type: number
|
||||
title: limit
|
||||
description: The promotion's limit.
|
||||
order:
|
||||
type: string
|
||||
title: order
|
||||
description: The promotion's order.
|
||||
@@ -0,0 +1,46 @@
|
||||
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: ./CampaignBudget.yaml
|
||||
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.
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminPostCustomerGroupsGroupCustomersBatchReq
|
||||
required:
|
||||
- customer_ids
|
||||
properties:
|
||||
customer_ids:
|
||||
type: array
|
||||
description: The customer group's customer ids.
|
||||
items:
|
||||
type: object
|
||||
description: The customer id's customer ids.
|
||||
x-schemaName: CustomerGroupsBatchCustomer
|
||||
required:
|
||||
- id
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The customer id's ID.
|
||||
+34
@@ -0,0 +1,34 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminPostFulfillmentShippingOptionsRulesBatchAddReq
|
||||
required:
|
||||
- rules
|
||||
properties:
|
||||
rules:
|
||||
type: array
|
||||
description: The fulfillment's rules.
|
||||
items:
|
||||
type: object
|
||||
description: The rule's rules.
|
||||
x-schemaName: FulfillmentRuleCreate
|
||||
required:
|
||||
- operator
|
||||
- attribute
|
||||
- value
|
||||
properties:
|
||||
operator: {}
|
||||
attribute:
|
||||
type: string
|
||||
title: attribute
|
||||
description: The rule's attribute.
|
||||
value:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: value
|
||||
description: The rule's value.
|
||||
- type: array
|
||||
description: The rule's value.
|
||||
items:
|
||||
type: string
|
||||
title: value
|
||||
description: The value's details.
|
||||
+13
@@ -0,0 +1,13 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminPostFulfillmentShippingOptionsRulesBatchRemoveReq
|
||||
required:
|
||||
- rule_ids
|
||||
properties:
|
||||
rule_ids:
|
||||
type: array
|
||||
description: The fulfillment's rule ids.
|
||||
items:
|
||||
type: string
|
||||
title: rule_ids
|
||||
description: The rule id's rule ids.
|
||||
+56
@@ -0,0 +1,56 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminPostInventoryItemsInventoryItemReq
|
||||
properties:
|
||||
sku:
|
||||
type: string
|
||||
title: sku
|
||||
description: The inventory item's sku.
|
||||
origin_country:
|
||||
type: string
|
||||
title: origin_country
|
||||
description: The inventory item's origin country.
|
||||
hs_code:
|
||||
type: string
|
||||
title: hs_code
|
||||
description: The inventory item's hs code.
|
||||
mid_code:
|
||||
type: string
|
||||
title: mid_code
|
||||
description: The inventory item's mid code.
|
||||
material:
|
||||
type: string
|
||||
title: material
|
||||
description: The inventory item's material.
|
||||
weight:
|
||||
type: number
|
||||
title: weight
|
||||
description: The inventory item's weight.
|
||||
height:
|
||||
type: number
|
||||
title: height
|
||||
description: The inventory item's height.
|
||||
length:
|
||||
type: number
|
||||
title: length
|
||||
description: The inventory item's length.
|
||||
width:
|
||||
type: number
|
||||
title: width
|
||||
description: The inventory item's width.
|
||||
title:
|
||||
type: string
|
||||
title: title
|
||||
description: The inventory item's title.
|
||||
description:
|
||||
type: string
|
||||
title: description
|
||||
description: The inventory item's description.
|
||||
thumbnail:
|
||||
type: string
|
||||
title: thumbnail
|
||||
description: The inventory item's thumbnail.
|
||||
requires_shipping:
|
||||
type: boolean
|
||||
title: requires_shipping
|
||||
description: The inventory item's requires shipping.
|
||||
+12
@@ -0,0 +1,12 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminPostInventoryItemsItemLocationLevelsLevelReq
|
||||
properties:
|
||||
incoming_quantity:
|
||||
type: number
|
||||
title: incoming_quantity
|
||||
description: The inventory item's incoming quantity.
|
||||
stocked_quantity:
|
||||
type: number
|
||||
title: stocked_quantity
|
||||
description: The inventory item's stocked quantity.
|
||||
+19
@@ -0,0 +1,19 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminPostInventoryItemsItemLocationLevelsReq
|
||||
required:
|
||||
- location_id
|
||||
- stocked_quantity
|
||||
properties:
|
||||
location_id:
|
||||
type: string
|
||||
title: location_id
|
||||
description: The inventory item's location id.
|
||||
stocked_quantity:
|
||||
type: number
|
||||
title: stocked_quantity
|
||||
description: The inventory item's stocked quantity.
|
||||
incoming_quantity:
|
||||
type: number
|
||||
title: incoming_quantity
|
||||
description: The inventory item's incoming quantity.
|
||||
+56
@@ -0,0 +1,56 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminPostInventoryItemsReq
|
||||
properties:
|
||||
sku:
|
||||
type: string
|
||||
title: sku
|
||||
description: The inventory item's sku.
|
||||
hs_code:
|
||||
type: string
|
||||
title: hs_code
|
||||
description: The inventory item's hs code.
|
||||
weight:
|
||||
type: number
|
||||
title: weight
|
||||
description: The inventory item's weight.
|
||||
length:
|
||||
type: number
|
||||
title: length
|
||||
description: The inventory item's length.
|
||||
height:
|
||||
type: number
|
||||
title: height
|
||||
description: The inventory item's height.
|
||||
width:
|
||||
type: number
|
||||
title: width
|
||||
description: The inventory item's width.
|
||||
origin_country:
|
||||
type: string
|
||||
title: origin_country
|
||||
description: The inventory item's origin country.
|
||||
mid_code:
|
||||
type: string
|
||||
title: mid_code
|
||||
description: The inventory item's mid code.
|
||||
material:
|
||||
type: string
|
||||
title: material
|
||||
description: The inventory item's material.
|
||||
title:
|
||||
type: string
|
||||
title: title
|
||||
description: The inventory item's title.
|
||||
description:
|
||||
type: string
|
||||
title: description
|
||||
description: The inventory item's description.
|
||||
thumbnail:
|
||||
type: string
|
||||
title: thumbnail
|
||||
description: The inventory item's thumbnail.
|
||||
metadata:
|
||||
type: object
|
||||
description: The inventory item's metadata.
|
||||
properties: {}
|
||||
+15
@@ -0,0 +1,15 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminPostInvitesInviteAcceptReq
|
||||
required:
|
||||
- first_name
|
||||
- last_name
|
||||
properties:
|
||||
first_name:
|
||||
type: string
|
||||
title: first_name
|
||||
description: The invite's first name.
|
||||
last_name:
|
||||
type: string
|
||||
title: last_name
|
||||
description: The invite's last name.
|
||||
+8
@@ -0,0 +1,8 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminPostPaymentsCapturesReq
|
||||
properties:
|
||||
amount:
|
||||
type: number
|
||||
title: amount
|
||||
description: The payment's amount.
|
||||
+8
@@ -0,0 +1,8 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminPostPaymentsRefundsReq
|
||||
properties:
|
||||
amount:
|
||||
type: number
|
||||
title: amount
|
||||
description: The payment's amount.
|
||||
+42
@@ -0,0 +1,42 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminPostPriceListsPriceListPricesBatchAddReq
|
||||
required:
|
||||
- prices
|
||||
properties:
|
||||
prices:
|
||||
type: array
|
||||
description: The price list's prices.
|
||||
items:
|
||||
type: object
|
||||
description: The price's prices.
|
||||
x-schemaName: AdminPriceListPricesCreateReq
|
||||
required:
|
||||
- currency_code
|
||||
- amount
|
||||
- variant_id
|
||||
properties:
|
||||
currency_code:
|
||||
type: string
|
||||
title: currency_code
|
||||
description: The price's currency code.
|
||||
amount:
|
||||
type: number
|
||||
title: amount
|
||||
description: The price's amount.
|
||||
variant_id:
|
||||
type: string
|
||||
title: variant_id
|
||||
description: The price's variant id.
|
||||
min_quantity:
|
||||
type: number
|
||||
title: min_quantity
|
||||
description: The price's min quantity.
|
||||
max_quantity:
|
||||
type: number
|
||||
title: max_quantity
|
||||
description: The price's max quantity.
|
||||
rules:
|
||||
type: object
|
||||
description: The price's rules.
|
||||
properties: {}
|
||||
+13
@@ -0,0 +1,13 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminPostPriceListsPriceListPricesBatchRemoveReq
|
||||
required:
|
||||
- ids
|
||||
properties:
|
||||
ids:
|
||||
type: array
|
||||
description: The price list's ids.
|
||||
items:
|
||||
type: string
|
||||
title: ids
|
||||
description: The id's ids.
|
||||
+64
@@ -0,0 +1,64 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminPostPriceListsPriceListReq
|
||||
required:
|
||||
- prices
|
||||
properties:
|
||||
title:
|
||||
type: string
|
||||
title: title
|
||||
description: The price list's title.
|
||||
description:
|
||||
type: string
|
||||
title: description
|
||||
description: The price list's description.
|
||||
starts_at:
|
||||
type: string
|
||||
title: starts_at
|
||||
description: The price list's starts at.
|
||||
ends_at:
|
||||
type: string
|
||||
title: ends_at
|
||||
description: The price list's ends at.
|
||||
status: {}
|
||||
type: {}
|
||||
prices:
|
||||
type: array
|
||||
description: The price list's prices.
|
||||
items:
|
||||
type: object
|
||||
description: The price's prices.
|
||||
x-schemaName: AdminPriceListPricesCreateReq
|
||||
required:
|
||||
- currency_code
|
||||
- amount
|
||||
- variant_id
|
||||
properties:
|
||||
currency_code:
|
||||
type: string
|
||||
title: currency_code
|
||||
description: The price's currency code.
|
||||
amount:
|
||||
type: number
|
||||
title: amount
|
||||
description: The price's amount.
|
||||
variant_id:
|
||||
type: string
|
||||
title: variant_id
|
||||
description: The price's variant id.
|
||||
min_quantity:
|
||||
type: number
|
||||
title: min_quantity
|
||||
description: The price's min quantity.
|
||||
max_quantity:
|
||||
type: number
|
||||
title: max_quantity
|
||||
description: The price's max quantity.
|
||||
rules:
|
||||
type: object
|
||||
description: The price's rules.
|
||||
properties: {}
|
||||
rules:
|
||||
type: object
|
||||
description: The price list's rules.
|
||||
properties: {}
|
||||
@@ -0,0 +1,67 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminPostPriceListsReq
|
||||
required:
|
||||
- title
|
||||
- description
|
||||
- type
|
||||
- prices
|
||||
properties:
|
||||
title:
|
||||
type: string
|
||||
title: title
|
||||
description: The price list's title.
|
||||
description:
|
||||
type: string
|
||||
title: description
|
||||
description: The price list's description.
|
||||
starts_at:
|
||||
type: string
|
||||
title: starts_at
|
||||
description: The price list's starts at.
|
||||
ends_at:
|
||||
type: string
|
||||
title: ends_at
|
||||
description: The price list's ends at.
|
||||
status: {}
|
||||
type: {}
|
||||
prices:
|
||||
type: array
|
||||
description: The price list's prices.
|
||||
items:
|
||||
type: object
|
||||
description: The price's prices.
|
||||
x-schemaName: AdminPriceListPricesCreateReq
|
||||
required:
|
||||
- currency_code
|
||||
- amount
|
||||
- variant_id
|
||||
properties:
|
||||
currency_code:
|
||||
type: string
|
||||
title: currency_code
|
||||
description: The price's currency code.
|
||||
amount:
|
||||
type: number
|
||||
title: amount
|
||||
description: The price's amount.
|
||||
variant_id:
|
||||
type: string
|
||||
title: variant_id
|
||||
description: The price's variant id.
|
||||
min_quantity:
|
||||
type: number
|
||||
title: min_quantity
|
||||
description: The price's min quantity.
|
||||
max_quantity:
|
||||
type: number
|
||||
title: max_quantity
|
||||
description: The price's max quantity.
|
||||
rules:
|
||||
type: object
|
||||
description: The price's rules.
|
||||
properties: {}
|
||||
rules:
|
||||
type: object
|
||||
description: The price list's rules.
|
||||
properties: {}
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminPostPricingRuleTypesReq
|
||||
required:
|
||||
- name
|
||||
- rule_attribute
|
||||
- default_priority
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
title: name
|
||||
description: The pricing's name.
|
||||
rule_attribute:
|
||||
type: string
|
||||
title: rule_attribute
|
||||
description: The pricing's rule attribute.
|
||||
default_priority:
|
||||
type: number
|
||||
title: default_priority
|
||||
description: The pricing's default priority.
|
||||
+16
@@ -0,0 +1,16 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminPostPricingRuleTypesRuleTypeReq
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
title: name
|
||||
description: The pricing's name.
|
||||
rule_attribute:
|
||||
type: string
|
||||
title: rule_attribute
|
||||
description: The pricing's rule attribute.
|
||||
default_priority:
|
||||
type: number
|
||||
title: default_priority
|
||||
description: The pricing's default priority.
|
||||
+49
@@ -0,0 +1,49 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminPostPromotionsPromotionReq
|
||||
properties:
|
||||
code:
|
||||
type: string
|
||||
title: code
|
||||
description: The promotion's code.
|
||||
is_automatic:
|
||||
type: boolean
|
||||
title: is_automatic
|
||||
description: The promotion's is automatic.
|
||||
type: {}
|
||||
campaign_id:
|
||||
type: string
|
||||
title: campaign_id
|
||||
description: The promotion's campaign id.
|
||||
campaign:
|
||||
$ref: ./AdminPostCampaignsReq.yaml
|
||||
application_method:
|
||||
$ref: ./ApplicationMethodsMethodPostReq.yaml
|
||||
rules:
|
||||
type: array
|
||||
description: The promotion's rules.
|
||||
items:
|
||||
type: object
|
||||
description: The rule's rules.
|
||||
x-schemaName: PromotionRule
|
||||
required:
|
||||
- operator
|
||||
- attribute
|
||||
- values
|
||||
properties:
|
||||
operator: {}
|
||||
description:
|
||||
type: string
|
||||
title: description
|
||||
description: The rule's description.
|
||||
attribute:
|
||||
type: string
|
||||
title: attribute
|
||||
description: The rule's attribute.
|
||||
values:
|
||||
type: array
|
||||
description: The rule's values.
|
||||
items:
|
||||
type: string
|
||||
title: values
|
||||
description: The value's values.
|
||||
+34
@@ -0,0 +1,34 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminPostPromotionsPromotionRulesBatchAddReq
|
||||
required:
|
||||
- rules
|
||||
properties:
|
||||
rules:
|
||||
type: array
|
||||
description: The promotion's rules.
|
||||
items:
|
||||
type: object
|
||||
description: The rule's rules.
|
||||
x-schemaName: PromotionRule
|
||||
required:
|
||||
- operator
|
||||
- attribute
|
||||
- values
|
||||
properties:
|
||||
operator: {}
|
||||
description:
|
||||
type: string
|
||||
title: description
|
||||
description: The rule's description.
|
||||
attribute:
|
||||
type: string
|
||||
title: attribute
|
||||
description: The rule's attribute.
|
||||
values:
|
||||
type: array
|
||||
description: The rule's values.
|
||||
items:
|
||||
type: string
|
||||
title: values
|
||||
description: The value's values.
|
||||
+13
@@ -0,0 +1,13 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminPostPromotionsPromotionRulesBatchRemoveReq
|
||||
required:
|
||||
- rule_ids
|
||||
properties:
|
||||
rule_ids:
|
||||
type: array
|
||||
description: The promotion's rule ids.
|
||||
items:
|
||||
type: string
|
||||
title: rule_ids
|
||||
description: The rule id's rule ids.
|
||||
+38
@@ -0,0 +1,38 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminPostPromotionsPromotionRulesBatchUpdateReq
|
||||
required:
|
||||
- rules
|
||||
properties:
|
||||
rules:
|
||||
type: array
|
||||
description: The promotion's rules.
|
||||
items:
|
||||
type: object
|
||||
description: The rule's rules.
|
||||
x-schemaName: UpdatePromotionRule
|
||||
required:
|
||||
- id
|
||||
- attribute
|
||||
- values
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The rule's ID.
|
||||
operator: {}
|
||||
description:
|
||||
type: string
|
||||
title: description
|
||||
description: The rule's description.
|
||||
attribute:
|
||||
type: string
|
||||
title: attribute
|
||||
description: The rule's attribute.
|
||||
values:
|
||||
type: array
|
||||
description: The rule's values.
|
||||
items:
|
||||
type: string
|
||||
title: values
|
||||
description: The value's values.
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminPostStockLocationsReq
|
||||
required:
|
||||
- name
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
title: name
|
||||
description: The stock location's name.
|
||||
address:
|
||||
$ref: ./StockLocationAddress.yaml
|
||||
address_id:
|
||||
type: string
|
||||
title: address_id
|
||||
description: The stock location's address id.
|
||||
metadata:
|
||||
type: object
|
||||
description: The stock location's metadata.
|
||||
properties: {}
|
||||
@@ -0,0 +1,54 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminPostTaxRatesReq
|
||||
required:
|
||||
- name
|
||||
- tax_region_id
|
||||
properties:
|
||||
rate:
|
||||
type: number
|
||||
title: rate
|
||||
description: The tax rate's rate.
|
||||
code:
|
||||
type: string
|
||||
title: code
|
||||
description: The tax rate's code.
|
||||
rules:
|
||||
type: array
|
||||
description: The tax rate's rules.
|
||||
items:
|
||||
type: object
|
||||
description: The rule's rules.
|
||||
x-schemaName: CreateTaxRateRule
|
||||
required:
|
||||
- reference
|
||||
- reference_id
|
||||
properties:
|
||||
reference:
|
||||
type: string
|
||||
title: reference
|
||||
description: The rule's reference.
|
||||
reference_id:
|
||||
type: string
|
||||
title: reference_id
|
||||
description: The rule's reference id.
|
||||
name:
|
||||
type: string
|
||||
title: name
|
||||
description: The tax rate's name.
|
||||
is_default:
|
||||
type: boolean
|
||||
title: is_default
|
||||
description: The tax rate's is default.
|
||||
is_combinable:
|
||||
type: boolean
|
||||
title: is_combinable
|
||||
description: The tax rate's is combinable.
|
||||
tax_region_id:
|
||||
type: string
|
||||
title: tax_region_id
|
||||
description: The tax rate's tax region id.
|
||||
metadata:
|
||||
type: object
|
||||
description: The tax rate's metadata.
|
||||
properties: {}
|
||||
+41
@@ -0,0 +1,41 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminPostTaxRatesTaxRateReq
|
||||
properties:
|
||||
code:
|
||||
type: string
|
||||
title: code
|
||||
description: The tax rate's code.
|
||||
name:
|
||||
type: string
|
||||
title: name
|
||||
description: The tax rate's name.
|
||||
region_id:
|
||||
type: string
|
||||
title: region_id
|
||||
description: The tax rate's region id.
|
||||
rate:
|
||||
type: number
|
||||
title: rate
|
||||
description: The tax rate's rate.
|
||||
products:
|
||||
type: array
|
||||
description: The tax rate's products.
|
||||
items:
|
||||
type: string
|
||||
title: products
|
||||
description: The product's products.
|
||||
shipping_options:
|
||||
type: array
|
||||
description: The tax rate's shipping options.
|
||||
items:
|
||||
type: string
|
||||
title: shipping_options
|
||||
description: The shipping option's shipping options.
|
||||
product_types:
|
||||
type: array
|
||||
description: The tax rate's product types.
|
||||
items:
|
||||
type: string
|
||||
title: product_types
|
||||
description: The product type's product types.
|
||||
+15
@@ -0,0 +1,15 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminPostTaxRatesTaxRateRulesReq
|
||||
required:
|
||||
- reference
|
||||
- reference_id
|
||||
properties:
|
||||
reference:
|
||||
type: string
|
||||
title: reference
|
||||
description: The tax rate's reference.
|
||||
reference_id:
|
||||
type: string
|
||||
title: reference_id
|
||||
description: The tax rate's reference id.
|
||||
@@ -0,0 +1,24 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminPostTaxRegionsReq
|
||||
required:
|
||||
- country_code
|
||||
properties:
|
||||
country_code:
|
||||
type: string
|
||||
title: country_code
|
||||
description: The tax region's country code.
|
||||
province_code:
|
||||
type: string
|
||||
title: province_code
|
||||
description: The tax region's province code.
|
||||
parent_id:
|
||||
type: string
|
||||
title: parent_id
|
||||
description: The tax region's parent id.
|
||||
default_tax_rate:
|
||||
$ref: ./CreateDefaultTaxRate.yaml
|
||||
metadata:
|
||||
type: object
|
||||
description: The tax region's metadata.
|
||||
properties: {}
|
||||
+18
@@ -0,0 +1,18 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminPostWorkflowsAsyncResponseReq
|
||||
required:
|
||||
- transaction_id
|
||||
- step_id
|
||||
properties:
|
||||
transaction_id:
|
||||
type: string
|
||||
title: transaction_id
|
||||
description: The workflows execution's transaction id.
|
||||
step_id:
|
||||
type: string
|
||||
title: step_id
|
||||
description: The workflows execution's step id.
|
||||
response: {}
|
||||
compensate_input: {}
|
||||
action: {}
|
||||
@@ -0,0 +1,9 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminPostWorkflowsRunReq
|
||||
properties:
|
||||
input: {}
|
||||
transaction_id:
|
||||
type: string
|
||||
title: transaction_id
|
||||
description: The workflows execution's transaction id.
|
||||
@@ -0,0 +1,18 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminUpdateUserRequest
|
||||
required:
|
||||
- avatar_url
|
||||
properties:
|
||||
first_name:
|
||||
type: string
|
||||
title: first_name
|
||||
description: The user's first name.
|
||||
last_name:
|
||||
type: string
|
||||
title: last_name
|
||||
description: The user's last name.
|
||||
avatar_url:
|
||||
type: string
|
||||
title: avatar_url
|
||||
description: The user's avatar url.
|
||||
@@ -0,0 +1,4 @@
|
||||
type: object
|
||||
description: The promotion's application method.
|
||||
x-schemaName: ApplicationMethod
|
||||
properties: {}
|
||||
+83
@@ -0,0 +1,83 @@
|
||||
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: {}
|
||||
target_type: {}
|
||||
allocation: {}
|
||||
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: {}
|
||||
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: {}
|
||||
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,4 @@
|
||||
type: object
|
||||
description: The promotion's campaign.
|
||||
x-schemaName: Campaign
|
||||
properties: {}
|
||||
@@ -0,0 +1,9 @@
|
||||
type: object
|
||||
description: The campaign's budget.
|
||||
x-schemaName: CampaignBudget
|
||||
properties:
|
||||
type: {}
|
||||
limit:
|
||||
type: number
|
||||
title: limit
|
||||
description: The budget's limit.
|
||||
@@ -0,0 +1,52 @@
|
||||
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: {}
|
||||
@@ -0,0 +1,16 @@
|
||||
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
|
||||
+161
@@ -0,0 +1,161 @@
|
||||
type: object
|
||||
description: The promotion's application method.
|
||||
x-schemaName: CreateApplicationMethod
|
||||
required:
|
||||
- type
|
||||
- target_type
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
enum:
|
||||
- fixed
|
||||
- percentage
|
||||
target_type:
|
||||
type: string
|
||||
enum:
|
||||
- order
|
||||
- shipping_methods
|
||||
- items
|
||||
allocation:
|
||||
type: string
|
||||
enum:
|
||||
- each
|
||||
- across
|
||||
value:
|
||||
type: number
|
||||
title: value
|
||||
description: The application method's value.
|
||||
max_quantity:
|
||||
type: number
|
||||
title: max_quantity
|
||||
description: The application method's max quantity.
|
||||
buy_rules_min_quantity:
|
||||
type: number
|
||||
title: buy_rules_min_quantity
|
||||
description: The application method's buy rules min quantity.
|
||||
apply_to_quantity:
|
||||
type: number
|
||||
title: apply_to_quantity
|
||||
description: The application method's apply to quantity.
|
||||
promotion:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: promotion
|
||||
description: The application method's promotion.
|
||||
- type: object
|
||||
description: The application method's promotion.
|
||||
x-schemaName: Promotion
|
||||
required:
|
||||
- id
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The promotion's ID.
|
||||
code:
|
||||
type: string
|
||||
title: code
|
||||
description: The promotion's code.
|
||||
type:
|
||||
type: string
|
||||
enum:
|
||||
- standard
|
||||
- buyget
|
||||
is_automatic:
|
||||
type: boolean
|
||||
title: is_automatic
|
||||
description: The promotion's is automatic.
|
||||
application_method:
|
||||
$ref: ./ApplicationMethod.yaml
|
||||
rules:
|
||||
type: array
|
||||
description: The promotion's rules.
|
||||
items:
|
||||
type: object
|
||||
description: The rule's rules.
|
||||
x-schemaName: PromotionRule
|
||||
properties: {}
|
||||
campaign:
|
||||
$ref: ./Campaign.yaml
|
||||
target_rules:
|
||||
type: array
|
||||
description: The application method's target rules.
|
||||
items:
|
||||
type: object
|
||||
description: The target rule's target rules.
|
||||
x-schemaName: CreatePromotionRule
|
||||
required:
|
||||
- attribute
|
||||
- operator
|
||||
- values
|
||||
properties:
|
||||
description:
|
||||
type: string
|
||||
title: description
|
||||
description: The target rule's description.
|
||||
attribute:
|
||||
type: string
|
||||
title: attribute
|
||||
description: The target rule's attribute.
|
||||
operator:
|
||||
type: string
|
||||
enum:
|
||||
- gt
|
||||
- lt
|
||||
- eq
|
||||
- ne
|
||||
- in
|
||||
- lte
|
||||
- gte
|
||||
values:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: values
|
||||
description: The target rule's values.
|
||||
- type: array
|
||||
description: The target rule's values.
|
||||
items:
|
||||
type: string
|
||||
title: values
|
||||
description: The value's values.
|
||||
buy_rules:
|
||||
type: array
|
||||
description: The application method's buy rules.
|
||||
items:
|
||||
type: object
|
||||
description: The buy rule's buy rules.
|
||||
x-schemaName: CreatePromotionRule
|
||||
required:
|
||||
- attribute
|
||||
- operator
|
||||
- values
|
||||
properties:
|
||||
description:
|
||||
type: string
|
||||
title: description
|
||||
description: The buy rule's description.
|
||||
attribute:
|
||||
type: string
|
||||
title: attribute
|
||||
description: The buy rule's attribute.
|
||||
operator:
|
||||
type: string
|
||||
enum:
|
||||
- gt
|
||||
- lt
|
||||
- eq
|
||||
- ne
|
||||
- in
|
||||
- lte
|
||||
- gte
|
||||
values:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: values
|
||||
description: The buy rule's values.
|
||||
- type: array
|
||||
description: The buy rule's values.
|
||||
items:
|
||||
type: string
|
||||
title: values
|
||||
description: The value's values.
|
||||
@@ -0,0 +1,51 @@
|
||||
type: object
|
||||
description: The promotion's campaign.
|
||||
x-schemaName: CreateCampaign
|
||||
required:
|
||||
- name
|
||||
- campaign_identifier
|
||||
- starts_at
|
||||
- ends_at
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
title: name
|
||||
description: The campaign's name.
|
||||
description:
|
||||
type: string
|
||||
title: description
|
||||
description: The campaign's description.
|
||||
currency:
|
||||
type: string
|
||||
title: currency
|
||||
description: The campaign's currency.
|
||||
campaign_identifier:
|
||||
type: string
|
||||
title: campaign_identifier
|
||||
description: The campaign's campaign identifier.
|
||||
starts_at:
|
||||
type: string
|
||||
title: starts_at
|
||||
description: The campaign's starts at.
|
||||
format: date-time
|
||||
ends_at:
|
||||
type: string
|
||||
title: ends_at
|
||||
description: The campaign's ends at.
|
||||
format: date-time
|
||||
budget:
|
||||
$ref: ./CreateCampaignBudget.yaml
|
||||
promotions:
|
||||
type: array
|
||||
description: The campaign's promotions.
|
||||
items:
|
||||
type: object
|
||||
description: The promotion's promotions.
|
||||
x-schemaName: Promotion
|
||||
required:
|
||||
- id
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The promotion's ID.
|
||||
@@ -0,0 +1,20 @@
|
||||
type: object
|
||||
description: The campaign's budget.
|
||||
x-schemaName: CreateCampaignBudget
|
||||
required:
|
||||
- type
|
||||
- limit
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
enum:
|
||||
- spend
|
||||
- usage
|
||||
limit:
|
||||
type: number
|
||||
title: limit
|
||||
description: The budget's limit.
|
||||
used:
|
||||
type: number
|
||||
title: used
|
||||
description: The budget's used.
|
||||
@@ -0,0 +1,48 @@
|
||||
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: {}
|
||||
+103
@@ -0,0 +1,103 @@
|
||||
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: {}
|
||||
+257
@@ -0,0 +1,257 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: CreateCartWorkflowInput
|
||||
properties:
|
||||
region_id:
|
||||
type: string
|
||||
title: region_id
|
||||
description: The cart's region id.
|
||||
customer_id:
|
||||
type: string
|
||||
title: customer_id
|
||||
description: The cart's customer id.
|
||||
sales_channel_id:
|
||||
type: string
|
||||
title: sales_channel_id
|
||||
description: The cart's sales channel id.
|
||||
email:
|
||||
type: string
|
||||
title: email
|
||||
description: The cart's email.
|
||||
format: email
|
||||
currency_code:
|
||||
type: string
|
||||
title: currency_code
|
||||
description: The cart's currency code.
|
||||
shipping_address_id:
|
||||
type: string
|
||||
title: shipping_address_id
|
||||
description: The cart's shipping address id.
|
||||
billing_address_id:
|
||||
type: string
|
||||
title: billing_address_id
|
||||
description: The cart's billing address id.
|
||||
shipping_address:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: shipping_address
|
||||
description: The cart's shipping address.
|
||||
- type: object
|
||||
description: The cart's shipping address.
|
||||
x-schemaName: CreateCartAddress
|
||||
properties:
|
||||
first_name:
|
||||
type: string
|
||||
title: first_name
|
||||
description: The shipping address's first name.
|
||||
last_name:
|
||||
type: string
|
||||
title: last_name
|
||||
description: The shipping address's last name.
|
||||
phone:
|
||||
type: string
|
||||
title: phone
|
||||
description: The shipping address's phone.
|
||||
company:
|
||||
type: string
|
||||
title: company
|
||||
description: The shipping address's company.
|
||||
address_1:
|
||||
type: string
|
||||
title: address_1
|
||||
description: The shipping address's address 1.
|
||||
address_2:
|
||||
type: string
|
||||
title: address_2
|
||||
description: The shipping address's address 2.
|
||||
city:
|
||||
type: string
|
||||
title: city
|
||||
description: The shipping address's city.
|
||||
country_code:
|
||||
type: string
|
||||
title: country_code
|
||||
description: The shipping address's country code.
|
||||
province:
|
||||
type: string
|
||||
title: province
|
||||
description: The shipping address's province.
|
||||
postal_code:
|
||||
type: string
|
||||
title: postal_code
|
||||
description: The shipping address's postal code.
|
||||
metadata:
|
||||
type: object
|
||||
description: The shipping address's metadata.
|
||||
properties: {}
|
||||
billing_address:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: billing_address
|
||||
description: The cart's billing address.
|
||||
- type: object
|
||||
description: The cart's billing address.
|
||||
x-schemaName: CreateCartAddress
|
||||
properties:
|
||||
first_name:
|
||||
type: string
|
||||
title: first_name
|
||||
description: The billing address's first name.
|
||||
last_name:
|
||||
type: string
|
||||
title: last_name
|
||||
description: The billing address's last name.
|
||||
phone:
|
||||
type: string
|
||||
title: phone
|
||||
description: The billing address's phone.
|
||||
company:
|
||||
type: string
|
||||
title: company
|
||||
description: The billing address's company.
|
||||
address_1:
|
||||
type: string
|
||||
title: address_1
|
||||
description: The billing address's address 1.
|
||||
address_2:
|
||||
type: string
|
||||
title: address_2
|
||||
description: The billing address's address 2.
|
||||
city:
|
||||
type: string
|
||||
title: city
|
||||
description: The billing address's city.
|
||||
country_code:
|
||||
type: string
|
||||
title: country_code
|
||||
description: The billing address's country code.
|
||||
province:
|
||||
type: string
|
||||
title: province
|
||||
description: The billing address's province.
|
||||
postal_code:
|
||||
type: string
|
||||
title: postal_code
|
||||
description: The billing address's postal code.
|
||||
metadata:
|
||||
type: object
|
||||
description: The billing address's metadata.
|
||||
properties: {}
|
||||
metadata:
|
||||
type: object
|
||||
description: The cart's metadata.
|
||||
properties: {}
|
||||
items:
|
||||
type: array
|
||||
description: The cart's items.
|
||||
items:
|
||||
type: object
|
||||
description: The item's items.
|
||||
x-schemaName: CreateCartCreateLineItem
|
||||
required:
|
||||
- quantity
|
||||
- variant_id
|
||||
properties:
|
||||
quantity:
|
||||
type: number
|
||||
title: quantity
|
||||
description: The item's quantity.
|
||||
variant_id:
|
||||
type: string
|
||||
title: variant_id
|
||||
description: The item's variant id.
|
||||
title:
|
||||
type: string
|
||||
title: title
|
||||
description: The item's title.
|
||||
subtitle:
|
||||
type: string
|
||||
title: subtitle
|
||||
description: The item's subtitle.
|
||||
thumbnail:
|
||||
type: string
|
||||
title: thumbnail
|
||||
description: The item's thumbnail.
|
||||
product_id:
|
||||
type: string
|
||||
title: product_id
|
||||
description: The item's product id.
|
||||
product_title:
|
||||
type: string
|
||||
title: product_title
|
||||
description: The item's product title.
|
||||
product_description:
|
||||
type: string
|
||||
title: product_description
|
||||
description: The item's product description.
|
||||
product_subtitle:
|
||||
type: string
|
||||
title: product_subtitle
|
||||
description: The item's product subtitle.
|
||||
product_type:
|
||||
type: string
|
||||
title: product_type
|
||||
description: The item's product type.
|
||||
product_collection:
|
||||
type: string
|
||||
title: product_collection
|
||||
description: The item's product collection.
|
||||
product_handle:
|
||||
type: string
|
||||
title: product_handle
|
||||
description: The item's product handle.
|
||||
variant_sku:
|
||||
type: string
|
||||
title: variant_sku
|
||||
description: The item's variant sku.
|
||||
variant_barcode:
|
||||
type: string
|
||||
title: variant_barcode
|
||||
description: The item's variant barcode.
|
||||
variant_title:
|
||||
type: string
|
||||
title: variant_title
|
||||
description: The item's variant title.
|
||||
variant_option_values:
|
||||
type: object
|
||||
description: The item's variant option values.
|
||||
properties: {}
|
||||
requires_shipping:
|
||||
type: boolean
|
||||
title: requires_shipping
|
||||
description: The item's requires shipping.
|
||||
is_discountable:
|
||||
type: boolean
|
||||
title: is_discountable
|
||||
description: The item's is discountable.
|
||||
is_tax_inclusive:
|
||||
type: boolean
|
||||
title: is_tax_inclusive
|
||||
description: The item's is tax inclusive.
|
||||
is_giftcard:
|
||||
type: boolean
|
||||
title: is_giftcard
|
||||
description: The item's is giftcard.
|
||||
compare_at_unit_price:
|
||||
type: number
|
||||
title: compare_at_unit_price
|
||||
description: The item's compare at unit price.
|
||||
unit_price:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: unit_price
|
||||
description: The item's unit price.
|
||||
- type: number
|
||||
title: unit_price
|
||||
description: The item's unit price.
|
||||
metadata:
|
||||
type: object
|
||||
description: The item's metadata.
|
||||
properties: {}
|
||||
promo_codes:
|
||||
type: array
|
||||
description: The cart's promo codes.
|
||||
items:
|
||||
type: string
|
||||
title: promo_codes
|
||||
description: The promo code's promo codes.
|
||||
@@ -0,0 +1,97 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: CreateCustomer
|
||||
properties:
|
||||
company_name:
|
||||
type: string
|
||||
title: company_name
|
||||
description: The customer's company name.
|
||||
first_name:
|
||||
type: string
|
||||
title: first_name
|
||||
description: The customer's first name.
|
||||
last_name:
|
||||
type: string
|
||||
title: last_name
|
||||
description: The customer's last name.
|
||||
email:
|
||||
type: string
|
||||
title: email
|
||||
description: The customer's email.
|
||||
format: email
|
||||
phone:
|
||||
type: string
|
||||
title: phone
|
||||
description: The customer's phone.
|
||||
created_by:
|
||||
type: string
|
||||
title: created_by
|
||||
description: The customer's created by.
|
||||
addresses:
|
||||
type: array
|
||||
description: The customer's addresses.
|
||||
items:
|
||||
type: object
|
||||
description: The address's addresses.
|
||||
x-schemaName: CreateCustomerAddress
|
||||
properties:
|
||||
address_name:
|
||||
type: string
|
||||
title: address_name
|
||||
description: The address's address name.
|
||||
is_default_shipping:
|
||||
type: boolean
|
||||
title: is_default_shipping
|
||||
description: The address's is default shipping.
|
||||
is_default_billing:
|
||||
type: boolean
|
||||
title: is_default_billing
|
||||
description: The address's is default billing.
|
||||
company:
|
||||
type: string
|
||||
title: company
|
||||
description: The address's company.
|
||||
first_name:
|
||||
type: string
|
||||
title: first_name
|
||||
description: The address's first name.
|
||||
last_name:
|
||||
type: string
|
||||
title: last_name
|
||||
description: The address's last name.
|
||||
address_1:
|
||||
type: string
|
||||
title: address_1
|
||||
description: The address's address 1.
|
||||
address_2:
|
||||
type: string
|
||||
title: address_2
|
||||
description: The address's address 2.
|
||||
city:
|
||||
type: string
|
||||
title: city
|
||||
description: The address's city.
|
||||
country_code:
|
||||
type: string
|
||||
title: country_code
|
||||
description: The address's country code.
|
||||
province:
|
||||
type: string
|
||||
title: province
|
||||
description: The address's province.
|
||||
postal_code:
|
||||
type: string
|
||||
title: postal_code
|
||||
description: The address's postal code.
|
||||
phone:
|
||||
type: string
|
||||
title: phone
|
||||
description: The address's phone.
|
||||
metadata:
|
||||
type: object
|
||||
description: The address's metadata.
|
||||
properties: {}
|
||||
metadata:
|
||||
type: object
|
||||
description: The customer's metadata.
|
||||
properties: {}
|
||||
@@ -0,0 +1,66 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: CreateCustomerAddress
|
||||
required:
|
||||
- customer_id
|
||||
properties:
|
||||
address_name:
|
||||
type: string
|
||||
title: address_name
|
||||
description: The customer's address name.
|
||||
is_default_shipping:
|
||||
type: boolean
|
||||
title: is_default_shipping
|
||||
description: The customer's is default shipping.
|
||||
is_default_billing:
|
||||
type: boolean
|
||||
title: is_default_billing
|
||||
description: The customer's is default billing.
|
||||
customer_id:
|
||||
type: string
|
||||
title: customer_id
|
||||
description: The customer's customer id.
|
||||
company:
|
||||
type: string
|
||||
title: company
|
||||
description: The customer's company.
|
||||
first_name:
|
||||
type: string
|
||||
title: first_name
|
||||
description: The customer's first name.
|
||||
last_name:
|
||||
type: string
|
||||
title: last_name
|
||||
description: The customer's last name.
|
||||
address_1:
|
||||
type: string
|
||||
title: address_1
|
||||
description: The customer's address 1.
|
||||
address_2:
|
||||
type: string
|
||||
title: address_2
|
||||
description: The customer's address 2.
|
||||
city:
|
||||
type: string
|
||||
title: city
|
||||
description: The customer's city.
|
||||
country_code:
|
||||
type: string
|
||||
title: country_code
|
||||
description: The customer's country code.
|
||||
province:
|
||||
type: string
|
||||
title: province
|
||||
description: The customer's province.
|
||||
postal_code:
|
||||
type: string
|
||||
title: postal_code
|
||||
description: The customer's postal code.
|
||||
phone:
|
||||
type: string
|
||||
title: phone
|
||||
description: The customer's phone.
|
||||
metadata:
|
||||
type: object
|
||||
description: The customer's metadata.
|
||||
properties: {}
|
||||
@@ -0,0 +1,18 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: CreateCustomerGroup
|
||||
required:
|
||||
- name
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
title: name
|
||||
description: The customer group's name.
|
||||
metadata:
|
||||
type: object
|
||||
description: The customer group's metadata.
|
||||
properties: {}
|
||||
created_by:
|
||||
type: string
|
||||
title: created_by
|
||||
description: The customer group's created by.
|
||||
@@ -0,0 +1,22 @@
|
||||
type: object
|
||||
description: The tax region's default tax rate.
|
||||
x-schemaName: CreateDefaultTaxRate
|
||||
required:
|
||||
- name
|
||||
properties:
|
||||
rate:
|
||||
type: number
|
||||
title: rate
|
||||
description: The default tax rate's rate.
|
||||
code:
|
||||
type: string
|
||||
title: code
|
||||
description: The default tax rate's code.
|
||||
name:
|
||||
type: string
|
||||
title: name
|
||||
description: The default tax rate's name.
|
||||
metadata:
|
||||
type: object
|
||||
description: The default tax rate's metadata.
|
||||
properties: {}
|
||||
@@ -0,0 +1,19 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: CreateInvite
|
||||
required:
|
||||
- email
|
||||
properties:
|
||||
email:
|
||||
type: string
|
||||
title: email
|
||||
description: The invite's email.
|
||||
format: email
|
||||
accepted:
|
||||
type: boolean
|
||||
title: accepted
|
||||
description: The invite's accepted.
|
||||
metadata:
|
||||
type: object
|
||||
description: The invite's metadata.
|
||||
properties: {}
|
||||
@@ -0,0 +1,256 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: CreateProduct
|
||||
required:
|
||||
- title
|
||||
properties:
|
||||
title:
|
||||
type: string
|
||||
title: title
|
||||
description: The product's title.
|
||||
subtitle:
|
||||
type: string
|
||||
title: subtitle
|
||||
description: The product's subtitle.
|
||||
description:
|
||||
type: string
|
||||
title: description
|
||||
description: The product's description.
|
||||
is_giftcard:
|
||||
type: boolean
|
||||
title: is_giftcard
|
||||
description: The product's is giftcard.
|
||||
discountable:
|
||||
type: boolean
|
||||
title: discountable
|
||||
description: The product's discountable.
|
||||
images:
|
||||
oneOf:
|
||||
- type: array
|
||||
description: The product's images.
|
||||
items:
|
||||
type: string
|
||||
title: images
|
||||
description: The image's images.
|
||||
- type: array
|
||||
description: The product's images.
|
||||
items:
|
||||
type: object
|
||||
description: The image's images.
|
||||
required:
|
||||
- url
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The image's ID.
|
||||
url:
|
||||
type: string
|
||||
title: url
|
||||
description: The image's url.
|
||||
thumbnail:
|
||||
type: string
|
||||
title: thumbnail
|
||||
description: The product's thumbnail.
|
||||
handle:
|
||||
type: string
|
||||
title: handle
|
||||
description: The product's handle.
|
||||
status:
|
||||
type: string
|
||||
enum:
|
||||
- draft
|
||||
- proposed
|
||||
- published
|
||||
- rejected
|
||||
type:
|
||||
$ref: ./CreateProductType.yaml
|
||||
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
|
||||
properties:
|
||||
title:
|
||||
type: string
|
||||
title: title
|
||||
description: The option's title.
|
||||
product_id:
|
||||
type: string
|
||||
title: product_id
|
||||
description: The option's product id.
|
||||
variants:
|
||||
type: array
|
||||
description: The product's variants.
|
||||
items:
|
||||
type: object
|
||||
description: The variant's variants.
|
||||
x-schemaName: CreateProductVariant
|
||||
required:
|
||||
- title
|
||||
properties:
|
||||
product_id:
|
||||
type: string
|
||||
title: product_id
|
||||
description: The variant's product id.
|
||||
title:
|
||||
type: string
|
||||
title: title
|
||||
description: The variant's title.
|
||||
sku:
|
||||
type: string
|
||||
title: sku
|
||||
description: The variant's sku.
|
||||
barcode:
|
||||
type: string
|
||||
title: barcode
|
||||
description: The variant's barcode.
|
||||
ean:
|
||||
type: string
|
||||
title: ean
|
||||
description: The variant's ean.
|
||||
upc:
|
||||
type: string
|
||||
title: upc
|
||||
description: The variant's upc.
|
||||
allow_backorder:
|
||||
type: boolean
|
||||
title: allow_backorder
|
||||
description: The variant's allow backorder.
|
||||
inventory_quantity:
|
||||
type: number
|
||||
title: inventory_quantity
|
||||
description: The variant's inventory quantity.
|
||||
manage_inventory:
|
||||
type: boolean
|
||||
title: manage_inventory
|
||||
description: The variant's manage inventory.
|
||||
hs_code:
|
||||
type: string
|
||||
title: hs_code
|
||||
description: The variant's hs code.
|
||||
origin_country:
|
||||
type: string
|
||||
title: origin_country
|
||||
description: The variant's origin country.
|
||||
mid_code:
|
||||
type: string
|
||||
title: mid_code
|
||||
description: The variant's mid code.
|
||||
material:
|
||||
type: string
|
||||
title: material
|
||||
description: The variant's material.
|
||||
weight:
|
||||
type: number
|
||||
title: weight
|
||||
description: The variant's weight.
|
||||
length:
|
||||
type: number
|
||||
title: length
|
||||
description: The variant's length.
|
||||
height:
|
||||
type: number
|
||||
title: height
|
||||
description: The variant's height.
|
||||
width:
|
||||
type: number
|
||||
title: width
|
||||
description: The variant's width.
|
||||
options:
|
||||
type: array
|
||||
description: The variant's options.
|
||||
items:
|
||||
type: object
|
||||
description: The option's options.
|
||||
x-schemaName: CreateProductVariantOption
|
||||
required:
|
||||
- value
|
||||
properties:
|
||||
value:
|
||||
type: string
|
||||
title: value
|
||||
description: The option's value.
|
||||
option_id:
|
||||
type: string
|
||||
title: option_id
|
||||
description: The option's option id.
|
||||
metadata:
|
||||
type: object
|
||||
description: The variant's metadata.
|
||||
properties: {}
|
||||
width:
|
||||
type: number
|
||||
title: width
|
||||
description: The product's width.
|
||||
height:
|
||||
type: number
|
||||
title: height
|
||||
description: The product's height.
|
||||
length:
|
||||
type: number
|
||||
title: length
|
||||
description: The product's length.
|
||||
weight:
|
||||
type: number
|
||||
title: weight
|
||||
description: The product's weight.
|
||||
origin_country:
|
||||
type: string
|
||||
title: origin_country
|
||||
description: The product's origin country.
|
||||
hs_code:
|
||||
type: string
|
||||
title: hs_code
|
||||
description: The product's hs code.
|
||||
material:
|
||||
type: string
|
||||
title: material
|
||||
description: The product's material.
|
||||
mid_code:
|
||||
type: string
|
||||
title: mid_code
|
||||
description: The product's mid code.
|
||||
metadata:
|
||||
type: object
|
||||
description: The product's metadata.
|
||||
properties: {}
|
||||
@@ -0,0 +1,25 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: CreateProductCollection
|
||||
required:
|
||||
- title
|
||||
properties:
|
||||
title:
|
||||
type: string
|
||||
title: title
|
||||
description: The collection's title.
|
||||
handle:
|
||||
type: string
|
||||
title: handle
|
||||
description: The collection's handle.
|
||||
product_ids:
|
||||
type: array
|
||||
description: The collection's product ids.
|
||||
items:
|
||||
type: string
|
||||
title: product_ids
|
||||
description: The product id's product ids.
|
||||
metadata:
|
||||
type: object
|
||||
description: The collection's metadata.
|
||||
properties: {}
|
||||
@@ -0,0 +1,14 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: CreateProductOption
|
||||
required:
|
||||
- title
|
||||
properties:
|
||||
title:
|
||||
type: string
|
||||
title: title
|
||||
description: The product's title.
|
||||
product_id:
|
||||
type: string
|
||||
title: product_id
|
||||
description: The product's product id.
|
||||
@@ -0,0 +1,10 @@
|
||||
type: object
|
||||
description: The tag's tags.
|
||||
x-schemaName: CreateProductTag
|
||||
required:
|
||||
- value
|
||||
properties:
|
||||
value:
|
||||
type: string
|
||||
title: value
|
||||
description: The tag's value.
|
||||
@@ -0,0 +1,18 @@
|
||||
type: object
|
||||
description: The product's type.
|
||||
x-schemaName: CreateProductType
|
||||
required:
|
||||
- value
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The type's ID.
|
||||
value:
|
||||
type: string
|
||||
title: value
|
||||
description: The type's value.
|
||||
metadata:
|
||||
type: object
|
||||
description: The type's metadata.
|
||||
properties: {}
|
||||
@@ -0,0 +1,96 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: CreateProductVariant
|
||||
required:
|
||||
- title
|
||||
properties:
|
||||
product_id:
|
||||
type: string
|
||||
title: product_id
|
||||
description: The product's product id.
|
||||
title:
|
||||
type: string
|
||||
title: title
|
||||
description: The product's title.
|
||||
sku:
|
||||
type: string
|
||||
title: sku
|
||||
description: The product's sku.
|
||||
barcode:
|
||||
type: string
|
||||
title: barcode
|
||||
description: The product's barcode.
|
||||
ean:
|
||||
type: string
|
||||
title: ean
|
||||
description: The product's ean.
|
||||
upc:
|
||||
type: string
|
||||
title: upc
|
||||
description: The product's upc.
|
||||
allow_backorder:
|
||||
type: boolean
|
||||
title: allow_backorder
|
||||
description: The product's allow backorder.
|
||||
inventory_quantity:
|
||||
type: number
|
||||
title: inventory_quantity
|
||||
description: The product's inventory quantity.
|
||||
manage_inventory:
|
||||
type: boolean
|
||||
title: manage_inventory
|
||||
description: The product's manage inventory.
|
||||
hs_code:
|
||||
type: string
|
||||
title: hs_code
|
||||
description: The product's hs code.
|
||||
origin_country:
|
||||
type: string
|
||||
title: origin_country
|
||||
description: The product's origin country.
|
||||
mid_code:
|
||||
type: string
|
||||
title: mid_code
|
||||
description: The product's mid code.
|
||||
material:
|
||||
type: string
|
||||
title: material
|
||||
description: The product's material.
|
||||
weight:
|
||||
type: number
|
||||
title: weight
|
||||
description: The product's weight.
|
||||
length:
|
||||
type: number
|
||||
title: length
|
||||
description: The product's length.
|
||||
height:
|
||||
type: number
|
||||
title: height
|
||||
description: The product's height.
|
||||
width:
|
||||
type: number
|
||||
title: width
|
||||
description: The product's width.
|
||||
options:
|
||||
type: array
|
||||
description: The product's options.
|
||||
items:
|
||||
type: object
|
||||
description: The option's options.
|
||||
x-schemaName: CreateProductVariantOption
|
||||
required:
|
||||
- value
|
||||
properties:
|
||||
value:
|
||||
type: string
|
||||
title: value
|
||||
description: The option's value.
|
||||
option_id:
|
||||
type: string
|
||||
title: option_id
|
||||
description: The option's option id.
|
||||
metadata:
|
||||
type: object
|
||||
description: The product's metadata.
|
||||
properties: {}
|
||||
+14
@@ -0,0 +1,14 @@
|
||||
type: object
|
||||
description: The option's options.
|
||||
x-schemaName: CreateProductVariantOption
|
||||
required:
|
||||
- value
|
||||
properties:
|
||||
value:
|
||||
type: string
|
||||
title: value
|
||||
description: The option's value.
|
||||
option_id:
|
||||
type: string
|
||||
title: option_id
|
||||
description: The option's option id.
|
||||
@@ -0,0 +1,69 @@
|
||||
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: ./CreateApplicationMethod.yaml
|
||||
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: ./CreateCampaign.yaml
|
||||
campaign_id:
|
||||
type: string
|
||||
title: campaign_id
|
||||
description: The promotion's campaign id.
|
||||
@@ -0,0 +1,37 @@
|
||||
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.
|
||||
@@ -0,0 +1,26 @@
|
||||
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.
|
||||
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,15 @@
|
||||
type: object
|
||||
description: The rule's rules.
|
||||
x-schemaName: CreateTaxRateRule
|
||||
required:
|
||||
- reference
|
||||
- reference_id
|
||||
properties:
|
||||
reference:
|
||||
type: string
|
||||
title: reference
|
||||
description: The rule's reference.
|
||||
reference_id:
|
||||
type: string
|
||||
title: reference_id
|
||||
description: The rule's reference id.
|
||||
@@ -0,0 +1,27 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: CreateUser
|
||||
required:
|
||||
- email
|
||||
properties:
|
||||
email:
|
||||
type: string
|
||||
title: email
|
||||
description: The user's email.
|
||||
format: email
|
||||
first_name:
|
||||
type: string
|
||||
title: first_name
|
||||
description: The user's first name.
|
||||
last_name:
|
||||
type: string
|
||||
title: last_name
|
||||
description: The user's last name.
|
||||
avatar_url:
|
||||
type: string
|
||||
title: avatar_url
|
||||
description: The user's avatar url.
|
||||
metadata:
|
||||
type: object
|
||||
description: The user's metadata.
|
||||
properties: {}
|
||||
@@ -0,0 +1,87 @@
|
||||
type: object
|
||||
description: The context's customer.
|
||||
x-schemaName: Customer
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The customer's ID.
|
||||
email:
|
||||
type: string
|
||||
title: email
|
||||
description: The customer's email.
|
||||
format: email
|
||||
default_billing_address_id:
|
||||
type: string
|
||||
title: default_billing_address_id
|
||||
description: The customer's default billing address id.
|
||||
default_shipping_address_id:
|
||||
type: string
|
||||
title: default_shipping_address_id
|
||||
description: The customer's default shipping address id.
|
||||
company_name:
|
||||
type: string
|
||||
title: company_name
|
||||
description: The customer's company name.
|
||||
first_name:
|
||||
type: string
|
||||
title: first_name
|
||||
description: The customer's first name.
|
||||
last_name:
|
||||
type: string
|
||||
title: last_name
|
||||
description: The customer's last name.
|
||||
addresses:
|
||||
type: array
|
||||
description: The customer's addresses.
|
||||
items:
|
||||
type: object
|
||||
description: The address's addresses.
|
||||
x-schemaName: CustomerAddress
|
||||
properties: {}
|
||||
phone:
|
||||
type: string
|
||||
title: phone
|
||||
description: The customer's phone.
|
||||
groups:
|
||||
type: array
|
||||
description: The customer's groups.
|
||||
items:
|
||||
type: object
|
||||
description: The group's groups.
|
||||
properties: {}
|
||||
metadata:
|
||||
type: object
|
||||
description: The customer's metadata.
|
||||
properties: {}
|
||||
created_by:
|
||||
type: string
|
||||
title: created_by
|
||||
description: The customer's created by.
|
||||
deleted_at:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: deleted_at
|
||||
description: The customer's deleted at.
|
||||
- type: string
|
||||
title: deleted_at
|
||||
description: The customer's deleted at.
|
||||
format: date-time
|
||||
created_at:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: created_at
|
||||
description: The customer's created at.
|
||||
- type: string
|
||||
title: created_at
|
||||
description: The customer's created at.
|
||||
format: date-time
|
||||
updated_at:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: updated_at
|
||||
description: The customer's updated at.
|
||||
- type: string
|
||||
title: updated_at
|
||||
description: The customer's updated at.
|
||||
format: date-time
|
||||
@@ -0,0 +1,76 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: CustomerAddress
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The customer's ID.
|
||||
address_name:
|
||||
type: string
|
||||
title: address_name
|
||||
description: The customer's address name.
|
||||
is_default_shipping:
|
||||
type: boolean
|
||||
title: is_default_shipping
|
||||
description: The customer's is default shipping.
|
||||
is_default_billing:
|
||||
type: boolean
|
||||
title: is_default_billing
|
||||
description: The customer's is default billing.
|
||||
customer_id:
|
||||
type: string
|
||||
title: customer_id
|
||||
description: The customer's customer id.
|
||||
company:
|
||||
type: string
|
||||
title: company
|
||||
description: The customer's company.
|
||||
first_name:
|
||||
type: string
|
||||
title: first_name
|
||||
description: The customer's first name.
|
||||
last_name:
|
||||
type: string
|
||||
title: last_name
|
||||
description: The customer's last name.
|
||||
address_1:
|
||||
type: string
|
||||
title: address_1
|
||||
description: The customer's address 1.
|
||||
address_2:
|
||||
type: string
|
||||
title: address_2
|
||||
description: The customer's address 2.
|
||||
city:
|
||||
type: string
|
||||
title: city
|
||||
description: The customer's city.
|
||||
country_code:
|
||||
type: string
|
||||
title: country_code
|
||||
description: The customer's country code.
|
||||
province:
|
||||
type: string
|
||||
title: province
|
||||
description: The customer's province.
|
||||
postal_code:
|
||||
type: string
|
||||
title: postal_code
|
||||
description: The customer's postal code.
|
||||
phone:
|
||||
type: string
|
||||
title: phone
|
||||
description: The customer's phone.
|
||||
metadata:
|
||||
type: object
|
||||
description: The customer's metadata.
|
||||
properties: {}
|
||||
created_at:
|
||||
type: string
|
||||
title: created_at
|
||||
description: The customer's created at.
|
||||
updated_at:
|
||||
type: string
|
||||
title: updated_at
|
||||
description: The customer's updated at.
|
||||
+12
@@ -0,0 +1,12 @@
|
||||
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: {}
|
||||
+10
@@ -0,0 +1,10 @@
|
||||
type: object
|
||||
description: The customer id's customer ids.
|
||||
x-schemaName: CustomerGroupsBatchCustomer
|
||||
required:
|
||||
- id
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The customer id's ID.
|
||||
@@ -0,0 +1,29 @@
|
||||
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,33 @@
|
||||
title: Response Error
|
||||
type: object
|
||||
properties:
|
||||
code:
|
||||
type: string
|
||||
description: A slug code to indicate the type of the error.
|
||||
enum:
|
||||
- invalid_state_error
|
||||
- invalid_request_error
|
||||
- api_error
|
||||
- unknown_error
|
||||
message:
|
||||
type: string
|
||||
description: Description of the error that occurred.
|
||||
example: first_name must be a string
|
||||
type:
|
||||
type: string
|
||||
description: A slug indicating the type of the error.
|
||||
enum:
|
||||
- QueryRunnerAlreadyReleasedError
|
||||
- TransactionAlreadyStartedError
|
||||
- TransactionNotStartedError
|
||||
- conflict
|
||||
- unauthorized
|
||||
- payment_authorization_error
|
||||
- duplicate_error
|
||||
- not_allowed
|
||||
- invalid_data
|
||||
- not_found
|
||||
- database_error
|
||||
- unexpected_state
|
||||
- invalid_argument
|
||||
- unknown_error
|
||||
@@ -0,0 +1,10 @@
|
||||
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,13 @@
|
||||
title: Multiple Errors
|
||||
type: object
|
||||
properties:
|
||||
errors:
|
||||
type: array
|
||||
description: Array of errors
|
||||
items:
|
||||
$ref: ./Error.yaml
|
||||
message:
|
||||
type: string
|
||||
default: >-
|
||||
Provided request body contains errors. Please check the data and retry the
|
||||
request
|
||||
@@ -0,0 +1,10 @@
|
||||
type: object
|
||||
description: The promotion's promotions.
|
||||
x-schemaName: Promotion
|
||||
required:
|
||||
- id
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The promotion's ID.
|
||||
@@ -0,0 +1,33 @@
|
||||
type: object
|
||||
description: The rule's 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 rule's description.
|
||||
attribute:
|
||||
type: string
|
||||
title: attribute
|
||||
description: The rule's attribute.
|
||||
values:
|
||||
type: array
|
||||
description: The rule's values.
|
||||
items:
|
||||
type: string
|
||||
title: values
|
||||
description: The value's values.
|
||||
@@ -0,0 +1,39 @@
|
||||
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.
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: StorePostCartsCartTaxesReq
|
||||
properties: {}
|
||||
+15
@@ -0,0 +1,15 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: StorePostPaymentCollectionsPaymentSessionReq
|
||||
required:
|
||||
- provider_id
|
||||
properties:
|
||||
provider_id:
|
||||
type: string
|
||||
title: provider_id
|
||||
description: The payment collection's provider id.
|
||||
context: {}
|
||||
data:
|
||||
type: object
|
||||
description: The payment collection's data.
|
||||
properties: {}
|
||||
@@ -0,0 +1,58 @@
|
||||
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: {}
|
||||
@@ -0,0 +1,8 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: UpdateApiKey
|
||||
properties:
|
||||
title:
|
||||
type: string
|
||||
title: title
|
||||
description: The api key's title.
|
||||
@@ -0,0 +1,261 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: UpdateCartData
|
||||
properties:
|
||||
region_id:
|
||||
type: string
|
||||
title: region_id
|
||||
description: The cart's region id.
|
||||
customer_id:
|
||||
type: string
|
||||
title: customer_id
|
||||
description: The cart's customer id.
|
||||
sales_channel_id:
|
||||
type: string
|
||||
title: sales_channel_id
|
||||
description: The cart's sales channel id.
|
||||
email:
|
||||
type: string
|
||||
title: email
|
||||
description: The cart's email.
|
||||
format: email
|
||||
currency_code:
|
||||
type: string
|
||||
title: currency_code
|
||||
description: The cart's currency code.
|
||||
shipping_address_id:
|
||||
type: string
|
||||
title: shipping_address_id
|
||||
description: The cart's shipping address id.
|
||||
billing_address_id:
|
||||
type: string
|
||||
title: billing_address_id
|
||||
description: The cart's billing address id.
|
||||
billing_address:
|
||||
oneOf:
|
||||
- type: object
|
||||
description: The cart's billing address.
|
||||
x-schemaName: CreateAddress
|
||||
properties:
|
||||
customer_id:
|
||||
type: string
|
||||
title: customer_id
|
||||
description: The billing address's customer id.
|
||||
company:
|
||||
type: string
|
||||
title: company
|
||||
description: The billing address's company.
|
||||
first_name:
|
||||
type: string
|
||||
title: first_name
|
||||
description: The billing address's first name.
|
||||
last_name:
|
||||
type: string
|
||||
title: last_name
|
||||
description: The billing address's last name.
|
||||
address_1:
|
||||
type: string
|
||||
title: address_1
|
||||
description: The billing address's address 1.
|
||||
address_2:
|
||||
type: string
|
||||
title: address_2
|
||||
description: The billing address's address 2.
|
||||
city:
|
||||
type: string
|
||||
title: city
|
||||
description: The billing address's city.
|
||||
country_code:
|
||||
type: string
|
||||
title: country_code
|
||||
description: The billing address's country code.
|
||||
province:
|
||||
type: string
|
||||
title: province
|
||||
description: The billing address's province.
|
||||
postal_code:
|
||||
type: string
|
||||
title: postal_code
|
||||
description: The billing address's postal code.
|
||||
phone:
|
||||
type: string
|
||||
title: phone
|
||||
description: The billing address's phone.
|
||||
metadata:
|
||||
type: object
|
||||
description: The billing address's metadata.
|
||||
properties: {}
|
||||
- type: object
|
||||
description: The cart's billing address.
|
||||
x-schemaName: UpdateAddress
|
||||
required:
|
||||
- id
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The billing address's ID.
|
||||
customer_id:
|
||||
type: string
|
||||
title: customer_id
|
||||
description: The billing address's customer id.
|
||||
company:
|
||||
type: string
|
||||
title: company
|
||||
description: The billing address's company.
|
||||
first_name:
|
||||
type: string
|
||||
title: first_name
|
||||
description: The billing address's first name.
|
||||
last_name:
|
||||
type: string
|
||||
title: last_name
|
||||
description: The billing address's last name.
|
||||
address_1:
|
||||
type: string
|
||||
title: address_1
|
||||
description: The billing address's address 1.
|
||||
address_2:
|
||||
type: string
|
||||
title: address_2
|
||||
description: The billing address's address 2.
|
||||
city:
|
||||
type: string
|
||||
title: city
|
||||
description: The billing address's city.
|
||||
country_code:
|
||||
type: string
|
||||
title: country_code
|
||||
description: The billing address's country code.
|
||||
province:
|
||||
type: string
|
||||
title: province
|
||||
description: The billing address's province.
|
||||
postal_code:
|
||||
type: string
|
||||
title: postal_code
|
||||
description: The billing address's postal code.
|
||||
phone:
|
||||
type: string
|
||||
title: phone
|
||||
description: The billing address's phone.
|
||||
metadata:
|
||||
type: object
|
||||
description: The billing address's metadata.
|
||||
properties: {}
|
||||
shipping_address:
|
||||
oneOf:
|
||||
- type: object
|
||||
description: The cart's shipping address.
|
||||
x-schemaName: CreateAddress
|
||||
properties:
|
||||
customer_id:
|
||||
type: string
|
||||
title: customer_id
|
||||
description: The shipping address's customer id.
|
||||
company:
|
||||
type: string
|
||||
title: company
|
||||
description: The shipping address's company.
|
||||
first_name:
|
||||
type: string
|
||||
title: first_name
|
||||
description: The shipping address's first name.
|
||||
last_name:
|
||||
type: string
|
||||
title: last_name
|
||||
description: The shipping address's last name.
|
||||
address_1:
|
||||
type: string
|
||||
title: address_1
|
||||
description: The shipping address's address 1.
|
||||
address_2:
|
||||
type: string
|
||||
title: address_2
|
||||
description: The shipping address's address 2.
|
||||
city:
|
||||
type: string
|
||||
title: city
|
||||
description: The shipping address's city.
|
||||
country_code:
|
||||
type: string
|
||||
title: country_code
|
||||
description: The shipping address's country code.
|
||||
province:
|
||||
type: string
|
||||
title: province
|
||||
description: The shipping address's province.
|
||||
postal_code:
|
||||
type: string
|
||||
title: postal_code
|
||||
description: The shipping address's postal code.
|
||||
phone:
|
||||
type: string
|
||||
title: phone
|
||||
description: The shipping address's phone.
|
||||
metadata:
|
||||
type: object
|
||||
description: The shipping address's metadata.
|
||||
properties: {}
|
||||
- type: object
|
||||
description: The cart's shipping address.
|
||||
x-schemaName: UpdateAddress
|
||||
required:
|
||||
- id
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The shipping address's ID.
|
||||
customer_id:
|
||||
type: string
|
||||
title: customer_id
|
||||
description: The shipping address's customer id.
|
||||
company:
|
||||
type: string
|
||||
title: company
|
||||
description: The shipping address's company.
|
||||
first_name:
|
||||
type: string
|
||||
title: first_name
|
||||
description: The shipping address's first name.
|
||||
last_name:
|
||||
type: string
|
||||
title: last_name
|
||||
description: The shipping address's last name.
|
||||
address_1:
|
||||
type: string
|
||||
title: address_1
|
||||
description: The shipping address's address 1.
|
||||
address_2:
|
||||
type: string
|
||||
title: address_2
|
||||
description: The shipping address's address 2.
|
||||
city:
|
||||
type: string
|
||||
title: city
|
||||
description: The shipping address's city.
|
||||
country_code:
|
||||
type: string
|
||||
title: country_code
|
||||
description: The shipping address's country code.
|
||||
province:
|
||||
type: string
|
||||
title: province
|
||||
description: The shipping address's province.
|
||||
postal_code:
|
||||
type: string
|
||||
title: postal_code
|
||||
description: The shipping address's postal code.
|
||||
phone:
|
||||
type: string
|
||||
title: phone
|
||||
description: The shipping address's phone.
|
||||
metadata:
|
||||
type: object
|
||||
description: The shipping address's metadata.
|
||||
properties: {}
|
||||
metadata:
|
||||
type: object
|
||||
description: The cart's metadata.
|
||||
properties: {}
|
||||
@@ -0,0 +1,271 @@
|
||||
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: ./CreateProductType.yaml
|
||||
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
|
||||
properties:
|
||||
title:
|
||||
type: string
|
||||
title: title
|
||||
description: The option's title.
|
||||
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
|
||||
required:
|
||||
- title
|
||||
- metadata
|
||||
- sku
|
||||
- barcode
|
||||
- ean
|
||||
- upc
|
||||
- allow_backorder
|
||||
- inventory_quantity
|
||||
- manage_inventory
|
||||
- hs_code
|
||||
- origin_country
|
||||
- mid_code
|
||||
- material
|
||||
- weight
|
||||
- length
|
||||
- height
|
||||
- width
|
||||
- options
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The variant's ID.
|
||||
title:
|
||||
type: string
|
||||
title: title
|
||||
description: The variant's title.
|
||||
metadata:
|
||||
type: object
|
||||
description: The variant's metadata.
|
||||
properties: {}
|
||||
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: array
|
||||
description: The variant's options.
|
||||
items:
|
||||
type: object
|
||||
description: The option's options.
|
||||
x-schemaName: CreateProductVariantOption
|
||||
required:
|
||||
- value
|
||||
properties:
|
||||
value:
|
||||
type: string
|
||||
title: value
|
||||
description: The option's value.
|
||||
option_id:
|
||||
type: string
|
||||
title: option_id
|
||||
description: The option's option id.
|
||||
width:
|
||||
type: number
|
||||
title: width
|
||||
description: The product's width.
|
||||
height:
|
||||
type: number
|
||||
title: height
|
||||
description: The product's height.
|
||||
length:
|
||||
type: number
|
||||
title: length
|
||||
description: The product's length.
|
||||
weight:
|
||||
type: number
|
||||
title: weight
|
||||
description: The product's weight.
|
||||
origin_country:
|
||||
type: string
|
||||
title: origin_country
|
||||
description: The product's origin country.
|
||||
hs_code:
|
||||
type: string
|
||||
title: hs_code
|
||||
description: The product's hs code.
|
||||
material:
|
||||
type: string
|
||||
title: material
|
||||
description: The product's material.
|
||||
mid_code:
|
||||
type: string
|
||||
title: mid_code
|
||||
description: The product's mid code.
|
||||
metadata:
|
||||
type: object
|
||||
description: The product's metadata.
|
||||
properties: {}
|
||||
@@ -0,0 +1,27 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: UpdateProductCollection
|
||||
properties:
|
||||
value:
|
||||
type: string
|
||||
title: value
|
||||
description: The collection's value.
|
||||
title:
|
||||
type: string
|
||||
title: title
|
||||
description: The collection's title.
|
||||
handle:
|
||||
type: string
|
||||
title: handle
|
||||
description: The collection's handle.
|
||||
product_ids:
|
||||
type: array
|
||||
description: The collection's product ids.
|
||||
items:
|
||||
type: string
|
||||
title: product_ids
|
||||
description: The product id's product ids.
|
||||
metadata:
|
||||
type: object
|
||||
description: The collection's metadata.
|
||||
properties: {}
|
||||
@@ -0,0 +1,18 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: UpdateProductOption
|
||||
required:
|
||||
- id
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The product's ID.
|
||||
title:
|
||||
type: string
|
||||
title: title
|
||||
description: The product's title.
|
||||
product_id:
|
||||
type: string
|
||||
title: product_id
|
||||
description: The product's product id.
|
||||
@@ -0,0 +1,96 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: UpdateProductVariant
|
||||
required:
|
||||
- id
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The product's ID.
|
||||
title:
|
||||
type: string
|
||||
title: title
|
||||
description: The product's title.
|
||||
sku:
|
||||
type: string
|
||||
title: sku
|
||||
description: The product's sku.
|
||||
barcode:
|
||||
type: string
|
||||
title: barcode
|
||||
description: The product's barcode.
|
||||
ean:
|
||||
type: string
|
||||
title: ean
|
||||
description: The product's ean.
|
||||
upc:
|
||||
type: string
|
||||
title: upc
|
||||
description: The product's upc.
|
||||
allow_backorder:
|
||||
type: boolean
|
||||
title: allow_backorder
|
||||
description: The product's allow backorder.
|
||||
inventory_quantity:
|
||||
type: number
|
||||
title: inventory_quantity
|
||||
description: The product's inventory quantity.
|
||||
manage_inventory:
|
||||
type: boolean
|
||||
title: manage_inventory
|
||||
description: The product's manage inventory.
|
||||
hs_code:
|
||||
type: string
|
||||
title: hs_code
|
||||
description: The product's hs code.
|
||||
origin_country:
|
||||
type: string
|
||||
title: origin_country
|
||||
description: The product's origin country.
|
||||
mid_code:
|
||||
type: string
|
||||
title: mid_code
|
||||
description: The product's mid code.
|
||||
material:
|
||||
type: string
|
||||
title: material
|
||||
description: The product's material.
|
||||
weight:
|
||||
type: number
|
||||
title: weight
|
||||
description: The product's weight.
|
||||
length:
|
||||
type: number
|
||||
title: length
|
||||
description: The product's length.
|
||||
height:
|
||||
type: number
|
||||
title: height
|
||||
description: The product's height.
|
||||
width:
|
||||
type: number
|
||||
title: width
|
||||
description: The product's width.
|
||||
options:
|
||||
type: array
|
||||
description: The product's options.
|
||||
items:
|
||||
type: object
|
||||
description: The option's options.
|
||||
x-schemaName: CreateProductVariantOption
|
||||
required:
|
||||
- value
|
||||
properties:
|
||||
value:
|
||||
type: string
|
||||
title: value
|
||||
description: The option's value.
|
||||
option_id:
|
||||
type: string
|
||||
title: option_id
|
||||
description: The option's option id.
|
||||
metadata:
|
||||
type: object
|
||||
description: The product's metadata.
|
||||
properties: {}
|
||||
@@ -0,0 +1,23 @@
|
||||
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.
|
||||
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,113 @@
|
||||
type: object
|
||||
description: The variant's variants.
|
||||
x-schemaName: UpsertProductVariant
|
||||
required:
|
||||
- title
|
||||
- metadata
|
||||
- sku
|
||||
- barcode
|
||||
- ean
|
||||
- upc
|
||||
- allow_backorder
|
||||
- inventory_quantity
|
||||
- manage_inventory
|
||||
- hs_code
|
||||
- origin_country
|
||||
- mid_code
|
||||
- material
|
||||
- weight
|
||||
- length
|
||||
- height
|
||||
- width
|
||||
- options
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The variant's ID.
|
||||
title:
|
||||
type: string
|
||||
title: title
|
||||
description: The variant's title.
|
||||
metadata:
|
||||
type: object
|
||||
description: The variant's metadata.
|
||||
properties: {}
|
||||
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: array
|
||||
description: The variant's options.
|
||||
items:
|
||||
type: object
|
||||
description: The option's options.
|
||||
x-schemaName: CreateProductVariantOption
|
||||
required:
|
||||
- value
|
||||
properties:
|
||||
value:
|
||||
type: string
|
||||
title: value
|
||||
description: The option's value.
|
||||
option_id:
|
||||
type: string
|
||||
title: option_id
|
||||
description: The option's option id.
|
||||
Reference in New Issue
Block a user