{
  "opencollection": "1.0.0",
  "info": {
    "name": "Addresses Introduction Account Addresses Jobs API",
    "version": "25.1126.6886238"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Jobs",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Reindex all releases for tenant",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://useast.api.elasticpath.com/pcm/catalogs/reindex-releases",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new job to reindex all releases for the tenant."
        },
        {
          "info": {
            "name": "Get All Jobs",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://useast.api.elasticpath.com/v2/jobs"
          },
          "docs": "You can use this endpoint to display the status of your jobs."
        },
        {
          "info": {
            "name": "Create Job",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://useast.api.elasticpath.com/v2/jobs",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a Job to export orders to a CSV file. Jobs automatically expire one week after creation. You must fetch the exported data before the jobs expire."
        },
        {
          "info": {
            "name": "Get a Job",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://useast.api.elasticpath.com/v2/jobs/:jobID",
            "params": [
              {
                "name": "jobID",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the requested job."
              }
            ]
          },
          "docs": "Retrieves the specified job."
        },
        {
          "info": {
            "name": "Get a Job File",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://useast.api.elasticpath.com/v2/jobs/:jobID/file",
            "params": [
              {
                "name": "jobID",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the job whose CSC file you want to retrieve."
              }
            ]
          },
          "docs": "Retrieves a link to the CSV file that contains your exported order."
        },
        {
          "info": {
            "name": "Get All Jobs",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://useast.api.elasticpath.com/pcm/jobs"
          },
          "docs": "The jobs endpoints displays the status of a number of endpoints that function as jobs, for example, product import and export, price book import, building child products, and duplicating hierarchies."
        },
        {
          "info": {
            "name": "Get a Job",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://useast.api.elasticpath.com/pcm/jobs/:jobID",
            "params": [
              {
                "name": "jobID",
                "value": "",
                "type": "path",
                "description": "A unique identifier for the job."
              }
            ]
          },
          "docs": "Get a Job"
        },
        {
          "info": {
            "name": "Cancel a Job",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://useast.api.elasticpath.com/pcm/jobs/:jobID/cancel",
            "params": [
              {
                "name": "jobID",
                "value": "",
                "type": "path",
                "description": "A unique identifier for the job."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "The jobs endpoints display the status of a number of endpoints that function as jobs, for example, product import and export, and duplicating hierarchies.\n\nJobs are processed one at a time. You can continue to send job requests, but those jobs are queued. In other words, Commerce looks for any jobs that have a status of PENDING and starts the job with the earliest created date. If you decide that a specific job needs to be prioritized over another, you can cancel the less critical job using the "
        },
        {
          "info": {
            "name": "Get Job Errors",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://useast.api.elasticpath.com/pcm/jobs/:jobID/errors",
            "params": [
              {
                "name": "jobID",
                "value": "",
                "type": "path",
                "description": "A unique identifier for the job."
              }
            ]
          },
          "docs": "Get Job Errors"
        },
        {
          "info": {
            "name": "List jobs",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://useast.api.elasticpath.com/v2/subscriptions/jobs",
            "params": [
              {
                "name": "filter",
                "value": "",
                "type": "query"
              },
              {
                "name": "page[offset]",
                "value": "",
                "type": "query",
                "description": "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](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used."
              },
              {
                "name": "page[limit]",
                "value": "",
                "type": "query",
                "description": "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 [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used."
              }
            ]
          },
          "docs": "Retrieves a list of all jobs.\n\n### Filtering\n\nThis endpoint supports filtering. For the general syntax, see [**Filtering**](/guides/Getting-Started/filtering).\n\nThe following attributes and operators are supported.\n\n| Operator | Attribute | Description |\n| --- | --- | --- | \n| `eq` | `external_ref` | Equals. Checks if the values of two operands are equal. If they are, the condition is true. |\n| `in` | `external_ref` | In. Checks if the value is in the specified list. If it is, the condition is t"
        },
        {
          "info": {
            "name": "Create a job",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://useast.api.elasticpath.com/v2/subscriptions/jobs",
            "params": [
              {
                "name": "filter",
                "value": "",
                "type": "query"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a job"
        },
        {
          "info": {
            "name": "Get job",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://useast.api.elasticpath.com/v2/subscriptions/jobs/:job_uuid",
            "params": [
              {
                "name": "job_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the job."
              }
            ]
          },
          "docs": "Get job"
        },
        {
          "info": {
            "name": "Delete job",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://useast.api.elasticpath.com/v2/subscriptions/jobs/:job_uuid",
            "params": [
              {
                "name": "job_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the job."
              }
            ]
          },
          "docs": "Delete job"
        }
      ]
    }
  ],
  "bundled": true
}