From 7375cdc26481ba55e756479a87270432635bfcf7 Mon Sep 17 00:00:00 2001 From: "ct-sdks[bot]" <153784748+ct-sdks[bot]@users.noreply.github.com> Date: Wed, 4 Dec 2024 14:59:31 +0000 Subject: [PATCH] Updated API from documentation release --- api-specs/api/types/product/ProductDraft.raml | 2 +- .../product/updates/ProductSetKeyAction.raml | 2 +- api-specs/connect/types/types.raml | 1 - api-specs/import/api.raml | 4 +- api-specs/import/types/category-import.raml | 10 +- api-specs/import/types/common.raml | 12 +- api-specs/import/types/customer-import.raml | 127 ++++++++++++++---- .../import/types/discount-code-import.raml | 2 +- api-specs/import/types/error.raml | 18 ++- api-specs/import/types/import-operation.raml | 6 +- api-specs/import/types/import-request.raml | 22 +-- api-specs/import/types/import-summary.raml | 10 +- api-specs/import/types/inventory-import.raml | 4 +- api-specs/import/types/order-import.raml | 16 +-- .../import/types/order-patch-import.raml | 4 +- api-specs/import/types/price-import.raml | 22 +-- .../import/types/product-draft-import.raml | 24 ++-- api-specs/import/types/product-import.raml | 28 ++-- .../import/types/product-type-import.raml | 6 +- .../import/types/product-variant-import.raml | 30 ++--- .../import/types/standalone-price-import.raml | 10 +- api-specs/import/types/type-import.raml | 82 +++++------ 22 files changed, 260 insertions(+), 182 deletions(-) diff --git a/api-specs/api/types/product/ProductDraft.raml b/api-specs/api/types/product/ProductDraft.raml index 663f729a8..8ce4a986a 100644 --- a/api-specs/api/types/product/ProductDraft.raml +++ b/api-specs/api/types/product/ProductDraft.raml @@ -23,7 +23,7 @@ properties: description: | User-defined unique identifier for the Product. - This field is optional for backwards compatibility reasons, but we strongly recommend setting it. Keys are mandatory for importing Products with the [Import API](/../import-export/) and the [Merchant Center](/../merchant-center/import-data). + This field is optional for backwards compatibility reasons, but we strongly recommend setting it. Keys are mandatory for importing Products with the [Import API](/../api/import-export/) and the [Merchant Center](/../merchant-center/import-data). To update a Product using the Import API or Merchant Center, the Product `key` must match the pattern `^[A-Za-z0-9_-]{2,256}$`. description?: diff --git a/api-specs/api/types/product/updates/ProductSetKeyAction.raml b/api-specs/api/types/product/updates/ProductSetKeyAction.raml index 26b3e7382..d586060c1 100644 --- a/api-specs/api/types/product/updates/ProductSetKeyAction.raml +++ b/api-specs/api/types/product/updates/ProductSetKeyAction.raml @@ -10,4 +10,4 @@ properties: description: | Value to set. If empty, any existing value will be removed. - To update a Product using the [Import API](/../import-export/) and the [Merchant Center](/../merchant-center/import-data), the Product `key` must match the pattern `^[A-Za-z0-9_-]{2,256}$`. + To update a Product using the [Import API](/../api/import-export/) and the [Merchant Center](/../merchant-center/import-data), the Product `key` must match the pattern `^[A-Za-z0-9_-]{2,256}$`. diff --git a/api-specs/connect/types/types.raml b/api-specs/connect/types/types.raml index 1663d2853..140964db7 100644 --- a/api-specs/connect/types/types.raml +++ b/api-specs/connect/types/types.raml @@ -71,4 +71,3 @@ DeploymentApplicationRequiredError: !include error/DeploymentApplicationRequired DeploymentUnknownGlobalConfigurationKeyError: !include error/DeploymentUnknownGlobalConfigurationKeyError.raml DeploymentMissingGlobalConfigurationKeyError: !include error/DeploymentMissingGlobalConfigurationKeyError.raml DeploymentEmptyRequiredGlobalConfigurationKeyError: !include error/DeploymentEmptyRequiredGlobalConfigurationKeyError.raml - diff --git a/api-specs/import/api.raml b/api-specs/import/api.raml index 2ab4c30f2..f334bf138 100644 --- a/api-specs/import/api.raml +++ b/api-specs/import/api.raml @@ -19,7 +19,7 @@ baseUri: https://import.europe-west1.gcp.commercetools.com - eastus.azure - germanywestcentral.azure description: | - The [Region](/hosts-and-authorization#hosts) in which the Project is hosted. + The [Region](/import-export/hosts-and-authorization#hosts) in which the Project is hosted. (annotations.serviceRegions): - uri: https://import.us-central1.gcp.commercetools.com/ region: us-central1 @@ -531,7 +531,7 @@ traits: post: description: | Creates a new import request for Product Variant Patches. - Returns an [InvalidField](/error#invalidfielderror) error if the [ProductVariantPatchRequest](ctp:import:type:ProductVariantPatchRequest) contains patches with and without the `product` field set. + Returns an [InvalidField](ctp:import:type:InvalidFieldError) error if the [ProductVariantPatchRequest](ctp:import:type:ProductVariantPatchRequest) contains patches with and without the `product` field set. is: - secured_by_manage_products body: diff --git a/api-specs/import/types/category-import.raml b/api-specs/import/types/category-import.raml index a996999a3..908a61a14 100644 --- a/api-specs/import/types/category-import.raml +++ b/api-specs/import/types/category-import.raml @@ -10,12 +10,12 @@ uses: types: CategoryImport: description: | - The data representation for a Category to be imported that is persisted as a [Category](/../api/projects/categories#category) in the Project. + The data representation for a Category to be imported that is persisted as a [Category](ctp:api:type:Category) in the Project. type: common.ImportResource properties: key: type: string - description: User-defined unique identifier. If a [Category](/../api/projects/categories#category) with this `key` exists, it will be updated with the imported data. + description: User-defined unique identifier. If a [Category](ctp:api:type:Category) with this `key` exists, it will be updated with the imported data. pattern: ^[A-Za-z0-9_-]+$ minLength: 2 maxLength: 256 @@ -35,8 +35,8 @@ types: parent?: description: | Maps to `Category.parent`. - The Reference to the parent [Category](/../api/projects/categories#category) with which the Category is associated. - If referenced Category does not exist, the `state` of the [ImportOperation](/import-operation#importoperation) will be set to `unresolved` until the necessary Category is created. + The Reference to the parent [Category](ctp:api:type:Category) with which the Category is associated. + If referenced Category does not exist, the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be set to `unresolved` until the necessary Category is created. type: common.CategoryKeyReference orderHint?: description: | @@ -59,6 +59,8 @@ types: Maps to `Category.metaKeywords`. type: common.LocalizedString assets?: + description: | + Maps to `Category.assets`. type: common.Asset[] custom?: description: The custom fields for this Category. diff --git a/api-specs/import/types/common.raml b/api-specs/import/types/common.raml index 39680ffe1..3736bb811 100644 --- a/api-specs/import/types/common.raml +++ b/api-specs/import/types/common.raml @@ -209,9 +209,14 @@ types: properties: container: string UnresolvedReferences: + description: References a resource which could not be resolved. properties: - key: string - typeId: ReferenceType + key: + type: string + description: The `key` of the resource. + typeId: + type: ReferenceType + description: The type of resource. MoneyType: type: string enum: @@ -245,6 +250,7 @@ types: properties: value: type: TypedMoney + description: Money value of the discounted price. discount: description: Reference to a ProductDiscount. type: ProductDiscountKeyReference @@ -344,7 +350,7 @@ types: - key-value-document ProcessingState: description: | - Every [Import Operation](/import-operation) is assigned one of the following states. + Every [Import Operation](ctp:import:type:ImportOperation) is assigned one of the following states. (annotations.enumDescriptions): processing: The initial state assigned if the request payload (JSON structure and fields) meets Import API specifications. The resource import is in progress. imported: The resource was successfully imported. diff --git a/api-specs/import/types/customer-import.raml b/api-specs/import/types/customer-import.raml index cc2254091..5fdd36f7e 100644 --- a/api-specs/import/types/customer-import.raml +++ b/api-specs/import/types/customer-import.raml @@ -19,47 +19,116 @@ types: ExternalAuth: If set, the `password` field is optional for the Customer. CustomerAddress: description: | - Different from Address in that `key` is required and `id` is not supported. + Different from [Address](/types#address) in that `key` is required and `id` is not supported. properties: key: description: | User-defined identifier for the address. Must follow the pattern `[a-zA-Z0-9_\-]{2,256}` and must be unique per customer. type: string - title?: string - salutation?: string - firstName?: string - lastName?: string - streetName?: string - streetNumber?: string - additionalStreetInfo?: string - postalCode?: string - city?: string - region?: string - state?: string - country: common.CountryCode - company?: string - department?: string - building?: string - apartment?: string - pOBox?: string - phone?: string - mobile?: string - email?: string - fax?: string - additionalAddressInfo?: string - externalId?: string + country: + type: common.CountryCode + description: | + Name of the country. + title?: + type: string + description: | + Title of the contact, for example 'Dr.' + salutation?: + type: string + description: | + Salutation of the contact, for example 'Mr.' or 'Ms.' + firstName?: + type: string + description: | + Given name (first name) of the contact. + lastName?: + type: string + description: | + Family name (last name) of the contact. + streetName?: + type: string + description: | + Name of the street. + streetNumber?: + type: string + description: | + Street number. + additionalStreetInfo?: + type: string + description: | + Further information on the street address. + postalCode?: + type: string + description: | + Postal code. + city?: + type: string + description: | + Name of the city. + region?: + type: string + description: | + Name of the region. + state?: + type: string + description: | + Name of the state, for example, Colorado. + company?: + type: string + description: | + Name of the company. + department?: + type: string + description: | + Name of the department. + building?: + type: string + description: | + Number or name of the building. + apartment?: + type: string + description: | + Number or name of the apartment. + pOBox?: + type: string + description: | + Post office box number. + phone?: + type: string + description: | + Phone number of the contact. + mobile?: + type: string + description: | + Mobile phone number of the contact. + email?: + type: string + description: | + Email address of the contact. + fax?: + type: string + description: | + Fax number of the contact. + additionalAddressInfo?: + type: string + description: | + Further information on the Address. + externalId?: + type: string + description: | + ID for the contact used in an external system. custom?: description: Custom Fields for the address. type: custom-field.Custom CustomerImport: description: | - The data representation for a Customer to be imported that is persisted as a [Customer](/../api/projects/customers#top) in the Project. + The data representation for a Customer to be imported that is persisted as a [Customer](ctp:api:type:Customer) in the Project. type: common.ImportResource properties: key: type: string - description: User-defined unique identifier. If a [Customer](/../api/projects/customers#customer) with this `key` exists, it will be updated with the imported data. + description: User-defined unique identifier. If a [Customer](ctp:api:type:Customer) with this `key` exists, it will be updated with the imported data. pattern: ^[A-Za-z0-9_-]+$ minLength: 2 maxLength: 256 @@ -77,7 +146,7 @@ types: type: string stores?: description: | - The References to the Stores with which the Customer is associated. If referenced Stores do not exist, the `state` of the [ImportOperation](/import-operation#importoperation) will be set to `unresolved` until the necessary Stores are created. + The References to the Stores with which the Customer is associated. If referenced Stores do not exist, the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be set to `unresolved` until the necessary Stores are created. type: common.StoreKeyReference[] firstName?: description: | @@ -121,8 +190,8 @@ types: type: boolean customerGroup?: description: | - The Reference to the [CustomerGroup](/../api/projects/customerGroups#customergroup) with which the Customer is associated. - If referenced CustomerGroup does not exist, the `state` of the [ImportOperation](/import-operation#importoperation) will be set to `unresolved` until the necessary CustomerGroup is created. + The Reference to the [CustomerGroup](ctp:api:type:CustomerGroup) with which the Customer is associated. + If referenced CustomerGroup does not exist, the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be set to `unresolved` until the necessary CustomerGroup is created. type: common.CustomerGroupKeyReference addresses?: description: | diff --git a/api-specs/import/types/discount-code-import.raml b/api-specs/import/types/discount-code-import.raml index f7c904f7e..e604c0859 100644 --- a/api-specs/import/types/discount-code-import.raml +++ b/api-specs/import/types/discount-code-import.raml @@ -32,7 +32,7 @@ types: description: | User-defined unique identifier of the DiscountCode that is used by the customer to apply the discount. - The value cannot be updated. Attempting to update the value will result in an [InvalidFieldsUpdate](/error#invalidfieldsupdateerror) error. + The value cannot be updated. Attempting to update the value will result in an [InvalidFieldsUpdate](/import-export/error#invalidfieldsupdateerror) error. type: string cartDiscounts: description: | diff --git a/api-specs/import/types/error.raml b/api-specs/import/types/error.raml index 2da43d284..71a46c385 100644 --- a/api-specs/import/types/error.raml +++ b/api-specs/import/types/error.raml @@ -34,13 +34,17 @@ types: The errors that caused this error response. type: ErrorObject[] ErrorObject: - description: + description: | + Base representation of an error response containing common fields to all errors. + + An error response may contain additional fields depending on the type of an error, for example, `attribute` in [DuplicateAttributeValueError](#duplicateattributevalueerror). discriminator: code properties: code: + description: An error identifier. type: string message: - description: + description: A plain language description of the cause of an error. type: string AccessDeniedError: description: This is the generic error code for access denied. In case of a wrong scope, an [InvalidScopeError](#invalidscopeerror) will be returned. @@ -58,7 +62,7 @@ types: type: ErrorObject discriminatorValue: InvalidOperation DuplicateAttributeValueError: - description: The `Unique` [AttributeConstraintEnum](/../api/projects/productTypes#attributeconstraintenum) was violated. + description: The `Unique` [AttributeConstraintEnum](ctp:api:type:AttributeConstraintEnum) was violated. type: ErrorObject discriminatorValue: DuplicateAttributeValue properties: @@ -66,7 +70,7 @@ types: description: The attribute in conflict. type: product-variant-import.Attribute DuplicateAttributeValuesError: - description: The `CombinationUnique` [AttributeConstraintEnum](/../api/projects/productTypes#attributeconstraintenum) was violated. + description: The `CombinationUnique` [AttributeConstraintEnum](ctp:api:type:AttributeConstraintEnum) was violated. type: ErrorObject discriminatorValue: DuplicateAttributeValues properties: @@ -85,8 +89,8 @@ types: type: any DuplicateVariantValuesError: description: | - The given combination of values of a [Product Variant](/../api/projects/products#productvariant) conflicts with an existing one. - Every [Product Variant](/../api/projects/products#productvariant) must have a distinct combination of SKU, prices, and custom attribute values. + The given combination of values of a [Product Variant](ctp:api:type:ProductVariant) conflicts with an existing one. + Every [Product Variant](ctp:api:type:ProductVariant) must have a distinct combination of SKU, prices, and custom attribute values. type: ErrorObject discriminatorValue: DuplicateVariantValues properties: @@ -113,7 +117,7 @@ types: InvalidFieldError: description: | A given field is not supported. - This error occurs, for example, if the field `variants`, which is not supported by [Product Import](/product#productimport), is sent to the Product Import endpoint. + This error occurs, for example, if the field `variants`, which is not supported by [Product Import](ctp:import:type:ProductImport), is sent to the Product Import endpoint. type: ErrorObject discriminatorValue: InvalidField properties: diff --git a/api-specs/import/types/import-operation.raml b/api-specs/import/types/import-operation.raml index 1c227bcc7..9f0bee677 100644 --- a/api-specs/import/types/import-operation.raml +++ b/api-specs/import/types/import-operation.raml @@ -17,7 +17,7 @@ types: type: integer format: long importContainerKey: - description: The key of the [importContainer](/import-container#importcontainer). + description: The key of the [ImportContainer](ctp:import:type:ImportContainer). type: string resourceKey: description: The key of the resource. @@ -35,7 +35,7 @@ types: format: long errors?: description: | - Contains an error if the import of the resource was not successful. See [Errors](/error). + Contains an error if the import of the resource was not successful. See [Errors](/import-export/error). type: error.ErrorObject[] unresolvedReferences?: description: | @@ -98,5 +98,5 @@ types: errors?: description: | The validation errors for the [ImportOperation](#importoperation). - See [Errors](/error). + See [Errors](/import-export/error). type: error.ErrorObject[] diff --git a/api-specs/import/types/import-request.raml b/api-specs/import/types/import-request.raml index e4be7a381..6684ec12c 100644 --- a/api-specs/import/types/import-request.raml +++ b/api-specs/import/types/import-request.raml @@ -31,14 +31,14 @@ types: ImportResponse: description: | A list of the ID's and validation statuses of newly created [ImportOperations](#importoperation). - Used as a response at each resource-specific import endpoint, for example, at [Import Categories](/category#import-categories) and [Import ProductTypes](/product-type#import-producttypes). + Used as a response at each resource-specific import endpoint, for example, at [Import Categories](ctp:import:type:CategoryImport) and [Import ProductTypes](ctp:import:type:ProductTypeImport). properties: operationStatus: type: import-operation.ImportOperationStatus[] maxItems: 20 CategoryImportRequest: description: | - The request body to [import Categories](#import-categories). Contains data for [Categories](/../api/projects/categories#category) to be created or updated in a Project. + The request body to [import Categories](#import-categories). Contains data for [Categories](ctp:api:type:Category) to be created or updated in a Project. type: ImportRequest discriminatorValue: category properties: @@ -50,7 +50,7 @@ types: example: !include ../examples/category-import-request.json ProductImportRequest: description: | - The request body to [import Products](#import-products). Contains data for [Products](/../api/projects/products#product) to be created or updated in a Project. + The request body to [import Products](#import-products). Contains data for [Products](ctp:api:type:Product) to be created or updated in a Project. type: ImportRequest discriminatorValue: product properties: @@ -62,7 +62,7 @@ types: example: !include ../examples/product-import-request.json ProductDraftImportRequest: description: | - The request body to [import ProductDrafts](#import-productdrafts). Contains data for [Products](/../api/projects/products#productdraft) to be created or updated in a Project. + The request body to [import ProductDrafts](#import-productdrafts). Contains data for [Products](ctp:api:type:Product) to be created or updated in a Project. type: ImportRequest discriminatorValue: product-draft properties: @@ -74,7 +74,7 @@ types: example: !include ../examples/product-draft-import-request.json ProductTypeImportRequest: description: | - The request body to [import ProductTypes](#import-producttypes). Contains data for [ProductTypes](/../api/projects/productTypes#producttype) to be created or updated in a Project. + The request body to [import ProductTypes](#import-producttypes). Contains data for [ProductTypes](ctp:api:type:ProductType) to be created or updated in a Project. type: ImportRequest discriminatorValue: product-type properties: @@ -86,7 +86,7 @@ types: example: !include ../examples/product-type-import-request.json ProductVariantImportRequest: description: | - The request body to [import ProductVariants](#import-productvariants). Contains data for [ProductVariants](/../api/projects/products#productvariant) to be created or updated in a Project. + The request body to [import ProductVariants](#import-productvariants). Contains data for [ProductVariants](ctp:api:type:ProductVariant) to be created or updated in a Project. type: ImportRequest discriminatorValue: product-variant properties: @@ -110,7 +110,7 @@ types: example: !include ../examples/price-import-request.json StandalonePriceImportRequest: description: | - The request body to [import Standalone Prices](#import-standalone-prices). Contains data for [Standalone Prices](/../api/projects/standalone-prices#standaloneprice) to be created or updated in a Project. + The request body to [import Standalone Prices](#import-standalone-prices). Contains data for [Standalone Prices](ctp:api:type:StandalonePrice) to be created or updated in a Project. type: ImportRequest discriminatorValue: standalone-price properties: @@ -121,7 +121,7 @@ types: maxItems: 20 OrderImportRequest: description: | - The request body to [import Orders](#import-orders). Contains data for [Orders](/../api/projects/orders#order) to be created in a Project. + The request body to [import Orders](#import-orders). Contains data for [Orders](ctp:api:type:Order) to be created in a Project. type: ImportRequest discriminatorValue: order properties: @@ -157,7 +157,7 @@ types: example: !include ../examples/product-variant-patch-import-request.json CustomerImportRequest: description: | - The request body to [import Customers](#import-customers). Contains data for [Customers](/../api/projects/customers#customer) to be created or updated in a Project. + The request body to [import Customers](#import-customers). Contains data for [Customers](ctp:api:type:Customer) to be created or updated in a Project. type: ImportRequest discriminatorValue: customer properties: @@ -169,7 +169,7 @@ types: example: !include ../examples/customer-import-request.json InventoryImportRequest: description: | - The request body to [import Inventories](#import-inventory). Contains data for [InventoryEntries](/../api/projects/inventory#inventoryentry) to be created or updated in a commercetools Project. + The request body to [import Inventories](#import-inventory). Contains data for [InventoryEntries](ctp:api:type:InventoryEntry) to be created or updated in a commercetools Project. type: ImportRequest discriminatorValue: inventory properties: @@ -181,7 +181,7 @@ types: example: !include ../examples/inventory-import-request.json TypeImportRequest: description: | - The request body to [import Types](#import-types). Contains data for [Types](/../api/projects/types#type) to be created or updated in a Project. + The request body to [import Types](#import-types). Contains data for [Types](ctp:api:type:Type) to be created or updated in a Project. type: ImportRequest discriminatorValue: type properties: diff --git a/api-specs/import/types/import-summary.raml b/api-specs/import/types/import-summary.raml index 260ab8544..01cc77383 100644 --- a/api-specs/import/types/import-summary.raml +++ b/api-specs/import/types/import-summary.raml @@ -9,19 +9,19 @@ uses: types: ImportSummary: description: | - Describes the status of an [ImportContainer](/import-container#importcontainer) by the number of resources in each [Processing State](/processing-state#processingstate). - Can be used to monitor the import progress per [Import Container](/import-container). + Describes the status of an [ImportContainer](ctp:import:type:ImportContainer) by the number of resources in each [Processing State](ctp:import:type:ProcessingState). + Can be used to monitor the import progress per [Import Container](ctp:import:type:ImportContainer). properties: states: description: | - The import status of an [ImportContainer](/import-container#importcontainer) given by the number of resources in each [Processing State](/processing-state#processingstate). + The import status of an [ImportContainer](ctp:import:type:ImportContainer) given by the number of resources in each [Processing State](ctp:import:type:ProcessingState). type: OperationStates total: - description: The total number of [ImportOperations](/import-operation#importoperation) received for this Import Summary. + description: The total number of [ImportOperations](ctp:import:type:ImportOperation) received for this Import Summary. type: integer format: long OperationStates: - description: The number of resources in each [Processing State](/processing-state#processingstate). + description: The number of resources in each [Processing State](ctp:import:type:ProcessingState). properties: processing: type: integer diff --git a/api-specs/import/types/inventory-import.raml b/api-specs/import/types/inventory-import.raml index adc6e4350..0a8fe1cdb 100644 --- a/api-specs/import/types/inventory-import.raml +++ b/api-specs/import/types/inventory-import.raml @@ -10,12 +10,12 @@ uses: types: InventoryImport: description: | - The data representation for an Inventory to be imported that is persisted as a [Inventory](/../api/projects/inventory#top) in the Project. + The data representation for an Inventory to be imported that is persisted as a [Inventory](ctp:api:type:InventoryEntry) in the Project. type: common.ImportResource properties: key: type: string - description: User-defined unique identifier. If an [InventoryEntry](/../api/projects/inventory#inventoryentry) with this `key` exists, it will be updated with the imported data. + description: User-defined unique identifier. If an [InventoryEntry](ctp:api:type:InventoryEntry) with this `key` exists, it will be updated with the imported data. pattern: ^[A-Za-z0-9_-]+$ minLength: 2 maxLength: 256 diff --git a/api-specs/import/types/order-import.raml b/api-specs/import/types/order-import.raml index 5b0fc4628..754d8a6f2 100644 --- a/api-specs/import/types/order-import.raml +++ b/api-specs/import/types/order-import.raml @@ -131,14 +131,14 @@ types: supplyChannel?: description: | Maps to `LineItem.supplyChannel`. - The Reference to the Supply [Channel](/../api/projects/channels#channel) with which the LineItem is associated. - If referenced Supply Channel does not exist, the `state` of the [ImportOperation](/import-operation#importoperation) will be set to `unresolved` until the necessary Supply Channel is created. + The Reference to the Supply [Channel](ctp:api:type:Channel) with which the LineItem is associated. + If referenced Supply Channel does not exist, the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be set to `unresolved` until the necessary Supply Channel is created. type: common.ChannelKeyReference distributionChannel?: description: | Maps to `LineItem.distributionChannel`. - The Reference to the Distribution [Channel](/../api/projects/channels#channel) with which the LineItem is associated. - If referenced CustomerGroup does not exist, the `state` of the [ImportOperation](/import-operation#importoperation) will be set to `unresolved` until the necessary Distribution Channel is created. + The Reference to the Distribution [Channel](ctp:api:type:Channel) with which the LineItem is associated. + If referenced CustomerGroup does not exist, the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be set to `unresolved` until the necessary Distribution Channel is created. type: common.ChannelKeyReference taxRate?: description: | @@ -458,11 +458,9 @@ types: format: int64 OrderImport: description: | - The data representation for an Order to be imported that is persisted as an [Order](/../api/projects/orders#top) in the Project. + The data representation for an Order to be imported that is persisted as an [Order](ctp:api:type:Order) in the Project. - In commercetools, you can import an Order using the - [Create Order by Import](ctp:import:endpoint:/{projectKey}/orders/import:POST) - endpoint method instead of creating it from a Cart. + In commercetools, you can import an Order using the [Create Order by Import](/projects/orders-import#create-order-by-import) endpoint method instead of creating it from a Cart. An OrderImport is a snapshot of an order at the time it was imported. properties: @@ -555,7 +553,7 @@ types: type: common.Address[] store?: description: | - Reference to the Store in which the Order is associated. If referenced Store does not exist, the `state` of the [ImportOperation](/import-operation#importoperation) will be set to `unresolved` until the necessary Store exists. + Reference to the Store in which the Order is associated. If referenced Store does not exist, the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be set to `unresolved` until the necessary Store exists. type: common.StoreKeyReference state?: description: | diff --git a/api-specs/import/types/order-patch-import.raml b/api-specs/import/types/order-patch-import.raml index 833a7a941..64bd26686 100644 --- a/api-specs/import/types/order-patch-import.raml +++ b/api-specs/import/types/order-patch-import.raml @@ -133,8 +133,8 @@ types: type: ParcelItems[] OrderPatchImport: description: | - Representation for an update of an [Order](/../api/projects/orders#order). Use this type to import updates for existing - [Orders](/../api/projects/orders#order) in a Project. + Representation for an update of an [Order](ctp:api:type:Order). Use this type to import updates for existing + [Orders](ctp:api:type:Order) in a Project. properties: orderNumber: description: | diff --git a/api-specs/import/types/price-import.raml b/api-specs/import/types/price-import.raml index c173d7a20..8a84d3b7c 100644 --- a/api-specs/import/types/price-import.raml +++ b/api-specs/import/types/price-import.raml @@ -63,13 +63,13 @@ types: type: datetime customerGroup?: description: | - The Reference to the [CustomerGroup](/../api/projects/customerGroups#customergroup) with which the [Price](/../api/types#price) is associated. - If referenced CustomerGroup does not exist, the `state` of the [ImportOperation](/import-operation#importoperation) will be set to `unresolved` until the necessary CustomerGroup is created. + The Reference to the [CustomerGroup](ctp:api:type:CustomerGroup) with which the [Price](/../api/types#price) is associated. + If referenced CustomerGroup does not exist, the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be set to `unresolved` until the necessary CustomerGroup is created. type: common.CustomerGroupKeyReference channel?: description: | - The Reference to the [Channel](/../api/projects/channels#channel) with which the [Price](/../api/types#price) is associated. - If referenced Channel does not exist, the `state` of the [ImportOperation](/import-operation#importoperation) will be set to `unresolved` until the necessary Channel is created. + The Reference to the [Channel](ctp:api:type:Channel) with which the [Price](/../api/types#price) is associated. + If referenced Channel does not exist, the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be set to `unresolved` until the necessary Channel is created. type: common.ChannelKeyReference discounted?: description: Sets a discounted price from an external service. @@ -79,7 +79,7 @@ types: (annotations.deprecated): true default: false description: | - Only the [Embedded Price](/../api/types#price) updates will be published to `staged` and `current` projection. + Only the [Embedded Price](/types#price) updates will be published to `staged` and `current` projection. staged?: type: boolean default: true @@ -94,13 +94,13 @@ types: type: custom-field.Custom productVariant: description: | - The ProductVariant in which this [Embedded Price](/../api/types#price) is contained. - The Reference to the [ProductVariant](/../api/projects/products#productvariant) with which the [Price](/../api/types#price) is associated. - If referenced ProductVariant does not exist, the `state` of the [ImportOperation](/import-operation#importoperation) will be set to `unresolved` until the necessary ProductVariant is created. + The ProductVariant in which this [Embedded Price](/types#price) is contained. + The Reference to the [ProductVariant](/projects/products#productvariant) with which the [Price](/types#price) is associated. + If the referenced ProductVariant does not exist, the `state` of the [ImportOperation](/import-export/import-operation#importoperation) will be set to `unresolved` until the necessary ProductVariant is created. type: common.ProductVariantKeyReference product: description: | - The Product in which the Product Variant containing this [Embedded Price](/../api/types#price) is contained. Maps to `ProductVariant.product`. - The Reference to the [Product](/../api/projects/products#product) with which the [Price](/../api/types#price) is associated. - If referenced Product does not exist, the `state` of the [ImportOperation](/import-operation#importoperation) will be set to `unresolved` until the necessary Product is created. + The Product in which the Product Variant containing this [Embedded Price](/types#price) is contained. Maps to `ProductVariant.product`. + The Reference to the [Product](/projects/products#product) with which the [Price](/types#price) is associated. + If referenced Product does not exist, the `state` of the [ImportOperation](/import-export/import-operation#importoperation) will be set to `unresolved` until the necessary Product is created. type: common.ProductKeyReference diff --git a/api-specs/import/types/product-draft-import.raml b/api-specs/import/types/product-draft-import.raml index 2891b0af8..caff2eeaa 100644 --- a/api-specs/import/types/product-draft-import.raml +++ b/api-specs/import/types/product-draft-import.raml @@ -17,16 +17,16 @@ types: properties: key: type: string - description: User-defined unique identifier. If a [Product](/../api/projects/products#product) with this `key` exists, it will be updated with the imported data. + description: User-defined unique identifier. If a [Product](ctp:api:type:Product) with this `key` exists, it will be updated with the imported data. pattern: ^[A-Za-z0-9_-]+$ minLength: 2 maxLength: 256 productType: description: | - The `productType` of a [Product](/../api/projects/products#product). + The `productType` of a [Product](ctp:api:type:Product). Maps to `Product.productType`. - The Reference to the [ProductType](/../api/projects/productTypes#producttype) with which the ProductDraft is associated. - If referenced ProductType does not exist, the `state` of the [ImportOperation](/import-operation#importoperation) will be set to `unresolved` until the necessary ProductType is created. + The Reference to the [ProductType](ctp:api:type:ProductType) with which the ProductDraft is associated. + If referenced ProductType does not exist, the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be set to `unresolved` until the necessary ProductType is created. type: common.ProductTypeKeyReference name: type: common.LocalizedString @@ -42,8 +42,8 @@ types: Maps to `Product.description`. categories?: description: | - The Reference to the [Categories](/../api/projects/categories#category) with which the ProductDraft is associated. - If referenced Categories do not exist, the `state` of the [ImportOperation](/import-operation#importoperation) will be set to `unresolved` until the necessary Categories are created. + The Reference to the [Categories](ctp:api:type:Category) with which the ProductDraft is associated. + If referenced Categories do not exist, the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be set to `unresolved` until the necessary Categories are created. type: common.CategoryKeyReference[] metaTitle?: type: common.LocalizedString @@ -61,25 +61,25 @@ types: description: An array of related Product Variants. taxCategory?: description: | - The Reference to the [TaxCategory](/../api/projects/taxCategories#taxcategory) with which the ProductDraft is associated. - If referenced TaxCategory does not exist, the `state` of the [ImportOperation](/import-operation#importoperation) will be set to `unresolved` until the necessary TaxCategory is created. + The Reference to the [TaxCategory](/projects/taxCategories#taxcategory) with which the ProductDraft is associated. + If referenced TaxCategory does not exist, the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be set to `unresolved` until the necessary TaxCategory is created. type: common.TaxCategoryKeyReference searchKeywords?: type: product-import.SearchKeywords state?: description: | - The Reference to the [State](/../api/projects/states#state) with which the ProductDraft is associated. - If referenced State does not exist, the `state` of the [ImportOperation](/import-operation#importoperation) will be set to `unresolved` until the necessary State is created. + The Reference to the [State](/projects/states#state) with which the ProductDraft is associated. + If referenced State does not exist, the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be set to `unresolved` until the necessary State is created. type: common.StateKeyReference publish?: type: boolean default: false description: | - Determines the published status and current/staged projection of the Product. For more information, see [Managing the published state of Products](/best-practices#managing-the-published-state-of-products). + Determines the published status and current/staged projection of the Product. For more information, see [Managing the published state of Products](/import-export/best-practices#managing-the-published-state-of-products). priceMode?: type: common.ProductPriceModeEnum description: | - Determines the type of Prices the API uses. See [ProductPriceMode](/../api/projects/products#productpricemode) for more details. If not provided, the existing `Product.priceMode` is not changed. + Determines the type of Prices the API uses. If not provided, the existing `Product.priceMode` is not changed. ProductVariantDraftImport: type: object description: | diff --git a/api-specs/import/types/product-import.raml b/api-specs/import/types/product-import.raml index 6a186bf99..359b5c463 100644 --- a/api-specs/import/types/product-import.raml +++ b/api-specs/import/types/product-import.raml @@ -57,14 +57,14 @@ types: ProductImport: type: common.ImportResource description: | - The data representation for a Product to be imported that is persisted as a [Product](/../api/projects/products#product) in the Project. + The data representation for a Product to be imported that is persisted as a [Product](ctp:api:type:Product) in the Project. - This is the minimal representation required for creating a [Product](/../api/projects/products#product) in commercetools. + This is the minimal representation required for creating a [Product](ctp:api:type:Product) in commercetools. additionalProperties: false properties: key: type: string - description: User-defined unique identifier. If a [Product](/../api/projects/products#product) with this `key` exists, it will be updated with the imported data. + description: User-defined unique identifier. If a [Product](ctp:api:type:Product) with this `key` exists, it will be updated with the imported data. pattern: ^[A-Za-z0-9_-]+$ minLength: 2 maxLength: 256 @@ -74,10 +74,10 @@ types: type: common.LocalizedString productType: description: | - The `productType` of a [Product](/../api/projects/products#product). + The `productType` of a [Product](ctp:api:type:Product). Maps to `Product.productType`. - The Reference to the [ProductType](/../api/projects/productTypes#producttype) with which the Product is associated. - If referenced ProductType does not exist, the `state` of the [ImportOperation](/import-operation#importoperation) will be set to `unresolved` until the necessary ProductType is created. + The Reference to the [ProductType](ctp:api:type:ProductType) with which the Product is associated. + If referenced ProductType does not exist, the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be set to `unresolved` until the necessary ProductType is created. type: common.ProductTypeKeyReference slug: description: | @@ -91,8 +91,8 @@ types: categories?: description: | Maps to `Product.categories`. - The References to the [Categories](/../api/projects/categories#category) with which the Product is associated. - If referenced Categories do not exist, the `state` of the [ImportOperation](/import-operation#importoperation) will be set to `unresolved` until the necessary Categories are created. + The References to the [Categories](ctp:api:type:Category) with which the Product is associated. + If referenced Categories do not exist, the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be set to `unresolved` until the necessary Categories are created. type: common.CategoryKeyReference[] metaTitle?: type: common.LocalizedString @@ -102,22 +102,22 @@ types: type: common.LocalizedString taxCategory?: description: | - The Reference to the [TaxCategory](/../api/projects/taxCategories#taxcategory) with which the Product is associated. - If referenced TaxCategory does not exist, the `state` of the [ImportOperation](/import-operation#importoperation) will be set to `unresolved` until the necessary TaxCategory is created. + The Reference to the [TaxCategory](/projects/taxCategories#taxcategory) with which the Product is associated. + If referenced TaxCategory does not exist, the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be set to `unresolved` until the necessary TaxCategory is created. type: common.TaxCategoryKeyReference searchKeywords?: type: SearchKeywords state?: description: | - The Reference to the [State](/../api/projects/states#state) with which the Product is associated. - If referenced State does not exist, the `state` of the [ImportOperation](/import-operation#importoperation) will be set to `unresolved` until the necessary State is created. + The Reference to the [State](/projects/states#state) with which the Product is associated. + If referenced State does not exist, the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be set to `unresolved` until the necessary State is created. type: common.StateKeyReference publish?: type: boolean default: false description: | - Determines the published status and current/staged projection of the Product. For more information, see [Managing the published state of Products](/best-practices#managing-the-published-state-of-products). + Determines the published status and current/staged projection of the Product. For more information, see [Managing the published state of Products](/import-export/best-practices#managing-the-published-state-of-products). priceMode?: type: common.ProductPriceModeEnum description: | - Determines the type of Prices the API uses. See [ProductPriceMode](/../api/projects/products#productpricemode) for more details. If not provided, the existing `Product.priceMode` is not changed. + Determines the type of Prices the API uses. If not provided, the existing `Product.priceMode` is not changed. diff --git a/api-specs/import/types/product-type-import.raml b/api-specs/import/types/product-type-import.raml index 1e58b19eb..f8d8b0b8a 100644 --- a/api-specs/import/types/product-type-import.raml +++ b/api-specs/import/types/product-type-import.raml @@ -112,7 +112,7 @@ types: - MultiLine ProductTypeImport: description: | - The data representation for a ProductType to be imported that is persisted as a [ProductType](/../api/projects/productTypes#producttype) in the Project. + The data representation for a ProductType to be imported that is persisted as a [ProductType](ctp:api:type:ProductType) in the Project. type: common.ImportResource properties: key: @@ -120,7 +120,7 @@ types: pattern: ^[A-Za-z0-9_-]+$ minLength: 2 maxLength: 256 - description: User-defined unique identifier. If a [ProductType](/../api/projects/productTypes#producttype) with this `key` exists, it will be updated with the imported data. + description: User-defined unique identifier. If a [ProductType](ctp:api:type:ProductType) with this `key` exists, it will be updated with the imported data. name: description: | Maps to `ProductType.name`. @@ -131,5 +131,5 @@ types: type: string attributes?: description: | - The `attributes` of [ProductType](/../api/projects/productTypes#producttype). + The `attributes` of [ProductType](ctp:api:type:ProductType). type: AttributeDefinition[] diff --git a/api-specs/import/types/product-variant-import.raml b/api-specs/import/types/product-variant-import.raml index ba954e63f..02ca5bca9 100644 --- a/api-specs/import/types/product-variant-import.raml +++ b/api-specs/import/types/product-variant-import.raml @@ -206,25 +206,25 @@ types: type: time-only[] ProductVariantImport: description: | - The data representation for a ProductVariant to be imported that is persisted as a [ProductVariant](/../api/projects/products#productvariant) in the Project. + The data representation for a ProductVariant to be imported that is persisted as a [ProductVariant](ctp:api:type:ProductVariant) in the Project. type: common.ImportResource properties: key: type: string - description: User-defined unique identifier. If a [ProductVariant](/../api/projects/products#productvariant) with this `key` exists on the specified `product`, it will be updated with the imported data. + description: User-defined unique identifier. If a [ProductVariant](ctp:api:type:ProductVariant) with this `key` exists on the specified `product`, it will be updated with the imported data. sku?: description: | Maps to `ProductVariant.sku`. type: string isMasterVariant: description: | - - When creating a new ProductVariant, set to `false`; otherwise, the import operation will fail with a [NewMasterVariantAdditionNotAllowed](/error#newmastervariantadditionnotallowederror) error. + - When creating a new ProductVariant, set to `false`; otherwise, the import operation will fail with a [NewMasterVariantAdditionNotAllowed](ctp:import:type:NewMasterVariantAdditionNotAllowedError) error. - Set to `true` if the ProductVariant exists and you want to set this ProductVariant as the Master Variant. type: boolean attributes?: description: | Maps to `ProductVariant.attributes`. - The referenced attribute must be defined in an already existing ProductType in the project, or the `state` of the [ImportOperation](/import-operation#importoperation) will be `unresolved`. + The referenced attribute must be defined in an already existing ProductType in the project, or the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be `unresolved`. type: Attribute[] images?: description: | @@ -249,33 +249,33 @@ types: - Leave empty or set to `true` to only update the staged projection. product: description: | - The [Product](/../api/projects/products#productvariant) to which this Product Variant belongs. Maps to `ProductVariant.product`. - The Reference to the [Product](/../api/projects/products#product) with which the ProductVariant is associated. - If referenced Product does not exist, the `state` of the [ImportOperation](/import-operation#importoperation) will be set to `unresolved` until the necessary Product is created. + The [Product](ctp:api:type:ProductVariant) to which this Product Variant belongs. Maps to `ProductVariant.product`. + The Reference to the [Product](ctp:api:type:Product) with which the ProductVariant is associated. + If referenced Product does not exist, the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be set to `unresolved` until the necessary Product is created. type: common.ProductKeyReference ProductVariantPatch: description: | - Representation for an update of a [ProductVariant](/../api/projects/products#productvariant). Use this type to import updates for existing - [ProductVariants](/../api/projects/products#productvariant) in a Project. + Representation for an update of a [ProductVariant](ctp:api:type:ProductVariant). Use this type to import updates for existing + [ProductVariants](ctp:api:type:ProductVariant) in a Project. properties: productVariant: description: | - Reference to the [ProductVariant](/../api/projects/products#productvariant) to update. - If the referenced ProductVariant does not exist, the `state` of the [ImportOperation](/import-operation#importoperation) will be set to `unresolved` until the necessary ProductVariant is created. + Reference to the [ProductVariant](ctp:api:type:ProductVariant) to update. + If the referenced ProductVariant does not exist, the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be set to `unresolved` until the necessary ProductVariant is created. type: common.ProductVariantKeyReference attributes?: description: | Maps to `ProductVariant.attributes`. - - The referenced Attribute must be defined in an existing [ProductType](/../api/projects/productTypes#producttype), or the `state` of the [ImportOperation](/import-operation#importoperation) will be `validationFailed`. + - The referenced Attribute must be defined in an existing [ProductType](ctp:api:type:ProductType), or the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be `validationFailed`. - Setting the value of a non-required Attribute to `null` will remove the Attribute. - - Attempting to set a `null` value to a required Attribute will make the import operation fail with an [InvalidOperation](/error#invalidoperation) error. - - Importing [LocalizableTextAttributes](/product-variant#localizabletextattribute) or [LocalizableTextSetAttributes](/product-variant#localizabletextsetattribute) follows an override pattern, meaning that omitted localized fields will be deleted, new fields will be created, and existing fields will be updated. You can also delete localized fields by setting their value to `null`. + - Attempting to set a `null` value to a required Attribute will make the import operation fail with an [InvalidOperation](ctp:import:type:InvalidOperation) error. + - Importing [LocalizableTextAttributes](ctp:import:type:LocalizableTextAttribute) or [LocalizableTextSetAttributes](ctp:import:type:LocalizableTextSetAttribute) follows an override pattern, meaning that omitted localized fields will be deleted, new fields will be created, and existing fields will be updated. You can also delete localized fields by setting their value to `null`. type: Attributes staged?: type: boolean default: true description: | - If `false`, the attribute changes are applied to both [current and staged projected representations](/../api/projects/productProjections#current--staged) of the [Product](/../api/projects/products#product). + If `false`, the attribute changes are applied to both [current and staged projected representations](/projects/productProjections#current--staged) of the [Product](ctp:api:type:Product). product?: description: | Reference to the [Product](/../api/projects/products#product) that contains the ProductVariant. diff --git a/api-specs/import/types/standalone-price-import.raml b/api-specs/import/types/standalone-price-import.raml index eb1f9235d..5866d8ab7 100644 --- a/api-specs/import/types/standalone-price-import.raml +++ b/api-specs/import/types/standalone-price-import.raml @@ -10,12 +10,12 @@ uses: types: StandalonePriceImport: description: | - The data representation for a Standalone Price to be imported that is persisted as a [Standalone Price](/../api/projects/standalone-prices#standaloneprice) in the Project. + The data representation for a Standalone Price to be imported that is persisted as a [Standalone Price](ctp:api:type:StandalonePrice)) in the Project. type: common.ImportResource properties: key: description: | - User-defined unique identifier for the Standalone Price. If a [StandalonePrice](/../api/projects/standalone-prices#standaloneprice) with this `key` exists, it will be updated with the imported data. + User-defined unique identifier for the Standalone Price. If a [StandalonePrice](ctp:api:type:StandalonePrice)) with this `key` exists, it will be updated with the imported data. type: string pattern: ^[A-Za-z0-9_-]+$ minLength: 2 @@ -32,19 +32,19 @@ types: description: | Sets the country for which this Price is valid. - The value cannot be updated. Attempting to update the value will result in an [InvalidFieldsUpdate](/error#invalidfieldsupdateerror) error. + The value cannot be updated. Attempting to update the value will result in an [InvalidFieldsUpdate](/import-export/error#invalidfieldsupdateerror) error. type: common.CountryCode customerGroup?: description: | Sets the CustomerGroup for which this Price is valid. - The value cannot be updated. Attempting to update the value will result in an [InvalidFieldsUpdate](/error#invalidfieldsupdateerror) error. + The value cannot be updated. Attempting to update the value will result in an [InvalidFieldsUpdate](/import-export/error#invalidfieldsupdateerror) error. type: common.CustomerGroupKeyReference channel?: description: | Sets the product distribution Channel for which this Price is valid. - The value cannot be updated. Attempting to update the value will result in an [InvalidFieldsUpdate](/error#invalidfieldsupdateerror) error. + The value cannot be updated. Attempting to update the value will result in an [InvalidFieldsUpdate](/import-export/error#invalidfieldsupdateerror) error. type: common.ChannelKeyReference validFrom?: description: | diff --git a/api-specs/import/types/type-import.raml b/api-specs/import/types/type-import.raml index 2550fb421..f6c3669fd 100644 --- a/api-specs/import/types/type-import.raml +++ b/api-specs/import/types/type-import.raml @@ -22,7 +22,7 @@ types: ResourceTypeId: type: string description: | - With Types, you can model your own Custom Fields on the following resources and data types. Maps to `Type.resourceTypeId`. + IDs indicating the [type of resource](ctp:api:type:ResourceTypeId). Maps to `Type.resourceTypeIds`. enum: - address - asset @@ -56,69 +56,69 @@ types: - transaction (annotations.enumDescriptions): address: | - [Address](/../api/types#address) on [BusinessUnit](/../api/projects/business-units#businessunit), [Cart](/../api/projects/carts#cart), [Order](/../api/projects/orders#order), [OrderEdit](/../api/projects/order-edits#orderedit), [Customer](/../api/projects/customers#customer), and [Channel](/../api/projects/channels#channel) + [Address](ctp:api:type:Address) on [BusinessUnit](ctp:api:type:BusinessUnit), [Cart](ctp:api:type:Cart), [Order](ctp:api:type:Order), [OrderEdit](ctp:api:type:OrderEdit), [Customer](ctp:api:type:Customer), and [Channel](ctp:api:type:Channel) asset: | - [Asset](/../api/types#asset) on [Category](/../api/projects/categories#category) and [ProductVariant](/../api/projects/products#productvariant) + [Asset](ctp:api:type:Asset) on [Category](ctp:api:type:Category) and [ProductVariant](ctp:api:type:ProductVariant) business-unit: | - [BusinessUnit](/../api/projects/business-units#businessunit) + [BusinessUnit](ctp:api:type:BusinessUnit) cart-discount: | - [CartDiscount](/../api/projects/cartDiscounts#cartdiscount) + [CartDiscount](ctp:api:type:CartDiscount) category: | - [Category](/../api/projects/categories#category) + [Category](ctp:api:type:Category) channel: | - [Channel](/../api/projects/channels#channel) + [Channel](ctp:api:type:Channel) custom-line-item: | - [CustomLineItem](/../api/projects/carts#customlineitem) on [Cart](/../api/projects/carts#cart) and [Order](/../api/projects/orders#order) + [CustomLineItem](ctp:api:type:CustomLineItem) on [Cart](ctp:api:type:Cart) and [Order](ctp:api:type:Order) customer: | - [Customer](/../api/projects/customers#customer) + [Customer](ctp:api:type:Customer) customer-group: | - [CustomerGroup](/../api/projects/customerGroups#customergroup) + [CustomerGroup](ctp:api:type:CustomerGroup) discount-code: | - [DiscountCode](/../api/projects/discountCodes#discountcode) + [DiscountCode](ctp:api:type:DiscountCode) inventory-entry: | - [InventoryEntry](/../api/projects/inventory#inventoryentry) + [InventoryEntry](ctp:api:type:InventoryEntry) line-item: | - [LineItem](/../api/projects/carts#lineitem) on [Cart](/../api/projects/carts#cart) and [Order](/../api/projects/orders#order), and [LineItem](/../api/projects/carts#lineitem) on [ShoppingList](/../api/projects/shoppingLists#shoppinglist) + [LineItem](ctp:api:type:LineItem) on [Cart](ctp:api:type:Cart) and [Order](ctp:api:type:Order), and on [ShoppingListLineItem](ctp:api:type:ShoppingListLineItem). order: | - [Cart](/../api/projects/carts#cart) and [Order](/../api/projects/orders#order). - When a [Cart](/../api/projects/carts#cart) is ordered, the [CustomFields](/../api/projects/custom-fields#customfields) need to be copied to the [Order](/../api/projects/orders#order). + [Cart](ctp:api:type:Cart) and [Order](ctp:api:type:Order). + When a [Cart](ctp:api:type:Cart) is ordered, the [CustomFields](/projects/custom-fields#customfields) need to be copied to the [Order](ctp:api:type:Order). For this reason, the Types for Carts are also valid for Orders, and hence both have the same identifier: `order`. order-edit: | - [OrderEdit](/../api/projects/order-edits#orderedit) + [OrderEdit](ctp:api:type:OrderEdit) order-delivery: | - [Delivery](/../api/projects/orders#delivery) + [Delivery](ctp:api:type:Delivery) order-parcel: | - [Parcel](/../api/projects/orders#parcel) + [Parcel](ctp:api:type:Parcel) order-return-item: | - [ReturnItem](/../api/projects/orders#returnitem) + [ReturnItem](ctp:api:type:ReturnItem) payment: | - [Payment](/../api/projects/payments#payment) + [Payment](ctp:api:type:Payment) payment-interface-interaction: | - [InterfaceInteraction](/../api/projects/payments#add-interfaceinteraction) on [Payment](/../api/projects/payments#payment) + [InterfaceInteraction](ctp:api:type:PaymentAddInterfaceInteractionAction) on [Payment](ctp:api:type:Payment) product-price: | [Embedded Price](/../api/types#price) on [ProductVariant](/../api/projects/products#productvariant) product-selection: | - [ProductSelection](/../api/projects/product-selections#productselection) + [ProductSelection](ctp:api:type:ProductSelection) quote: | - [Quote](/../api/projects/quotes#quote), [QuoteRequest](/../api/projects/quote-requests#quoterequest) and [StagedQuote](/../api/projects/staged-quotes#stagedquote). - When a [StagedQuote](/../api/projects/staged-quotes#stagedquote) is created, the [CustomFields](/../api/projects/custom-fields#customfields) will be copied from the [QuoteRequest](/../api/projects/quote-requests#quoterequest) and when a [Quote](/../api/projects/quotes#quote) is created, the [CustomFields](/../api/projects/custom-fields#customfields) will be copied from the [StagedQuote](/../api/projects/staged-quotes#stagedquote). + [Quote](ctp:api:type:Quote), [QuoteRequest](ctp:api:type:QuoteRequest) and [StagedQuote](ctp:api:type:StagedQuote). + When a [StagedQuote](ctp:api:type:StagedQuote) is created, the [CustomFields](/projects/custom-fields#customfields) will be copied from the [QuoteRequest](ctp:api:type:QuoteRequest) and when a [Quote](ctp:api:type:Quote) is created, the [CustomFields](/projects/custom-fields#customfields) will be copied from the [StagedQuote](ctp:api:type:StagedQuote). For this reason, the Types for Quotes are also valid for QuoteRequests and StagedQuotes, and hence all have the same identifier: `quote`. review: | - [Review](/../api/projects/reviews#review) + [Review](ctp:api:type:Review) shipping: | - [Shipping](/../api/projects/carts#shipping) + [Shipping](ctp:api:type:Shipping) shipping-method: | - [ShippingMethod](/../api/projects/shippingMethods#shippingmethod) + [ShippingMethod](ctp:api:type:ShippingMethod) shopping-list: | - [ShoppingList](/../api/projects/shoppingLists#shoppinglist) + [ShoppingList](ctp:api:type:ShoppingList) shopping-list-text-line-item: | - [TextLineItem](/../api/projects/shoppingLists#textlineitem) on [ShoppingList](/../api/projects/shoppingLists#shoppinglist) + [TextLineItem](ctp:api:type:TextLineItem) on [ShoppingList](ctp:api:type:ShoppingList) standalone-price: | - [StandalonePrice](/../api/projects/standalone-prices#standaloneprice) + [StandalonePrice](ctp:api:type:StandalonePrice)) store: | - [Store](/../api/projects/stores#store) + [Store](ctp:api:type:Store) transaction: | - [Transaction](/../api/projects/payments#transaction) on [Payment](/../api/projects/payments#payment) + [Transaction](ctp:api:type:Transaction) on [Payment](ctp:api:type:Payment) FieldType: type: object @@ -133,11 +133,11 @@ types: discriminatorValue: Boolean CustomFieldDateTimeType: type: FieldType - description: Field type for [DateTime](ctp:import:type:DateTime) values. + description: Field type for [DateTime](ctp:api:type:DateTime) values. discriminatorValue: DateTime CustomFieldDateType: type: FieldType - description: Field type for [Date](ctp:import:type:Date) values. + description: Field type for [Date](ctp:api:type:Date) values. discriminatorValue: Date CustomFieldEnumType: type: FieldType @@ -177,11 +177,11 @@ types: description: Descriptive localized label of the value. CustomFieldLocalizedStringType: type: FieldType - description: Field type for [LocalizedString](ctp:import:type:LocalizedString) values. + description: Field type for [LocalizedString](ctp:api:type:LocalizedString) values. discriminatorValue: LocalizedString CustomFieldMoneyType: type: FieldType - description: Field type for [CentPrecisionMoney](ctp:import:type:CentPrecisionMoney) values. + description: Field type for [CentPrecisionMoney](ctp:api:type:CentPrecisionMoney) values. discriminatorValue: Money CustomFieldNumberType: type: FieldType @@ -189,7 +189,7 @@ types: discriminatorValue: Number CustomFieldReferenceType: type: FieldType - description: Field type for [Reference](ctp:import:type:Reference) values. + description: Field type for [Reference](ctp:api:type:Reference) values. discriminatorValue: Reference properties: referenceTypeId: @@ -228,12 +228,12 @@ types: discriminatorValue: String CustomFieldTimeType: type: FieldType - description: Field type for [Time](ctp:import:type:Time) values. + description: Field type for [Time](ctp:api:type:Time) values. discriminatorValue: Time FieldDefinition: description: | - Defines a [Custom Field](/../api/projects/custom-fields) and its meta-information. Maps to `Type.FieldDefinition`. + Defines a [Custom Field](/projects/custom-fields) and its meta-information. Maps to `Type.FieldDefinition`. properties: type: type: FieldType @@ -256,12 +256,12 @@ types: TypeImport: description: | - The data representation for a Type to be imported that is persisted as a [Type](/../api/projects/types#type) in the Project. + The data representation for a Type to be imported that is persisted as a [Type](ctp:api:type:Type) in the Project. type: common.ImportResource properties: key: description: | - User-defined unique identifier for the Type. If a [Type](/../api/projects/types#type) with this `key` exists, it will be updated with the imported data. + User-defined unique identifier for the Type. If a [Type](ctp:api:type:Type) with this `key` exists, it will be updated with the imported data. type: string pattern: ^[A-Za-z0-9_-]+$ minLength: 2