Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(docs): Updated API Reference (automated) #9804

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
curl -X POST '{backend_url}/admin/customers/{id}/customer-groups' \
-H 'Authorization: Bearer {access_token}'
Original file line number Diff line number Diff line change
Expand Up @@ -29,38 +29,79 @@ required:
- updated_at
- deleted_at
properties:
collection:
$ref: ./BaseCollection.yaml
categories:
type: array
description: The product's categories.
items:
$ref: ./BaseProductCategory.yaml
variants:
type: array
description: The product's variants.
items:
type: object
type:
$ref: ./BaseProductType.yaml
tags:
type: array
description: The product's tags.
items:
$ref: ./BaseProductTag.yaml
length:
type: number
title: length
description: The product's length.
title:
type: string
title: title
description: The product's title.
status:
type: string
description: The product's status.
enum:
- draft
- proposed
- published
- rejected
options:
type: array
description: The product's options.
items:
$ref: ./BaseProductOption.yaml
description:
type: string
title: description
description: The product's description.
id:
type: string
title: id
description: The product's ID.
title:
metadata:
type: object
description: The product's metadata, can hold custom key-value pairs.
created_at:
type: string
title: title
description: The product's title.
format: date-time
title: created_at
description: The date the product was created.
updated_at:
type: string
format: date-time
title: updated_at
description: The date the product was updated.
handle:
type: string
title: handle
description: The product's handle.
description: The product's unique 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
Expand All @@ -73,10 +114,6 @@ properties:
type: number
title: weight
description: The product's weight.
length:
type: number
title: length
description: The product's length.
height:
type: number
title: height
Expand All @@ -88,47 +125,23 @@ properties:
hs_code:
type: string
title: hs_code
description: The product's hs code.
description: The product's HS code.
mid_code:
type: string
title: mid_code
description: The product's 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
description: The ID of the collection that the product belongs to.
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
description: The ID of the product's type.
images:
type: array
description: The product's images.
Expand All @@ -137,26 +150,13 @@ properties:
discountable:
type: boolean
title: discountable
description: Whether the product is discountable.
description: Whether discounts can be applied on the product.
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 product was created.
updated_at:
type: string
format: date-time
title: updated_at
description: The date the product was updated.
description: The ID of a product in an external system, such as an ERP or CMS.
deleted_at:
type: string
format: date-time
title: deleted_at
description: The date the product was deleted.
metadata:
type: object
description: The product's metadata, can hold custom key-value pairs.
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,6 @@ properties:
type: string
title: phone
description: The customer's phone.
metadata:
type: object
description: The customer's metadata, can hold custom key-value pairs.
Loading
Loading