Skip to content

Commit fcb2793

Browse files
authored
Updated API from documentation release
1 parent 25a404a commit fcb2793

4 files changed

Lines changed: 15 additions & 6 deletions

File tree

api-specs/api/types/channel/ChannelRoleEnum.raml

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
displayName: ChannelRoleEnum
44
type: string
55
description: |
6-
Describes the purpose and type of the Channel. A Channel can have one or more roles.
6+
Describes how a Channel is used. A Channel can have one or more roles.
77
enum:
88
- InventorySupply
99
- ProductDistribution
@@ -17,8 +17,11 @@ enum:
1717
Channel can be used to expose Products to a specific distribution Channel.
1818
The Channel can be used by a Cart to [select](/api/pricing-and-discounts-overview#line-item-price-selection) a Product Price.
1919
OrderExport: |
20-
Channel can be used to track order export activities.
20+
Channel identifies a synchronization destination used when storing export information in [SyncInfo](ctp:api:type:SyncInfo).
21+
You can reference it with [Update SyncInfo](ctp:api:type:OrderUpdateSyncInfoAction) on Orders and Order Edits.
2122
OrderImport: |
22-
Channel can be used to track order import activities.
23+
Channel identifies a synchronization destination used when storing import information in [SyncInfo](ctp:api:type:SyncInfo).
24+
You can reference it with [Update SyncInfo](ctp:api:type:OrderUpdateSyncInfoAction) on Orders and Order Edits.
2325
Primary: |
24-
This role can be combined with the other roles (for example, with `InventorySupply`). If used, the Channel is considered as the primary or main channel among Channels of the same type.
26+
Marks the Channel as the default or preferred Channel among Channels with the same role.
27+
It can be combined with another role, for example `InventorySupply`.

api-specs/api/types/project/ExternalOAuth.raml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,13 @@ type: object
44
displayName: ExternalOAuth
55
example: !include ../../examples/Project/ExternalOAuth.json
66
description: |
7-
Represents a RFC 7662 compliant [OAuth 2.0 Token Introspection](https://datatracker.ietf.org/doc/html/rfc7662) endpoint. For more information, see [Requesting an access token using an external OAuth 2.0 server](/api/authorization#request-an-access-token-using-an-external-oauth-server).
7+
Represents an RFC 7662-compliant [OAuth 2.0 Token Introspection](https://datatracker.ietf.org/doc/html/rfc7662) endpoint.
8+
For more information, see [Requesting an access token using an external OAuth 2.0 server](/api/authorization#request-an-access-token-using-an-external-oauth-server).
89
9-
You can only configure **one** external OAuth 2.0 endpoint per Project. To authenticate using multiple external services (such as social network logins), use a middle layer authentication service.
10+
You can only configure **one** external OAuth 2.0 endpoint per Project.
11+
To authenticate using multiple external services (such as social network logins), use a middle layer authentication service that delegates to those services and exposes a single RFC 7662-compliant OAuth 2.0 Token Introspection endpoint to the commercetools APIs.
12+
This middle layer is a custom service that you build and host.
13+
It receives the token introspection request from the APIs, routes the token validation to the appropriate external service, and returns the introspection response in the expected format.
1014
properties:
1115
url:
1216
type: string

api-specs/api/types/tax-category/TaxRate.raml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ properties:
3838
type: string
3939
description: |
4040
State within the country, such as Texas in the United States.
41+
The value is case-sensitive and must use the same casing as the `state` value in the Cart `shippingAddress`.
4142
subRates?:
4243
type: SubRate[]
4344
description: |

api-specs/api/types/tax-category/TaxRateDraft.raml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ properties:
2626
type: string
2727
description: |
2828
State within the country, such as Texas in the United States.
29+
The value is case-sensitive and must use the same casing as the `state` value in the Cart `shippingAddress`.
2930
subRates?:
3031
type: SubRate[]
3132
description: |

0 commit comments

Comments
 (0)