Skip to content

Commit 4043a90

Browse files
committed
update api specs
1 parent 869a17e commit 4043a90

4 files changed

Lines changed: 555 additions & 82 deletions

File tree

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

Lines changed: 163 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1777,9 +1777,7 @@ components:
17771777
low_stock_threshold:
17781778
maximum: 2147483647
17791779
minimum: 0
1780-
type:
1781-
- integer
1782-
- 'null'
1780+
type: integer
17831781
num_in_stock:
17841782
type: integer
17851783
product:
@@ -5054,9 +5052,7 @@ components:
50545052
low_stock_threshold:
50555053
maximum: 2147483647
50565054
minimum: 0
5057-
type:
5058-
- integer
5059-
- 'null'
5055+
type: integer
50605056
num_in_stock:
50615057
type: integer
50625058
product:
@@ -6690,6 +6686,28 @@ components:
66906686
images:
66916687
readOnly: true
66926688
type: string
6689+
inventory_availability:
6690+
description: 'Inventory availability at fulfillment locations
6691+
6692+
6693+
* `in_stock` - In Stock
6694+
6695+
* `low_stock` - Low Stock
6696+
6697+
* `out_of_stock` - Out of Stock
6698+
6699+
* `untracked` - Untracked'
6700+
enum:
6701+
- in_stock
6702+
- low_stock
6703+
- out_of_stock
6704+
- untracked
6705+
- ''
6706+
- null
6707+
type:
6708+
- string
6709+
- 'null'
6710+
x-spec-enum-id: b27c4da75c8684c5
66936711
metadata:
66946712
oneOf:
66956713
- {}
@@ -6700,6 +6718,22 @@ components:
67006718
type: array
67016719
product_id:
67026720
type: integer
6721+
purchase_availability:
6722+
description: 'Product''s availability to purchase in new orders
6723+
6724+
6725+
* `available` - Available
6726+
6727+
* `unavailable` - Unavailable'
6728+
enum:
6729+
- available
6730+
- unavailable
6731+
- ''
6732+
- null
6733+
type:
6734+
- string
6735+
- 'null'
6736+
x-spec-enum-id: c3aa4eaf80db200b
67036737
requires_shipping:
67046738
title: Requires shipping?
67056739
type: boolean
@@ -7312,9 +7346,7 @@ components:
73127346
low_stock_threshold:
73137347
maximum: 2147483647
73147348
minimum: 0
7315-
type:
7316-
- integer
7317-
- 'null'
7349+
type: integer
73187350
net_stock_level:
73197351
readOnly: true
73207352
type: integer
@@ -7367,9 +7399,7 @@ components:
73677399
low_stock_threshold:
73687400
maximum: 2147483647
73697401
minimum: 0
7370-
type:
7371-
- integer
7372-
- 'null'
7402+
type: integer
73737403
num_allocated:
73747404
maximum: 2147483647
73757405
minimum: -2147483648
@@ -7420,9 +7450,7 @@ components:
74207450
low_stock_threshold:
74217451
maximum: 2147483647
74227452
minimum: 0
7423-
type:
7424-
- integer
7425-
- 'null'
7453+
type: integer
74267454
num_allocated:
74277455
readOnly: true
74287456
title: Number allocated
@@ -14949,6 +14977,41 @@ paths:
1494914977
name: sku
1495014978
schema:
1495114979
type: string
14980+
- description: 'Inventory Availability
14981+
14982+
14983+
* `in_stock` - In Stock
14984+
14985+
* `low_stock` - Low Stock
14986+
14987+
* `out_of_stock` - Out of Stock
14988+
14989+
* `untracked` - Untracked'
14990+
in: query
14991+
name: inventory_availability
14992+
schema:
14993+
enum:
14994+
- in_stock
14995+
- low_stock
14996+
- out_of_stock
14997+
- untracked
14998+
type: string
14999+
- description: 'Purchase Availability
15000+
15001+
15002+
* `available` - Available
15003+
15004+
* `unavailable` - Unavailable'
15005+
in: query
15006+
name: purchase_availability
15007+
schema:
15008+
enum:
15009+
- available
15010+
- unavailable
15011+
type:
15012+
- string
15013+
- 'null'
15014+
x-spec-enum-id: c3aa4eaf80db200b
1495215015
- description: The pagination cursor value.
1495315016
in: query
1495415017
name: cursor
@@ -18062,9 +18125,7 @@ webhooks:
1806218125
low_stock_threshold:
1806318126
maximum: 2147483647
1806418127
minimum: 0
18065-
type:
18066-
- integer
18067-
- 'null'
18128+
type: integer
1806818129
num_allocated:
1806918130
maximum: 2147483647
1807018131
minimum: -2147483648
@@ -20479,9 +20540,7 @@ webhooks:
2047920540
low_stock_threshold:
2048020541
maximum: 2147483647
2048120542
minimum: 0
20482-
type:
20483-
- integer
20484-
- 'null'
20543+
type: integer
2048520544
num_allocated:
2048620545
maximum: 2147483647
2048720546
minimum: -2147483648
@@ -21906,9 +21965,7 @@ webhooks:
2190621965
low_stock_threshold:
2190721966
maximum: 2147483647
2190821967
minimum: 0
21909-
type:
21910-
- integer
21911-
- 'null'
21968+
type: integer
2191221969
num_allocated:
2191321970
maximum: 2147483647
2191421971
minimum: -2147483648
@@ -23011,6 +23068,28 @@ webhooks:
2301123068
type: integer
2301223069
images:
2301323070
type: string
23071+
inventory_availability:
23072+
description: 'Inventory availability at fulfillment locations
23073+
23074+
23075+
* `in_stock` - In Stock
23076+
23077+
* `low_stock` - Low Stock
23078+
23079+
* `out_of_stock` - Out of Stock
23080+
23081+
* `untracked` - Untracked'
23082+
enum:
23083+
- in_stock
23084+
- low_stock
23085+
- out_of_stock
23086+
- untracked
23087+
- ''
23088+
- null
23089+
type:
23090+
- string
23091+
- 'null'
23092+
x-spec-enum-id: b27c4da75c8684c5
2301423093
metadata:
2301523094
oneOf:
2301623095
- {}
@@ -23052,6 +23131,23 @@ webhooks:
2305223131
type: array
2305323132
product_id:
2305423133
type: integer
23134+
purchase_availability:
23135+
description: 'Product''s availability to purchase in new
23136+
orders
23137+
23138+
23139+
* `available` - Available
23140+
23141+
* `unavailable` - Unavailable'
23142+
enum:
23143+
- available
23144+
- unavailable
23145+
- ''
23146+
- null
23147+
type:
23148+
- string
23149+
- 'null'
23150+
x-spec-enum-id: c3aa4eaf80db200b
2305523151
requires_shipping:
2305623152
title: Requires shipping?
2305723153
type: boolean
@@ -23070,9 +23166,7 @@ webhooks:
2307023166
low_stock_threshold:
2307123167
maximum: 2147483647
2307223168
minimum: 0
23073-
type:
23074-
- integer
23075-
- 'null'
23169+
type: integer
2307623170
num_allocated:
2307723171
title: Number allocated
2307823172
type:
@@ -23531,6 +23625,28 @@ webhooks:
2353123625
type: integer
2353223626
images:
2353323627
type: string
23628+
inventory_availability:
23629+
description: 'Inventory availability at fulfillment locations
23630+
23631+
23632+
* `in_stock` - In Stock
23633+
23634+
* `low_stock` - Low Stock
23635+
23636+
* `out_of_stock` - Out of Stock
23637+
23638+
* `untracked` - Untracked'
23639+
enum:
23640+
- in_stock
23641+
- low_stock
23642+
- out_of_stock
23643+
- untracked
23644+
- ''
23645+
- null
23646+
type:
23647+
- string
23648+
- 'null'
23649+
x-spec-enum-id: b27c4da75c8684c5
2353423650
metadata:
2353523651
oneOf:
2353623652
- {}
@@ -23572,6 +23688,23 @@ webhooks:
2357223688
type: array
2357323689
product_id:
2357423690
type: integer
23691+
purchase_availability:
23692+
description: 'Product''s availability to purchase in new
23693+
orders
23694+
23695+
23696+
* `available` - Available
23697+
23698+
* `unavailable` - Unavailable'
23699+
enum:
23700+
- available
23701+
- unavailable
23702+
- ''
23703+
- null
23704+
type:
23705+
- string
23706+
- 'null'
23707+
x-spec-enum-id: c3aa4eaf80db200b
2357523708
requires_shipping:
2357623709
title: Requires shipping?
2357723710
type: boolean
@@ -23590,9 +23723,7 @@ webhooks:
2359023723
low_stock_threshold:
2359123724
maximum: 2147483647
2359223725
minimum: 0
23593-
type:
23594-
- integer
23595-
- 'null'
23726+
type: integer
2359623727
num_allocated:
2359723728
title: Number allocated
2359823729
type:
@@ -24429,9 +24560,7 @@ webhooks:
2442924560
low_stock_threshold:
2443024561
maximum: 2147483647
2443124562
minimum: 0
24432-
type:
24433-
- integer
24434-
- 'null'
24563+
type: integer
2443524564
num_allocated:
2443624565
maximum: 2147483647
2443724566
minimum: -2147483648
@@ -25014,9 +25143,7 @@ webhooks:
2501425143
low_stock_threshold:
2501525144
maximum: 2147483647
2501625145
minimum: 0
25017-
type:
25018-
- integer
25019-
- 'null'
25146+
type: integer
2502025147
num_allocated:
2502125148
maximum: 2147483647
2502225149
minimum: -2147483648

0 commit comments

Comments
 (0)