Skip to content

Commit 625964d

Browse files
olivermrblolivermrbl
committed
Merge branch 'master' into develop
2 parents 6f4b221 + d47b785 commit 625964d

File tree

196 files changed

+4558
-2156
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

196 files changed

+4558
-2156
lines changed

‎docs/api/admin-spec3.json

+277-5
Large diffs are not rendered by default.

‎docs/api/admin-spec3.yaml

+277-5
Large diffs are not rendered by default.

‎docs/api/admin/code_samples/Shell/uploads/postundefined

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
curl --location --request POST 'https://medusa-url.com/admin/uploads' \
22
--header 'Authorization: Bearer {api_token}' \
33
--header 'Content-Type: image/jpeg' \
4-
--data-binary '{file_path}'
4+
--form 'files=@"<FILE_PATH_1>"' \
5+
--form 'files=@"<FILE_PATH_1>"'

‎docs/api/admin/components/schemas/currency.yaml

+3
Original file line numberDiff line numberDiff line change
@@ -26,3 +26,6 @@ properties:
2626
description: The written name of the currency
2727
type: string
2828
example: US Dollar
29+
includes_tax:
30+
description: '[EXPERIMENTAL] Does the currency prices include tax'
31+
type: boolean

‎docs/api/admin/components/schemas/custom_shipping_option.yaml

+3
Original file line numberDiff line numberDiff line change
@@ -51,3 +51,6 @@ properties:
5151
description: An optional key-value map with additional details
5252
example:
5353
car: white
54+
includes_tax:
55+
description: '[EXPERIMENTAL] Indicates if the custom shipping option price include tax'
56+
type: boolean

‎docs/api/admin/components/schemas/line_item.yaml

+3
Original file line numberDiff line numberDiff line change
@@ -157,6 +157,9 @@ properties:
157157
type: integer
158158
description: The total of the gift card of the line item
159159
example: 0
160+
includes_tax:
161+
description: '[EXPERIMENTAL] Indicates if the line item unit_price include tax'
162+
type: boolean
160163
created_at:
161164
type: string
162165
description: The date with timezone at which the resource was created.

‎docs/api/admin/components/schemas/order.yaml

+7
Original file line numberDiff line numberDiff line change
@@ -187,6 +187,13 @@ properties:
187187
is expanded.
188188
items:
189189
$ref: ./line_item.yaml
190+
edits:
191+
type: array
192+
description: >-
193+
[EXPERIMENTAL] Order edits done on the order. Available if the relation
194+
`edits` is expanded.
195+
items:
196+
$ref: ./order_edit.yaml
190197
gift_card_transactions:
191198
type: array
192199
description: >-

‎docs/api/admin/components/schemas/order_edit.yaml

+87
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
title: Order Edit
2+
description: Order edit keeps track of order items changes.
3+
x-resourceId: order_edit
4+
required:
5+
- order_id
6+
- order
7+
- changes
8+
- created_by
9+
properties:
10+
id:
11+
type: string
12+
description: The order edit's ID
13+
example: oe_01G8TJSYT9M6AVS5N4EMNFS1EK
14+
order_id:
15+
type: string
16+
description: The ID of the order that is edited
17+
example: order_01G2SG30J8C85S4A5CHM2S1NS2
18+
order:
19+
description: Order object
20+
$ref: ./order.yaml
21+
changes:
22+
type: array
23+
description: Line item changes array.
24+
items:
25+
$ref: ./order_item_change.yaml
26+
internal_note:
27+
description: An optional note with additional details about the order edit.
28+
type: string
29+
example: Included two more items B to the order.
30+
created_by:
31+
type: string
32+
description: The unique identifier of the user or customer who created the order edit.
33+
requested_by:
34+
type: string
35+
description: >-
36+
The unique identifier of the user or customer who requested the order
37+
edit.
38+
requested_at:
39+
type: string
40+
description: The date with timezone at which the edit was requested.
41+
format: date-time
42+
confirmed_by:
43+
type: string
44+
description: >-
45+
The unique identifier of the user or customer who confirmed the order
46+
edit.
47+
confirmed_at:
48+
type: string
49+
description: The date with timezone at which the edit was confirmed.
50+
format: date-time
51+
declined_by:
52+
type: string
53+
description: The unique identifier of the user or customer who declined the order edit.
54+
declined_at:
55+
type: string
56+
description: The date with timezone at which the edit was declined.
57+
format: date-time
58+
declined_reason:
59+
description: An optional note why the order edit is declined.
60+
type: string
61+
subtotal:
62+
type: integer
63+
description: The subtotal for line items computed from changes.
64+
example: 8000
65+
discount_total:
66+
type: integer
67+
description: The total of discount
68+
example: 800
69+
tax_total:
70+
type: integer
71+
description: The total of tax
72+
example: 0
73+
total:
74+
type: integer
75+
description: The total amount of the edited order.
76+
example: 8200
77+
difference_due:
78+
type: integer
79+
description: >-
80+
The difference between the total amount of the order and total amount of
81+
edited order.
82+
example: 8200
83+
items:
84+
type: array
85+
description: Computed line items from the changes.
86+
items:
87+
$ref: ./line_item.yaml

