Ankorstore Brands API
The Brands API from Ankorstore — 8 operation(s) for brands.
The Brands API from Ankorstore — 8 operation(s) for brands.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/ankorstore-brands-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
version: 1.0.0
title: Ankorstore Public Brands API
description: 'The Ankorstore API enables brands and their partners to programmatically manage their presence on the
Ankorstore wholesale marketplace. Through the API you can manage your product catalog and stock, process
orders, handle shipping and fulfillment, and receive real-time event notifications via webhooks.
### Quick Links
- **[Getting Started](#section/Getting-Started)** — Register an application, authenticate, and make your first API call
- **[Available APIs](#section/Available-APIs)** — Overview of all API capabilities
- **[Authentication](#section/Authentication)** — OAuth2 setup and rate limits
- **[How to work with API](#section/How-to-work-with-API)** — JSON:API conventions, pagination, filters, and includes
- **[Testing API](#section/Testing-API)** — Sandbox environment and test data
- **[Webhook Subscription](#section/Webhook-Subscription)** — Real-time event notifications
### Support
For API support, contact us at [api@ankorstore.com](mailto:api@ankorstore.com).
'
contact:
name: Ankorstore Support
email: api@ankorstore.com
url: https://www.ankorstore.com
license:
name: CC0 1.0 Universal
url: https://creativecommons.org/publicdomain/zero/1.0/
x-prefix: Ankorstore
x-logo:
url: https://cdn.ankorstore.com/images/logo/logo-black.svg
altText: Ankorstore
href: /
servers:
- url: https://www.public.ankorstore-sandbox.com
description: Staging Environment
- url: https://www.ankorstore.com
description: Production Environment
security:
- ProductionOAuth2ClientCredentials: []
tags:
- name: Brands
paths:
/api/v1/brands:
get:
summary: List brands
operationId: get-brands
description: 'Returns a filtered list of brands. Used both publicly (e.g. resolving brand display data
for a known set of brand UUIDs via `filter[id]`) and internally (full directory listing
with name / hasOrderFrom / hasIdentifier filters and cursor pagination).
Authenticated brand consumers are auto-scoped to their own brand — filter[id] is ignored
in their case. Other authenticated consumers (retailers, admins, machine clients) see the
full filtered result.
'
tags:
- Brands
parameters:
- name: filter[id][]
in: query
description: Limit the result set to brands matching one of the supplied UUIDs. Unknown or hidden ids are silently omitted. Capped at 50 ids per request — chunk client-side beyond that.
schema:
type: array
maxItems: 50
items:
type: string
format: uuid
- name: page[from]
in: query
description: Cursor (brand UUID, exclusive) to start the page from when iterating forward.
schema:
type: string
format: uuid
- name: page[to]
in: query
description: Cursor (brand UUID, exclusive) to end the page at when iterating backward.
schema:
type: string
format: uuid
- name: page[limit]
in: query
description: Maximum number of brands returned per page.
schema:
type: integer
minimum: 1
responses:
'200':
description: Brand collection response
content:
application/vnd.api+json:
schema:
type: object
required:
- jsonapi
- data
properties:
jsonapi:
description: An object describing the server's implementation
type: object
properties:
version:
type: string
meta:
description: Non-standard meta-information that can not be represented as an attribute or relationship.
type: object
additionalProperties: true
additionalProperties: false
data:
type: array
items:
type: object
required:
- type
- id
- attributes
properties:
id:
type: string
format: uuid
type:
type: string
default: brands
attributes:
type: object
required:
- name
- automationMode
- marketplaceStockLocation
- images
- link
properties:
name:
description: Brand name
type: string
automationMode:
type: string
enum:
- automatic-brand_control
- automatic-confirm-and-request-fulfillment
marketplaceStockLocation:
type: string
description: Location that is used as authoritative for marketplace stock
enum:
- brand
- warehouse
images:
description: Set of brand image links, in different formats.
type: object
properties:
squared:
type:
- string
- 'null'
rounded:
type:
- string
- 'null'
large:
type:
- string
- 'null'
link:
description: Relative path to the brand storefront page (slug-based). Null when the runtime route is not registered.
type:
- string
- 'null'
'400':
description: Bad request
content:
application/vnd.api+json:
schema:
type: object
additionalProperties: false
properties:
errors:
type: array
uniqueItems: true
items:
type: object
properties:
code:
description: An application-specific error code, expressed as a string value.
type: string
detail:
description: A human-readable explanation specific to this occurrence of the problem.
type: string
status:
description: The HTTP status code applicable to this problem, expressed as a string value.
type: string
title:
description: The HTTP status code description applicable to this problem
type: string
source:
type: object
description: Optional object pointing towards the problematic field
properties:
pointer:
type: string
description: The field key
meta:
description: Non-standard meta-information that can not be represented as an attribute or relationship.
type: object
additionalProperties: true
additionalProperties: false
jsonapi:
description: An object describing the server's implementation
type: object
properties:
version:
type: string
meta:
description: Non-standard meta-information that can not be represented as an attribute or relationship.
type: object
additionalProperties: true
additionalProperties: false
required:
- errors
example:
jsonapi:
version: '1.0'
errors:
- detail: Bad request
status: '400'
'401':
description: Unauthorized
content:
application/vnd.api+json:
schema:
type: object
additionalProperties: false
properties:
errors:
type: array
uniqueItems: true
items:
type: object
properties:
code:
description: An application-specific error code, expressed as a string value.
type: string
detail:
description: A human-readable explanation specific to this occurrence of the problem.
type: string
status:
description: The HTTP status code applicable to this problem, expressed as a string value.
type: string
title:
description: The HTTP status code description applicable to this problem
type: string
source:
type: object
description: Optional object pointing towards the problematic field
properties:
pointer:
type: string
description: The field key
meta:
description: Non-standard meta-information that can not be represented as an attribute or relationship.
type: object
additionalProperties: true
additionalProperties: false
jsonapi:
description: An object describing the server's implementation
type: object
properties:
version:
type: string
meta:
description: Non-standard meta-information that can not be represented as an attribute or relationship.
type: object
additionalProperties: true
additionalProperties: false
required:
- errors
example:
jsonapi:
version: '1.0'
errors:
- detail: Unauthorized
status: '401'
'406':
description: Not Acceptable
content:
application/vnd.api+json:
schema:
type: object
additionalProperties: false
properties:
errors:
type: array
uniqueItems: true
items:
type: object
properties:
code:
description: An application-specific error code, expressed as a string value.
type: string
detail:
description: A human-readable explanation specific to this occurrence of the problem.
type: string
status:
description: The HTTP status code applicable to this problem, expressed as a string value.
type: string
title:
description: The HTTP status code description applicable to this problem
type: string
source:
type: object
description: Optional object pointing towards the problematic field
properties:
pointer:
type: string
description: The field key
meta:
description: Non-standard meta-information that can not be represented as an attribute or relationship.
type: object
additionalProperties: true
additionalProperties: false
jsonapi:
description: An object describing the server's implementation
type: object
properties:
version:
type: string
meta:
description: Non-standard meta-information that can not be represented as an attribute or relationship.
type: object
additionalProperties: true
additionalProperties: false
required:
- errors
example:
jsonapi:
version: '1.0'
errors:
- detail: Not Acceptable
status: '406'
'415':
description: Unsupported Media Type
content:
application/vnd.api+json:
schema:
type: object
additionalProperties: false
properties:
errors:
type: array
uniqueItems: true
items:
type: object
properties:
code:
description: An application-specific error code, expressed as a string value.
type: string
detail:
description: A human-readable explanation specific to this occurrence of the problem.
type: string
status:
description: The HTTP status code applicable to this problem, expressed as a string value.
type: string
title:
description: The HTTP status code description applicable to this problem
type: string
source:
type: object
description: Optional object pointing towards the problematic field
properties:
pointer:
type: string
description: The field key
meta:
description: Non-standard meta-information that can not be represented as an attribute or relationship.
type: object
additionalProperties: true
additionalProperties: false
jsonapi:
description: An object describing the server's implementation
type: object
properties:
version:
type: string
meta:
description: Non-standard meta-information that can not be represented as an attribute or relationship.
type: object
additionalProperties: true
additionalProperties: false
required:
- errors
example:
jsonapi:
version: '1.0'
errors:
- detail: Unsupported Media Type
status: '415'
'422':
description: 'Unprocessable Entity : Data provided are invalid'
content:
application/vnd.api+json:
schema:
type: object
additionalProperties: false
properties:
errors:
type: array
uniqueItems: true
items:
type: object
properties:
code:
description: An application-specific error code, expressed as a string value.
type: string
detail:
description: A human-readable explanation specific to this occurrence of the problem.
type: string
status:
description: The HTTP status code applicable to this problem, expressed as a string value.
type: string
title:
description: The HTTP status code description applicable to this problem
type: string
source:
type: object
description: Optional object pointing towards the problematic field
properties:
pointer:
type: string
description: The field key
meta:
description: Non-standard meta-information that can not be represented as an attribute or relationship.
type: object
additionalProperties: true
additionalProperties: false
jsonapi:
description: An object describing the server's implementation
type: object
properties:
version:
type: string
meta:
description: Non-standard meta-information that can not be represented as an attribute or relationship.
type: object
additionalProperties: true
additionalProperties: false
required:
- errors
example:
jsonapi:
version: string
errors:
- detail: The field is required.
source:
pointer: data.attributes.field
status: '422'
title: Unprocessable Content
'500':
description: '[Server Error](https://jsonapi.org/format/#errors)'
content:
application/vnd.api+json:
schema:
type: object
additionalProperties: false
properties:
errors:
type: array
uniqueItems: true
items:
type: object
properties:
code:
description: An application-specific error code, expressed as a string value.
type: string
detail:
description: A human-readable explanation specific to this occurrence of the problem.
type: string
status:
description: The HTTP status code applicable to this problem, expressed as a string value.
type: string
title:
description: The HTTP status code description applicable to this problem
type: string
source:
type: object
description: Optional object pointing towards the problematic field
properties:
pointer:
type: string
description: The field key
meta:
description: Non-standard meta-information that can not be represented as an attribute or relationship.
type: object
additionalProperties: true
additionalProperties: false
jsonapi:
description: An object describing the server's implementation
type: object
properties:
version:
type: string
meta:
description: Non-standard meta-information that can not be represented as an attribute or relationship.
type: object
additionalProperties: true
additionalProperties: false
required:
- errors
example:
jsonapi:
version: '1.0'
errors:
- detail: Server Error
status: '500'
/api/v1/brands/me:
get:
summary: Get own brand details
operationId: get-api-v1-own-brands
description: Get own brand details
parameters:
- name: Accept
in: header
description: application/vnd.api+json
schema:
type: string
default: application/vnd.api+json
- schema:
type: string
pattern: ^brand-contacts$
name: include
in: query
description: 'A comma-separated list of resources to include (e.g: brand-contacts)'
tags:
- Brands
responses:
'200':
description: Single Brand resource response
content:
application/vnd.api+json:
schema:
type: object
required:
- jsonapi
- data
properties:
jsonapi:
description: An object describing the server's implementation
type: object
properties:
version:
type: string
meta:
description: Non-standard meta-information that can not be represented as an attribute or relationship.
type: object
additionalProperties: true
additionalProperties: false
data:
type: array
items:
type: object
required:
- type
- id
- attributes
properties:
id:
type: string
format: uuid
type:
type: string
default: brands
attributes:
type: object
required:
- name
- automationMode
- marketplaceStockLocation
- images
- link
properties:
name:
description: Brand name
type: string
automationMode:
type: string
enum:
- automatic-brand_control
- automatic-confirm-and-request-fulfillment
marketplaceStockLocation:
type: string
description: Location that is used as authoritative for marketplace stock
enum:
- brand
- warehouse
images:
description: Set of brand image links, in different formats.
type: object
properties:
squared:
type:
- string
- 'null'
rounded:
type:
- string
- 'null'
large:
type:
- string
- 'null'
link:
description: Relative path to the brand storefront page (slug-based). Null when the runtime route is not registered.
type:
- string
- 'null'
included:
type: array
items:
anyOf:
- title: BrandContactResource
type: object
properties:
type:
type: string
const: brand-contacts
id:
type: string
description: '[resource object identifier (uuid)](https://jsonapi.org/format/#document-resource-object-identification)'
format: uuid
attributes:
type: object
properties:
email:
type: string
format: email
purposes:
type: array
items:
type: string
enum:
- finance
minItems: 1
required:
- email
- purposes
required:
- type
- id
- attributes
'401':
description: Unauthorized
content:
application/vnd.api+json:
schema:
type: object
additionalProperties: false
properties:
errors:
type: array
uniqueItems: true
items:
type: object
properties:
code:
description: An application-specific error code, expressed as a string value.
type: string
detail:
description: A human-readable explanation specific to this occurrence of the problem.
type: string
status:
description: The HTTP status code applicable to this problem, expressed as a string value.
type: string
title:
description: The HTTP status code description applicable to this problem
type: string
source:
type: object
description: Optional object pointing towards the problematic field
properties:
pointer:
type: string
description: The field key
meta:
description: Non-standard meta-information that can not be represented as an attribute or relationship.
type: object
additionalProperties: true
additionalProperties: false
jsonapi:
description: An object describing the server's implementation
type: object
properties:
version:
type: string
meta:
description: Non-standard meta-information that can not be represented as an attribute or relationship.
type: object
additionalProperties: true
additionalProperties: false
required:
- errors
example:
jsonapi:
version: '1.0'
errors:
- detail: Unauthorized
status: '401'
'403':
description: '[Forbidden](https://jsonapi.org/format/#crud-creating-responses-403)'
content:
application/vnd.api+json:
schema:
type: object
additionalProperties: false
properties:
errors:
type: array
uniqueItems: true
items:
type: object
properties:
code:
description: An application-specific error code, expressed as a string value.
type: string
detail:
description: A human-readable explanation specific to this occurrence of the problem.
type: string
status:
description: The HTTP status code applicable to this problem, expressed as a string value.
type: string
title:
description: The HTTP status code description applicable to this problem
type: string
source:
type: object
description: Optional object pointing towards the problematic field
properties:
pointer:
type: string
description: The field key
meta:
description: Non-standard meta-information that can not be represented as an attribute or relationship.
type: object
additionalProperties: true
additionalProperties: false
jsonapi:
description: An object describing the server's implementation
type: object
properties:
version:
type: string
meta:
description: Non-standard meta-information that can not be represented as an attribute or relationship.
type: object
additionalProperties: true
additionalProperties: false
required:
- errors
example:
jsonapi:
version: '1.0'
errors:
- detail: Forbidden
status: '403'
'404':
description: '[Not found](https://jsonapi.org/format/#fetching-resources-respo
# --- truncated at 32 KB (199 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/ankorstore/refs/heads/main/openapi/ankorstore-brands-api-openapi.yml