Skip to content

Commit 6f311b6

Browse files
alexphelpsalexphelps
committed
update admin api specs
1 parent e288f7f commit 6f311b6

3 files changed

Lines changed: 376 additions & 6 deletions

File tree

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

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15295,21 +15295,27 @@ paths:
1529515295
- description: 'Payment Method
1529615296

1529715297

15298+
* `apple_pay` - Apple Pay
15299+
1529815300
* `bankcard` - Bankcard
1529915301

15300-
* `paypal` - Paypal'
15302+
* `google_pay` - Google Pay
15303+
15304+
* `paypal` - PayPal'
1530115305
explode: true
1530215306
in: query
1530315307
name: payment_method
1530415308
schema:
1530515309
items:
1530615310
enum:
15311+
- apple_pay
1530715312
- bankcard
15313+
- google_pay
1530815314
- paypal
1530915315
type:
1531015316
- string
1531115317
- 'null'
15312-
x-spec-enum-id: 26db7321804e45c6
15318+
x-spec-enum-id: ee5cec980b0ff345
1531315319
type: array
1531415320
style: form
1531515321
- description: 'Gateway Status

‎static/api/admin/2024-04-01.yaml‎

Lines changed: 184 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -226,6 +226,77 @@ components:
226226
required:
227227
- available_locations
228228
type: object
229+
BasketLineReport:
230+
properties:
231+
currency:
232+
maxLength: 3
233+
readOnly: true
234+
type: string
235+
price_excl_tax:
236+
format: decimal
237+
pattern: ^-?\d{0,10}(?:\.\d{0,2})?$
238+
readOnly: true
239+
type: string
240+
price_incl_tax:
241+
format: decimal
242+
pattern: ^-?\d{0,10}(?:\.\d{0,2})?$
243+
readOnly: true
244+
type: string
245+
total_cost:
246+
format: decimal
247+
pattern: ^-?\d{0,10}(?:\.\d{0,2})?$
248+
readOnly: true
249+
type: string
250+
total_discount:
251+
format: decimal
252+
pattern: ^-?\d{0,10}(?:\.\d{0,2})?$
253+
readOnly: true
254+
type: string
255+
unit_cost:
256+
format: decimal
257+
pattern: ^-?\d{0,10}(?:\.\d{0,2})?$
258+
readOnly: true
259+
type: string
260+
required:
261+
- currency
262+
- price_excl_tax
263+
- price_incl_tax
264+
- total_cost
265+
- total_discount
266+
- unit_cost
267+
type: object
268+
BasketReportValues:
269+
properties:
270+
currency:
271+
readOnly: true
272+
type: string
273+
total_cost:
274+
format: decimal
275+
pattern: ^-?\d{0,10}(?:\.\d{0,2})?$
276+
readOnly: true
277+
type: string
278+
total_discount:
279+
format: decimal
280+
pattern: ^-?\d{0,10}(?:\.\d{0,2})?$
281+
readOnly: true
282+
type: string
283+
total_excl_tax:
284+
format: decimal
285+
pattern: ^-?\d{0,10}(?:\.\d{0,2})?$
286+
readOnly: true
287+
type: string
288+
total_incl_tax:
289+
format: decimal
290+
pattern: ^-?\d{0,10}(?:\.\d{0,2})?$
291+
readOnly: true
292+
type: string
293+
required:
294+
- currency
295+
- total_cost
296+
- total_discount
297+
- total_excl_tax
298+
- total_incl_tax
299+
type: object
229300
BillingAddress:
230301
properties:
231302
country:
@@ -635,10 +706,19 @@ components:
635706
oneOf:
636707
- {}
637708
- type: 'null'
709+
report_values:
710+
allOf:
711+
- $ref: '#/components/schemas/BasketReportValues'
712+
readOnly: true
638713
status:
639714
description: 'Available values : Open'
640715
readOnly: true
641716
type: string
717+
total_cost:
718+
format: decimal
719+
pattern: ^-?\d{0,10}(?:\.\d{0,2})?$
720+
readOnly: true
721+
type: string
642722
total_discount:
643723
format: decimal
644724
pattern: ^-?\d{0,10}(?:\.\d{0,2})?$
@@ -667,7 +747,9 @@ components:
667747
- currency
668748
- id
669749
- lines
750+
- report_values
670751
- status
752+
- total_cost
671753
- total_discount
672754
- total_excl_tax
673755
- total_incl_tax
@@ -726,14 +808,28 @@ components:
726808
maximum: 2147483647
727809
minimum: 0
728810
type: integer
811+
report_values:
812+
allOf:
813+
- $ref: '#/components/schemas/BasketLineReport'
814+
readOnly: true
729815
sku:
730816
readOnly: true
731817
type: string
818+
total_cost:
819+
format: decimal
820+
pattern: ^-?\d{0,10}(?:\.\d{0,2})?$
821+
readOnly: true
822+
type: string
732823
total_discount:
733824
format: decimal
734825
pattern: ^-?\d{0,10}(?:\.\d{0,2})?$
735826
readOnly: true
736827
type: string
828+
unit_cost:
829+
format: decimal
830+
pattern: ^-?\d{0,10}(?:\.\d{0,2})?$
831+
readOnly: true
832+
type: string
737833
variant_id:
738834
readOnly: true
739835
type: integer
@@ -748,8 +844,11 @@ components:
748844
- product_image
749845
- product_title
750846
- product_url
847+
- report_values
751848
- sku
849+
- total_cost
752850
- total_discount
851+
- unit_cost
753852
- variant_id
754853
- variant_title
755854
type: object
@@ -15678,21 +15777,27 @@ paths:
1567815777
- description: 'Payment Method
1567915778

