You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: packages/platform-sdk/src/generated/client/edits/by-project-key-orders-edits-key-by-key-request-builder.ts
+9Lines changed: 9 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -19,6 +19,9 @@ export class ByProjectKeyOrdersEditsKeyByKeyRequestBuilder {
19
19
baseUri?: string
20
20
}
21
21
){}
22
+
/**
23
+
* Retrieves an OrderEdit with the provided `key`.
24
+
*/
22
25
publicget(methodArgs?: {
23
26
queryArgs?: {
24
27
expand?: string|string[]
@@ -63,6 +66,9 @@ export class ByProjectKeyOrdersEditsKeyByKeyRequestBuilder {
63
66
this.args.executeRequest
64
67
)
65
68
}
69
+
/**
70
+
* Updates an OrderEdit in the Project using one or more [update actions](/../api/projects/order-edits#update-actions).
71
+
*/
66
72
publicpost(methodArgs: {
67
73
queryArgs?: {
68
74
expand?: string|string[]
@@ -89,6 +95,9 @@ export class ByProjectKeyOrdersEditsKeyByKeyRequestBuilder {
Copy file name to clipboardExpand all lines: packages/platform-sdk/src/generated/client/edits/by-project-key-orders-edits-request-builder.ts
+4Lines changed: 4 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -49,6 +49,9 @@ export class ByProjectKeyOrdersEditsRequestBuilder {
49
49
})
50
50
}
51
51
52
+
/**
53
+
* Retrieves OrderEdits in the Project.
54
+
*/
52
55
publicget(methodArgs?: {
53
56
queryArgs?: {
54
57
expand?: string|string[]
@@ -104,6 +107,7 @@ export class ByProjectKeyOrdersEditsRequestBuilder {
104
107
)
105
108
}
106
109
/**
110
+
* Creates an OrderEdit in the Project.
107
111
* You can either create multiple Order Edits for an Order and apply them sequentially to an Order, or create multiple Order Edits parallelly (as alternatives to each other) and apply one of them to the Order.
108
112
*
109
113
* You can only create an Order Edit if the [InventoryMode](/projects/carts#inventorymode) of the Order and its [LineItems](/projects/carts#lineitem) is `None`.
Copy file name to clipboardExpand all lines: packages/platform-sdk/src/generated/client/orders/by-project-key-as-associate-by-associate-id-in-business-unit-key-by-business-unit-key-orders-by-id-request-builder.ts
+5-3Lines changed: 5 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -22,7 +22,8 @@ export class ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnit
22
22
}
23
23
){}
24
24
/**
25
-
* If the Order exists in the [Project](ctp:api:type:Project) but does not reference the requested [BusinessUnit](ctp:api:type:BusinessUnit), this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
25
+
* Retrieves an Order with the provided `id` in a [BusinessUnit](ctp:api:type:BusinessUnit).
26
+
* If the Order exists in the [Project](ctp:api:type:Project) but does not reference the requested Business Unit, this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
26
27
*
27
28
*/
28
29
publicget(methodArgs?: {
@@ -50,7 +51,7 @@ export class ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnit
50
51
)
51
52
}
52
53
/**
53
-
* Checks if an Order exists with the provided `id`. Returns a `200 OK` status if the Order exists or a `404 Not Found` otherwise.
54
+
* Checks if an Order exists with the provided `id` in a [BusinessUnit](ctp:api:type:BusinessUnit). Returns a `200 OK` status if the Order exists or a `404 Not Found` otherwise.
54
55
*/
55
56
publichead(methodArgs?: {
56
57
headers?: {
@@ -72,7 +73,8 @@ export class ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnit
72
73
)
73
74
}
74
75
/**
75
-
* If the Order exists in the [Project](ctp:api:type:Project) but does not reference the requested [BusinessUnit](ctp:api:type:BusinessUnit), this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
76
+
* Updates an Order in a [BusinessUnit](ctp:api:type:BusinessUnit) using one or more [update actions](/../api/projects/orders#update-actions).
77
+
* If the Order exists in the [Project](ctp:api:type:Project) but does not reference the requested Business Unit, this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
Copy file name to clipboardExpand all lines: packages/platform-sdk/src/generated/client/orders/by-project-key-as-associate-by-associate-id-in-business-unit-key-by-business-unit-key-orders-order-number-by-order-number-request-builder.ts
+4-2Lines changed: 4 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -22,6 +22,7 @@ export class ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnit
22
22
}
23
23
){}
24
24
/**
25
+
* Retrieves an Order with the provided `orderNumber` in a [BusinessUnit](ctp:api:type:BusinessUnit).
25
26
* If the Order exists in the [Project](ctp:api:type:Project) but does not reference the requested [BusinessUnit](ctp:api:type:BusinessUnit), this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
26
27
*
27
28
*/
@@ -50,7 +51,7 @@ export class ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnit
50
51
)
51
52
}
52
53
/**
53
-
* Checks if an Order exists for a given `orderNumber`. Returns a `200 OK` status if the Order exists or a `404 Not Found` otherwise.
54
+
* Checks if an Order exists with the provided `orderNumber` in a [BusinessUnit](ctp:api:type:BusinessUnit). Returns a `200 OK` status if the Order exists or a `404 Not Found` otherwise.
54
55
*/
55
56
publichead(methodArgs?: {
56
57
headers?: {
@@ -72,7 +73,8 @@ export class ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnit
72
73
)
73
74
}
74
75
/**
75
-
* If the Order exists in the [Project](ctp:api:type:Project) but does not reference the requested [BusinessUnit](ctp:api:type:BusinessUnit), this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
76
+
* Updates an Order in a [BusinessUnit](ctp:api:type:BusinessUnit) using one or more [update actions](/../api/projects/orders#update-actions).
77
+
* If the Order exists in the [Project](ctp:api:type:Project) but does not reference the requested Business Unit, this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
Copy file name to clipboardExpand all lines: packages/platform-sdk/src/generated/client/orders/by-project-key-as-associate-by-associate-id-in-business-unit-key-by-business-unit-key-orders-request-builder.ts
+4-1Lines changed: 4 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -67,6 +67,9 @@ export class ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnit
67
67
)
68
68
}
69
69
70
+
/**
71
+
* Retrieves Orders in a [BusinessUnit](ctp:api:type:BusinessUnit).
72
+
*/
70
73
publicget(methodArgs?: {
71
74
queryArgs?: {
72
75
expand?: string|string[]
@@ -97,7 +100,7 @@ export class ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnit
97
100
)
98
101
}
99
102
/**
100
-
* Checks if one or more Orders exist for the provided query predicate. Returns a `200 OK` status if any Orders match the query predicate, or a `404 Not Found` otherwise.
103
+
* Checks if one or more Orders exist with provided query predicate in a [BusinessUnit](ctp:api:type:BusinessUnit). Returns a `200 OK` status if any Orders match the query predicate, or a `404 Not Found` otherwise.
Copy file name to clipboardExpand all lines: packages/platform-sdk/src/generated/client/orders/by-project-key-in-store-key-by-store-key-me-orders-by-id-request-builder.ts
+9-9Lines changed: 9 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -21,13 +21,13 @@ export class ByProjectKeyInStoreKeyByStoreKeyMeOrdersByIDRequestBuilder {
21
21
}
22
22
){}
23
23
/**
24
-
* Returns an Order for a given `id` in a Store. Returns a `200 OK` status if successful.
24
+
* Retrieves an Order with the provided `id` in a [Store](ctp:api:type:Store) for the authenticated Customer or anonymous user. Returns a `200 OK` status if successful.
25
25
*
26
26
* A [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error is returned in the following scenarios:
27
27
*
28
-
* - If no Order exists in the Store for the given `id`.
29
-
* - If the Order exists but does not have a `store` specified, or the `store` field references a different Store.
30
-
* - If the Order exists but does not have a `customerId` that matches the [customer:{id}](/scopes#composable-commerce-oauth) scope, or `anonymousId` that matches the [anonymous_id:{id}](/scopes#composable-commerce-oauth) scope.
28
+
* - If no Orders exists in the Store with the provided `id`.
29
+
* - If an Order exists but does not have a `store` specified, or the `store` field references a different Store.
30
+
* - If an Order exists but does not have a `customerId` that matches the [customer:{id}](/scopes#composable-commerce-oauth) scope, or `anonymousId` that matches the [anonymous_id:{id}](/scopes#composable-commerce-oauth) scope.
31
31
*
32
32
*/
33
33
publicget(methodArgs?: {
@@ -54,13 +54,13 @@ export class ByProjectKeyInStoreKeyByStoreKeyMeOrdersByIDRequestBuilder {
54
54
)
55
55
}
56
56
/**
57
-
* Checks if an Order exists with the provided `id` in a Store. Returns a `200 OK` status if successful.
57
+
* Checks if an Order exists with the provided `id` in a [Store](ctp:api:type:Store) for the authenticated Customer or anonymous user. Returns a `200 OK` status if successful.
58
58
*
59
-
* A [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error is returned in the following scenarios:
59
+
* A [Not Found](/../api/errors#404-not-found) error is returned in the following scenarios:
60
60
*
61
-
* - If no Order exists in the Store for the given `id`.
62
-
* - If the Order exists but does not have a `store` specified, or the `store` field references a different Store.
63
-
* - If the Order exists but does not have a `customerId` that matches the [customer:{id}](/scopes#composable-commerce-oauth) scope, or `anonymousId` that matches the [anonymous_id:{id}](/scopes#composable-commerce-oauth) scope.
61
+
* - If no Order exists in the Store with the provided `id`.
62
+
* - If an Order exists but does not have a `store` specified, or the `store` field references a different Store.
63
+
* - If an Order exists but does not have a `customerId` that matches the [customer:{id}](/scopes#composable-commerce-oauth) scope, or `anonymousId` that matches the [anonymous_id:{id}](/scopes#composable-commerce-oauth) scope.
Copy file name to clipboardExpand all lines: packages/platform-sdk/src/generated/client/orders/by-project-key-in-store-key-by-store-key-me-orders-request-builder.ts
+9-4Lines changed: 9 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -35,7 +35,12 @@ export class ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestBuilder {
35
35
}
36
36
37
37
/**
38
-
* Returns all Orders in a Store that match a given Query Predicate and contain either a `customerId` that matches the [customer_id:{id}](/scopes#composable-commerce-oauth) scope, or an `anonymousId` that matches the [anonymous_id:{id}](/scopes#composable-commerce-oauth) scope.
38
+
* Retrieves Orders in a [Store](ctp:api:type:Store) for the authenticated Customer or anonymous user.
39
+
*
40
+
* A [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error is returned in the following scenarios:
41
+
*
42
+
* - If no Orders exist that match the provided query predicate.
43
+
* - If an Order exists but does not have a `customerId` that matches the [customer:{id}](/scopes#composable-commerce-oauth) scope, or `anonymousId` that matches the [anonymous_id:{id}](/scopes#composable-commerce-oauth) scope.
39
44
*
40
45
*/
41
46
publicget(methodArgs?: {
@@ -67,9 +72,9 @@ export class ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestBuilder {
67
72
)
68
73
}
69
74
/**
70
-
* Checks if one or more Orders exist for the provided query predicate in a Store. Returns a `200 OK` status if successful.
75
+
* Checks if one or more Orders exist for the provided query predicate in a [Store](ctp:api:type:Store) for the authenticated Customer or anonymous user. Returns a `200 OK` status if successful.
71
76
*
72
-
* A [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error is returned in the following scenarios:
77
+
* A [Not Found](/../api/errors#404-not-found) error is returned in the following scenarios:
73
78
*
74
79
* - If no Orders exist in the Store that match the Query Predicate.
75
80
* - If an Order matches the Query Predicate, but no `store` is specified, or the `store` field references a different Store.
@@ -101,7 +106,7 @@ export class ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestBuilder {
101
106
}
102
107
/**
103
108
*
104
-
* Creates an Order in a Store from a Cart for the Customer or anonymous user. The `customerId` or `anonymousId` field on the Order is automatically set based on the [customer:{id}](/scopes#composable-commerce-oauth) or [anonymous_id:{id}](/scopes#composable-commerce-oauth) scope.
109
+
* Creates an Order from a Cart in a [Store](ctp:api:type:Store) for the Customer or anonymous user. The `customerId` or `anonymousId` field on the Order is automatically set based on the [customer:{id}](/scopes#composable-commerce-oauth) or [anonymous_id:{id}](/scopes#composable-commerce-oauth) scope.
105
110
*
106
111
* The Cart must have a [shipping address set](ctp:api:type:CartSetShippingAddressAction) for taxes to be calculated. When creating [B2B Orders](/associates-overview#b2b-resources), the Customer must have the `CreateMyOrdersFromMyCarts` [Permission](ctp:api:type:Permission).
Copy file name to clipboardExpand all lines: packages/platform-sdk/src/generated/client/orders/by-project-key-in-store-key-by-store-key-orders-by-id-request-builder.ts
+4-1Lines changed: 4 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -21,6 +21,7 @@ export class ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestBuilder {
21
21
}
22
22
){}
23
23
/**
24
+
* Retrieves an Order with the provided `id` in a [Store](ctp:api:type:Store).
24
25
* If the Order exists in the Project but does not have a `store` specified, or the `store` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error.
25
26
*
26
27
*/
@@ -48,7 +49,7 @@ export class ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestBuilder {
48
49
)
49
50
}
50
51
/**
51
-
* Checks if an Order exists with the provided `id`. Returns a `200 OK` status if the Order exists or [Not Found](/../api/errors#404-not-found) otherwise.
52
+
* Checks if an Order exists with the provided `id` in a [Store](ctp:api:type:Store). Returns a `200 OK` status if the Order exists or [Not Found](/../api/errors#404-not-found) otherwise.
52
53
*/
53
54
publichead(methodArgs?: {
54
55
headers?: {
@@ -69,6 +70,7 @@ export class ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestBuilder {
69
70
)
70
71
}
71
72
/**
73
+
* Updates an Order in a [Store](ctp:api:type:Store) using one or more [update actions](/../api/projects/orders#update-actions).
72
74
* If the Order exists in the Project but does not have a `store` specified, or the `store` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error.
73
75
*
74
76
*/
@@ -99,6 +101,7 @@ export class ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestBuilder {
99
101
)
100
102
}
101
103
/**
104
+
* Deletes an Order in a [Store](ctp:api:type:Store).
102
105
* If the Order exists in the Project but does not have a `store` specified, or the `store` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error.
103
106
*
104
107
* Deleting an Order produces the [OrderDeleted](ctp:api:type:OrderDeletedMessage) Message.
0 commit comments