Import Containers

An Import Container is the entry point of the Import API requests and serves as a data container for asynchronous API calls.

Every create, update, or patch request sent to the Import API is first accumulated in an Import Container and then asynchronously imported into commercetools Composable Commerce. For more information on using Import Containers effectively for your requirements, see best practices.

Representations

ImportContainer

ImportContainerDraft

ImportContainerUpdateDraft

ImportResourceType

ImportContainerPagedResponse

ImportContainer

Serves as the entry point of resources. An Import Container is not resource type-specific.

`version` Int	The version of the ImportContainer.
`key` String	User-defined unique identifier for the ImportContainer. Keys can only contain alphanumeric characters (a-Z, 0-9), underscores and hyphens (_, -).
`resourceType` ImportResourceType	The resource type the ImportContainer is able to handle. If not present, the ImportContainer is able to import all of the supported ImportResourceTypes.
`createdAt` DateTime	The time when the ImportContainer was created.
`lastModifiedAt` DateTime	The last time when the ImportContainer was modified.

Example: minimaljson

{
  "key" : "my-import-container",
  "version" : 1,
  "createdAt" : "2018-02-05T09:47:16.648Z",
  "lastModifiedAt" : "2018-02-05T09:47:16.649Z"
}

ImportContainerDraft

The representation sent to the server when creating an ImportContainer.

`key` String	User-defined unique identifier of the ImportContainer. Keys can only contain alphanumeric characters (a-Z, 0-9), underscores and hyphens (_, -).
`resourceType` ImportResourceType	The resource type to be imported. If not given, the ImportContainer is able to import all of the supported ImportResourceTypes.

Example: minimaljson

{
  "key" : "my-import-container"
}

ImportContainerUpdateDraft

The representation sent to the server when updating an import container.

`version` Int	Current version of the ImportContainer.
`resourceType` ImportResourceType	The resource type to be imported. If not given, the ImportContainer is able to import all of the supported ImportResourceTypes.

Example: minimaljson

{
  "version" : 1,
  "resourceType" : "product"
}

ImportResourceType

The resource types that can be imported.

category: The Category import resource type.
order: The Order import resource type.
order-patch: The Order patch import resource type.
price: The Embedded Price import resource type.
product: The Product import resource type.
product-draft: The Product draft import resource type.
product-type: The Product Type import resource type.
product-variant: The Product Variant import resource type.
product-variant-patch: The Product Variant patch resource type.
customer: The Customer import resource type.
inventory: The Inventory import resource type.
standalone-price: The Standalone Price import resource type.
type

ImportContainerPagedResponse

PagedQueryResult for ImportContainers. Used as a response to a query request for ImportContainers.

`limit` Int	Number of results requested.
`offset` Int	Number of elements skipped.
`count` Int	The actual number of results returned.
`total` Int	The total number of results matching the query.
`results` Array of ImportContainer	The array of Import Containers matching the query.

Get ImportContainer

GET

https://import.{region}.commercetools.com/{projectKey}/import-containers/{importContainerKey}

Retrieves the import container given by the key.

OAuth 2.0 Scopes:

manage_import_containers:{projectKey}, view_import_containers:{projectKey}

Path parameters:

`region` String	The Region in which the Project is hosted.
`projectKey` String	The Project key.
`importContainerKey` String	The key of the import container.

Response:

200ImportContainer

Request Example:cURL

curl --get https://import.{region}.commercetools.com/{projectKey}/import-containers/{importContainerKey} -i \
--header 'Authorization: Bearer ${BEARER_TOKEN}'

200 Response Example: ImportContainerjson

{
  "key" : "my-import-container",
  "version" : 1,
  "createdAt" : "2018-02-05T09:47:16.648Z",
  "lastModifiedAt" : "2018-02-05T09:47:16.649Z"
}

Query ImportContainers

GET

https://import.{region}.commercetools.com/{projectKey}/import-containers

Retrieves all import containers of a given project key.

OAuth 2.0 Scopes:

manage_import_containers:{projectKey}, view_import_containers:{projectKey}

Path parameters:

`region` String	The Region in which the Project is hosted.
`projectKey` String	The Project key.

Query parameters:

`sort` String	See Sorting. The parameter can be passed multiple times.
`limit` Float	Number of results requested.
`offset` Float	Number of elements skipped.

Response:

200ImportContainerPagedResponse

Request Example:cURL

curl --get https://import.{region}.commercetools.com/{projectKey}/import-containers -i \
--header 'Authorization: Bearer ${BEARER_TOKEN}'

Create ImportContainer

POST

https://import.{region}.commercetools.com/{projectKey}/import-containers

Creates a new import container.

OAuth 2.0 Scopes:

manage_import_containers:{projectKey}

Path parameters:

`region` String	The Region in which the Project is hosted.
`projectKey` String	The Project key.

Request Body:ImportContainerDraftasapplication/json

Response:

201ImportContainerasapplication/json

201 Response Example: ImportContainerjson

{
  "key" : "my-import-container",
  "version" : 1,
  "createdAt" : "2018-02-05T09:47:16.648Z",
  "lastModifiedAt" : "2018-02-05T09:47:16.649Z"
}

Update ImportContainer

PUT

https://import.{region}.commercetools.com/{projectKey}/import-containers/{importContainerKey}

Updates the import container given by the key.

OAuth 2.0 Scopes:

manage_import_containers:{projectKey}

Path parameters:

`region` String	The Region in which the Project is hosted.
`projectKey` String	The Project key.
`importContainerKey` String	The key of the import container.

Request Body:ImportContainerUpdateDraftasapplication/json

Response:

200ImportContainerasapplication/json

200 Response Example: ImportContainerjson

{
  "key" : "my-import-container",
  "version" : 1,
  "createdAt" : "2018-02-05T09:47:16.648Z",
  "lastModifiedAt" : "2018-02-05T09:47:16.649Z"
}

Delete ImportContainer

DELETE

https://import.{region}.commercetools.com/{projectKey}/import-containers/{importContainerKey}

Deletes the import container given by the key.

OAuth 2.0 Scopes:

manage_import_containers:{projectKey}

Path parameters:

`region` String	The Region in which the Project is hosted.
`projectKey` String	The Project key.
`importContainerKey` String	The key of the import container.

Response:

200ImportContainer

Request Example:cURL

curl -X DELETE https://import.{region}.commercetools.com/{projectKey}/import-containers/{importContainerKey} -i \
--header 'Authorization: Bearer ${BEARER_TOKEN}'

200 Response Example: ImportContainerjson

{
  "key" : "my-import-container",
  "version" : 1,
  "createdAt" : "2018-02-05T09:47:16.648Z",
  "lastModifiedAt" : "2018-02-05T09:47:16.649Z"
}