Skip to content

Commit 6b3455d

Browse files
shahednassershahednasser
committed
docs: fix description of ID param in order-edit routes
1 parent fa88a1f commit 6b3455d

26 files changed

Lines changed: 51 additions & 52 deletions

‎www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_order-edits_{id}/delete.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ export const sdk = new Medusa({
88
},
99
})
1010

11-
sdk.admin.orderEdit.cancelRequest("ordch_123")
11+
sdk.admin.orderEdit.cancelRequest("order_123")
1212
.then(({ deleted }) => {
1313
console.log(deleted)
1414
})

‎www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_order-edits_{id}_confirm/post.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ export const sdk = new Medusa({
88
},
99
})
1010

11-
sdk.admin.orderEdit.confirm("ordch_123")
11+
sdk.admin.orderEdit.confirm("order_123")
1212
.then(({ order_preview }) => {
1313
console.log(order_preview)
1414
})

‎www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_order-edits_{id}_items/post.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ export const sdk = new Medusa({
88
},
99
})
1010

11-
sdk.admin.orderEdit.addItems("ordch_123", {
11+
sdk.admin.orderEdit.addItems("order_123", {
1212
items: [
1313
{
1414
variant_id: "variant_123",

‎www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_order-edits_{id}_items_item_{item_id}/post.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ export const sdk = new Medusa({
99
})
1010

1111
sdk.admin.orderEdit.updateOriginalItem(
12-
"ordch_123",
12+
"order_123",
1313
"orli_123",
1414
{
1515
quantity: 1

‎www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_order-edits_{id}_items_{action_id}/delete.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ export const sdk = new Medusa({
99
})
1010

1111
sdk.admin.orderEdit.removeAddedItem(
12-
"ordch_123",
12+
"order_123",
1313
"orli_123",
1414
)
1515
.then(({ order_preview }) => {

‎www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_order-edits_{id}_items_{action_id}/post.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ export const sdk = new Medusa({
99
})
1010

1111
sdk.admin.orderEdit.updateAddedItem(
12-
"ordch_123",
12+
"order_123",
1313
"orli_123",
1414
{
1515
quantity: 1

‎www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_order-edits_{id}_request/post.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ export const sdk = new Medusa({
88
},
99
})
1010

11-
sdk.admin.orderEdit.request("ordch_123")
11+
sdk.admin.orderEdit.request("order_123")
1212
.then(({ order_preview }) => {
1313
console.log(order_preview)
1414
})

‎www/apps/api-reference/specs/admin/openapi.full.yaml‎

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -27467,7 +27467,7 @@ paths:
2746727467
parameters:
2746827468
- name: id
2746927469
in: path
27470-
description: The order edit's ID.
27470+
description: The ID of the order that is being edited.
2747127471
required: true
2747227472
schema:
2747327473
type: string
@@ -27489,7 +27489,7 @@ paths:
2748927489
},
2749027490
})
2749127491

27492-
sdk.admin.orderEdit.cancelRequest("ordch_123")
27492+
sdk.admin.orderEdit.cancelRequest("order_123")
2749327493
.then(({ deleted }) => {
2749427494
console.log(deleted)
2749527495
})
@@ -27560,7 +27560,7 @@ paths:
2756027560
parameters:
2756127561
- name: id
2756227562
in: path
27563-
description: The order edit's ID.
27563+
description: The ID of the order that is being edited.
2756427564
required: true
2756527565
schema:
2756627566
type: string
@@ -27582,7 +27582,7 @@ paths:
2758227582
},
2758327583
})
2758427584

27585-
sdk.admin.orderEdit.confirm("ordch_123")
27585+
sdk.admin.orderEdit.confirm("order_123")
2758627586
.then(({ order_preview }) => {
2758727587
console.log(order_preview)
2758827588
})
@@ -27635,7 +27635,7 @@ paths:
2763527635
parameters:
2763627636
- name: id
2763727637
in: path
27638-
description: The order edit's ID.
27638+
description: The ID of the order that is being edited.
2763927639
required: true
2764027640
schema:
2764127641
type: string
@@ -27662,7 +27662,7 @@ paths:
2766227662
},
2766327663
})
2766427664

27665-
sdk.admin.orderEdit.addItems("ordch_123", {
27665+
sdk.admin.orderEdit.addItems("order_123", {
2766627666
items: [
2766727667
{
2766827668
variant_id: "variant_123",
@@ -27713,7 +27713,7 @@ paths:
2771327713
parameters:
2771427714
- name: id
2771527715
in: path
27716-
description: The order edit's ID.
27716+
description: The ID of the order that is being edited.
2771727717
required: true
2771827718
schema:
2771927719
type: string
@@ -27747,7 +27747,7 @@ paths:
2774727747
})
2774827748

2774927749
sdk.admin.orderEdit.updateOriginalItem(
27750-
"ordch_123",
27750+
"order_123",
2775127751
"orli_123",
2775227752
{
2775327753
quantity: 1
@@ -27801,7 +27801,7 @@ paths:
2780127801
parameters:
2780227802
- name: id
2780327803
in: path
27804-
description: The order edit's ID.
27804+
description: The ID of the order that is being edited.
2780527805
required: true
2780627806
schema:
2780727807
type: string
@@ -27835,7 +27835,7 @@ paths:
2783527835
})
2783627836

2783727837
sdk.admin.orderEdit.updateAddedItem(
27838-
"ordch_123",
27838+
"order_123",
2783927839
"orli_123",
2784027840
{
2784127841
quantity: 1
@@ -27884,7 +27884,7 @@ paths:
2788427884
parameters:
2788527885
- name: id
2788627886
in: path
27887-
description: The order edit's ID.
27887+
description: The ID of the order that is being edited.
2788827888
required: true
2788927889
schema:
2789027890
type: string
@@ -27913,7 +27913,7 @@ paths:
2791327913
})
2791427914

2791527915
sdk.admin.orderEdit.removeAddedItem(
27916-
"ordch_123",
27916+
"order_123",
2791727917
"orli_123",
2791827918
)
2791927919
.then(({ order_preview }) => {
@@ -27956,7 +27956,7 @@ paths:
2795627956
parameters:
2795727957
- name: id
2795827958
in: path
27959-
description: The order edit's ID.
27959+
description: The ID of the order that is being edited.
2796027960
required: true
2796127961
schema:
2796227962
type: string
@@ -27978,7 +27978,7 @@ paths:
2797827978
},
2797927979
})
2798027980

27981-
sdk.admin.orderEdit.request("ordch_123")
27981+
sdk.admin.orderEdit.request("order_123")
2798227982
.then(({ order_preview }) => {
2798327983
console.log(order_preview)
2798427984
})
@@ -28031,7 +28031,7 @@ paths:
2803128031
parameters:
2803228032
- name: id
2803328033
in: path
28034-
description: The order edit's ID.
28034+
description: The ID of the order that is being edited.
2803528035
required: true
2803628036
schema:
2803728037
type: string
@@ -28090,7 +28090,7 @@ paths:
2809028090
parameters:
2809128091
- name: id
2809228092
in: path
28093-
description: The order edit's ID.
28093+
description: The ID of the order that is being edited.
2809428094
required: true
2809528095
schema:
2809628096
type: string
@@ -28150,7 +28150,7 @@ paths:
2815028150
parameters:
2815128151
- name: id
2815228152
in: path
28153-
description: The order edit's ID.
28153+
description: The ID of the order that is being edited.
2815428154
required: true
2815528155
schema:
2815628156
type: string
@@ -64633,7 +64633,6 @@ paths:
6463364633
.then(({ created, updated, deleted }) => {
6463464634
console.log(created, updated, deleted)
6463564635
})
64636-
```
6463764636
- lang: Shell
6463864637
label: cURL
6463964638
source: |-

‎www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ delete:
66
parameters:
77
- name: id
88
in: path
9-
description: The order edit's ID.
9+
description: The ID of the order that is being edited.
1010
required: true
1111
schema:
1212
type: string

‎www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_confirm.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ post:
66
parameters:
77
- name: id
88
in: path
9-
description: The order edit's ID.
9+
description: The ID of the order that is being edited.
1010
required: true
1111
schema:
1212
type: string

0 commit comments

Comments
 (0)