1568015779

15780+
* `apple_pay` - Apple Pay
15781+
1568115782
* `bankcard` - Bankcard
1568215783

15683-
* `paypal` - Paypal'
15784+
* `google_pay` - Google Pay
15785+
15786+
* `paypal` - PayPal'
1568415787
explode: true
1568515788
in: query
1568615789
name: payment_method
1568715790
schema:
1568815791
items:
1568915792
enum:
15793+
- apple_pay
1569015794
- bankcard
15795+
- google_pay
1569115796
- paypal
1569215797
type:
1569315798
- string
1569415799
- 'null'
15695-
x-spec-enum-id: 26db7321804e45c6
15800+
x-spec-enum-id: ee5cec980b0ff345
1569615801
type: array
1569715802
style: form
1569815803
- description: 'Gateway Status
@@ -18209,12 +18314,53 @@ webhooks:
1820918314
maximum: 2147483647
1821018315
minimum: 0
1821118316
type: integer
18317+
report_values:
18318+
properties:
18319+
currency:
18320+
maxLength: 3
18321+
type: string
18322+
price_excl_tax:
18323+
format: decimal
18324+
pattern: ^-?\d{0,10}(?:\.\d{0,2})?$
18325+
type: string
18326+
price_incl_tax:
18327+
format: decimal
18328+
pattern: ^-?\d{0,10}(?:\.\d{0,2})?$
18329+
type: string
18330+
total_cost:
18331+
format: decimal
18332+
pattern: ^-?\d{0,10}(?:\.\d{0,2})?$
18333+
type: string
18334+
total_discount:
18335+
format: decimal
18336+
pattern: ^-?\d{0,10}(?:\.\d{0,2})?$
18337+
type: string
18338+
unit_cost:
18339+
format: decimal
18340+
pattern: ^-?\d{0,10}(?:\.\d{0,2})?$
18341+
type: string
18342+
required:
18343+
- currency
18344+
- price_excl_tax
18345+
- price_incl_tax
18346+
- total_cost
18347+
- total_discount
18348+
- unit_cost
18349+
type: object
1821218350
sku:
1821318351
type: string
18352+
total_cost:
18353+
format: decimal
18354+
pattern: ^-?\d{0,10}(?:\.\d{0,2})?$
18355+
type: string
1821418356
total_discount:
1821518357
format: decimal
1821618358
pattern: ^-?\d{0,10}(?:\.\d{0,2})?$
1821718359
type: string
18360+
unit_cost:
18361+
format: decimal
18362+
pattern: ^-?\d{0,10}(?:\.\d{0,2})?$
18363+
type: string
1821818364
variant_id:
1821918365
type: integer
1822018366
variant_title:
@@ -18227,8 +18373,11 @@ webhooks:
1822718373
- product_image
1822818374
- product_title
1822918375
- product_url
18376+
- report_values
1823018377
- sku
18378+
- total_cost
1823118379
- total_discount
18380+
- unit_cost
1823218381
- variant_id
1823318382
- variant_title
1823418383
type: object
@@ -18237,9 +18386,40 @@ webhooks:
1823718386
oneOf:
1823818387
- {}
1823918388
- type: 'null'
18389+
report_values:
18390+
properties:
18391+
currency:
18392+
type: string
18393+
total_cost:
18394+
format: decimal
18395+
pattern: ^-?\d{0,10}(?:\.\d{0,2})?$
18396+
type: string
18397+
total_discount:
18398+
format: decimal
18399+
pattern: ^-?\d{0,10}(?:\.\d{0,2})?$
18400+
type: string
18401+
total_excl_tax:
18402+
format: decimal
18403+
pattern: ^-?\d{0,10}(?:\.\d{0,2})?$
18404+
type: string
18405+
total_incl_tax:
18406+
format: decimal
18407+
pattern: ^-?\d{0,10}(?:\.\d{0,2})?$
18408+
type: string
18409+
required:
18410+
- currency
18411+
- total_cost
18412+
- total_discount
18413+
- total_excl_tax
18414+
- total_incl_tax
18415+
type: object
1824018416
status:
1824118417
description: 'Available values : Open'
1824218418
type: string
18419+
total_cost:
18420+
format: decimal
18421+
pattern: ^-?\d{0,10}(?:\.\d{0,2})?$
18422+
type: string
1824318423
total_discount:
1824418424
format: decimal
1824518425
pattern: ^-?\d{0,10}(?:\.\d{0,2})?$
@@ -18339,7 +18519,9 @@ webhooks:
1833918519
- currency
1834018520
- id
1834118521
- lines
18522+
- report_values
1834218523
- status
18524+
- total_cost
1834318525
- total_discount
1834418526
- total_excl_tax
1834518527
- total_incl_tax

0 commit comments

Comments
 (0)