chore(docs): Generated API Reference (#4706)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
This commit is contained in:
co-authored by
olivermrbl
Shahed Nasser
parent
efdea04963
commit
658339767b
@@ -2,21 +2,37 @@ type: object
|
||||
properties:
|
||||
region_id:
|
||||
type: string
|
||||
description: The ID of the Region to create the Cart in.
|
||||
description: >-
|
||||
The ID of the Region to create the Cart in. Setting the cart's region can
|
||||
affect the pricing of the items in the cart as well as the used currency.
|
||||
If this parameter is not provided, the first region in the store is used
|
||||
by default.
|
||||
sales_channel_id:
|
||||
type: string
|
||||
description: '[EXPERIMENTAL] The ID of the Sales channel to create the Cart in.'
|
||||
description: >-
|
||||
The ID of the Sales channel to create the Cart in. The cart's sales
|
||||
channel affects which products can be added to the cart. If a product does
|
||||
not exist in the cart's sales channel, it cannot be added to the cart. If
|
||||
you add a publishable API key in the header of this request and specify a
|
||||
sales channel ID, the specified sales channel must be within the scope of
|
||||
the publishable API key's resources. If you add a publishable API key in
|
||||
the header of this request, you don't specify a sales channel ID, and the
|
||||
publishable API key is associated with one sales channel, that sales
|
||||
channel will be attached to the cart. If no sales channel is passed and no
|
||||
publishable API key header is passed or the publishable API key isn't
|
||||
associated with any sales channel, the cart will not be associated with
|
||||
any sales channel.
|
||||
country_code:
|
||||
type: string
|
||||
description: The 2 character ISO country code to create the Cart in.
|
||||
description: >-
|
||||
The 2 character ISO country code to create the Cart in. Setting this
|
||||
parameter will set the country code of the shipping address.
|
||||
externalDocs:
|
||||
url: >-
|
||||
https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements
|
||||
description: See a list of codes.
|
||||
items:
|
||||
description: >-
|
||||
An optional array of `variant_id`, `quantity` pairs to generate Line Items
|
||||
from.
|
||||
description: An array of product variants to generate line items from.
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
@@ -25,14 +41,14 @@ properties:
|
||||
- quantity
|
||||
properties:
|
||||
variant_id:
|
||||
description: The id of the Product Variant to generate a Line Item from.
|
||||
description: The ID of the Product Variant.
|
||||
type: string
|
||||
quantity:
|
||||
description: The quantity of the Product Variant to add
|
||||
description: The quantity to add into the cart.
|
||||
type: integer
|
||||
context:
|
||||
description: >-
|
||||
An optional object to provide context to the Cart. The `context` field is
|
||||
An object to provide context to the Cart. The `context` field is
|
||||
automatically populated with `ip` and `user_agent`
|
||||
type: object
|
||||
example:
|
||||
|
||||
Reference in New Issue
Block a user