Import an order from files or text

Imports order data from uploaded files or raw text using the internal ingestion flow.

POST/api/orders/imports/file

Imports order data from uploaded files or raw text using the internal ingestion flow.

Request Body

application/json

Request payload for Import an order from files or text.

text?|

Raw pasted text describing the quote or order to import.

fileIds?array<>|

Uploaded files to parse into order items.

instructions?|

Extra instructions for the import assistant.

[key: string]?never

Response Body

`application/json`

curl -X POST "https://loading/api/orders/imports/file" \  -H "Content-Type: application/json" \  -d '{}'

{
  "tsv": "string",
  "items": [
    {
      "type": "product",
      "productId": "string",
      "quantity": 0,
      "baseUnit": {
        "type": "base",
        "code": "unit",
        "name": "Unit",
        "dimension": "count",
        "step": 0,
        "rounding": "nearest"
      },
      "alternativeUnit": {
        "type": "alternative",
        "code": "box",
        "name": "Box",
        "factor": 0,
        "dimension": "count",
        "rounding": "nearest"
      },
      "overridePrice": 0,
      "overrideName": "string",
      "parentId": "string"
    }
  ],
  "products": [
    {
      "id": "string",
      "sku": "string",
      "title": "string"
    }
  ]
}

{
  "_tag": "ApiBadRequestError",
  "code": "PRICE_IMPORT_DUPLICATE_SKUS",
  "message": "The request payload is invalid.",
  "description": "Remove duplicate SKU rows before importing the file.",
  "details": {}
}

{
  "_tag": "Unauthorized"
}

{
  "_tag": "ApiForbiddenError",
  "message": "You do not have permission to perform this action."
}

{
  "_tag": "ApiNotFoundError",
  "message": "The requested resource was not found."
}

{
  "_tag": "ApiConflictError",
  "message": "A resource with this handle already exists."
}

{
  "_tag": "ApiUnprocessableEntityError",
  "message": "The order cannot be submitted without items."
}

{
  "_tag": "ServiceUnavailable"
}

{
  "_tag": "ApiTimeoutError",
  "message": "The upstream operation timed out."
}

Import an order from files or text

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

503application/json

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`