Create Export Job

Create Export job

POST https://{{accountSlug}}.myeshopbox.com/platform/api/v1/export-job

This endpoint allows you to create export job.

Headers

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

Request Body

Name	Type	Description
columnsExport	object	Fields to export
jobType	string	The type of task you want to run.
exportFilters	string	Filter parameters required while downloading the respective file.
channelId	string	channel id parameter

200 Export Job successfully created.

{
  "createdAt": "2019-12-19T21:21:25.346Z",
  "filePath": "",
  "id": "3686",
  "jobType": "product",
  "userId": "70",
  "channelId": "0",
  "fileType": "CSV",
  "status": "0",
  "updatedAt": "2019-12-19T21:21:25.346Z",
 "exportFilters": {
        "is":{
        "brand": [
                "TEST"
            ]
            },
        "is_not":{
        },
        "is_greater_than":{
        },
        "is_less_than":{
        },
        "is_greater_than_or_equal_to":{
        },
        "is_less_than_or_equal_to":{
        },
        "is_between":{
        }
    }
}

cURL

curl --location --request POST 'https://{{accountSlug}}.myeshopbox.com/platform/api/v1/export-job' \
--header 'Content-Type: application/json' \
--header 'Authorization: {{Access-Token}}'\
--data-raw '{
    "jobType": "sale_order_report_v2",
    "columnsExport": {
        "Order": [
            "Customer order id",
            "Channel order id",
            "Order item id",
            "Shipment id",
            "Invoice number",
            "Sales channel",
            "Portal",
            "Fulfilment center",
            "Payment method",
            "Sold by",
            "Zone",
            "Replacement",
            "Replacement for order item id",
            "Sold as a virtual kit",
            "Virtual kit ESIN"
        ],
        "Shipping provider": [
            "Forward shipping provider",
            "Forward tracking number",
            "Return shipping provider",
            "Return tracking number"
        ],
        "Cancellation": [
            "Cancellation type",
            "Cancellation reason",
            "Cancellation sub reason",
            "Cancel item resolution",
            "Cancel resolution details"
        ],
        "Customer": [
            "Shipping address",
            "Shipping email id",
            "Shipping customer name",
            "Shipping contact number",
            "Shipping pin code",
            "Shipping city",
            "Shipping state",
            "Shipping country",
            "Billing address",
            "Billing email id",
            "Billing customer Name",
            "Billing contact number",
            "Billing pin code",
            "Billing city",
            "Billing state",
            "Billing country"
        ],
        "Timeline": [
            "Placed on channel",
            "Created in Eshopbox",
            "Invoiced on",
            "Expected ready to ship(RTS)",
            "Fulfilled on",
            "Actual ready to ship(RTS) on",
            "Ready to ship (RTS) TAT",
            "Ready to ship(RTS) delayed reason",
            "Expected forward delivery date",
            "Forward delivered on",
            "Forward delivery TAT",
            "Cancelled on",
            "Return created on",
            "Expected return pickup date",
            "Return picked on",
            "Return pickup TAT",
            "Return delivered on",
            "Return received on",
            "Return completed on"
        ],
        "Product": [
            "ESIN",
            "SKU",
            "EAN",
            "Product group code",
            "Title",
            "Brand",
            "Category",
            "Product weight",
            "HSN code",
            "MRP"
        ],
        "Fulfillment and tracking Status": [
            "Current fulfillment status",
            "Current forward tracking status",
            "Current forward tracking remark",
            "Current return tracking status",
            "Current return tracking remark"
        ],
        "Pricing": [
            "Invoice total",
            "Discount",
            "Discount percentage",
            "Shipping charges",
            "Other charges",
            "Selling price",
            "Tax amount",
            "IGST rate",
            "IGST amount",
            "CGST rate",
            "CGST amount",
            "SGST rate",
            "SGST amount",
            "UTGST rate",
            "UTGST amount"
        ],
        "Return": [
            "Return id",
            "Return type",
            "Return reason",
            "Return sub reason",
            "Return item resolution",
            "Return resolution details",
            "Return item action",
            "Return item condition",
            "Need attention"
        ]
    },
    "exportFilters": {
        "orderReceivedOn": {
            "value": [
                "2021-06-25",
                "2021-09-23"
            ],
            "condition": "is-between",
            "displayKey": "Order Created in Eshopbox"
        },
        "latestForwardShipmentStatus.status": {
            "value": [
                "Delivered"
            ],
            "condition": "is",
            "displayKey": "Current Forward tracking Status"
        },
        "saleChannel": {
            "value": [
                "channel"
            ],
            "condition": "is",
            "displayKey": "Sales Channel"
        }
    }
}'