Pagination

Pagination is used to move through pages of results.

Example:

{
    "page": 1,
    "perPage": 5,
    "total": "30",
    "data": [
        {
            "accountSlug": "montecarlo",
            "label": "fabric",
            "internalName": "style type",
            "description": "this is style code type property",
            "isUnique": "no",
            "fieldType": "multi_select",
            "options": [
                "rock",
                "classy"
            ],
            "scope": [
                "order"
            ],
            "createdAt": "2020-03-09T11:46:20.645Z",
            "updatedAt": "2020-03-13T06:57:05.981Z"
        },
        {
            "accountSlug": "montecarlo",
            "label": "fabric",
            "internalName": "fabric",
            "description": "type of fabric used in a dress",
            "isUnique": "no",
            "fieldType": "single_select",
            "options": [
                "silk",
                "cotton"
            ],
            "scope": [
                "product"
            ],
            "createdAt": "2020-03-09T04:58:34.645Z",
            "updatedAt": "2020-03-09T04:58:34.645Z"
        },
        {
            "accountSlug": "montecarlo",
            "label": "Season",
            "internalName": "xyz",
            "description": "qwerty-new",
            "isUnique": "yes",
            "fieldType": "long_text",
            "scope": [
                "product"
            ],
            "createdAt": "2020-03-07T05:59:05.346Z",
            "updatedAt": "2020-03-11T12:17:53.431Z"
        },
        {
            "accountSlug": "montecarlo",
            "label": "Size",
            "internalName": "fashionu544cgf",
            "isUnique": "no",
            "fieldType": "short_text",
            "scope": [
                "product"
            ],
            "createdAt": "2020-02-28T09:10:34.472Z",
            "updatedAt": "2020-03-11T12:18:47.048Z"
        },
        {
            "accountSlug": "montecarlo",
            "label": "fashiontype",
            "internalName": "fashionu54cgf",
            "isUnique": "no",
            "fieldType": "short_text",
            "scope": [
                "product"
            ],
            "createdAt": "2020-02-28T09:10:20.308Z",
            "updatedAt": "2020-02-28T09:10:20.308Z"
        }
    ]
}

Page includes information about the current page i.e Page Number of current Page. The default value for the Page in each API is 1.

PerPage includes information about the no of records in the current page. The default value for perPage in each API is 25.

Total defines the total number of records for the applied set of filters.

Data includes information about the whole result set.i.e.List of Records

Pagination fields will never be omitted from a listing response, even if there are no results.

You can, therefore, easily paginate resources using page[offset] and page[limit] query string parameters on most top-level endpoints. Both of these values are integers.

Get all Import Jobs

GET https://{{accountSlug}}.myeshopbox.com/api/platform/v1/import-job?page=1&per_page=10

This endpoint allows you to get all import jobs.

Headers

Name	Type	Description
Authorization	string	The Bearer token to grant access to the API.

200 Import Jobs successfully retrieved.

