-
-
Notifications
You must be signed in to change notification settings - Fork 2.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
ae4b552
commit 9024771
Showing
44 changed files
with
1,956 additions
and
238 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
47 changes: 47 additions & 0 deletions
47
www/apps/api-reference/specs/admin/components/schemas/BaseCollection.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
type: object | ||
description: The product collection's details. | ||
x-schemaName: BaseCollection | ||
required: | ||
- id | ||
- title | ||
- handle | ||
- created_at | ||
- updated_at | ||
- deleted_at | ||
- metadata | ||
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 creation date. | ||
updated_at: | ||
type: string | ||
format: date-time | ||
title: updated_at | ||
description: The collection's update date. | ||
deleted_at: | ||
type: string | ||
format: date-time | ||
title: deleted_at | ||
description: The collection's deletion date. | ||
products: | ||
type: array | ||
description: The collection's products. | ||
items: | ||
type: object | ||
metadata: | ||
type: object | ||
description: The collection's metadata, used to store custom key-value pairs. |
147 changes: 137 additions & 10 deletions
147
www/apps/api-reference/specs/admin/components/schemas/BaseProduct.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,35 +1,162 @@ | ||
type: object | ||
description: The product type's details. | ||
description: The product's details. | ||
x-schemaName: BaseProduct | ||
required: | ||
- id | ||
- value | ||
- title | ||
- handle | ||
- subtitle | ||
- description | ||
- is_giftcard | ||
- status | ||
- thumbnail | ||
- width | ||
- weight | ||
- length | ||
- height | ||
- origin_country | ||
- hs_code | ||
- mid_code | ||
- material | ||
- collection_id | ||
- type_id | ||
- variants | ||
- options | ||
- images | ||
- discountable | ||
- external_id | ||
- created_at | ||
- updated_at | ||
- deleted_at | ||
properties: | ||
id: | ||
type: string | ||
title: id | ||
description: The type's ID. | ||
value: | ||
description: The product's ID. | ||
title: | ||
type: string | ||
title: value | ||
description: The type's value. | ||
title: title | ||
description: The product's title. | ||
handle: | ||
type: string | ||
title: handle | ||
description: The product's handle. | ||
subtitle: | ||
type: string | ||
title: subtitle | ||
description: The product's subtitle. | ||
description: | ||
type: string | ||
title: description | ||
description: The product's description. | ||
is_giftcard: | ||
type: boolean | ||
title: is_giftcard | ||
description: Whether the product is a gift card. | ||
status: | ||
type: string | ||
description: The product's status. | ||
enum: | ||
- draft | ||
- proposed | ||
- published | ||
- rejected | ||
thumbnail: | ||
type: string | ||
title: thumbnail | ||
description: The product's thumbnail URL. | ||
width: | ||
type: number | ||
title: width | ||
description: The product's width. | ||
weight: | ||
type: number | ||
title: weight | ||
description: The product's weight. | ||
length: | ||
type: number | ||
title: length | ||
description: The product's length. | ||
height: | ||
type: number | ||
title: height | ||
description: The product's height. | ||
origin_country: | ||
type: string | ||
title: origin_country | ||
description: The product's origin country. | ||
hs_code: | ||
type: string | ||
title: hs_code | ||
description: The product's hs code. | ||
mid_code: | ||
type: string | ||
title: mid_code | ||
description: The product's mid code. | ||
material: | ||
type: string | ||
title: material | ||
description: The product's material. | ||
collection: | ||
$ref: ./BaseCollection.yaml | ||
collection_id: | ||
type: string | ||
title: collection_id | ||
description: The ID of the collection the product belongs to. | ||
categories: | ||
type: array | ||
description: The product's categories. | ||
items: | ||
$ref: ./BaseProductCategory.yaml | ||
type: | ||
$ref: ./BaseProductType.yaml | ||
type_id: | ||
type: string | ||
title: type_id | ||
description: The ID of the type the product belongs to. | ||
tags: | ||
type: array | ||
description: The product's tags. | ||
items: | ||
$ref: ./BaseProductTag.yaml | ||
variants: | ||
type: array | ||
description: The product's variants. | ||
items: | ||
type: object | ||
options: | ||
type: array | ||
description: The product's options. | ||
items: | ||
$ref: ./BaseProductOption.yaml | ||
images: | ||
type: array | ||
description: The product's images. | ||
items: | ||
$ref: ./BaseProductImage.yaml | ||
discountable: | ||
type: boolean | ||
title: discountable | ||
description: Whether the product is discountable. | ||
external_id: | ||
type: string | ||
title: external_id | ||
description: The ID of the product in an external or third-party system. | ||
created_at: | ||
type: string | ||
format: date-time | ||
title: created_at | ||
description: The date the type was created. | ||
description: The date the product was created. | ||
updated_at: | ||
type: string | ||
format: date-time | ||
title: updated_at | ||
description: The date the type was updated. | ||
description: The date the product was updated. | ||
deleted_at: | ||
type: string | ||
format: date-time | ||
title: deleted_at | ||
description: The date the type was deleted. | ||
description: The date the product was deleted. | ||
metadata: | ||
type: object | ||
description: The type's metadata, can hold custom key-value pairs. | ||
description: The product's metadata, can hold custom key-value pairs. |
84 changes: 84 additions & 0 deletions
84
www/apps/api-reference/specs/admin/components/schemas/BaseProductCategory.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,84 @@ | ||
type: object | ||
description: The product category's details. | ||
x-schemaName: BaseProductCategory | ||
required: | ||
- id | ||
- name | ||
- description | ||
- handle | ||
- is_active | ||
- is_internal | ||
- rank | ||
- parent_category_id | ||
- parent_category | ||
- category_children | ||
- created_at | ||
- updated_at | ||
- deleted_at | ||
properties: | ||
category_children: | ||
type: array | ||
description: The category's 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. | ||
metadata: | ||
type: object | ||
description: The category's metadata, can hold custom key-value pairs. | ||
created_at: | ||
type: string | ||
format: date-time | ||
title: created_at | ||
description: The date the category was created. | ||
updated_at: | ||
type: string | ||
format: date-time | ||
title: updated_at | ||
description: The date the category was updated. | ||
handle: | ||
type: string | ||
title: handle | ||
description: The category's unique handle. | ||
deleted_at: | ||
type: string | ||
format: date-time | ||
title: deleted_at | ||
description: The date the category was deleted. | ||
is_active: | ||
type: boolean | ||
title: is_active | ||
description: >- | ||
Whether the category is active. If disabled, the category isn't shown in | ||
the storefront. | ||
is_internal: | ||
type: boolean | ||
title: is_internal | ||
description: >- | ||
Whether the category is internal. If enabled, the category is only seen by | ||
admin users. | ||
rank: | ||
type: number | ||
title: rank | ||
description: The category's rank among sibling categories. | ||
parent_category_id: | ||
type: string | ||
title: parent_category_id | ||
description: The ID of the category's parent. |
33 changes: 33 additions & 0 deletions
33
www/apps/api-reference/specs/admin/components/schemas/BaseProductImage.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
type: object | ||
description: The image's details. | ||
x-schemaName: BaseProductImage | ||
properties: | ||
id: | ||
type: string | ||
title: id | ||
description: The image's ID. | ||
url: | ||
type: string | ||
title: url | ||
description: The image's URL. | ||
created_at: | ||
type: string | ||
format: date-time | ||
title: created_at | ||
description: The date the image was created. | ||
updated_at: | ||
type: string | ||
format: date-time | ||
title: updated_at | ||
description: The date the image was updated. | ||
deleted_at: | ||
type: string | ||
format: date-time | ||
title: deleted_at | ||
description: The date the image was deleted. | ||
metadata: | ||
type: object | ||
description: The image's metadata, can hold custom key-value pairs. | ||
required: | ||
- id | ||
- url |
Oops, something went wrong.