younifyd
Menu

Export Products

Export Products

POST/pcm/products/export

Use it in a workflow

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

Request

Query parameters

useTemplateSlugsboolean

Set to `true` if you want to use a template slug instead of a template ID when exporting products that have custom data.

Default false

filterstring

Many Commerce API endpoints support filtering. The general syntax is described [**here**](/guides/Getting-Started/filtering), but you must go to a specific endpoint to understand the attributes and operators an endpoint supports. For more information about the attributes and operators that this endpoint supports, see [Export Products](/docs/api/pxm/products/export-products).

Request body

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

dataobject
attributesobject1 fields
typestringrequired
json
{
  "data": {
    "type": "product-export",
    "attributes": {
      "columns": {
        "include": [
          "string"
        ]
      }
    }
  }
}

Response

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

dataobject
idstringrequired

A unique identifier generated when a job is created.

typestringrequired

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

One ofpim-job

attributesobjectrequired6 fields
metaobjectrequired5 fields
json
{
  "data": {
    "id": "string",
    "type": "pim-job",
    "attributes": {
      "started_at": "2020-09-22T09:00:00.000Z",
      "completed_at": "2020-09-22T09:00:00.000Z",
      "created_at": "2020-09-22T09:00:00.000Z",
      "updated_at": "2020-09-22T09:00:00.000Z",
      "type": "child-products",
      "status": "pending"
    },
    "meta": {
      "x_request_id": "string",
      "copied_from": "string",
      "hierarchy_id": "string",
      "file_locations": [
        "string"
      ],
      "filter": "string"
    }
  }
}

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