chore(docs): Updated API Reference (automated) (#10437)
* chore(docs): Generated API Reference (automated) * fixes --------- Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
This commit is contained in:
committed by
GitHub
parent
29e463e8c3
commit
c9eeaebdd9
@@ -0,0 +1,105 @@
|
||||
type: object
|
||||
description: The details to update in the order.
|
||||
x-schemaName: AdminUpdateOrder
|
||||
properties:
|
||||
email:
|
||||
type: string
|
||||
title: email
|
||||
description: The order's email.
|
||||
format: email
|
||||
shipping_address:
|
||||
type: object
|
||||
description: The order's shipping address.
|
||||
properties:
|
||||
first_name:
|
||||
type: string
|
||||
title: first_name
|
||||
description: The address's first name.
|
||||
last_name:
|
||||
type: string
|
||||
title: last_name
|
||||
description: The address's last name.
|
||||
phone:
|
||||
type: string
|
||||
title: phone
|
||||
description: The address's phone.
|
||||
company:
|
||||
type: string
|
||||
title: company
|
||||
description: The address's company.
|
||||
address_1:
|
||||
type: string
|
||||
title: address_1
|
||||
description: The address's first line.
|
||||
address_2:
|
||||
type: string
|
||||
title: address_2
|
||||
description: The address's second line.
|
||||
city:
|
||||
type: string
|
||||
title: city
|
||||
description: The address's city.
|
||||
country_code:
|
||||
type: string
|
||||
title: country_code
|
||||
description: The address's country code.
|
||||
example: us
|
||||
province:
|
||||
type: string
|
||||
title: province
|
||||
description: The address's province.
|
||||
postal_code:
|
||||
type: string
|
||||
title: postal_code
|
||||
description: The address's postal code.
|
||||
metadata:
|
||||
type: object
|
||||
description: The address's metadata, can hold custom key-value pairs.
|
||||
billing_address:
|
||||
type: object
|
||||
description: The order's billing address.
|
||||
properties:
|
||||
first_name:
|
||||
type: string
|
||||
title: first_name
|
||||
description: The address's first name.
|
||||
last_name:
|
||||
type: string
|
||||
title: last_name
|
||||
description: The address's last name.
|
||||
phone:
|
||||
type: string
|
||||
title: phone
|
||||
description: The address's phone.
|
||||
company:
|
||||
type: string
|
||||
title: company
|
||||
description: The address's company.
|
||||
address_1:
|
||||
type: string
|
||||
title: address_1
|
||||
description: The address's first line.
|
||||
address_2:
|
||||
type: string
|
||||
title: address_2
|
||||
description: The address's second line.
|
||||
city:
|
||||
type: string
|
||||
title: city
|
||||
description: The address's city.
|
||||
country_code:
|
||||
type: string
|
||||
title: country_code
|
||||
description: The address's country code.
|
||||
example: us
|
||||
province:
|
||||
type: string
|
||||
title: province
|
||||
description: The address's province.
|
||||
postal_code:
|
||||
type: string
|
||||
title: postal_code
|
||||
description: The address's postal code.
|
||||
metadata:
|
||||
type: object
|
||||
description: The address's metadata, can hold custom key-value pairs.
|
||||
@@ -56,60 +56,6 @@ properties:
|
||||
calculated_price:
|
||||
type: object
|
||||
description: The calculated price's details.
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The ID of the price.
|
||||
price_list_id:
|
||||
type: string
|
||||
title: price_list_id
|
||||
description: The ID of the associated price list.
|
||||
price_list_type:
|
||||
type: string
|
||||
title: price_list_type
|
||||
description: The price list's type. For example, sale.
|
||||
min_quantity:
|
||||
type: number
|
||||
title: min_quantity
|
||||
description: The minimum quantity required in the cart for this price to apply.
|
||||
max_quantity:
|
||||
type: number
|
||||
title: max_quantity
|
||||
description: The maximum quantity allowed in the cart for this price to apply.
|
||||
required:
|
||||
- id
|
||||
- price_list_id
|
||||
- price_list_type
|
||||
- min_quantity
|
||||
- max_quantity
|
||||
original_price:
|
||||
type: object
|
||||
description: The original price's details.
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The ID of the price.
|
||||
price_list_id:
|
||||
type: string
|
||||
title: price_list_id
|
||||
description: The ID of the associated price list.
|
||||
price_list_type:
|
||||
type: string
|
||||
title: price_list_type
|
||||
description: The price list's type. For example, sale.
|
||||
min_quantity:
|
||||
type: number
|
||||
title: min_quantity
|
||||
description: The minimum quantity required in the cart for this price to apply.
|
||||
max_quantity:
|
||||
type: number
|
||||
title: max_quantity
|
||||
description: The maximum quantity allowed in the cart for this price to apply.
|
||||
required:
|
||||
- id
|
||||
- price_list_id
|
||||
- price_list_type
|
||||
- min_quantity
|
||||
- max_quantity
|
||||
|
||||
Reference in New Issue
Block a user