‎docs/api/admin/components/schemas/order_item_change.yaml

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
title: Order Item Change
2+
description: Represents an order edit item change
3+
x-resourceId: order_item_change
4+
required:
5+
- type
6+
- order_edit_id
7+
properties:
8+
id:
9+
type: string
10+
description: The order item change's ID
11+
example: oic_01G8TJSYT9M6AVS5N4EMNFS1EK
12+
type:
13+
type: string
14+
description: The order's status
15+
enum:
16+
- item_add
17+
- item_remove
18+
- item_update
19+
order_edit_id:
20+
type: string
21+
description: The ID of the order edit
22+
example: oe_01G2SG30J8C85S4A5CHM2S1NS2
23+
order_edit:
24+
description: Order edit object
25+
$ref: ./order_edit.yaml
26+
original_line_item_id:
27+
type: string
28+
description: The ID of the original line item in the order
29+
example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN
30+
original_line_item:
31+
description: Original line item object.
32+
$ref: ./line_item.yaml
33+
line_item_id:
34+
type: string
35+
description: The ID of the cloned line item.
36+
example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN
37+
line_item:
38+
description: Line item object.
39+
$ref: ./line_item.yaml

‎docs/api/admin/components/schemas/price_list.yaml

+6-1
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,12 @@ properties:
5555
the relation `prices` is expanded.
5656
type: array
5757
items:
58-
$ref: ./money_amount.yaml
58+
oneOf:
59+
- $ref: ./money_amount.yaml
60+
- $ref: ./customer_group.yaml
61+
includes_tax:
62+
description: '[EXPERIMENTAL] Does the price list prices include tax'
63+
type: boolean
5964
created_at:
6065
type: string
6166
description: The date with timezone at which the resource was created.

‎docs/api/admin/components/schemas/region.yaml

+3
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,9 @@ properties:
8383
type: array
8484
items:
8585
$ref: ./fulfillment_provider.yaml
86+
includes_tax:
87+
description: '[EXPERIMENTAL] Does the prices for the region include tax'
88+
type: boolean
8689
created_at:
8790
type: string
8891
description: The date with timezone at which the resource was created.

‎docs/api/admin/components/schemas/shipping_method.yaml

+3
Original file line numberDiff line numberDiff line change
@@ -74,3 +74,6 @@ properties:
7474
may contain information such as a drop point id.
7575
type: object
7676
example: {}
77+
includes_tax:
78+
description: '[EXPERIMENTAL] Indicates if the shipping method price include tax'
79+
type: boolean

‎docs/api/admin/components/schemas/shipping_option.yaml

+3
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,9 @@ properties:
8484
Option.
8585
type: object
8686
example: {}
87+
includes_tax:
88+
description: '[EXPERIMENTAL] Does the shipping option price include tax'
89+
type: boolean
8790
created_at:
8891
type: string
8992
description: The date with timezone at which the resource was created.

‎docs/api/admin/openapi.yaml

+4
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,10 @@ paths:
139139
$ref: paths/collections.yaml
140140
/collections/{id}:
141141
$ref: paths/collections_{id}.yaml
142+
/currencies:
143+
$ref: paths/currencies.yaml
144+
/currencies/{code}:
145+
$ref: paths/currencies_{code}.yaml
142146
/customer-groups/{id}/customers/batch:
143147
$ref: paths/customer-groups_{id}_customers_batch.yaml
144148
/customer-groups:

‎docs/api/admin/paths/currencies.yaml

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
get:
2+
operationId: GetCurrencies
3+
summary: List Currency
4+
description: Retrieves a list of Currency
5+
x-authenticated: true
6+
parameters:
7+
- in: query
8+
name: code
9+
description: Code of the currency to search for.
10+
schema:
11+
type: string
12+
- in: query
13+
name: includes_tax
14+
description: Search for tax inclusive currencies.
15+
schema:
16+
type: boolean
17+
- in: query
18+
name: order
19+
description: to retrieve products in.
20+
schema:
21+
type: string
22+
- in: query
23+
name: offset
24+
description: How many products to skip in the result.
25+
schema:
26+
type: string
27+
- in: query
28+
name: limit
29+
description: Limit the number of products returned.
30+
schema:
31+
type: string
32+
tags:
33+
- Currency
34+
responses:
35+
'200':
36+
description: OK
37+
content:
38+
application/json:
39+
schema:
40+
properties:
41+
count:
42+
description: The number of Currency.
43+
type: integer
44+
offset:
45+
description: The offset of the Currency query.
46+
type: integer
47+
limit:
48+
description: The limit of the currency query.
49+
type: integer
50+
currencies:
51+
type: array
52+
items:
53+
$ref: ../components/schemas/currency.yaml

