younifyd
Menu

Create Import

Import a dataset

POST/inventories/imports

Use it in a workflow

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

Request

Request body

Enter the body as JSON in the step's Body field.

external_refstring

A unique attribute that you could use to contain information from another company system, for example. The maximum length is 2048 characters.

import_filestring (binary)required

The JSONL file you want to upload.

json
{
  "import_file": "string",
  "external_ref": "abc123"
}

Response

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

dataobject
idstringrequired

The unique identifier.

typestringrequired

One ofinventories_import

attributesobjectrequired2 fields
metaobjectrequired2 fields
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
        }
      }
    }
  }
}

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