List import jobs

GET 
https://euwest.api.elasticpath.com/v2/inventories/imports

Retrieves a list of all import jobs.

Request

Query Parameters

filter string
page[offset] int

Possible values: >= 0 and <= 10000

The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the page length store setting is used.

page[limit] int

Possible values: >= 0

The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the the page length store setting is used.

Responses

200

Success. A list of import jobs is returned.

application/json

Schema

Schema

data Import[]
Array [
idUUID (string)required
The unique identifier.
Example: 00000000-0000-0000-0000-000000000000
typeInventoriesImportType (string)required
Possible values: [inventories_import]
Example: inventories_import
attributes ImportAttributesrequired
external_refExternalRef (string)
A unique attribute that you could use to contain information from another company system, for example. The maximum length is 2048 characters.
Possible values: <= 2048 characters
Example: abc123
statusstringrequired
The status of job.
• pending - Commerce has received the request but is currently busy processing other requests.
• started - Commerce has started processing the job.
• success - The job has successfully completed.
• failed - The job has failed.
Possible values: [pending, started, success, failed]
Example: pending
meta ImportMetarequired
timestamps JobTimestamps
updated_atstring
The date and time a resource was updated.
Example: 2017-01-10T11:41:19.244842Z
created_atstringrequired
The date and time a resource was created.
Example: 2017-01-10T11:41:19.244842Z
started_atstring
The date and time a job is started.
Example: 2017-01-10T11:41:19.244842Z
finished_atstring
The date and time a job finished.
Example: 2017-01-10T11:41:19.244842Z
records objectrequired
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 imported. However, this does not mean they are valid objects, only that they have the correct type and their JSON format is properly formatted. Imported shows the number of records that have been both validated and successfully added.
uploaded objectrequired
stockintegerrequired
The total number of product transactions uploaded.
Example: 50000
imported required
stockintegerrequired
The total number of product transactions uploaded.
Example: 50000
]
links object
property name* Link
anyOf
LinkURI
stringnullable
Example: http://example.com/articles/1/comments
LinkObject
hrefstring<uri>
Example: http://example.com/articles/1/comments
titlestring
Example: Comments
describedbystring<uri>
Example: http://example.com/schemas/article-comments

Example (auto)

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "type": "inventories_import",
      "attributes": {
        "external_ref": "abc123",
        "status": "pending"
      },
      "meta": {
        "timestamps": {
          "updated_at": "2017-01-10T11:41:19.244842Z",
          "created_at": "2017-01-10T11:41:19.244842Z",
          "started_at": "2017-01-10T11:41:19.244842Z",
          "finished_at": "2017-01-10T11:41:19.244842Z"
        },
        "records": {
          "uploaded": {
            "stock": 50000
          },
          "imported": {
            "stock": 50000
          }
        }
      }
    }
  ],
  "links": {}
}

500

Internal server error. There was a system failure in the platform.

application/json

Schema

Schema

errors object[]required
Array [
statusstringrequired
The HTTP response code of the error.
Example: 500
titlestringrequired
A brief summary of the error.
Example: Internal server error
detailstring
Optional additional detail about the error.
Example: An internal error has occurred.
metaobject
Additional supporting meta data for the error.
Example: {"missing_ids":["e7d50bd5-1833-43c0-9848-f9d325b08be8"]}
]

Example (auto)

{
  "errors": [
    {
      "status": 500,
      "title": "Internal server error",
      "detail": "An internal error has occurred.",
      "meta": {
        "missing_ids": [
          "e7d50bd5-1833-43c0-9848-f9d325b08be8"
        ]
      }
    }
  ]
}

internal-server-error

{
  "errors": [
    {
      "title": "Internal Server Error",
      "status": "500"
    }
  ]
}

Authorization: http

name: bearerAuthtype: httpscheme: bearer

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://euwest.api.elasticpath.com/v2/inventories/imports");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://euwest.api.elasticpath.com/v2

Auth

Bearer Token

Parameters

filter — query

page[offset] — query

page[limit] — query

ResponseClear

Click the Send API Request button above and see the response here!