Elastic Path Commerce Cloud
    • PXM Products/
    PXM Product Export/
    Overview

    Export PXM Products Overview

    The Export API in PXM is available to make bulk updates to products in PXM. You might also export products for your personal requirements. See EP PXM Bulk Product Update.

    Characteristics of Exporting Products

    • Product exports are an asynchronous operation. When you send a request to the Export API, it triggers an asynchronous job to build the .csv file containing the product entries.
    • The Export API response includes a job resource. In the Job endpoint response, you can verify the job status; if the status is successful, the response includes a link to the location where the .csv file is stored. See Get a Job.
    • You cannot export product bundles.

    A single CSV file contains 50,000 rows, excluding the header. If you are exporting 100,000 products, the job endpoint response contains links to two .csv files; each .csv file including 50,000 products.

    Exporting Product Attributes

    You might have specified custom product attributes in the .csv file when you imported the products. These modifications are all exported. So, when you send a request to the Export API, the .csv file, included in the Job endpoint response, reflects the changes that you have made. The Export API supports the following product attributes:

    • name
    • sku
    • slug
    • commodity_type
    • description
    • status
    • mpn
    • upc_ean
    • main_image_id
    • template.flowslug.fieldslug

    Using Filters

    The Export API supports the following filters:

    OperatorDescriptionSupported Attributes
    EqChecks if the values of two operands are equal. If they are, the condition is true.sku, slug, upc_ean, mpn, name, description
    inChecks if the values are included in the specified string. If they are, the condition is true. Wildcards are supported.sku

    For more information, see Filtering in pcm/products.

    Example File

    The Job endpoint response specifies the location where the .csv file is stored. The .csv file includes the following:

    • Each row after the first line represents a single product.
    • For long strings, such as lengthy descriptions, quotes " " are used.
    • After each value, a single comma , is used to indicate the start of the next field.

    For more information, see PXM Product Import CSV File.

    POST Export Products in PXM

    https://api.moltin.com/pcm/products/export

    Export catalog data to manage product data.

    Path Parameters

    Headers

    NameRequiredTypeDescription
    AuthorizationRequiredstringThe Bearer token required to get access to the API.

    Request Example

    curl -X POST https://api.moltin.com/pcm/products/export \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer XXXX" \

    Response Example

    200 OK

    {
    "data": {
        "type": "pim-job",
        "id": "7d0689ea-baf1-4817-ba9e-8ae73199ca8d",
        "attributes": {
            "created_at": "2022-11-15 13:39:09.703613777 +0000 UTC m=+15658.529150276",
            "status": "pending",
            "type": "product-export",
            "updated_at": "2022-11-15 13:39:09.703613777 +0000 UTC m=+15658.529150276"
        },
        "meta": {
            "file_locations": null,
            "filter": "eq(sku,doom-1)"
        }
    }
}

    Was this helpful?

    Next
    Export PXM Products in Commerce Manager→