docs: generate OAS for v2 (#7883)
This commit is contained in:
Shahed Nasser
@@ -1,14 +1,10 @@
|
||||
description: Client Error or Multiple Errors
|
||||
description: Client Error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: ../schemas/Error.yaml
|
||||
- $ref: ../schemas/MultipleErrors.yaml
|
||||
$ref: ../schemas/Error.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,10 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminArchiveOrder
|
||||
required:
|
||||
- order_id
|
||||
properties:
|
||||
order_id:
|
||||
type: string
|
||||
title: order_id
|
||||
description: The order's order id.
|
||||
@@ -0,0 +1,21 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminBatchProductRequest
|
||||
properties:
|
||||
create:
|
||||
type: array
|
||||
description: The product's create.
|
||||
items:
|
||||
$ref: ./AdminCreateProduct.yaml
|
||||
update:
|
||||
type: array
|
||||
description: The product's update.
|
||||
items:
|
||||
$ref: ./AdminUpdateProduct.yaml
|
||||
delete:
|
||||
type: array
|
||||
description: The product's delete.
|
||||
items:
|
||||
type: string
|
||||
title: delete
|
||||
description: The delete's details.
|
||||
@@ -0,0 +1,41 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminBatchProductResponse
|
||||
required:
|
||||
- created
|
||||
- updated
|
||||
- deleted
|
||||
properties:
|
||||
created:
|
||||
type: array
|
||||
description: The product's created.
|
||||
items:
|
||||
$ref: ./AdminProduct.yaml
|
||||
updated:
|
||||
type: array
|
||||
description: The product's updated.
|
||||
items:
|
||||
$ref: ./AdminProduct.yaml
|
||||
deleted:
|
||||
type: object
|
||||
description: The product's deleted.
|
||||
required:
|
||||
- ids
|
||||
- object
|
||||
- deleted
|
||||
properties:
|
||||
ids:
|
||||
type: array
|
||||
description: The deleted's ids.
|
||||
items:
|
||||
type: string
|
||||
title: ids
|
||||
description: The id's ids.
|
||||
object:
|
||||
type: string
|
||||
title: object
|
||||
description: The deleted's object.
|
||||
deleted:
|
||||
type: boolean
|
||||
title: deleted
|
||||
description: The deleted's details.
|
||||
+21
@@ -0,0 +1,21 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminBatchProductVariantRequest
|
||||
properties:
|
||||
create:
|
||||
type: array
|
||||
description: The product's create.
|
||||
items:
|
||||
$ref: ./AdminCreateProductVariant.yaml
|
||||
update:
|
||||
type: array
|
||||
description: The product's update.
|
||||
items:
|
||||
$ref: ./AdminUpdateProductVariant.yaml
|
||||
delete:
|
||||
type: array
|
||||
description: The product's delete.
|
||||
items:
|
||||
type: string
|
||||
title: delete
|
||||
description: The delete's details.
|
||||
+41
@@ -0,0 +1,41 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminBatchProductVariantResponse
|
||||
required:
|
||||
- created
|
||||
- updated
|
||||
- deleted
|
||||
properties:
|
||||
created:
|
||||
type: array
|
||||
description: The product's created.
|
||||
items:
|
||||
$ref: ./AdminProductVariant.yaml
|
||||
updated:
|
||||
type: array
|
||||
description: The product's updated.
|
||||
items:
|
||||
$ref: ./AdminProductVariant.yaml
|
||||
deleted:
|
||||
type: object
|
||||
description: The product's deleted.
|
||||
required:
|
||||
- ids
|
||||
- object
|
||||
- deleted
|
||||
properties:
|
||||
ids:
|
||||
type: array
|
||||
description: The deleted's ids.
|
||||
items:
|
||||
type: string
|
||||
title: ids
|
||||
description: The id's ids.
|
||||
object:
|
||||
type: string
|
||||
title: object
|
||||
description: The deleted's object.
|
||||
deleted:
|
||||
type: boolean
|
||||
title: deleted
|
||||
description: The deleted's details.
|
||||
@@ -0,0 +1,3 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminCancelFulfillment
|
||||
@@ -0,0 +1,39 @@
|
||||
type: object
|
||||
description: The parent's collection.
|
||||
x-schemaName: AdminCollection
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The collection's ID.
|
||||
title:
|
||||
type: string
|
||||
title: title
|
||||
description: The collection's title.
|
||||
handle:
|
||||
type: string
|
||||
title: handle
|
||||
description: The collection's handle.
|
||||
created_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: created_at
|
||||
description: The collection's created at.
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: updated_at
|
||||
description: The collection's updated at.
|
||||
deleted_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: deleted_at
|
||||
description: The collection's deleted at.
|
||||
products:
|
||||
type: array
|
||||
description: The collection's products.
|
||||
items:
|
||||
type: object
|
||||
metadata:
|
||||
type: object
|
||||
description: The collection's metadata.
|
||||
@@ -0,0 +1,10 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminCompleteOrder
|
||||
required:
|
||||
- order_id
|
||||
properties:
|
||||
order_id:
|
||||
type: string
|
||||
title: order_id
|
||||
description: The order's order id.
|
||||
+2
-2
@@ -1,6 +1,6 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: CreateApiKey
|
||||
x-schemaName: AdminCreateApiKey
|
||||
required:
|
||||
- title
|
||||
- type
|
||||
@@ -12,5 +12,5 @@ properties:
|
||||
type:
|
||||
type: string
|
||||
enum:
|
||||
- secret
|
||||
- publishable
|
||||
- secret
|
||||
+2
-9
@@ -1,8 +1,9 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: CreateProductCollection
|
||||
x-schemaName: AdminCreateCollection
|
||||
required:
|
||||
- title
|
||||
- metadata
|
||||
properties:
|
||||
title:
|
||||
type: string
|
||||
@@ -12,14 +13,6 @@ properties:
|
||||
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: {}
|
||||
+13
-7
@@ -1,7 +1,19 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: CustomerUpdatableFields
|
||||
x-schemaName: AdminCreateCustomer
|
||||
required:
|
||||
- email
|
||||
- company_name
|
||||
- first_name
|
||||
- last_name
|
||||
- phone
|
||||
- metadata
|
||||
properties:
|
||||
email:
|
||||
type: string
|
||||
title: email
|
||||
description: The customer's email.
|
||||
format: email
|
||||
company_name:
|
||||
type: string
|
||||
title: company_name
|
||||
@@ -14,11 +26,6 @@ properties:
|
||||
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
|
||||
@@ -26,4 +33,3 @@ properties:
|
||||
metadata:
|
||||
type: object
|
||||
description: The customer's metadata.
|
||||
properties: {}
|
||||
+13
-7
@@ -1,8 +1,19 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: CreateCustomerAddress
|
||||
x-schemaName: AdminCreateCustomerAddress
|
||||
required:
|
||||
- customer_id
|
||||
- address_name
|
||||
- company
|
||||
- first_name
|
||||
- last_name
|
||||
- address_1
|
||||
- address_2
|
||||
- city
|
||||
- country_code
|
||||
- province
|
||||
- postal_code
|
||||
- phone
|
||||
- metadata
|
||||
properties:
|
||||
address_name:
|
||||
type: string
|
||||
@@ -16,10 +27,6 @@ properties:
|
||||
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
|
||||
@@ -63,4 +70,3 @@ properties:
|
||||
metadata:
|
||||
type: object
|
||||
description: The customer's metadata.
|
||||
properties: {}
|
||||
+4
-2
@@ -1,6 +1,9 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: CustomerGroupUpdatableFields
|
||||
x-schemaName: AdminCreateCustomerGroup
|
||||
required:
|
||||
- name
|
||||
- metadata
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
@@ -9,4 +12,3 @@ properties:
|
||||
metadata:
|
||||
type: object
|
||||
description: The customer group's metadata.
|
||||
properties: {}
|
||||
@@ -0,0 +1,184 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminCreateFulfillment
|
||||
required:
|
||||
- location_id
|
||||
- provider_id
|
||||
- delivery_address
|
||||
- items
|
||||
- labels
|
||||
- order
|
||||
- order_id
|
||||
- shipping_option_id
|
||||
- data
|
||||
- packed_at
|
||||
- shipped_at
|
||||
- delivered_at
|
||||
- canceled_at
|
||||
- metadata
|
||||
properties:
|
||||
location_id:
|
||||
type: string
|
||||
title: location_id
|
||||
description: The fulfillment's location id.
|
||||
provider_id:
|
||||
type: string
|
||||
title: provider_id
|
||||
description: The fulfillment's provider id.
|
||||
delivery_address:
|
||||
type: object
|
||||
description: The fulfillment's delivery address.
|
||||
required:
|
||||
- first_name
|
||||
- last_name
|
||||
- phone
|
||||
- company
|
||||
- address_1
|
||||
- address_2
|
||||
- city
|
||||
- country_code
|
||||
- province
|
||||
- postal_code
|
||||
- metadata
|
||||
properties:
|
||||
first_name:
|
||||
type: string
|
||||
title: first_name
|
||||
description: The delivery address's first name.
|
||||
last_name:
|
||||
type: string
|
||||
title: last_name
|
||||
description: The delivery address's last name.
|
||||
phone:
|
||||
type: string
|
||||
title: phone
|
||||
description: The delivery address's phone.
|
||||
company:
|
||||
type: string
|
||||
title: company
|
||||
description: The delivery address's company.
|
||||
address_1:
|
||||
type: string
|
||||
title: address_1
|
||||
description: The delivery address's address 1.
|
||||
address_2:
|
||||
type: string
|
||||
title: address_2
|
||||
description: The delivery address's address 2.
|
||||
city:
|
||||
type: string
|
||||
title: city
|
||||
description: The delivery address's city.
|
||||
country_code:
|
||||
type: string
|
||||
title: country_code
|
||||
description: The delivery address's country code.
|
||||
province:
|
||||
type: string
|
||||
title: province
|
||||
description: The delivery address's province.
|
||||
postal_code:
|
||||
type: string
|
||||
title: postal_code
|
||||
description: The delivery address's postal code.
|
||||
metadata:
|
||||
type: object
|
||||
description: The delivery address's metadata.
|
||||
items:
|
||||
type: array
|
||||
description: The fulfillment's items.
|
||||
items:
|
||||
type: object
|
||||
description: The item's items.
|
||||
required:
|
||||
- title
|
||||
- sku
|
||||
- quantity
|
||||
- barcode
|
||||
- line_item_id
|
||||
- inventory_item_id
|
||||
properties:
|
||||
title:
|
||||
type: string
|
||||
title: title
|
||||
description: The item's title.
|
||||
sku:
|
||||
type: string
|
||||
title: sku
|
||||
description: The item's sku.
|
||||
quantity:
|
||||
type: number
|
||||
title: quantity
|
||||
description: The item's quantity.
|
||||
barcode:
|
||||
type: string
|
||||
title: barcode
|
||||
description: The item's barcode.
|
||||
line_item_id:
|
||||
type: string
|
||||
title: line_item_id
|
||||
description: The item's line item id.
|
||||
inventory_item_id:
|
||||
type: string
|
||||
title: inventory_item_id
|
||||
description: The item's inventory item id.
|
||||
labels:
|
||||
type: array
|
||||
description: The fulfillment's labels.
|
||||
items:
|
||||
type: object
|
||||
description: The label's labels.
|
||||
required:
|
||||
- tracking_number
|
||||
- tracking_url
|
||||
- label_url
|
||||
properties:
|
||||
tracking_number:
|
||||
type: string
|
||||
title: tracking_number
|
||||
description: The label's tracking number.
|
||||
tracking_url:
|
||||
type: string
|
||||
title: tracking_url
|
||||
description: The label's tracking url.
|
||||
label_url:
|
||||
type: string
|
||||
title: label_url
|
||||
description: The label's label url.
|
||||
order:
|
||||
type: object
|
||||
description: The fulfillment's order.
|
||||
order_id:
|
||||
type: string
|
||||
title: order_id
|
||||
description: The fulfillment's order id.
|
||||
shipping_option_id:
|
||||
type: string
|
||||
title: shipping_option_id
|
||||
description: The fulfillment's shipping option id.
|
||||
data:
|
||||
type: object
|
||||
description: The fulfillment's data.
|
||||
packed_at:
|
||||
type: string
|
||||
title: packed_at
|
||||
description: The fulfillment's packed at.
|
||||
format: date-time
|
||||
shipped_at:
|
||||
type: string
|
||||
title: shipped_at
|
||||
description: The fulfillment's shipped at.
|
||||
format: date-time
|
||||
delivered_at:
|
||||
type: string
|
||||
title: delivered_at
|
||||
description: The fulfillment's delivered at.
|
||||
format: date-time
|
||||
canceled_at:
|
||||
type: string
|
||||
title: canceled_at
|
||||
description: The fulfillment's canceled at.
|
||||
format: date-time
|
||||
metadata:
|
||||
type: object
|
||||
description: The fulfillment's metadata.
|
||||
+18
-11
@@ -1,11 +1,11 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminPostPriceListsReq
|
||||
x-schemaName: AdminCreatePriceList
|
||||
required:
|
||||
- title
|
||||
- description
|
||||
- type
|
||||
- prices
|
||||
- starts_at
|
||||
- ends_at
|
||||
properties:
|
||||
title:
|
||||
type: string
|
||||
@@ -23,19 +23,31 @@ properties:
|
||||
type: string
|
||||
title: ends_at
|
||||
description: The price list's ends at.
|
||||
status: {}
|
||||
type: {}
|
||||
status:
|
||||
type: string
|
||||
enum:
|
||||
- active
|
||||
- draft
|
||||
type:
|
||||
type: string
|
||||
enum:
|
||||
- sale
|
||||
- override
|
||||
rules:
|
||||
type: object
|
||||
description: The price list's rules.
|
||||
prices:
|
||||
type: array
|
||||
description: The price list's prices.
|
||||
items:
|
||||
type: object
|
||||
description: The price's prices.
|
||||
x-schemaName: AdminPriceListPricesCreateReq
|
||||
required:
|
||||
- currency_code
|
||||
- amount
|
||||
- variant_id
|
||||
- min_quantity
|
||||
- max_quantity
|
||||
properties:
|
||||
currency_code:
|
||||
type: string
|
||||
@@ -60,8 +72,3 @@ properties:
|
||||
rules:
|
||||
type: object
|
||||
description: The price's rules.
|
||||
properties: {}
|
||||
rules:
|
||||
type: object
|
||||
description: The price list's rules.
|
||||
properties: {}
|
||||
@@ -0,0 +1,148 @@
|
||||
type: object
|
||||
description: The create's details.
|
||||
x-schemaName: AdminCreateProduct
|
||||
required:
|
||||
- title
|
||||
properties:
|
||||
title:
|
||||
type: string
|
||||
title: title
|
||||
description: The create's title.
|
||||
subtitle:
|
||||
type: string
|
||||
title: subtitle
|
||||
description: The create's subtitle.
|
||||
description:
|
||||
type: string
|
||||
title: description
|
||||
description: The create's description.
|
||||
is_giftcard:
|
||||
type: boolean
|
||||
title: is_giftcard
|
||||
description: The create's is giftcard.
|
||||
discountable:
|
||||
type: boolean
|
||||
title: discountable
|
||||
description: The create's discountable.
|
||||
images:
|
||||
type: array
|
||||
description: The create's images.
|
||||
items:
|
||||
type: object
|
||||
description: The image's images.
|
||||
required:
|
||||
- url
|
||||
properties:
|
||||
url:
|
||||
type: string
|
||||
title: url
|
||||
description: The image's url.
|
||||
thumbnail:
|
||||
type: string
|
||||
title: thumbnail
|
||||
description: The create's thumbnail.
|
||||
handle:
|
||||
type: string
|
||||
title: handle
|
||||
description: The create's handle.
|
||||
status:
|
||||
type: string
|
||||
enum:
|
||||
- draft
|
||||
- proposed
|
||||
- published
|
||||
- rejected
|
||||
type_id:
|
||||
type: string
|
||||
title: type_id
|
||||
description: The create's type id.
|
||||
collection_id:
|
||||
type: string
|
||||
title: collection_id
|
||||
description: The create's collection id.
|
||||
categories:
|
||||
type: array
|
||||
description: The create's categories.
|
||||
items:
|
||||
type: object
|
||||
description: The category's categories.
|
||||
required:
|
||||
- id
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The category's ID.
|
||||
tags:
|
||||
type: array
|
||||
description: The create's tags.
|
||||
items:
|
||||
type: object
|
||||
description: The tag's tags.
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The tag's ID.
|
||||
value:
|
||||
type: string
|
||||
title: value
|
||||
description: The tag's value.
|
||||
options:
|
||||
type: array
|
||||
description: The create's options.
|
||||
items:
|
||||
$ref: ./AdminCreateProductOption.yaml
|
||||
variants:
|
||||
type: array
|
||||
description: The create's variants.
|
||||
items:
|
||||
$ref: ./AdminCreateProductVariant.yaml
|
||||
sales_channels:
|
||||
type: array
|
||||
description: The create's sales channels.
|
||||
items:
|
||||
type: object
|
||||
description: The sales channel's sales channels.
|
||||
required:
|
||||
- id
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The sales channel's ID.
|
||||
weight:
|
||||
type: number
|
||||
title: weight
|
||||
description: The create's weight.
|
||||
length:
|
||||
type: number
|
||||
title: length
|
||||
description: The create's length.
|
||||
height:
|
||||
type: number
|
||||
title: height
|
||||
description: The create's height.
|
||||
width:
|
||||
type: number
|
||||
title: width
|
||||
description: The create's width.
|
||||
hs_code:
|
||||
type: string
|
||||
title: hs_code
|
||||
description: The create's hs code.
|
||||
mid_code:
|
||||
type: string
|
||||
title: mid_code
|
||||
description: The create's mid code.
|
||||
origin_country:
|
||||
type: string
|
||||
title: origin_country
|
||||
description: The create's origin country.
|
||||
material:
|
||||
type: string
|
||||
title: material
|
||||
description: The create's material.
|
||||
metadata:
|
||||
type: object
|
||||
description: The create's metadata.
|
||||
@@ -0,0 +1,18 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminCreateProductOption
|
||||
required:
|
||||
- title
|
||||
- values
|
||||
properties:
|
||||
title:
|
||||
type: string
|
||||
title: title
|
||||
description: The product's title.
|
||||
values:
|
||||
type: array
|
||||
description: The product's values.
|
||||
items:
|
||||
type: string
|
||||
title: values
|
||||
description: The value's values.
|
||||
@@ -0,0 +1,82 @@
|
||||
type: object
|
||||
description: The create's details.
|
||||
x-schemaName: AdminCreateProductVariant
|
||||
required:
|
||||
- title
|
||||
- prices
|
||||
properties:
|
||||
title:
|
||||
type: string
|
||||
title: title
|
||||
description: The create's title.
|
||||
sku:
|
||||
type: string
|
||||
title: sku
|
||||
description: The create's sku.
|
||||
ean:
|
||||
type: string
|
||||
title: ean
|
||||
description: The create's ean.
|
||||
upc:
|
||||
type: string
|
||||
title: upc
|
||||
description: The create's upc.
|
||||
barcode:
|
||||
type: string
|
||||
title: barcode
|
||||
description: The create's barcode.
|
||||
hs_code:
|
||||
type: string
|
||||
title: hs_code
|
||||
description: The create's hs code.
|
||||
mid_code:
|
||||
type: string
|
||||
title: mid_code
|
||||
description: The create's mid code.
|
||||
allow_backorder:
|
||||
type: boolean
|
||||
title: allow_backorder
|
||||
description: The create's allow backorder.
|
||||
manage_inventory:
|
||||
type: boolean
|
||||
title: manage_inventory
|
||||
description: The create's manage inventory.
|
||||
variant_rank:
|
||||
type: number
|
||||
title: variant_rank
|
||||
description: The create's variant rank.
|
||||
weight:
|
||||
type: number
|
||||
title: weight
|
||||
description: The create's weight.
|
||||
length:
|
||||
type: number
|
||||
title: length
|
||||
description: The create's length.
|
||||
height:
|
||||
type: number
|
||||
title: height
|
||||
description: The create's height.
|
||||
width:
|
||||
type: number
|
||||
title: width
|
||||
description: The create's width.
|
||||
origin_country:
|
||||
type: string
|
||||
title: origin_country
|
||||
description: The create's origin country.
|
||||
material:
|
||||
type: string
|
||||
title: material
|
||||
description: The create's material.
|
||||
metadata:
|
||||
type: object
|
||||
description: The create's metadata.
|
||||
prices:
|
||||
type: array
|
||||
description: The create's prices.
|
||||
items:
|
||||
$ref: ./AdminCreateProductVariantPrice.yaml
|
||||
options:
|
||||
type: object
|
||||
description: The create's options.
|
||||
+23
@@ -0,0 +1,23 @@
|
||||
type: object
|
||||
description: The price's prices.
|
||||
x-schemaName: AdminCreateProductVariantPrice
|
||||
required:
|
||||
- currency_code
|
||||
- amount
|
||||
properties:
|
||||
currency_code:
|
||||
type: string
|
||||
title: currency_code
|
||||
description: The price's currency code.
|
||||
amount:
|
||||
type: number
|
||||
title: amount
|
||||
description: The price's amount.
|
||||
min_quantity:
|
||||
type: number
|
||||
title: min_quantity
|
||||
description: The price's min quantity.
|
||||
max_quantity:
|
||||
type: number
|
||||
title: max_quantity
|
||||
description: The price's max quantity.
|
||||
@@ -0,0 +1,23 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminCreateSalesChannel
|
||||
required:
|
||||
- name
|
||||
- description
|
||||
- metadata
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
title: name
|
||||
description: The sales channel's name.
|
||||
description:
|
||||
type: string
|
||||
title: description
|
||||
description: The sales channel's description.
|
||||
is_disabled:
|
||||
type: boolean
|
||||
title: is_disabled
|
||||
description: The sales channel's is disabled.
|
||||
metadata:
|
||||
type: object
|
||||
description: The sales channel's metadata.
|
||||
@@ -0,0 +1,29 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminCreateShipment
|
||||
required:
|
||||
- labels
|
||||
properties:
|
||||
labels:
|
||||
type: array
|
||||
description: The fulfillment's labels.
|
||||
items:
|
||||
type: object
|
||||
description: The label's labels.
|
||||
required:
|
||||
- tracking_number
|
||||
- tracking_url
|
||||
- label_url
|
||||
properties:
|
||||
tracking_number:
|
||||
type: string
|
||||
title: tracking_number
|
||||
description: The label's tracking number.
|
||||
tracking_url:
|
||||
type: string
|
||||
title: tracking_url
|
||||
description: The label's tracking url.
|
||||
label_url:
|
||||
type: string
|
||||
title: label_url
|
||||
description: The label's label url.
|
||||
@@ -0,0 +1,64 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminCreateStockLocation
|
||||
required:
|
||||
- name
|
||||
- address_id
|
||||
- metadata
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
title: name
|
||||
description: The stock location's name.
|
||||
address:
|
||||
type: object
|
||||
description: The stock location's address.
|
||||
required:
|
||||
- address_1
|
||||
- address_2
|
||||
- company
|
||||
- city
|
||||
- country_code
|
||||
- phone
|
||||
- postal_code
|
||||
- province
|
||||
properties:
|
||||
address_1:
|
||||
type: string
|
||||
title: address_1
|
||||
description: The address's address 1.
|
||||
address_2:
|
||||
type: string
|
||||
title: address_2
|
||||
description: The address's address 2.
|
||||
company:
|
||||
type: string
|
||||
title: company
|
||||
description: The address's company.
|
||||
city:
|
||||
type: string
|
||||
title: city
|
||||
description: The address's city.
|
||||
country_code:
|
||||
type: string
|
||||
title: country_code
|
||||
description: The address's country code.
|
||||
phone:
|
||||
type: string
|
||||
title: phone
|
||||
description: The address's phone.
|
||||
postal_code:
|
||||
type: string
|
||||
title: postal_code
|
||||
description: The address's postal code.
|
||||
province:
|
||||
type: string
|
||||
title: province
|
||||
description: The address's province.
|
||||
address_id:
|
||||
type: string
|
||||
title: address_id
|
||||
description: The stock location's address id.
|
||||
metadata:
|
||||
type: object
|
||||
description: The stock location's metadata.
|
||||
+2
-3
@@ -1,9 +1,10 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminPostTaxRatesReq
|
||||
x-schemaName: AdminCreateTaxRate
|
||||
required:
|
||||
- name
|
||||
- tax_region_id
|
||||
- metadata
|
||||
properties:
|
||||
rate:
|
||||
type: number
|
||||
@@ -19,7 +20,6 @@ properties:
|
||||
items:
|
||||
type: object
|
||||
description: The rule's rules.
|
||||
x-schemaName: CreateTaxRateRule
|
||||
required:
|
||||
- reference
|
||||
- reference_id
|
||||
@@ -51,4 +51,3 @@ properties:
|
||||
metadata:
|
||||
type: object
|
||||
description: The tax rate's metadata.
|
||||
properties: {}
|
||||
+1
-1
@@ -1,6 +1,6 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminPostTaxRatesTaxRateRulesReq
|
||||
x-schemaName: AdminCreateTaxRateRule
|
||||
required:
|
||||
- reference
|
||||
- reference_id
|
||||
@@ -0,0 +1,51 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminCreateTaxRegion
|
||||
required:
|
||||
- country_code
|
||||
- province_code
|
||||
- parent_id
|
||||
- metadata
|
||||
properties:
|
||||
country_code:
|
||||
type: string
|
||||
title: country_code
|
||||
description: The tax region's country code.
|
||||
province_code:
|
||||
type: string
|
||||
title: province_code
|
||||
description: The tax region's province code.
|
||||
parent_id:
|
||||
type: string
|
||||
title: parent_id
|
||||
description: The tax region's parent id.
|
||||
default_tax_rate:
|
||||
type: object
|
||||
description: The tax region's default tax rate.
|
||||
required:
|
||||
- name
|
||||
- metadata
|
||||
properties:
|
||||
rate:
|
||||
type: number
|
||||
title: rate
|
||||
description: The default tax rate's rate.
|
||||
code:
|
||||
type: string
|
||||
title: code
|
||||
description: The default tax rate's code.
|
||||
name:
|
||||
type: string
|
||||
title: name
|
||||
description: The default tax rate's name.
|
||||
is_combinable:
|
||||
type: string
|
||||
enum:
|
||||
- 'true'
|
||||
- 'false'
|
||||
metadata:
|
||||
type: object
|
||||
description: The default tax rate's metadata.
|
||||
metadata:
|
||||
type: object
|
||||
description: The tax region's metadata.
|
||||
+15
@@ -0,0 +1,15 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminCreateVariantInventoryItem
|
||||
required:
|
||||
- required_quantity
|
||||
- inventory_item_id
|
||||
properties:
|
||||
required_quantity:
|
||||
type: number
|
||||
title: required_quantity
|
||||
description: The product's required quantity.
|
||||
inventory_item_id:
|
||||
type: string
|
||||
title: inventory_item_id
|
||||
description: The product's inventory item id.
|
||||
+6
-2
@@ -1,6 +1,6 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminPostWorkflowsAsyncResponseReq
|
||||
x-schemaName: AdminCreateWorkflowsAsyncResponse
|
||||
required:
|
||||
- transaction_id
|
||||
- step_id
|
||||
@@ -15,4 +15,8 @@ properties:
|
||||
description: The workflows execution's step id.
|
||||
response: {}
|
||||
compensate_input: {}
|
||||
action: {}
|
||||
action:
|
||||
type: string
|
||||
enum:
|
||||
- invoke
|
||||
- compensate
|
||||
+1
-1
@@ -1,6 +1,6 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminPostWorkflowsRunReq
|
||||
x-schemaName: AdminCreateWorkflowsRun
|
||||
properties:
|
||||
input: {}
|
||||
transaction_id:
|
||||
+34
-38
@@ -1,7 +1,26 @@
|
||||
type: object
|
||||
description: The context's customer.
|
||||
x-schemaName: Customer
|
||||
description: The customer's details.
|
||||
x-schemaName: AdminCustomer
|
||||
required:
|
||||
- has_account
|
||||
- id
|
||||
- email
|
||||
- default_billing_address_id
|
||||
- default_shipping_address_id
|
||||
- company_name
|
||||
- first_name
|
||||
- last_name
|
||||
- addresses
|
||||
properties:
|
||||
has_account:
|
||||
type: boolean
|
||||
title: has_account
|
||||
description: The customer's has account.
|
||||
groups:
|
||||
type: array
|
||||
description: The customer's groups.
|
||||
items:
|
||||
$ref: ./AdminCustomerGroup.yaml
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
@@ -35,53 +54,30 @@ properties:
|
||||
type: array
|
||||
description: The customer's addresses.
|
||||
items:
|
||||
type: object
|
||||
description: The address's addresses.
|
||||
x-schemaName: CustomerAddress
|
||||
properties: {}
|
||||
$ref: ./BaseCustomerAddress.yaml
|
||||
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
|
||||
type: string
|
||||
format: date-time
|
||||
title: deleted_at
|
||||
description: The customer's deleted at.
|
||||
created_at:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: created_at
|
||||
description: The customer's created at.
|
||||
- type: string
|
||||
title: created_at
|
||||
description: The customer's created at.
|
||||
format: date-time
|
||||
type: string
|
||||
format: date-time
|
||||
title: created_at
|
||||
description: The customer's created at.
|
||||
updated_at:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: updated_at
|
||||
description: The customer's updated at.
|
||||
- type: string
|
||||
title: updated_at
|
||||
description: The customer's updated at.
|
||||
format: date-time
|
||||
type: string
|
||||
format: date-time
|
||||
title: updated_at
|
||||
description: The customer's updated at.
|
||||
@@ -0,0 +1,37 @@
|
||||
type: object
|
||||
description: The group's groups.
|
||||
x-schemaName: AdminCustomerGroup
|
||||
required:
|
||||
- id
|
||||
- name
|
||||
- customers
|
||||
- metadata
|
||||
- created_at
|
||||
- updated_at
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The group's ID.
|
||||
name:
|
||||
type: string
|
||||
title: name
|
||||
description: The group's name.
|
||||
customers:
|
||||
type: array
|
||||
description: The group's customers.
|
||||
items:
|
||||
$ref: ./BaseCustomer.yaml
|
||||
metadata:
|
||||
type: object
|
||||
description: The group's metadata.
|
||||
created_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: created_at
|
||||
description: The group's created at.
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: updated_at
|
||||
description: The group's updated at.
|
||||
-4
@@ -1,4 +0,0 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminDeletePricingRuleTypesRuleTypeReq
|
||||
properties: {}
|
||||
@@ -0,0 +1,3 @@
|
||||
type: object
|
||||
description: The shipping option's provider.
|
||||
x-schemaName: AdminFulfillmentProvider
|
||||
@@ -0,0 +1,44 @@
|
||||
type: object
|
||||
description: The fulfillment set's details.
|
||||
x-schemaName: AdminFulfillmentSet
|
||||
required:
|
||||
- id
|
||||
- name
|
||||
- type
|
||||
- service_zones
|
||||
- created_at
|
||||
- updated_at
|
||||
- deleted_at
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The fulfillment set's ID.
|
||||
name:
|
||||
type: string
|
||||
title: name
|
||||
description: The fulfillment set's name.
|
||||
type:
|
||||
type: string
|
||||
title: type
|
||||
description: The fulfillment set's type.
|
||||
service_zones:
|
||||
type: array
|
||||
description: The fulfillment set's service zones.
|
||||
items:
|
||||
$ref: ./AdminServiceZone.yaml
|
||||
created_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: created_at
|
||||
description: The fulfillment set's created at.
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: updated_at
|
||||
description: The fulfillment set's updated at.
|
||||
deleted_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: deleted_at
|
||||
description: The fulfillment set's deleted at.
|
||||
+24
@@ -0,0 +1,24 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminFulfillmentSetDeleteResponse
|
||||
required:
|
||||
- id
|
||||
- object
|
||||
- deleted
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The fulfillment set's ID.
|
||||
object:
|
||||
type: string
|
||||
title: object
|
||||
description: The fulfillment set's object.
|
||||
default: fulfillment_set
|
||||
deleted:
|
||||
type: boolean
|
||||
title: deleted
|
||||
description: The fulfillment set's deleted.
|
||||
parent:
|
||||
type: object
|
||||
description: The fulfillment set's parent.
|
||||
@@ -0,0 +1,8 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminFulfillmentSetResponse
|
||||
required:
|
||||
- fulfillment_set
|
||||
properties:
|
||||
fulfillment_set:
|
||||
$ref: ./AdminFulfillmentSet.yaml
|
||||
@@ -0,0 +1,3 @@
|
||||
type: object
|
||||
description: The geo zone's geo zones.
|
||||
x-schemaName: AdminGeoZone
|
||||
-31
@@ -1,31 +0,0 @@
|
||||
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
@@ -1,12 +0,0 @@
|
||||
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.
|
||||
@@ -1,767 +0,0 @@
|
||||
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.
|
||||
@@ -1,28 +0,0 @@
|
||||
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,8 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminGetUploadParams
|
||||
properties:
|
||||
fields:
|
||||
type: string
|
||||
title: fields
|
||||
description: The upload's fields.
|
||||
@@ -0,0 +1,8 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminOrderCancelFulfillment
|
||||
properties:
|
||||
no_notification:
|
||||
type: boolean
|
||||
title: no_notification
|
||||
description: The order's no notification.
|
||||
+37
@@ -0,0 +1,37 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminOrderCreateFulfillment
|
||||
required:
|
||||
- items
|
||||
- location_id
|
||||
- metadata
|
||||
properties:
|
||||
items:
|
||||
type: array
|
||||
description: The order's items.
|
||||
items:
|
||||
type: object
|
||||
description: The item's items.
|
||||
required:
|
||||
- id
|
||||
- quantity
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The item's ID.
|
||||
quantity:
|
||||
type: number
|
||||
title: quantity
|
||||
description: The item's quantity.
|
||||
location_id:
|
||||
type: string
|
||||
title: location_id
|
||||
description: The order's location id.
|
||||
no_notification:
|
||||
type: boolean
|
||||
title: no_notification
|
||||
description: The order's no notification.
|
||||
metadata:
|
||||
type: object
|
||||
description: The order's metadata.
|
||||
@@ -0,0 +1,55 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminOrderCreateShipment
|
||||
required:
|
||||
- items
|
||||
- metadata
|
||||
properties:
|
||||
items:
|
||||
type: array
|
||||
description: The order's items.
|
||||
items:
|
||||
type: object
|
||||
description: The item's items.
|
||||
required:
|
||||
- id
|
||||
- quantity
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The item's ID.
|
||||
quantity:
|
||||
type: number
|
||||
title: quantity
|
||||
description: The item's quantity.
|
||||
labels:
|
||||
type: array
|
||||
description: The order's labels.
|
||||
items:
|
||||
type: object
|
||||
description: The label's labels.
|
||||
required:
|
||||
- tracking_number
|
||||
- tracking_url
|
||||
- label_url
|
||||
properties:
|
||||
tracking_number:
|
||||
type: string
|
||||
title: tracking_number
|
||||
description: The label's tracking number.
|
||||
tracking_url:
|
||||
type: string
|
||||
title: tracking_url
|
||||
description: The label's tracking url.
|
||||
label_url:
|
||||
type: string
|
||||
title: label_url
|
||||
description: The label's label url.
|
||||
no_notification:
|
||||
type: boolean
|
||||
title: no_notification
|
||||
description: The order's no notification.
|
||||
metadata:
|
||||
type: object
|
||||
description: The order's metadata.
|
||||
@@ -1,46 +0,0 @@
|
||||
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
@@ -1,20 +0,0 @@
|
||||
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
@@ -1,34 +0,0 @@
|
||||
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
@@ -1,13 +0,0 @@
|
||||
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
@@ -1,56 +0,0 @@
|
||||
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
@@ -1,12 +0,0 @@
|
||||
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
@@ -1,19 +0,0 @@
|
||||
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.
|
||||
@@ -1,56 +0,0 @@
|
||||
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
@@ -1,15 +0,0 @@
|
||||
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
@@ -1,8 +0,0 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminPostPaymentsCapturesReq
|
||||
properties:
|
||||
amount:
|
||||
type: number
|
||||
title: amount
|
||||
description: The payment's amount.
|
||||
@@ -1,8 +0,0 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminPostPaymentsRefundsReq
|
||||
properties:
|
||||
amount:
|
||||
type: number
|
||||
title: amount
|
||||
description: The payment's amount.
|
||||
-42
@@ -1,42 +0,0 @@
|
||||
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
@@ -1,13 +0,0 @@
|
||||
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
@@ -1,64 +0,0 @@
|
||||
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: {}
|
||||
-20
@@ -1,20 +0,0 @@
|
||||
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
@@ -1,16 +0,0 @@
|
||||
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
@@ -1,49 +0,0 @@
|
||||
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
@@ -1,34 +0,0 @@
|
||||
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
@@ -1,13 +0,0 @@
|
||||
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
@@ -1,38 +0,0 @@
|
||||
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.
|
||||
+44
@@ -0,0 +1,44 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminPostReceiveReturnsReqSchema
|
||||
required:
|
||||
- return_id
|
||||
- items
|
||||
- internal_note
|
||||
properties:
|
||||
return_id:
|
||||
type: string
|
||||
title: return_id
|
||||
description: The return's return id.
|
||||
items:
|
||||
type: array
|
||||
description: The return's items.
|
||||
items:
|
||||
type: object
|
||||
description: The item's items.
|
||||
required:
|
||||
- id
|
||||
- quantity
|
||||
- reason_id
|
||||
- note
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The item's ID.
|
||||
quantity:
|
||||
type: number
|
||||
title: quantity
|
||||
description: The item's quantity.
|
||||
reason_id:
|
||||
type: string
|
||||
title: reason_id
|
||||
description: The item's reason id.
|
||||
note:
|
||||
type: string
|
||||
title: note
|
||||
description: The item's note.
|
||||
internal_note:
|
||||
type: string
|
||||
title: internal_note
|
||||
description: The return's internal note.
|
||||
@@ -0,0 +1,72 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminPostReturnsReqSchema
|
||||
required:
|
||||
- order_id
|
||||
- items
|
||||
- return_shipping
|
||||
- internal_note
|
||||
- location_id
|
||||
properties:
|
||||
order_id:
|
||||
type: string
|
||||
title: order_id
|
||||
description: The return's order id.
|
||||
items:
|
||||
type: array
|
||||
description: The return's items.
|
||||
items:
|
||||
type: object
|
||||
description: The item's items.
|
||||
required:
|
||||
- id
|
||||
- quantity
|
||||
- reason_id
|
||||
- note
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The item's ID.
|
||||
quantity:
|
||||
type: number
|
||||
title: quantity
|
||||
description: The item's quantity.
|
||||
reason_id:
|
||||
type: string
|
||||
title: reason_id
|
||||
description: The item's reason id.
|
||||
note:
|
||||
type: string
|
||||
title: note
|
||||
description: The item's note.
|
||||
return_shipping:
|
||||
type: object
|
||||
description: The return's return shipping.
|
||||
required:
|
||||
- option_id
|
||||
properties:
|
||||
option_id:
|
||||
type: string
|
||||
title: option_id
|
||||
description: The return shipping's option id.
|
||||
price:
|
||||
type: number
|
||||
title: price
|
||||
description: The return shipping's price.
|
||||
internal_note:
|
||||
type: string
|
||||
title: internal_note
|
||||
description: The return's internal note.
|
||||
receive_now:
|
||||
type: boolean
|
||||
title: receive_now
|
||||
description: The return's receive now.
|
||||
refund_amount:
|
||||
type: number
|
||||
title: refund_amount
|
||||
description: The return's refund amount.
|
||||
location_id:
|
||||
type: string
|
||||
title: location_id
|
||||
description: The return's location id.
|
||||
@@ -1,20 +0,0 @@
|
||||
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: {}
|
||||
-41
@@ -1,41 +0,0 @@
|
||||
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.
|
||||
@@ -1,24 +0,0 @@
|
||||
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: {}
|
||||
@@ -0,0 +1,62 @@
|
||||
type: object
|
||||
description: The price's prices.
|
||||
x-schemaName: AdminPrice
|
||||
required:
|
||||
- id
|
||||
- title
|
||||
- currency_code
|
||||
- amount
|
||||
- raw_amount
|
||||
- min_quantity
|
||||
- max_quantity
|
||||
- price_set_id
|
||||
- created_at
|
||||
- updated_at
|
||||
- deleted_at
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The price's ID.
|
||||
title:
|
||||
type: string
|
||||
title: title
|
||||
description: The price's title.
|
||||
currency_code:
|
||||
type: string
|
||||
title: currency_code
|
||||
description: The price's currency code.
|
||||
amount:
|
||||
type: number
|
||||
title: amount
|
||||
description: The price's amount.
|
||||
raw_amount:
|
||||
type: object
|
||||
description: The price's raw amount.
|
||||
min_quantity:
|
||||
type: number
|
||||
title: min_quantity
|
||||
description: The price's min quantity.
|
||||
max_quantity:
|
||||
type: number
|
||||
title: max_quantity
|
||||
description: The price's max quantity.
|
||||
price_set_id:
|
||||
type: string
|
||||
title: price_set_id
|
||||
description: The price's price set id.
|
||||
created_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: created_at
|
||||
description: The price's created at.
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: updated_at
|
||||
description: The price's updated at.
|
||||
deleted_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: deleted_at
|
||||
description: The price's deleted at.
|
||||
@@ -0,0 +1,167 @@
|
||||
type: object
|
||||
description: The product's parent.
|
||||
x-schemaName: AdminProduct
|
||||
required:
|
||||
- type
|
||||
- title
|
||||
- status
|
||||
- length
|
||||
- options
|
||||
- description
|
||||
- id
|
||||
- handle
|
||||
- hs_code
|
||||
- weight
|
||||
- height
|
||||
- width
|
||||
- origin_country
|
||||
- mid_code
|
||||
- material
|
||||
- thumbnail
|
||||
- created_at
|
||||
- updated_at
|
||||
- deleted_at
|
||||
- subtitle
|
||||
- is_giftcard
|
||||
- collection_id
|
||||
- type_id
|
||||
- tags
|
||||
- images
|
||||
- discountable
|
||||
- external_id
|
||||
properties:
|
||||
collection:
|
||||
$ref: ./AdminCollection.yaml
|
||||
categories:
|
||||
type: array
|
||||
description: The parent's categories.
|
||||
items:
|
||||
$ref: ./AdminProductCategory.yaml
|
||||
sales_channels:
|
||||
type: array
|
||||
description: The parent's sales channels.
|
||||
items:
|
||||
$ref: ./AdminSalesChannel.yaml
|
||||
variants:
|
||||
type: array
|
||||
description: The parent's variants.
|
||||
items:
|
||||
$ref: ./AdminProductVariant.yaml
|
||||
type:
|
||||
type: object
|
||||
title:
|
||||
type: string
|
||||
title: title
|
||||
description: The parent's title.
|
||||
status:
|
||||
type: string
|
||||
enum:
|
||||
- draft
|
||||
- proposed
|
||||
- published
|
||||
- rejected
|
||||
length:
|
||||
type: number
|
||||
title: length
|
||||
description: The parent's length.
|
||||
options:
|
||||
type: array
|
||||
description: The parent's options.
|
||||
items:
|
||||
$ref: ./BaseProductOption.yaml
|
||||
description:
|
||||
type: string
|
||||
title: description
|
||||
description: The parent's description.
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The parent's ID.
|
||||
handle:
|
||||
type: string
|
||||
title: handle
|
||||
description: The parent's handle.
|
||||
metadata:
|
||||
type: object
|
||||
description: The parent's metadata.
|
||||
hs_code:
|
||||
type: string
|
||||
title: hs_code
|
||||
description: The parent's hs code.
|
||||
weight:
|
||||
type: number
|
||||
title: weight
|
||||
description: The parent's weight.
|
||||
height:
|
||||
type: number
|
||||
title: height
|
||||
description: The parent's height.
|
||||
width:
|
||||
type: number
|
||||
title: width
|
||||
description: The parent's width.
|
||||
origin_country:
|
||||
type: string
|
||||
title: origin_country
|
||||
description: The parent's origin country.
|
||||
mid_code:
|
||||
type: string
|
||||
title: mid_code
|
||||
description: The parent's mid code.
|
||||
material:
|
||||
type: string
|
||||
title: material
|
||||
description: The parent's material.
|
||||
thumbnail:
|
||||
type: string
|
||||
title: thumbnail
|
||||
description: The parent's thumbnail.
|
||||
created_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: created_at
|
||||
description: The parent's created at.
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: updated_at
|
||||
description: The parent's updated at.
|
||||
deleted_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: deleted_at
|
||||
description: The parent's deleted at.
|
||||
subtitle:
|
||||
type: string
|
||||
title: subtitle
|
||||
description: The parent's subtitle.
|
||||
is_giftcard:
|
||||
type: boolean
|
||||
title: is_giftcard
|
||||
description: The parent's is giftcard.
|
||||
collection_id:
|
||||
type: string
|
||||
title: collection_id
|
||||
description: The parent's collection id.
|
||||
type_id:
|
||||
type: string
|
||||
title: type_id
|
||||
description: The parent's type id.
|
||||
tags:
|
||||
type: array
|
||||
description: The parent's tags.
|
||||
items:
|
||||
$ref: ./BaseProductTag.yaml
|
||||
images:
|
||||
type: array
|
||||
description: The parent's images.
|
||||
items:
|
||||
$ref: ./BaseProductImage.yaml
|
||||
discountable:
|
||||
type: boolean
|
||||
title: discountable
|
||||
description: The parent's discountable.
|
||||
external_id:
|
||||
type: string
|
||||
title: external_id
|
||||
description: The parent's external id.
|
||||
@@ -0,0 +1,77 @@
|
||||
type: object
|
||||
description: The category's categories.
|
||||
x-schemaName: AdminProductCategory
|
||||
required:
|
||||
- category_children
|
||||
- parent_category
|
||||
- name
|
||||
- description
|
||||
- id
|
||||
- handle
|
||||
- created_at
|
||||
- updated_at
|
||||
- deleted_at
|
||||
- parent_category_id
|
||||
- is_internal
|
||||
- is_active
|
||||
- rank
|
||||
properties:
|
||||
category_children:
|
||||
type: array
|
||||
description: The category's category children.
|
||||
items:
|
||||
type: object
|
||||
parent_category:
|
||||
type: object
|
||||
products:
|
||||
type: array
|
||||
description: The category's products.
|
||||
items:
|
||||
type: object
|
||||
name:
|
||||
type: string
|
||||
title: name
|
||||
description: The category's name.
|
||||
description:
|
||||
type: string
|
||||
title: description
|
||||
description: The category's description.
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The category's ID.
|
||||
handle:
|
||||
type: string
|
||||
title: handle
|
||||
description: The category's handle.
|
||||
created_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: created_at
|
||||
description: The category's created at.
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: updated_at
|
||||
description: The category's updated at.
|
||||
deleted_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: deleted_at
|
||||
description: The category's deleted at.
|
||||
parent_category_id:
|
||||
type: string
|
||||
title: parent_category_id
|
||||
description: The category's parent category id.
|
||||
is_internal:
|
||||
type: boolean
|
||||
title: is_internal
|
||||
description: The category's is internal.
|
||||
is_active:
|
||||
type: boolean
|
||||
title: is_active
|
||||
description: The category's is active.
|
||||
rank:
|
||||
type: number
|
||||
title: rank
|
||||
description: The category's rank.
|
||||
+26
@@ -0,0 +1,26 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminProductCategoryListResponse
|
||||
required:
|
||||
- limit
|
||||
- offset
|
||||
- count
|
||||
- product_categories
|
||||
properties:
|
||||
limit:
|
||||
type: number
|
||||
title: limit
|
||||
description: The product category's limit.
|
||||
offset:
|
||||
type: number
|
||||
title: offset
|
||||
description: The product category's offset.
|
||||
count:
|
||||
type: number
|
||||
title: count
|
||||
description: The product category's count.
|
||||
product_categories:
|
||||
type: array
|
||||
description: The product category's product categories.
|
||||
items:
|
||||
$ref: ./AdminProductCategory.yaml
|
||||
+8
@@ -0,0 +1,8 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminProductCategoryResponse
|
||||
required:
|
||||
- product_category
|
||||
properties:
|
||||
product_category:
|
||||
$ref: ./AdminProductCategory.yaml
|
||||
@@ -0,0 +1,24 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminProductDeleteResponse
|
||||
required:
|
||||
- id
|
||||
- object
|
||||
- deleted
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The product's ID.
|
||||
object:
|
||||
type: string
|
||||
title: object
|
||||
description: The product's object.
|
||||
default: product
|
||||
deleted:
|
||||
type: boolean
|
||||
title: deleted
|
||||
description: The product's deleted.
|
||||
parent:
|
||||
type: object
|
||||
description: The product's parent.
|
||||
@@ -0,0 +1,44 @@
|
||||
type: object
|
||||
description: The product's product option.
|
||||
x-schemaName: AdminProductOption
|
||||
required:
|
||||
- id
|
||||
- title
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The product option's ID.
|
||||
title:
|
||||
type: string
|
||||
title: title
|
||||
description: The product option's title.
|
||||
product:
|
||||
$ref: ./BaseProduct.yaml
|
||||
product_id:
|
||||
type: string
|
||||
title: product_id
|
||||
description: The product option's product id.
|
||||
values:
|
||||
type: array
|
||||
description: The product option's values.
|
||||
items:
|
||||
$ref: ./BaseProductOptionValue.yaml
|
||||
metadata:
|
||||
type: object
|
||||
description: The product option's metadata.
|
||||
created_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: created_at
|
||||
description: The product option's created at.
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: updated_at
|
||||
description: The product option's updated at.
|
||||
deleted_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: deleted_at
|
||||
description: The product option's deleted at.
|
||||
+23
@@ -0,0 +1,23 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminProductOptionDeleteResponse
|
||||
required:
|
||||
- id
|
||||
- object
|
||||
- deleted
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The product's ID.
|
||||
object:
|
||||
type: string
|
||||
title: object
|
||||
description: The product's object.
|
||||
default: product_option
|
||||
deleted:
|
||||
type: boolean
|
||||
title: deleted
|
||||
description: The product's deleted.
|
||||
parent:
|
||||
$ref: ./AdminProduct.yaml
|
||||
@@ -0,0 +1,8 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminProductOptionResponse
|
||||
required:
|
||||
- product_option
|
||||
properties:
|
||||
product_option:
|
||||
$ref: ./AdminProductOption.yaml
|
||||
@@ -0,0 +1,8 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminProductResponse
|
||||
required:
|
||||
- product
|
||||
properties:
|
||||
product:
|
||||
$ref: ./AdminProduct.yaml
|
||||
@@ -0,0 +1,128 @@
|
||||
type: object
|
||||
description: The updated's details.
|
||||
x-schemaName: AdminProductVariant
|
||||
required:
|
||||
- prices
|
||||
- id
|
||||
- title
|
||||
- sku
|
||||
- barcode
|
||||
- ean
|
||||
- upc
|
||||
- allow_backorder
|
||||
- manage_inventory
|
||||
- hs_code
|
||||
- origin_country
|
||||
- mid_code
|
||||
- material
|
||||
- weight
|
||||
- length
|
||||
- height
|
||||
- width
|
||||
- options
|
||||
- created_at
|
||||
- updated_at
|
||||
- deleted_at
|
||||
properties:
|
||||
prices:
|
||||
type: array
|
||||
description: The updated's prices.
|
||||
items:
|
||||
$ref: ./AdminPrice.yaml
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The updated's ID.
|
||||
title:
|
||||
type: string
|
||||
title: title
|
||||
description: The updated's title.
|
||||
sku:
|
||||
type: string
|
||||
title: sku
|
||||
description: The updated's sku.
|
||||
barcode:
|
||||
type: string
|
||||
title: barcode
|
||||
description: The updated's barcode.
|
||||
ean:
|
||||
type: string
|
||||
title: ean
|
||||
description: The updated's ean.
|
||||
upc:
|
||||
type: string
|
||||
title: upc
|
||||
description: The updated's upc.
|
||||
allow_backorder:
|
||||
type: boolean
|
||||
title: allow_backorder
|
||||
description: The updated's allow backorder.
|
||||
manage_inventory:
|
||||
type: boolean
|
||||
title: manage_inventory
|
||||
description: The updated's manage inventory.
|
||||
hs_code:
|
||||
type: string
|
||||
title: hs_code
|
||||
description: The updated's hs code.
|
||||
origin_country:
|
||||
type: string
|
||||
title: origin_country
|
||||
description: The updated's origin country.
|
||||
mid_code:
|
||||
type: string
|
||||
title: mid_code
|
||||
description: The updated's mid code.
|
||||
material:
|
||||
type: string
|
||||
title: material
|
||||
description: The updated's material.
|
||||
weight:
|
||||
type: number
|
||||
title: weight
|
||||
description: The updated's weight.
|
||||
length:
|
||||
type: number
|
||||
title: length
|
||||
description: The updated's length.
|
||||
height:
|
||||
type: number
|
||||
title: height
|
||||
description: The updated's height.
|
||||
width:
|
||||
type: number
|
||||
title: width
|
||||
description: The updated's width.
|
||||
options:
|
||||
type: array
|
||||
description: The updated's options.
|
||||
items:
|
||||
$ref: ./BaseProductOptionValue.yaml
|
||||
product:
|
||||
$ref: ./BaseProduct.yaml
|
||||
product_id:
|
||||
type: string
|
||||
title: product_id
|
||||
description: The updated's product id.
|
||||
variant_rank:
|
||||
type: number
|
||||
title: variant_rank
|
||||
description: The updated's variant rank.
|
||||
created_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: created_at
|
||||
description: The updated's created at.
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: updated_at
|
||||
description: The updated's updated at.
|
||||
deleted_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: deleted_at
|
||||
description: The updated's deleted at.
|
||||
metadata:
|
||||
type: object
|
||||
description: The updated's metadata.
|
||||
+23
@@ -0,0 +1,23 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminProductVariantDeleteResponse
|
||||
required:
|
||||
- id
|
||||
- object
|
||||
- deleted
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The product's ID.
|
||||
object:
|
||||
type: string
|
||||
title: object
|
||||
description: The product's object.
|
||||
default: variant
|
||||
deleted:
|
||||
type: boolean
|
||||
title: deleted
|
||||
description: The product's deleted.
|
||||
parent:
|
||||
$ref: ./AdminProduct.yaml
|
||||
@@ -0,0 +1,276 @@
|
||||
type: object
|
||||
description: The product's variants.
|
||||
x-schemaName: AdminProductVariantParams
|
||||
properties:
|
||||
q:
|
||||
type: string
|
||||
title: q
|
||||
description: The variant's q.
|
||||
id:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: id
|
||||
description: The variant's ID.
|
||||
- type: array
|
||||
description: The variant's ID.
|
||||
items:
|
||||
type: string
|
||||
title: id
|
||||
description: The id's ID.
|
||||
sku:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: sku
|
||||
description: The variant's sku.
|
||||
- type: array
|
||||
description: The variant's sku.
|
||||
items:
|
||||
type: string
|
||||
title: sku
|
||||
description: The sku's details.
|
||||
product_id:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: product_id
|
||||
description: The variant's product id.
|
||||
- type: array
|
||||
description: The variant's product id.
|
||||
items:
|
||||
type: string
|
||||
title: product_id
|
||||
description: The product id's details.
|
||||
options:
|
||||
type: object
|
||||
description: The variant's options.
|
||||
limit:
|
||||
type: number
|
||||
title: limit
|
||||
description: The variant's limit.
|
||||
offset:
|
||||
type: number
|
||||
title: offset
|
||||
description: The variant's offset.
|
||||
order:
|
||||
type: string
|
||||
title: order
|
||||
description: The variant's order.
|
||||
fields:
|
||||
type: string
|
||||
title: fields
|
||||
description: The variant's fields.
|
||||
$and:
|
||||
type: array
|
||||
description: The variant's $and.
|
||||
items:
|
||||
oneOf:
|
||||
- type: object
|
||||
description: The $and's details.
|
||||
x-schemaName: BaseProductVariantParams
|
||||
properties:
|
||||
q:
|
||||
type: string
|
||||
title: q
|
||||
description: The $and's q.
|
||||
id:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: id
|
||||
description: The $and's ID.
|
||||
- type: array
|
||||
description: The $and's ID.
|
||||
items:
|
||||
type: string
|
||||
title: id
|
||||
description: The id's ID.
|
||||
sku:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: sku
|
||||
description: The $and's sku.
|
||||
- type: array
|
||||
description: The $and's sku.
|
||||
items:
|
||||
type: string
|
||||
title: sku
|
||||
description: The sku's details.
|
||||
product_id:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: product_id
|
||||
description: The $and's product id.
|
||||
- type: array
|
||||
description: The $and's product id.
|
||||
items:
|
||||
type: string
|
||||
title: product_id
|
||||
description: The product id's details.
|
||||
options:
|
||||
type: object
|
||||
description: The $and's options.
|
||||
limit:
|
||||
type: number
|
||||
title: limit
|
||||
description: The $and's limit.
|
||||
offset:
|
||||
type: number
|
||||
title: offset
|
||||
description: The $and's offset.
|
||||
order:
|
||||
type: string
|
||||
title: order
|
||||
description: The $and's order.
|
||||
fields:
|
||||
type: string
|
||||
title: fields
|
||||
description: The $and's fields.
|
||||
$and:
|
||||
type: array
|
||||
description: The $and's details.
|
||||
items:
|
||||
oneOf:
|
||||
- type: object
|
||||
description: The $and's details.
|
||||
x-schemaName: BaseProductVariantParams
|
||||
- type: object
|
||||
description: The $and's details.
|
||||
$or:
|
||||
type: array
|
||||
description: The $and's $or.
|
||||
items:
|
||||
oneOf:
|
||||
- type: object
|
||||
description: The $or's details.
|
||||
x-schemaName: BaseProductVariantParams
|
||||
- type: object
|
||||
description: The $or's details.
|
||||
- type: object
|
||||
description: The $and's details.
|
||||
properties:
|
||||
$and:
|
||||
type: array
|
||||
description: The $and's details.
|
||||
items:
|
||||
oneOf:
|
||||
- type: object
|
||||
description: The $and's details.
|
||||
x-schemaName: BaseProductVariantParams
|
||||
- type: object
|
||||
description: The $and's details.
|
||||
$or:
|
||||
type: array
|
||||
description: The $and's $or.
|
||||
items:
|
||||
oneOf:
|
||||
- type: object
|
||||
description: The $or's details.
|
||||
x-schemaName: BaseProductVariantParams
|
||||
- type: object
|
||||
description: The $or's details.
|
||||
$or:
|
||||
type: array
|
||||
description: The variant's $or.
|
||||
items:
|
||||
oneOf:
|
||||
- type: object
|
||||
description: The $or's details.
|
||||
x-schemaName: BaseProductVariantParams
|
||||
properties:
|
||||
q:
|
||||
type: string
|
||||
title: q
|
||||
description: The $or's q.
|
||||
id:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: id
|
||||
description: The $or's ID.
|
||||
- type: array
|
||||
description: The $or's ID.
|
||||
items:
|
||||
type: string
|
||||
title: id
|
||||
description: The id's ID.
|
||||
sku:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: sku
|
||||
description: The $or's sku.
|
||||
- type: array
|
||||
description: The $or's sku.
|
||||
items:
|
||||
type: string
|
||||
title: sku
|
||||
description: The sku's details.
|
||||
product_id:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: product_id
|
||||
description: The $or's product id.
|
||||
- type: array
|
||||
description: The $or's product id.
|
||||
items:
|
||||
type: string
|
||||
title: product_id
|
||||
description: The product id's details.
|
||||
options:
|
||||
type: object
|
||||
description: The $or's options.
|
||||
limit:
|
||||
type: number
|
||||
title: limit
|
||||
description: The $or's limit.
|
||||
offset:
|
||||
type: number
|
||||
title: offset
|
||||
description: The $or's offset.
|
||||
order:
|
||||
type: string
|
||||
title: order
|
||||
description: The $or's order.
|
||||
fields:
|
||||
type: string
|
||||
title: fields
|
||||
description: The $or's fields.
|
||||
$and:
|
||||
type: array
|
||||
description: The $or's $and.
|
||||
items:
|
||||
oneOf:
|
||||
- type: object
|
||||
description: The $and's details.
|
||||
x-schemaName: BaseProductVariantParams
|
||||
- type: object
|
||||
description: The $and's details.
|
||||
$or:
|
||||
type: array
|
||||
description: The $or's details.
|
||||
items:
|
||||
oneOf:
|
||||
- type: object
|
||||
description: The $or's details.
|
||||
x-schemaName: BaseProductVariantParams
|
||||
- type: object
|
||||
description: The $or's details.
|
||||
- type: object
|
||||
description: The $or's details.
|
||||
properties:
|
||||
$and:
|
||||
type: array
|
||||
description: The $or's $and.
|
||||
items:
|
||||
oneOf:
|
||||
- type: object
|
||||
description: The $and's details.
|
||||
x-schemaName: BaseProductVariantParams
|
||||
- type: object
|
||||
description: The $and's details.
|
||||
$or:
|
||||
type: array
|
||||
description: The $or's details.
|
||||
items:
|
||||
oneOf:
|
||||
- type: object
|
||||
description: The $or's details.
|
||||
x-schemaName: BaseProductVariantParams
|
||||
- type: object
|
||||
description: The $or's details.
|
||||
@@ -0,0 +1,8 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminProductVariantResponse
|
||||
required:
|
||||
- variant
|
||||
properties:
|
||||
variant:
|
||||
$ref: ./AdminProductVariant.yaml
|
||||
@@ -0,0 +1,8 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminRevokeApiKey
|
||||
properties:
|
||||
revoke_in:
|
||||
type: number
|
||||
title: revoke_in
|
||||
description: The api key's revoke in.
|
||||
@@ -0,0 +1,47 @@
|
||||
type: object
|
||||
description: The sales channel's sales channels.
|
||||
x-schemaName: AdminSalesChannel
|
||||
required:
|
||||
- id
|
||||
- name
|
||||
- description
|
||||
- is_disabled
|
||||
- metadata
|
||||
- created_at
|
||||
- updated_at
|
||||
- deleted_at
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The sales channel's ID.
|
||||
name:
|
||||
type: string
|
||||
title: name
|
||||
description: The sales channel's name.
|
||||
description:
|
||||
type: string
|
||||
title: description
|
||||
description: The sales channel's description.
|
||||
is_disabled:
|
||||
type: boolean
|
||||
title: is_disabled
|
||||
description: The sales channel's is disabled.
|
||||
metadata:
|
||||
type: object
|
||||
description: The sales channel's metadata.
|
||||
created_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: created_at
|
||||
description: The sales channel's created at.
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: updated_at
|
||||
description: The sales channel's updated at.
|
||||
deleted_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: deleted_at
|
||||
description: The sales channel's deleted at.
|
||||
@@ -0,0 +1,50 @@
|
||||
type: object
|
||||
description: The service zone's service zones.
|
||||
x-schemaName: AdminServiceZone
|
||||
required:
|
||||
- id
|
||||
- name
|
||||
- fulfillment_set_id
|
||||
- geo_zones
|
||||
- shipping_options
|
||||
- created_at
|
||||
- updated_at
|
||||
- deleted_at
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The service zone's ID.
|
||||
name:
|
||||
type: string
|
||||
title: name
|
||||
description: The service zone's name.
|
||||
fulfillment_set_id:
|
||||
type: string
|
||||
title: fulfillment_set_id
|
||||
description: The service zone's fulfillment set id.
|
||||
geo_zones:
|
||||
type: array
|
||||
description: The service zone's geo zones.
|
||||
items:
|
||||
$ref: ./AdminGeoZone.yaml
|
||||
shipping_options:
|
||||
type: array
|
||||
description: The service zone's shipping options.
|
||||
items:
|
||||
$ref: ./AdminShippingOption.yaml
|
||||
created_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: created_at
|
||||
description: The service zone's created at.
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: updated_at
|
||||
description: The service zone's updated at.
|
||||
deleted_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: deleted_at
|
||||
description: The service zone's deleted at.
|
||||
@@ -0,0 +1,8 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminServiceZoneResponse
|
||||
required:
|
||||
- service_zone
|
||||
properties:
|
||||
service_zone:
|
||||
$ref: ./AdminServiceZone.yaml
|
||||
@@ -0,0 +1,3 @@
|
||||
type: object
|
||||
description: The shipping option's shipping options.
|
||||
x-schemaName: AdminShippingOption
|
||||
+24
@@ -0,0 +1,24 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminShippingOptionDeleteResponse
|
||||
required:
|
||||
- id
|
||||
- object
|
||||
- deleted
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The shipping option's ID.
|
||||
object:
|
||||
type: string
|
||||
title: object
|
||||
description: The shipping option's object.
|
||||
default: shipping_option
|
||||
deleted:
|
||||
type: boolean
|
||||
title: deleted
|
||||
description: The shipping option's deleted.
|
||||
parent:
|
||||
type: object
|
||||
description: The shipping option's parent.
|
||||
@@ -0,0 +1,8 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminShippingOptionResponse
|
||||
required:
|
||||
- shipping_option
|
||||
properties:
|
||||
shipping_option:
|
||||
$ref: ./AdminShippingOption.yaml
|
||||
@@ -0,0 +1,3 @@
|
||||
type: object
|
||||
description: The shipping option's shipping profile.
|
||||
x-schemaName: AdminShippingProfile
|
||||
+24
@@ -0,0 +1,24 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminShippingProfileDeleteResponse
|
||||
required:
|
||||
- id
|
||||
- object
|
||||
- deleted
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The shipping profile's ID.
|
||||
object:
|
||||
type: string
|
||||
title: object
|
||||
description: The shipping profile's object.
|
||||
default: shipping_profile
|
||||
deleted:
|
||||
type: boolean
|
||||
title: deleted
|
||||
description: The shipping profile's deleted.
|
||||
parent:
|
||||
type: object
|
||||
description: The shipping profile's parent.
|
||||
+8
@@ -0,0 +1,8 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminShippingProfileResponse
|
||||
required:
|
||||
- shipping_profile
|
||||
properties:
|
||||
shipping_profile:
|
||||
$ref: ./AdminShippingProfile.yaml
|
||||
+3
-1
@@ -1,6 +1,8 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: UpdateApiKey
|
||||
x-schemaName: AdminUpdateApiKey
|
||||
required:
|
||||
- title
|
||||
properties:
|
||||
title:
|
||||
type: string
|
||||
+15
-15
@@ -1,9 +1,8 @@
|
||||
type: object
|
||||
description: The promotion's campaign.
|
||||
x-schemaName: CreateCampaign
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminUpdateCampaign
|
||||
required:
|
||||
- name
|
||||
- campaign_identifier
|
||||
- description
|
||||
- starts_at
|
||||
- ends_at
|
||||
properties:
|
||||
@@ -11,18 +10,22 @@ properties:
|
||||
type: string
|
||||
title: name
|
||||
description: The campaign's name.
|
||||
description:
|
||||
type: string
|
||||
title: description
|
||||
description: The campaign's description.
|
||||
currency:
|
||||
type: string
|
||||
title: currency
|
||||
description: The campaign's currency.
|
||||
campaign_identifier:
|
||||
type: string
|
||||
title: campaign_identifier
|
||||
description: The campaign's campaign identifier.
|
||||
description:
|
||||
type: string
|
||||
title: description
|
||||
description: The campaign's description.
|
||||
budget:
|
||||
type: object
|
||||
description: The campaign's budget.
|
||||
properties:
|
||||
limit:
|
||||
type: number
|
||||
title: limit
|
||||
description: The budget's limit.
|
||||
starts_at:
|
||||
type: string
|
||||
title: starts_at
|
||||
@@ -33,15 +36,12 @@ properties:
|
||||
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:
|
||||
@@ -0,0 +1,17 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminUpdateCollection
|
||||
required:
|
||||
- metadata
|
||||
properties:
|
||||
title:
|
||||
type: string
|
||||
title: title
|
||||
description: The collection's title.
|
||||
handle:
|
||||
type: string
|
||||
title: handle
|
||||
description: The collection's handle.
|
||||
metadata:
|
||||
type: object
|
||||
description: The collection's metadata.
|
||||
@@ -0,0 +1,35 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminUpdateCustomer
|
||||
required:
|
||||
- email
|
||||
- company_name
|
||||
- first_name
|
||||
- last_name
|
||||
- phone
|
||||
- metadata
|
||||
properties:
|
||||
email:
|
||||
type: string
|
||||
title: email
|
||||
description: The customer's email.
|
||||
format: email
|
||||
company_name:
|
||||
type: string
|
||||
title: company_name
|
||||
description: The customer's company name.
|
||||
first_name:
|
||||
type: string
|
||||
title: first_name
|
||||
description: The customer's first name.
|
||||
last_name:
|
||||
type: string
|
||||
title: last_name
|
||||
description: The customer's last name.
|
||||
phone:
|
||||
type: string
|
||||
title: phone
|
||||
description: The customer's phone.
|
||||
metadata:
|
||||
type: object
|
||||
description: The customer's metadata.
|
||||
+2
-6
@@ -1,8 +1,9 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: CreateCustomerGroup
|
||||
x-schemaName: AdminUpdateCustomerGroup
|
||||
required:
|
||||
- name
|
||||
- metadata
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
@@ -11,8 +12,3 @@ properties:
|
||||
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,37 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminUpdatePriceList
|
||||
required:
|
||||
- description
|
||||
- starts_at
|
||||
- ends_at
|
||||
properties:
|
||||
title:
|
||||
type: string
|
||||
title: title
|
||||
description: The price list's title.
|
||||
description:
|
||||
type: string
|
||||
title: description
|
||||
description: The price list's description.
|
||||
starts_at:
|
||||
type: string
|
||||
title: starts_at
|
||||
description: The price list's starts at.
|
||||
ends_at:
|
||||
type: string
|
||||
title: ends_at
|
||||
description: The price list's ends at.
|
||||
status:
|
||||
type: string
|
||||
enum:
|
||||
- active
|
||||
- draft
|
||||
type:
|
||||
type: string
|
||||
enum:
|
||||
- sale
|
||||
- override
|
||||
rules:
|
||||
type: object
|
||||
description: The price list's rules.
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user