Create Job

POST/v2/jobs

Use it in a workflow

Add a step and choose the Elastic Path connector.
Pick the Create Job action (under Exporter).
Fill in the fields below, then reference the result from later steps as {{createJob.response.data}}.

Fields

baseUrlstring

The API host this action calls. Choose one, or pick Custom to enter your own.

One ofhttps://api.moltin.comhttps://useast.api.elasticpath.com__custom__Default "https://api.moltin.com"

baseUrlCustomstring

bodystring

The request body content (for POST, PUT, PATCH requests).

forwardAllHeadersboolean

If enabled, all headers from the incoming request will be forwarded. Additional headers below will override forwarded ones.

Default false

headerskeyvalue

Extra HTTP headers to include, beyond what this action already declares. These override forwarded or declared headers with the same name.

queryParamskeyvalue

Extra URL query parameters to include, beyond what this action already declares. These override declared query parameters with the same name.

Response

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

dataarray<object>

idstring (uuid)

A unique ID generated when a job is created.

typestring

This represents the type of object being returned. Always `job`.

job_typestring

This represents the type of job. For example, `order_export`.

statusstring

The status of a 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.

errorstring

A message describing the error that caused a job to fail.

timestampsobject2 fields

The date and time a job is created/updated.

linksobject1 fields

Links are used to allow you to move between requests

linkobject1 fields

A link to the exported data.

json

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "type": "job",
      "job_type": "order_export",
      "status": "failed",
      "error": "No results matched the supplied filter",
      "timestamps": {
        "created_at": "2018-10-04T11:08:49.156490335Z",
        "updated_at": "2018-10-04T11:08:49.162867081Z"
      },
      "links": {
        "self": "https://useast.api.elasticpath.com/v2/jobs/974c9db4-38da-4dbf-90c2-33eed5f3e77c"
      },
      "link": {
        "href": "string"
      }
    }
  ]
}

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

Was this page helpful?