chore(docs): Generated API Reference (#2882)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
co-authored by
olivermrbl
parent
233d6904f8
commit
4814045036
@@ -7,77 +7,7 @@ post:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
required:
|
||||
- name
|
||||
- region_id
|
||||
- provider_id
|
||||
- data
|
||||
- price_type
|
||||
properties:
|
||||
name:
|
||||
description: The name of the Shipping Option
|
||||
type: string
|
||||
region_id:
|
||||
description: >-
|
||||
The ID of the Region in which the Shipping Option will be
|
||||
available.
|
||||
type: string
|
||||
provider_id:
|
||||
description: >-
|
||||
The ID of the Fulfillment Provider that handles the Shipping
|
||||
Option.
|
||||
type: string
|
||||
profile_id:
|
||||
description: The ID of the Shipping Profile to add the Shipping Option to.
|
||||
type: number
|
||||
data:
|
||||
description: >-
|
||||
The data needed for the Fulfillment Provider to handle shipping
|
||||
with this Shipping Option.
|
||||
type: object
|
||||
price_type:
|
||||
description: The type of the Shipping Option price.
|
||||
type: string
|
||||
enum:
|
||||
- flat_rate
|
||||
- calculated
|
||||
amount:
|
||||
description: The amount to charge for the Shipping Option.
|
||||
type: integer
|
||||
requirements:
|
||||
description: >-
|
||||
The requirements that must be satisfied for the Shipping Option
|
||||
to be available.
|
||||
type: array
|
||||
items:
|
||||
required:
|
||||
- type
|
||||
- amount
|
||||
properties:
|
||||
type:
|
||||
description: The type of the requirement
|
||||
type: string
|
||||
enum:
|
||||
- max_subtotal
|
||||
- min_subtotal
|
||||
amount:
|
||||
description: The amount to compare with.
|
||||
type: integer
|
||||
is_return:
|
||||
description: Whether the Shipping Option defines a return shipment.
|
||||
type: boolean
|
||||
default: false
|
||||
admin_only:
|
||||
description: If true, the option can be used for draft orders
|
||||
type: boolean
|
||||
default: false
|
||||
metadata:
|
||||
description: An optional set of key-value pairs with additional information.
|
||||
type: object
|
||||
includes_tax:
|
||||
description: '[EXPERIMENTAL] Tax included in prices of shipping option'
|
||||
type: boolean
|
||||
$ref: ../components/schemas/AdminPostShippingOptionsReq.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
@@ -101,7 +31,7 @@ post:
|
||||
type: object
|
||||
properties:
|
||||
shipping_option:
|
||||
$ref: ../components/schemas/shipping_option.yaml
|
||||
$ref: ../components/schemas/ShippingOption.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -160,7 +90,7 @@ get:
|
||||
shipping_options:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../components/schemas/shipping_option.yaml
|
||||
$ref: ../components/schemas/ShippingOption.yaml
|
||||
count:
|
||||
type: integer
|
||||
description: The total number of items available
|
||||
|
||||
Reference in New Issue
Block a user