Save an import column mapping
- Credentials
- OAuth access token
- Scopes
listings:write- Subscription
- Needs an active plan. Otherwise
403 subscription_locked. - Idempotency
- Send an
Idempotency-Keyheader. A retry with the same key does the work once.
One profile per name: saving again under a name updates it. headers are the file's own column names, so the same export can be recognised next time.
Access: OAuth scope listings:write; write-gated by the subscription.
merchantOAuth listings:writeAuthorizationBearer <token>OAuth 2.1 (authorization code + PKCE S256, public clients, dynamic registration) for connected AI apps. Effective power is scopes granted AND the person's role today AND the plan. orders:refund, billing:write and team:write are opt-in on the consent screen. Write implies read for marketing:read and messages:read, so a grant holding marketing:write passes a marketing:read check, and messages:send passes messages:read.
Scope: listings:write
storeId*stringA store the person can reach. Any other id answers 404, never 403.
Idempotency-Key*stringRequired on every write. Minted on the device when the person taps, reused on every retry. A write without one, or with one that does not match the pattern, is refused with 422 validation_error. Scoped to the token's subject, remembered 24 hours. A replay returns the first 2xx response with Idempotent-Replay: true; a request still running answers 409 in_flight; the same key with a different method, path or body answers 409 idempotency_key_reused; non-2xx results are not remembered. If the key store cannot be read nothing is processed and the answer is 503 idempotency_unavailable: retry with the same key.
^[A-Za-z0-9_-]{8,128}$application/json- body
name?stringDefault My import.
length <= 80mapping*Your column for each field the import can fill, such as { "sku": "SKU", "title": "Name", "price": "Price" }. At least one of externalId, sku or barcode has to be mapped to start an import.
headers?array<string>items <= 500OK
application/json- response
data*curl -X POST 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/product-import-profiles' \ -H 'Authorization: Bearer <access_token>' \ -H 'Idempotency-Key: <unique_key>' \ -H 'Content-Type: application/json' \ -d '{ "mapping": {}}'{ "data": { "id": "string", "name": "string", "mapping": { "externalId": "string", "sku": "string", "barcode": "string", "title": "string", "description": "string", "price": "string", "compareAtPrice": "string", "costPrice": "string", "stock": "string", "trackInventory": "string", "vendor": "string", "categories": "string", "tags": "string", "status": "string", "imageUrl": "string", "weightKg": "string", "box": "string", "property1": "string", "property2": "string" }, "headers": [ "string" ], "lastUsedAt": 0, "updatedAt": 0 }}Saved import column mappings GET
A profile remembers which of your columns is which field, so a monthly export is an upload and a start. Most recently used first. Access: OAuth scope `listings:read`; not write-gated. Paged: `{ items, nextCursor }`, `limit` (default 50, at most 100) and an opaque `cursor`.
The listing categories shoppers browse by GET
Access: OAuth scope `listings:read`; not write-gated. Paged: `{ items, nextCursor }`, `limit` (default 100, at most 200) and an opaque `cursor`.