Skip to content

Commit be3dc3f

Browse files
authored
Updated API from documentation release
1 parent 952b0ef commit be3dc3f

637 files changed

Lines changed: 1620 additions & 1272 deletions

File tree

Some content is hidden

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

api-specs/api/api.raml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ baseUriParameters:
1616
- eu-central-1.aws
1717
- australia-southeast1.gcp
1818
description: |
19-
[Region](/../api/general-concepts#hosts) in which the Project is hosted.
19+
[Region](/api/general-concepts#hosts) in which the Project is hosted.
2020
version: v1
2121
securitySchemes:
2222
oauth_2_0: !include securitySchemes/oauth2.raml

api-specs/api/resources/as-associate.raml

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -505,7 +505,7 @@ type: base
505505
type: Expansion[]
506506
required: false
507507
description: |
508-
Updates a ShoppingList in a [BusinessUnit](ctp:api:type:BusinessUnit) using one or more [update actions](/../api/projects/shoppingLists#update-actions).
508+
Updates a ShoppingList in a [BusinessUnit](ctp:api:type:BusinessUnit) using one or more [update actions](/api/projects/shoppingLists#update-actions).
509509
If the ShoppingList 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.
510510
body:
511511
application/json:
@@ -582,7 +582,7 @@ type: base
582582
application/json:
583583
example: !include ../examples/shopping-list-update.example.json
584584
description: |
585-
Updates a ShoppingList in a [BusinessUnit](ctp:api:type:BusinessUnit) using one or more [update actions](/../api/projects/shoppingLists#update-actions).
585+
Updates a ShoppingList in a [BusinessUnit](ctp:api:type:BusinessUnit) using one or more [update actions](/api/projects/shoppingLists#update-actions).
586586
If the ShoppingList exists in the Project but does not reference the requested [BusinessUnit](ctp:api:type:BusinessUnit), this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
587587
responses:
588588
200:
@@ -720,7 +720,7 @@ type: base
720720
displayName: Update Order in BusinessUnit by OrderNumber as Associate
721721
securedBy: [oauth_2_0: { scopes: ['manage_orders:{projectKey}'] }]
722722
description: |
723-
Updates an Order in a [BusinessUnit](ctp:api:type:BusinessUnit) using one or more [update actions](/../api/projects/orders#update-actions).
723+
Updates an Order in a [BusinessUnit](ctp:api:type:BusinessUnit) using one or more [update actions](/api/projects/orders#update-actions).
724724
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.
725725
body:
726726
application/json:
@@ -756,7 +756,7 @@ type: base
756756
displayName: Update Order in BusinessUnit by ID as Associate
757757
securedBy: [oauth_2_0: { scopes: ['manage_orders:{projectKey}'] }]
758758
description: |
759-
Updates an Order in a [BusinessUnit](ctp:api:type:BusinessUnit) using one or more [update actions](/../api/projects/orders#update-actions).
759+
Updates an Order in a [BusinessUnit](ctp:api:type:BusinessUnit) using one or more [update actions](/api/projects/orders#update-actions).
760760
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.
761761
body:
762762
application/json:
@@ -789,7 +789,7 @@ type: base
789789
example: !include ../examples/quotes.example.json
790790
head:
791791
displayName: Check if Quote exists in BusinessUnit by Query Predicate as Associate
792-
description: Checks if one or more Quotes exist for the provided query predicate in a BusinessUnit. Returns a `200 OK` status if any Quotes match the query predicate, or a [Not Found](/../api/errors#404-not-found) error otherwise.
792+
description: Checks if one or more Quotes exist for the provided query predicate in a BusinessUnit. Returns a `200 OK` status if any Quotes match the query predicate, or a [Not Found](/api/errors#404-not-found) error otherwise.
793793
securedBy: [oauth_2_0: { scopes: ['view_quotes:{projectKey}'] }]
794794
queryParameters:
795795
where?:
@@ -814,12 +814,12 @@ type: base
814814
example: !include ../examples/quote.example.json
815815
head:
816816
displayName: Check if Quote exists in BusinessUnit by Key as Associate
817-
description: Checks if a Quote exists with the provided `key` in a BusinessUnit. Returns a `200 OK` status if the Quote exists, or a [Not Found](/../api/errors#404-not-found) error otherwise.
817+
description: Checks if a Quote exists with the provided `key` in a BusinessUnit. Returns a `200 OK` status if the Quote exists, or a [Not Found](/api/errors#404-not-found) error otherwise.
818818
securedBy: [oauth_2_0: { scopes: ['view_quotes:{projectKey}'] }]
819819
post:
820820
displayName: Update Quote in BusinessUnit by Key as Associate
821821
description: |
822-
Updates a Quote in a BusinessUnit using one or more [update actions](/../api/projects/quotes#update-actions).
822+
Updates a Quote in a BusinessUnit using one or more [update actions](/api/projects/quotes#update-actions).
823823
If the Quote 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.
824824
securedBy: [oauth_2_0: { scopes: ['manage_quotes:{projectKey}'] }]
825825
body:
@@ -850,12 +850,12 @@ type: base
850850
example: !include ../examples/quote.example.json
851851
head:
852852
displayName: Check if Quote exists in BusinessUnit by ID as Associate
853-
description: Checks if a Quote exists with the provided `id` in a BusinessUnit. Returns a `200 OK` status if the Quote exists or a [Not Found](/../api/errors#404-not-found) error otherwise.
853+
description: Checks if a Quote exists with the provided `id` in a BusinessUnit. Returns a `200 OK` status if the Quote exists or a [Not Found](/api/errors#404-not-found) error otherwise.
854854
securedBy: [oauth_2_0: { scopes: ['view_quotes:{projectKey}'] }]
855855
post:
856856
displayName: Update Quote in BusinessUnit by ID as Associate
857857
description: |
858-
Updates a Quote in a BusinessUnit using one or more [update actions](/../api/projects/quotes#update-actions).
858+
Updates a Quote in a BusinessUnit using one or more [update actions](/api/projects/quotes#update-actions).
859859
If the Quote 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.
860860
securedBy: [oauth_2_0: { scopes: ['manage_quotes:{projectKey}'] }]
861861
body:
@@ -888,7 +888,7 @@ type: base
888888
example: !include ../examples/quote-requests.example.json
889889
head:
890890
displayName: Check if QuoteRequest exists in BusinessUnit by Query Predicate as Associate
891-
description: Checks if one or more QuoteRequests exist for the provided query predicate in a BusinessUnit. Returns a `200 OK` status if any QuoteRequests match the query predicate, or a [Not Found](/../api/errors#404-not-found) error otherwise.
891+
description: Checks if one or more QuoteRequests exist for the provided query predicate in a BusinessUnit. Returns a `200 OK` status if any QuoteRequests match the query predicate, or a [Not Found](/api/errors#404-not-found) error otherwise.
892892
securedBy: [oauth_2_0: { scopes: ['view_quote_requests:{projectKey}'] }]
893893
queryParameters:
894894
where?:
@@ -929,13 +929,13 @@ type: base
929929
example: !include ../examples/quote-request.example.json
930930
head:
931931
displayName: Check if QuoteRequest exists in BusinessUnit by Key as Associate
932-
description: Checks if a QuoteRequest exists with the provided `key` in a BusinessUnit. Returns a `200 OK` status if the QuoteRequest exists or a [Not Found](/../api/errors#404-not-found) error otherwise.
932+
description: Checks if a QuoteRequest exists with the provided `key` in a BusinessUnit. Returns a `200 OK` status if the QuoteRequest exists or a [Not Found](/api/errors#404-not-found) error otherwise.
933933
securedBy:
934934
[oauth_2_0: { scopes: ['view_quote_requests:{projectKey}'] }]
935935
post:
936936
displayName: Update QuoteRequest in BusinessUnit by Key as Associate
937937
description: |
938-
Updates a QuoteRequest in a BusinessUnit using one or more [update actions](/../api/projects/quote-requests#update-actions).
938+
Updates a QuoteRequest in a BusinessUnit using one or more [update actions](/api/projects/quote-requests#update-actions).
939939
If the QuoteRequest 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.
940940
securedBy:
941941
[oauth_2_0: { scopes: ['manage_quote_requests:{projectKey}'] }]
@@ -968,13 +968,13 @@ type: base
968968
example: !include ../examples/quote-request.example.json
969969
head:
970970
displayName: Check if QuoteRequest exists in BusinessUnit by ID as Associate
971-
description: Checks if a QuoteRequest exists with the provided `id` in a BusinessUnit. Returns a `200 OK` status if the QuoteRequest exists or a [Not Found](/../api/errors#404-not-found) error otherwise.
971+
description: Checks if a QuoteRequest exists with the provided `id` in a BusinessUnit. Returns a `200 OK` status if the QuoteRequest exists or a [Not Found](/api/errors#404-not-found) error otherwise.
972972
securedBy:
973973
[oauth_2_0: { scopes: ['view_quote_requests:{projectKey}'] }]
974974
post:
975975
displayName: Update QuoteRequest in BusinessUnit by ID as Associate
976976
description: |
977-
Updates a QuoteRequest in a BusinessUnit using one or more [update actions](/../api/projects/quote-requests#update-actions).
977+
Updates a QuoteRequest in a BusinessUnit using one or more [update actions](/api/projects/quote-requests#update-actions).
978978
If the QuoteRequest 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.
979979
securedBy:
980980
[oauth_2_0: { scopes: ['manage_quote_requests:{projectKey}'] }]

api-specs/api/resources/business-units.raml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ post:
159159
displayName: Search Business Units
160160
securedBy: [oauth_2_0: { scopes: ['view_business_units:{projectKey}'] }]
161161
description: |
162-
If the initial indexing is in progress or the feature is inactive, A [SearchNotReady](ctp:api:type:SearchNotReadyError) error is returned. If inactive, you can [reactivate](/../api/projects/business-unit-search#reactivate) it.
162+
If the initial indexing is in progress or the feature is inactive, A [SearchNotReady](ctp:api:type:SearchNotReadyError) error is returned. If inactive, you can [reactivate](/api/projects/business-unit-search#reactivate) it.
163163
body:
164164
application/json:
165165
type: BusinessUnitSearchRequest

api-specs/api/resources/carts.raml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ post:
119119
securedBy: [oauth_2_0: { scopes: ['manage_orders:{projectKey}'] }]
120120
description: |
121121
Merges items from an anonymous Cart into the most recently modified active Cart of a Customer. If no active Cart exists, the anonymous Cart becomes the Customer's active Cart.
122-
For more information about merge mode behaviors, merge rules, and tax recalculation, see [Merge a Cart](/../api/carts-orders-overview#merge-a-cart).
122+
For more information about merge mode behaviors, merge rules, and tax recalculation, see [Merge a Cart](/api/carts-orders-overview#merge-a-cart).
123123
124124
body:
125125
application/json:
@@ -155,7 +155,7 @@ post:
155155
description: Checks if a Cart exists with the provided `key`. Returns a `200` status if the Cart exists, or a `404` status otherwise.
156156
post:
157157
displayName: Update Cart by Key
158-
description: Updates a Cart in the Project using one or more [update actions](/../api/projects/carts#update-actions).
158+
description: Updates a Cart in the Project using one or more [update actions](/api/projects/carts#update-actions).
159159
securedBy: [oauth_2_0: { scopes: ['manage_orders:{projectKey}'] }]
160160
body:
161161
application/json:
@@ -201,7 +201,7 @@ post:
201201
post:
202202
displayName: Update Cart by ID
203203
securedBy: [oauth_2_0: { scopes: ['manage_orders:{projectKey}'] }]
204-
description: Updates a Cart in the Project using one or more [update actions](/../api/projects/carts#update-actions).
204+
description: Updates a Cart in the Project using one or more [update actions](/api/projects/carts#update-actions).
205205
body:
206206
application/json:
207207
example: !include ../examples/cart-update.example.json

api-specs/api/resources/categories.raml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ description: Categories are used to organize products in a hierarchical structur
1212
get:
1313
displayName: Query Categories
1414
description: |
15-
Either the [scope](/../api/scopes) `view_products:{projectKey}` or `view_categories:{projectKey}` is required.
15+
Either the [scope](/api/scopes) `view_products:{projectKey}` or `view_categories:{projectKey}` is required.
1616
securedBy:
1717
[
1818
oauth_2_0:
@@ -48,7 +48,7 @@ head:
4848
post:
4949
displayName: Create Category
5050
description: |
51-
Either the [scope](/../api/scopes) `manage_products:{projectKey}` or `manage_categories:{projectKey}` is required.
51+
Either the [scope](/api/scopes) `manage_products:{projectKey}` or `manage_categories:{projectKey}` is required.
5252
5353
Creating a Category produces the [CategoryCreated](ctp:api:type:CategoryCreatedMessage) Message.
5454
securedBy:
@@ -77,7 +77,7 @@ post:
7777
get:
7878
displayName: Get Category by Key
7979
description: |
80-
Either the [scope](/../api/scopes) `view_products:{projectKey}` or `view_categories:{projectKey}` is required.
80+
Either the [scope](/api/scopes) `view_products:{projectKey}` or `view_categories:{projectKey}` is required.
8181
securedBy:
8282
[
8383
oauth_2_0:
@@ -105,7 +105,7 @@ post:
105105
post:
106106
displayName: Update Category by Key
107107
description: |
108-
Either the [scope](/../api/scopes) `manage_products:{projectKey}` or `manage_categories:{projectKey}` is required.
108+
Either the [scope](/api/scopes) `manage_products:{projectKey}` or `manage_categories:{projectKey}` is required.
109109
securedBy:
110110
[
111111
oauth_2_0:
@@ -128,7 +128,7 @@ post:
128128
delete:
129129
displayName: Delete Category by Key
130130
description: |
131-
Either the [scope](/../api/scopes) `manage_products:{projectKey}` or `manage_categories:{projectKey}` is required.
131+
Either the [scope](/api/scopes) `manage_products:{projectKey}` or `manage_categories:{projectKey}` is required.
132132
securedBy:
133133
[
134134
oauth_2_0:
@@ -155,7 +155,7 @@ post:
155155
get:
156156
displayName: Get Category by ID
157157
description: |
158-
Either the [scope](/../api/scopes) `view_products:{projectKey}` or `view_categories:{projectKey}` is required.
158+
Either the [scope](/api/scopes) `view_products:{projectKey}` or `view_categories:{projectKey}` is required.
159159
securedBy:
160160
[
161161
oauth_2_0:
@@ -183,7 +183,7 @@ post:
183183
post:
184184
displayName: Update Category by ID
185185
description: |
186-
Either the [scope](/../api/scopes) `manage_products:{projectKey}` or `manage_categories:{projectKey}` is required.
186+
Either the [scope](/api/scopes) `manage_products:{projectKey}` or `manage_categories:{projectKey}` is required.
187187
securedBy:
188188
[
189189
oauth_2_0:
@@ -206,7 +206,7 @@ post:
206206
delete:
207207
displayName: Delete Category by ID
208208
description: |
209-
Either the [scope](/../api/scopes) `manage_products:{projectKey}` or `manage_categories:{projectKey}` is required.
209+
Either the [scope](/api/scopes) `manage_products:{projectKey}` or `manage_categories:{projectKey}` is required.
210210
securedBy:
211211
[
212212
oauth_2_0:

0 commit comments

Comments
 (0)