List Import Jobs

List import jobs

GET/inventories/imports

Use it in a workflow

Add a step and choose the Elastic Path connector.
Pick the List Import Jobs action (under Inventory).
Fill in the fields below, then reference the result from later steps as {{listImportJobs.response.data}}.

Request

Query parameters

filterstring (string)

Some Inventories API endpoints support filtering. For the general syntax, see [**Filtering**](/guides/Getting-Started/filtering), but you must go to a specific endpoint to understand the attributes and operators an endpoint supports.

page[offset]integer (int)

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**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.

page[limit]integer (int)

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**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.

Response

Returns 200 with an object. Read it in later steps with {{listImportJobs.response.data.<field>}}.

dataarray<object>

idstringrequired

The unique identifier.

typestringrequired

One ofinventories_import

attributesobjectrequired2 fields

metaobjectrequired2 fields

linksobject

json

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "type": "inventories_import",
      "attributes": {
        "status": "pending",
        "external_ref": "abc123"
      },
      "meta": {
        "timestamps": null,
        "records": {
          "uploaded": {
            "stock": 50000
          },
          "imported": {
            "stock": 50000
          }
        }
      }
    }
  ],
  "links": {}
}

Need more? See the Elastic Path guide for connection setup and behaviour shared by every action.

Was this page helpful?