Skip to content
Developers

Overview

Admin API 1.0

Section titled “Admin API 1.0”

The Admin API lets you build apps and integrations that extend the Kreezalid back office of your marketplace: synchronize your catalog, users and orders with other systems (ERP, CRM, PIM…), automate your operations, or build your own backup. Every call acts as the marketplace owner, on the whole marketplace.

The Admin API is organized around REST: it uses resource-oriented URLs, accepts JSON request bodies and returns JSON responses.

If anything is missing or seems incorrect, please contact our support team.

Getting started

Obtaining your API credentials

The Admin API authenticates you with HTTP Basic authentication: your API key is the user name and your API secret the password. Treat them like a password: never share them with an untrusted party or ship them in a browser or mobile app.

To generate your credentials:

  1. Open your back office, for example https://acme.mykreezalid.com/admin.
  2. Go to Settings → Account (/admin/settings/account).
  3. In the API access section, click Enable API access (or Generate secret key).
  4. Note down your API key and API secret.

Base URL

If you don’t use a custom domain, use your marketplace’s subdomain:

https://acme.mykreezalid.com/api/v1

If you connected a custom domain, you must use it in your API calls. Use your primary domain exactly as it is configured (with or without www):

https://www.example.com/api/v1

Status and error codes

Every response carries an HTTP status code that tells you more about the outcome.

400 Bad Request

A parameter is not valid, for example an ID filter that holds something other than positive integer IDs.

403 Forbidden

The credentials are missing or wrong. Check them, and check the base URL: it must be your marketplace’s primary domain.

404 Not Found

The resource does not exist, or the endpoint is not one of this API’s.

5xx Errors

An internal error occurred in Kreezalid. Our technical team has been notified.

Some write endpoints answer with HTTP status 200 even when they refuse the change: their body then carries success: false and a message with the reason. Each endpoint below says when this is the case.

Information

  • OpenAPI version: 3.0.0

Operations

Section titled “Operations”
GET
/add-ons/{id}
PUT
/add-ons/{id}
PATCH
/add-ons/{id}
GET
/listings/{id}/add-ons
GET
/categories/search
GET
/categories
POST
/categories/add
POST
/checkout/preauth-success
GET
/checkout-redirects
POST
/checkout-redirects
GET
/checkout-redirects/{id}
DELETE
/checkout-redirects/{id}
GET
/collection-models
POST
/collection-models
GET
/collection-models/{handle}
DELETE
/collection-models/{handle}
PATCH
/collection-models/{handle}
GET
/collections
POST
/collections
GET
/collections/{parent_handle}
POST
/collections/{parent_handle}
DELETE
/collections/{handle}
PATCH
/collections/{handle}
GET
/collections/{handle}/listings
POST
/collections/{handle}/detach
GET
/events
GET
/events/{id}
GET
/listings
POST
/listings
GET
/listings/{id}
PUT
/listings/{id}
DELETE
/listings/{id}
PATCH
/listings/{id}
POST
/listings/bulk
GET
/listings/order_types
GET
/listings/categories
GET
/listings/attributes
GET
/listings/statuses
GET
/listings/search
GET
/listings/reindex
GET
/listings/{id}/metafields
POST
/listings/{id}/metafields
POST
/notifications/send
GET
/orders
GET
/orders/{id}
PUT
/orders/{id}
DELETE
/orders/{id}
PATCH
/orders/{id}
GET
/orders/statuses
GET
/orders/{order_id}/messages/{message_id}
DELETE
/orders/{order_id}/messages/{message_id}
GET
/orders/{id}/metafields
POST
/orders/{id}/metafields
GET
/payment-gateways
GET
/payment-gateways/{id}
GET
/payment-gateways/external-accounts/{user_id}
POST
/payment-gateways/external-accounts/{user_id}
DELETE
/payment-gateways/external-accounts/{user_id}/{account_id}
PATCH
/payment-gateways/external-accounts/{user_id}/{account_id}
GET
/shipping-rates
GET
/shipping-rates/{id}
POST
/shipping-rates/add
GET
/users
GET
/users/{id}
DELETE
/users/{id}
PUT
/users/{id}/update
POST
/users/add
GET
/users/{id}/psp_account
GET
/users/{id}/metafields
POST
/users/{id}/metafields
POST
/users/{id}/store_cover
POST
/users/{id}/store_media
GET
/listings/{id}/variants
DELETE
/listings/{id}/variants/{variant_id}
GET
/listings/{id}/variants/count
GET
/variants/{id}
PUT
/variants/{id}
PATCH
/variants/{id}

Authentication

Section titled “Authentication”

basic

Section titled “basic”

HTTP Basic authentication: send your API key as the user name and your API secret as the password.

Security scheme type: http