‎docs/api/admin/paths/currencies_{code}.yaml

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
post:
2+
operationId: PostCurrenciesCurrency
3+
summary: Update a Currency
4+
description: Update a Currency
5+
x-authenticated: true
6+
parameters:
7+
- in: path
8+
name: code
9+
required: true
10+
description: The code of the Currency.
11+
schema:
12+
type: string
13+
requestBody:
14+
content:
15+
application/json:
16+
schema:
17+
properties:
18+
includes_tax:
19+
type: boolean
20+
description: '[EXPERIMENTAL] Tax included in prices of currency.'
21+
tags:
22+
- Currency
23+
responses:
24+
'200':
25+
description: OK
26+
content:
27+
application/json:
28+
schema:
29+
properties:
30+
currency:
31+
$ref: ../components/schemas/currency.yaml

‎docs/api/admin/paths/price-lists.yaml

+3
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,9 @@ post:
8282
id:
8383
description: The ID of a customer group
8484
type: string
85+
includes_tax:
86+
description: '[EXPERIMENTAL] Tax included in prices of price list'
87+
type: boolean
8588
x-codeSamples:
8689
- lang: JavaScript
8790
label: JS Client

‎docs/api/admin/paths/price-lists_{id}.yaml

+3
Original file line numberDiff line numberDiff line change
@@ -190,6 +190,9 @@ post:
190190
id:
191191
description: The ID of a customer group
192192
type: string
193+
includes_tax:
194+
description: '[EXPERIMENTAL] Tax included in prices of price list'
195+
type: boolean
193196
x-codeSamples:
194197
- lang: JavaScript
195198
label: JS Client

‎docs/api/admin/paths/regions.yaml

+3
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,9 @@ post:
5353
type: array
5454
items:
5555
type: string
56+
includes_tax:
57+
description: '[EXPERIMENTAL] Tax included in prices of region'
58+
type: boolean
5659
x-codeSamples:
5760
- lang: JavaScript
5861
label: JS Client

‎docs/api/admin/paths/regions_{id}.yaml

+3
Original file line numberDiff line numberDiff line change
@@ -149,6 +149,9 @@ post:
149149
tax_rate:
150150
description: The tax rate to use on Orders in the Region.
151151
type: number
152+
includes_tax:
153+
description: '[EXPERIMENTAL] Tax included in prices of region'
154+
type: boolean
152155
payment_providers:
153156
description: >-
154157
A list of Payment Provider IDs that should be enabled for the

‎docs/api/admin/paths/shipping-options.yaml

+3
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,9 @@ post:
7474
metadata:
7575
description: An optional set of key-value pairs with additional information.
7676
type: object
77+
includes_tax:
78+
description: '[EXPERIMENTAL] Tax included in prices of shipping option'
79+
type: boolean
7780
x-codeSamples:
7881
- lang: JavaScript
7982
label: JS Client

‎docs/api/admin/paths/shipping-options_{id}.yaml

+3
Original file line numberDiff line numberDiff line change
@@ -154,6 +154,9 @@ post:
154154
amount:
155155
description: The amount to compare with.
156156
type: integer
157+
includes_tax:
158+
description: '[EXPERIMENTAL] Tax included in prices of shipping option'
159+
type: boolean
157160
x-codeSamples:
158161
- lang: JavaScript
159162
label: JS Client

‎docs/api/admin/paths/uploads.yaml

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
post:
22
operationId: PostUploads
3-
summary: Upload a file
4-
description: Uploads a file to the specific fileservice that is installed in Medusa.
3+
summary: Upload files
4+
description: >-
5+
Uploads at least one file to the specific fileservice that is installed in
6+
Medusa.
57
x-authenticated: true
68
requestBody:
79
content:

‎docs/api/admin/paths/users_{id}.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ delete:
2323
- api_token: []
2424
- cookie_auth: []
2525
tags:
26-
- Users
26+
- User
2727
responses:
2828
'200':
2929
description: OK

0 commit comments

Comments
 (0)