{ "opencollection": "1.0.0", "info": { "name": "Addresses Introduction Account Addresses Imports API", "version": "25.1126.6886238" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Imports", "type": "folder" }, "items": [ { "info": { "name": "List import jobs", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/inventories/imports", "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**](https://elasticpath.dev/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 the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used." } ] }, "docs": "Retrieves a list of all import jobs.\n" }, { "info": { "name": "Import a dataset", "type": "http" }, "http": { "method": "POST", "url": "https://useast.api.elasticpath.com/inventories/imports", "body": { "type": "multipart-form", "data": [ { "name": "external_ref", "type": "text", "value": "" }, { "name": "import_file", "type": "text", "value": "" } ] } }, "docs": "Import a dataset" }, { "info": { "name": "Get import", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/inventories/imports/:import_uuid", "params": [ { "name": "import_uuid", "value": "", "type": "path", "description": "The unique identifier of the import." }, { "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**](https://elasticpath.dev/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 the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used." } ] }, "docs": "Retrieves the import job for the specified ID." }, { "info": { "name": "Get import errors", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/inventories/imports/:import_uuid/errors", "params": [ { "name": "import_uuid", "value": "", "type": "path", "description": "The unique identifier of the import." }, { "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**](https://elasticpath.dev/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 the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used." } ] }, "docs": "Retrieves all errors encountered as part of the import. Each error is attributed to a line in the JSONL file \nimported, so for example, if at line 1 in your JSONL you had a stock without locations, there would\nbe a missing key error for locations.\n\nErrors are also ordered by line number ascending, and can be paginated.\n" }, { "info": { "name": "List import jobs", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/v2/subscriptions/imports", "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 import jobs.\n" }, { "info": { "name": "Import a dataset", "type": "http" }, "http": { "method": "POST", "url": "https://useast.api.elasticpath.com/v2/subscriptions/imports", "params": [ { "name": "filter", "value": "", "type": "query" } ], "body": { "type": "multipart-form", "data": [ { "name": "external_ref", "type": "text", "value": "" }, { "name": "import_file", "type": "text", "value": "" } ] } }, "docs": "Import a dataset" }, { "info": { "name": "Get import", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/v2/subscriptions/imports/:import_uuid", "params": [ { "name": "import_uuid", "value": "", "type": "path", "description": "The unique identifier of the import." }, { "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 the import job for the specified ID." }, { "info": { "name": "Get import errors", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/v2/subscriptions/imports/:import_uuid/errors", "params": [ { "name": "import_uuid", "value": "", "type": "path", "description": "The unique identifier of the import." }, { "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 all errors encountered as part of the import. Each error is attributed to a line in the JSONL file \nimported, so for example, if at line 1 in your JSONL you had a subscription_offering without a name, there would\nbe a minimum string error for the `name` attribute with `\"line_number\": 1`.\n\nErrors are also ordered by line number ascending, and can be paginated.\n" } ] } ], "bundled": true }