Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Elastic Path Imports API

You can import stock positions for up to 50,000 products in a single operation via an import. This is useful for synchronosing external systems with Elastic Path.The API uses a [**JSONL**](https://jsonlines.org/) file, with one line per product. For each product one specifies the total stock in each location. For example```{"data":{"type":"stock","id":"b36ba644-6fdc-49b3-9ebb-410ed34908a8","attributes":{"locations":{"vancouver":{"total":20}}}}}{"data":{"type":"stock","id":"2e5a4c7b-6f88-4aad-a3c2-4d8b29bc32a4","attributes":{"locations":{"vancouver":{"total":54},"denver":{"total":1},"boston":{"total":20},"portland":{"total":100}}}}}```### Characteristics of Inventories ImportThe Inventories Import API has the following characteristics:- The Inventories Import API reads the entire file and then updates the inventory.- Inventories imports are asynchronous and are processed one at a time. You can continue to send import requests, but these are queued. - If a product in an import does not already exist in the inventories database it will be created.

Elastic Path Imports API is one of 100 APIs that Elastic Path publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Imports. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 8 operations across 6 paths, and defines 31 schemas. It is described by OpenAPI 3.1.0, at version 25.1126.6886238.

Requests are made against 2 base URLs: https://useast.api.elasticpath.com, https://euwest.api.elasticpath.com.

8 operations 6 paths 31 schemas 6 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
25.1126.6886238
Base URL
https://useast.api.elasticpath.com
Authentication
HTTP Bearer
License
Resource Areas
1

Authentication & Security 1

Elastic Path Imports API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerToken). By default, every request must be authenticated.

Paths & Operations 8

Across 6 paths, the API surfaces 8 operations — 6 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Imports 8

You can import stock positions for up to 50,000 products in a single operation via an import. This is useful for synchronosing external systems with Elastic Path. The API uses a […

POST
/inventories/imports
Import a dataset
CreateImport body → 201400500
GET
/inventories/imports
List import jobs
ListImportJobs 3 params → 200500
GET
/inventories/imports/{import_uuid}
Get import
GetImport 3 params → 200400404500
GET
/inventories/imports/{import_uuid}/errors
Get import errors
GetImportErrors 3 params → 200404500
POST
/v2/subscriptions/imports
Import a dataset
CreateImport 1 param body → 201400409500
GET
/v2/subscriptions/imports
List import jobs
ListImportJobs 3 params → 200500
GET
/v2/subscriptions/imports/{import_uuid}
Get import
GetImport 3 params → 200400404500
GET
/v2/subscriptions/imports/{import_uuid}/errors
Get import errors
GetImportErrors 3 params → 200404500

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are SubscriptionImportErrorMeta (6 properties), InventoriesImportErrorMeta (5 properties), Import_2 (4 properties), Import (4 properties). Each schema is shown below with its type and property counts.

Error_2
object
4 properties 2 required
Timestamps_2
object
2 properties 2 required
InventoriesImportError
object
3 properties 3 required
Timestamps
object
2 properties 1 required
ImportAttributes
object
2 properties 1 required
Link
Error
object
4 properties 2 required
ImportRecords
object
You can track the number of records imported to ensure the completeness, accuracy and integrity of the import. Uploaded shows the number of records ready to be…
2 properties 2 required
InventoriesImportErrorType
string
ErrorResponse
object
1 property 1 required
Import
object
4 properties 4 required
ImportAttributes_2
object
2 properties 1 required
Links
object
SubscriptionImportErrorType
string
LinkObject
object
3 properties
InventoriesImportErrorMeta
object
5 properties 4 required
InventoriesImportType
string
SubscriptionImportType
string
ImportMeta
object
2 properties 2 required
ImportRecords_2
object
You can track the number of records imported to ensure the completeness, accuracy and integrity of the import. Uploaded shows the number of records ready to be…
2 properties 2 required
UUID
string
The unique identifier.
LinkURI
string
OwnerMeta
string
The owner of a resource, either store or organization.
SubscriptionImportError
object
3 properties 3 required
Import_2
object
4 properties 3 required
UUID_2
string
The unique identifier.
JobTimestamps
SubscriptionImportErrorMeta
object
6 properties 5 required
ImportMeta_2
object
3 properties 3 required
ExternalRef
string
A unique attribute that you could use to contain information from another company system, for example. The maximum length is 2048 characters.
ErrorResponse_2
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elastic-path-imports-api-openapi.yml Raw ↑

Other APIs Elastic Path publishes across the network.

Elastic Path GraphQL API
Elastic Path Account Addresses API
Elastic Path Account Authentication Settings API
Elastic Path Account Cart Associations API
Elastic Path Account Management Authentication API
Elastic Path Account Members API
Elastic Path Account Membership API
Elastic Path Account Membership Settings API
Elastic Path Account Tags API
Elastic Path Accounts API
Elastic Path Administrator Latest Releases Catalog API API
Elastic Path Application Keys API