{
    "result": 1614,
    "perPage": 10,
    "page": 1,
    "data": [
        {
            "filePath": "https://cdn.filestackcontent.com/ZDcGB6WQXGqJq5Hb9y81",
            "userName": "[e-mail]",
            "userId": "70",
            "createdAt": "2019-12-11T17:09:22.000Z",
            "id": "1820",
            "jobType": "base.product",
            "channelId": "0",
            "status": "0",
            "updatedAt": "2019-12-11T17:09:22.000Z"
        },
        {
            "filePath": "https://cdn.filestackcontent.com/ZDcGB6WQXGqJq5Hb9y81",
            "userName": "[e-mail]",
            "userId": "70",
            "createdAt": "2019-12-11T17:11:35.000Z",
            "id": "1821",
            "jobType": "base.product",
            "channelId": "0",
            "status": "0",
            "updatedAt": "2019-12-11T17:11:35.000Z"
        },
        {
            "filePath": "https://cdn.filestackcontent.com/ZDcGB6WQXGqJq5Hb9y81",
            "additionalDetails": "this is temporary",
            "userName": "[e-mail]",
            "userId": "70",
            "createdAt": "2019-12-11T17:19:06.000Z",
            "id": "1822",
            "jobType": "base.product",
            "channelId": "0",
            "status": "0",
            "updatedAt": "2019-12-17T16:15:41.000Z"
        },
        {
            "filePath": "https://storage.googleapis.com/test-auperator-cloud/sample_product_template_1_114.csv",
            "userName": "[e-mail]",
            "userId": "70",
            "createdAt": "2019-12-17T17:08:14.000Z",
            "id": "1823",
            "jobType": "base.product",
            "channelId": "0",
            "status": "0",
            "updatedAt": "2019-12-17T17:08:14.000Z"
        },
        {
            "filePath": "https://storage.googleapis.com/test-auperator-cloud/sample_product_template_1_1143.csv",
            "userName": "[e-mail]",
            "userId": "70",
            "createdAt": "2019-12-18T08:16:17.000Z",
            "id": "1824",
            "jobType": "base.product",
            "channelId": "0",
            "status": "0",
            "updatedAt": "2019-12-18T08:16:17.000Z"
        },
        {
            "filePath": "https://storage.googleapis.com/uniware-inventory-test-dataflow/Demo_CSV_HSN.csv",
            "userName": "[e-mail]",
            "userId": "70",
            "createdAt": "2019-12-18T13:51:42.000Z",
            "id": "1825",
            "jobType": "base.product",
            "channelId": "0",
            "status": "0",
            "updatedAt": "2019-12-18T13:51:42.000Z"
        },
        {
            "filePath": "https://storage.googleapis.com/uniware-inventory-test-dataflow/Demo_CSV_HSN.csv",
            "userName": "[e-mail]",
            "userId": "70",
            "createdAt": "2019-12-18T16:48:59.000Z",
            "id": "1826",
            "jobType": "base.product",
            "channelId": "0",
            "status": "0",
            "updatedAt": "2019-12-18T16:48:59.000Z"
        },
        {
            "filePath": "https://storage.googleapis.com/uniware-inventory-test-dataflow/Demo_CSV_HSN.csv",
            "userName": "[e-mail]",
            "userId": "70",
            "createdAt": "2019-12-18T16:58:27.000Z",
            "id": "1827",
            "jobType": "base.product",
            "channelId": "0",
            "status": "0",
            "updatedAt": "2019-12-18T16:58:27.000Z"
        },
        {
            "filePath": "https://storage.googleapis.com/test-auperator-cloud/sample_product_template_1_114675.csv",
            "userName": "[e-mail]",
            "userId": "70",
            "createdAt": "2019-12-18T17:31:05.000Z",
            "id": "1828",
            "jobType": "base.product",
            "channelId": "0",
            "status": "0",
            "updatedAt": "2019-12-18T17:31:05.000Z"
        },
        {
            "filePath": "https://storage.googleapis.com/uniware-inventory-test-dataflow/Demo_CSV_HSN.csv",
            "userName": "[e-mail]",
            "userId": "70",
            "createdAt": "2019-12-18T17:47:34.000Z",
            "id": "1829",
            "jobType": "base.product",
            "channelId": "0",
            "status": "0",
            "updatedAt": "2019-12-18T17:47:34.000Z"
        }
    ]
}

curl

curl --location --request GET 'localhost:8080/_ah/api/esb/v1/import-job' \
--header 'Content-Type: application/json' \
--header 'Authorization: {{Access-Token}}'

Get all Import Jobs

GET https://{{accountSlug}}.myeshopbox.com/api/platform/v1/import-job?page=2&per_page=10

This endpoint allows you to get all import jobs.

Headers

Name	Type	Description
Authorization	string	The Bearer token to grant access to the API.

200 Import Jobs successfully retrieved.

