Skip to content

Commit a03ff2e

Browse files
committed
update admin api docs
1 parent f19bedb commit a03ff2e

3 files changed

Lines changed: 378 additions & 3 deletions

File tree

static/api/admin/2023-02-10.yaml

Lines changed: 66 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -647,6 +647,19 @@ components:
647647
- postcode
648648
- state
649649
type: object
650+
Country:
651+
properties:
652+
code:
653+
readOnly: true
654+
type: string
655+
name:
656+
maxLength: 128
657+
title: Official name
658+
type: string
659+
required:
660+
- code
661+
- name
662+
type: object
650663
CreateCart:
651664
properties:
652665
attribution:
@@ -2662,7 +2675,7 @@ components:
26622675
- $ref: '#/components/schemas/FulfillmentShippingAddress'
26632676
- type: 'null'
26642677
shipping_method:
2665-
$ref: '#/components/schemas/ShippingMethod'
2678+
$ref: '#/components/schemas/ShippingMethodObject'
26662679
status:
26672680
description: '* `not_required` - Not Requried
26682681

@@ -7061,6 +7074,44 @@ components:
70617074
- line4
70627075
type: object
70637076
ShippingMethod:
7077+
properties:
7078+
code:
7079+
description: If left empty, a code name will be generated based on the name
7080+
of the shipping method.
7081+
maxLength: 128
7082+
pattern: ^[-a-zA-Z0-9_]+$
7083+
type: string
7084+
countries:
7085+
items:
7086+
$ref: '#/components/schemas/Country'
7087+
type: array
7088+
delivery_time:
7089+
description: Shows in checkout, example value should be "3-5 days".
7090+
maxLength: 128
7091+
type: string
7092+
description:
7093+
type: string
7094+
id:
7095+
readOnly: true
7096+
type: integer
7097+
is_public:
7098+
description: Only public shipping methods are shown in the checkout flow.
7099+
type: boolean
7100+
name:
7101+
maxLength: 128
7102+
type: string
7103+
prices:
7104+
items:
7105+
$ref: '#/components/schemas/ShippingMethodPrices'
7106+
readOnly: true
7107+
type: array
7108+
required:
7109+
- countries
7110+
- id
7111+
- name
7112+
- prices
7113+
type: object
7114+
ShippingMethodObject:
70647115
properties:
70657116
code:
70667117
type: string
@@ -7070,6 +7121,20 @@ components:
70707121
- code
70717122
- name
70727123
type: object
7124+
ShippingMethodPrices:
7125+
properties:
7126+
currency:
7127+
description: Currency to apply this pricing.
7128+
maxLength: 5
7129+
type: string
7130+
price_per_order:
7131+
description: Shipping fee for the order.
7132+
format: decimal
7133+
pattern: ^-?\d{0,10}(?:\.\d{0,2})?$
7134+
type: string
7135+
required:
7136+
- currency
7137+
type: object
70737138
StockRecord:
70747139
properties:
70757140
date_created:

0 commit comments

Comments
 (0)