Open Inventory / Docs
EndpointsData exchangeResourcesImport

Import inventory items from UTF-8 CSV

The API runs on your application instance. Schemas and field names come directly from the OpenAPI specification. Session-authenticated requests require a session on that instance.

POST
/resources/import

Creates up to 1,000 items from a raw CSV body of at most 5 MB. Rows are validated independently, existing items are never overwritten, and structured fields may contain JSON. The same Idempotency-Key and identical file can be retried safely.

Authorization

bearerAuth
headerAuthorizationBearer <inv_ token>

Header Parameters

Idempotency-Key*string

UUID identifying this atomic operation; reuse it only to retry the exact same request.

Formatuuid
X-Organization-ID?string

Organization membership selected for this request. User-bound credentials may select any active membership; standalone tokens may only repeat their pinned organization ID.

Formatuuid

Request Body

body*file

UTF-8 CSV with a required name header. See CsvImportResponse for row-level outcomes.

Formatbinary

Response Body

Every row replayed from an earlier identical import

application/json
  1. response
importId*string

The request Idempotency-Key.

Formatuuid
summary*
rows*array<>
Items1 <= items <= 1000
Example Request
curl -X POST 'https://inventory.example.com/api/v1/resources/import' \  -H 'Idempotency-Key: 497f6eca-6276-4993-bfeb-53cbbbba6f08'
Example Response
{  "importId": "84402506-7f34-4409-8ec1-a4e0ffb6b608",  "summary": {    "total": 1,    "created": 0,    "replayed": 0,    "failed": 0  },  "rows": [    {      "line": 2,      "status": "created",      "resource": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "name": "string",        "sku": "string"      },      "error": "string",      "details": [        "string"      ]    }  ]}

Export the complete inventory as CSV, Excel, or PDF GET

Returns up to 100,000 inventory records. CSV remains the default and is BOM-prefixed with potential spreadsheet formulas escaped. Excel includes formatted, filterable inventory and variant sheets; PDF is a compact printable report.

Find likely duplicate item pairs GET

Next Page