{
    "result": 1614,
    "page": 2,
    "perPage": 10,
    "data": [
        {
            "filePath": "https://cdn.filestackcontent.com/OHHK4cy2SdSghXP5s2V7",
            "userName": "[e-mail]",
            "userId": "70",
            "createdAt": "2019-12-18T18:41:50.000Z",
            "id": "1830",
            "jobType": "BASE",
            "channelId": "0",
            "status": "0",
            "updatedAt": "2019-12-18T18:41:50.000Z"
        },
        {
            "filePath": "https://cdn.filestackcontent.com/PFtax9TTTLKVFqpaQHcm",
            "additionalDetails": "/pushertabassumpusher.csv",
            "userName": "[e-mail]",
            "userId": "70",
            "createdAt": "2019-12-18T18:49:55.000Z",
            "id": "1831",
            "jobType": "base_product",
            "channelId": "0",
            "status": "1",
            "updatedAt": "2019-12-18T18:49:55.000Z"
        },
        {
            "filePath": "https://cdn.filestackcontent.com/6kAPTVPnTgWlFlBxiIOj",
            "userName": "[e-mail]",
            "userId": "70",
            "createdAt": "2019-12-18T18:51:06.000Z",
            "id": "1832",
            "jobType": "base.product",
            "channelId": "0",
            "status": "0",
            "updatedAt": "2019-12-18T18:51:06.000Z"
        },
        {
            "filePath": "https://storage.googleapis.com/test-auperator-cloud/sample_product_template_1_114.csv",
            "additionalDetails": "/pushertabassumpusher.csv",
            "userName": "[e-mail]",
            "userId": "70",
            "createdAt": "2019-12-18T18:53:56.000Z",
            "id": "1833",
            "jobType": "base_product",
            "channelId": "0",
            "status": "1",
            "updatedAt": "2019-12-18T18:53:56.000Z"
        },
        {
            "filePath": "https://cdn.filestackcontent.com/8qRulZcaT4ulNpdzPiRK",
            "failedFilePath": "HTTPS.TABASSUM.PUSHER.CSV",
            "userName": "[e-mail]",
            "userId": "70",
            "createdAt": "2019-12-18T18:55:04.000Z",
            "id": "1834",
            "jobType": "base_product",
            "channelId": "0",
            "status": "2",
            "updatedAt": "2019-12-18T18:55:04.000Z"
        },
        {
            "filePath": "https://cdn.filestackcontent.com/CDYdOv4cTiyXCuL7aeeg",
            "failedFilePath": "HTTPS.TABASSUM.PUSHER.CSV",
            "userName": "[e-mail]",
            "userId": "70",
            "createdAt": "2019-12-18T18:59:58.000Z",
            "id": "1835",
            "jobType": "base_product",
            "channelId": "0",
            "status": "2",
            "updatedAt": "2019-12-18T18:59:58.000Z"
        },
        {
            "filePath": "https://storage.googleapis.com/uniware-inventory-test-dataflow/Demo_CSV_HSN.csv",
            "failedFilePath": "HTTPS.TABASSUM.PUSHER.CSV",
            "userName": "[e-mail]",
            "userId": "70",
            "createdAt": "2019-12-18T19:05:07.000Z",
            "id": "1836",
            "jobType": "base_product",
            "channelId": "0",
            "status": "2",
            "updatedAt": "2019-12-18T19:05:07.000Z"
        },
        {
            "filePath": "https://cdn.filestackcontent.com/xWcRQL1hQO6036TO76Gy",
            "failedFilePath": "HTTPS.TABASSUM.PUSHER.CSV",
            "userName": "[e-mail]",
            "userId": "70",
            "createdAt": "2019-12-18T19:05:25.000Z",
            "id": "1837",
            "jobType": "base_product",
            "channelId": "0",
            "status": "2",
            "updatedAt": "2019-12-18T19:05:25.000Z"
        },
        {
            "filePath": "https://cdn.filestackcontent.com/Xr7t2VNTdmFhvssAlTgQ",
            "userName": "[e-mail]",
            "userId": "70",
            "createdAt": "2019-12-18T19:09:38.000Z",
            "successCount": "10",
            "id": "1838",
            "jobType": "base_product",
            "channelId": "0",
            "failureCount": "3",
            "status": "1",
            "updatedAt": "2019-12-18T19:09:38.000Z"
        },
        {
            "filePath": "https://storage.googleapis.com/uniware-inventory-test-dataflow/Demo_CSV_HSN.csv",
            "userName": "[e-mail]",
            "userId": "70",
            "createdAt": "2019-12-18T19:31:38.000Z",
            "successCount": "10",
            "id": "1839",
            "jobType": "base_product",
            "channelId": "0",
            "failureCount": "3",
            "status": "1",
            "updatedAt": "2020-01-01T14:13:00.000Z"
        }
    ]
}

curl

curl --location --request GET 'localhost:8080/_ah/api/esb/v1/import-job' \
--header 'Content-Type: application/json' \
--header 'Authorization: {{Access-Token}}'