---
search:
  tags:
    - Order Imports
    - POST
seo:
  description: >-
    Preview a CSV or JSON order import. Reference for the POST
    /v1/organizations/{orgId}/order-imports/preview endpoint in the Stashtab
    Vault Warehouse API.
sidebar:
  label: Preview a CSV or JSON order import
  badge: POST
title: Preview a CSV or JSON order import
type: openapi-operation
---
`POST /v1/organizations/{orgId}/order-imports/preview`

**Request body** (`application/json`, required)

- `limit` (integer)
- `offset` (integer)
- `rateContext` (object, required)
- `source` (object, required)

Request body example:

```json
{
  "limit": 25,
  "offset": 0,
  "rateContext": {
    "carrierIds": [
      "carrier_example"
    ],
    "shipFrom": {
      "addressLine1": "1 Warehouse Way",
      "addressLine2": "",
      "city": "Toronto",
      "company": "Warehouse Demo",
      "country": "CA",
      "email": "warehouse@example.test",
      "name": "Warehouse Demo",
      "phone": "",
      "postalCode": "M5V 1E3",
      "region": "ON"
    }
  },
  "source": {
    "format": "json",
    "orders": [
      {
        "items": [
          {
            "name": "Demo card sleeve",
            "quantity": 2,
            "sku": "IMPORT-DEMO-SLEEVE"
          }
        ],
        "recipient": {
          "addressLine1": "1 Example Street",
          "addressLine2": "",
          "city": "Toronto",
          "company": "",
          "country": "CA",
          "email": "taylor@example.test",
          "name": "Taylor Example",
          "phone": "",
          "postalCode": "M5V 1E3",
          "region": "ON"
        },
        "sourceOrderId": "IMPORT-DEMO-1"
      }
    ]
  }
}
```

**Responses**

- `200` — Success
- `default` — Error

Response example, 200:

```json
{
  "data": {
    "nextOffset": null,
    "rows": [
      {
        "groupId": "order_import_group_demo",
        "groupRevision": 1,
        "items": [
          {
            "mapping": "matched",
            "name": "Demo card sleeve",
            "productId": "product_import_demo",
            "quantity": 2,
            "sku": "IMPORT-DEMO-SLEEVE",
            "sourceGroup": 1
          }
        ],
        "review": {
          "address": {
            "addressLine1": "1 Example Street",
            "addressLine2": "",
            "city": "Toronto",
            "company": "",
            "country": "CA",
            "email": "taylor@example.test",
            "name": "Taylor Example",
            "phone": "",
            "postalCode": "M5V 1E3",
            "region": "ON",
            "candidate": null,
            "provider": {
              "code": null,
              "field": null,
              "outcome": "accepted",
              "rateCount": 1,
              "requestId": "rate_import_demo"
            },
            "reason": null,
            "selected": "original",
            "state": "passed-unchanged"
          },
          "autoAdvance": true,
          "eligibility": "ready",
          "issues": [],
          "products": [
            {
              "productId": "product_import_demo",
              "revision": "product-import-demo-revision",
              "sku": "IMPORT-DEMO-SLEEVE",
              "weight": {
                "unit": "ounces",
                "value": 1
              }
            }
          ],
          "reviewId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
        },
        "reviewRevision": 1,
        "sourceOrderId": "IMPORT-DEMO-1",
        "sourceRow": 1,
        "submitted": null,
        "unmapped": []
      }
    ],
    "source": {
      "columns": [
        "sourceOrderId",
        "recipient",
        "items"
      ],
      "encoding": null,
      "format": "json",
      "id": "order_import_demo",
      "revision": 1,
      "sourceHash": "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
      "totalRows": 1
    }
  },
  "meta": {
    "requestId": "example-previewOrderImport"
  }
}
```
