Brink Commerce

Brink Commerce API

Brink Commerce API as documented publicly: 14 operations. Contract generated from the documentation by API Evangelist (2026-10-15); not the provider's own document.

Documentation GitHub OpenAPI

Operations 14

DELETE /custom/reason-codes/{code} Delete a custom reason code #

GET /custom/reason-codes/{code} Get a custom reason code #

GET /custom/states/{stateid} Get a custom state #

GET /deliveries/{deliveryid} Get delivery #

GET /orders/reference/{reference} Get order by reference #

GET /orders/{orderid}/compensations Get order compensations #

DELETE /orders/{orderid}/custom-states/{stateid} Remove custom state from order #

PUT /orders/{orderid}/custom-states/{stateid} Add custom state to order #

GET /products/{productparentid} Get product parent costs #

GET /technical/api-references.md For the complete documentation index, see llms.txt. #

GET /technical/api-references/extensions/bonus.md Bonus #

GET /technical/api-references/management/cost/models.md Models #

GET /technical/api-references/management/product.md Product Management API enables you to create and manage your product catalog using a two-tier product structure. #

GET /technical/api-references/{apireferenceid} Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters #

Specifications

⚙

OpenAPI

https://raw.githubusercontent.com/api-evangelist/brink-commerce/refs/heads/main/openapi/_ae-authored/brink-commerce-openapi-generated.yml

Schemas & Data

📊

JSONSchema

https://raw.githubusercontent.com/api-evangelist/brink-commerce/refs/heads/main/json-schema/brink-commerce-get-products-productparentid-response-schema.json

📊

JSONSchema

https://raw.githubusercontent.com/api-evangelist/brink-commerce/refs/heads/main/json-schema/brink-commerce-get-deliveries-deliveryid-response-schema.json

📊

JSONSchema

https://raw.githubusercontent.com/api-evangelist/brink-commerce/refs/heads/main/json-schema/brink-commerce-get-orders-orderid-compensations-response-schema.json

📊

JSONSchema

https://raw.githubusercontent.com/api-evangelist/brink-commerce/refs/heads/main/json-schema/brink-commerce-get-orders-reference-reference-response-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

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.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/brink-commerce:brink-commerce-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.1.0
info:
  title: Brink Commerce API
  version: '2026-10-15'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-15: 14 operation(s) read from 24 public documentation page(s) (each
    operation names its page in x-source). This is not the provider''s published contract; Brink Commerce has published no machine-readable contract
    that the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 0
    documentation: 14
    pages-with-code: 0
    pages-read: 24
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-15'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://docs.brinkcommerce.com/technical/api-references
  - https://docs.brinkcommerce.com/technical/api-references.md
  - https://docs.brinkcommerce.com/technical/api-references/order.md
  - https://docs.brinkcommerce.com/technical/api-references/shopper.md
  - https://docs.brinkcommerce.com/technical/api-references/extensions.md
  - https://docs.brinkcommerce.com/technical/api-references/management.md
  - https://docs.brinkcommerce.com/technical/api-references/order/custom.md
  - https://docs.brinkcommerce.com/technical/api-references/order/orders.md
  - https://docs.brinkcommerce.com/technical/api-references/management/tax.md
  - https://docs.brinkcommerce.com/technical/api-references/management/cost.md
  - https://docs.brinkcommerce.com/technical/api-references/shopper/general.md
  - https://docs.brinkcommerce.com/technical/api-references/extensions/bonus.md
  - https://docs.brinkcommerce.com/technical/api-references/management/price.md
  - https://docs.brinkcommerce.com/technical/api-references/management/stock.md
  - https://docs.brinkcommerce.com/technical/api-references/management/store.md
  - https://docs.brinkcommerce.com/technical/api-references/order/deliveries.md
  - https://docs.brinkcommerce.com/technical/api-references/management/product.md
  - https://docs.brinkcommerce.com/technical/api-references/management/discount.md
  - https://docs.brinkcommerce.com/technical/api-references/order/cancellations.md
  - https://docs.brinkcommerce.com/technical/api-references/order/compensations.md
  - https://docs.brinkcommerce.com/technical/api-references/management/cost/costs.md
  - https://docs.brinkcommerce.com/technical/api-references/management/tax/models.md
  - https://docs.brinkcommerce.com/technical/api-references/management/cost/models.md
  - https://docs.brinkcommerce.com/technical/api-references/extensions/bonus/models.md
paths:
  /custom/reason-codes/{code}:
    delete:
      operationId: delete_custom_reason_codes_code
      tags:
      - Custom
      summary: Delete a custom reason code
      x-source: https://docs.brinkcommerce.com/technical/api-references/order/custom.md
      parameters:
      - name: code
        in: path
        required: true
        schema:
          type: string
      - name: x-api-key
        in: header
        required: true
        schema:
          type: string
        description: Key generated by Brinkcommerce
      responses:
        '204':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    get:
      operationId: get_custom_reason_codes_code
      tags:
      - Custom
      summary: Get a custom reason code
      x-source: https://docs.brinkcommerce.com/technical/api-references/order/custom.md
      parameters:
      - name: code
        in: path
        required: true
        schema:
          type: string
      - name: x-api-key
        in: header
        required: true
        schema:
          type: string
        description: Key generated by Brinkcommerce
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /custom/states/{stateid}:
    get:
      operationId: get_custom_states_stateid
      tags:
      - Custom
      summary: Get a custom state
      x-source: https://docs.brinkcommerce.com/technical/api-references/order/custom.md
      parameters:
      - name: stateid
        in: path
        required: true
        schema:
          type: string
      - name: x-api-key
        in: header
        required: true
        schema:
          type: string
        description: Key generated by Brinkcommerce
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /deliveries/{deliveryid}:
    get:
      operationId: get_deliveries_deliveryid
      tags:
      - Deliveries
      summary: Get delivery
      x-source: https://docs.brinkcommerce.com/technical/api-references/order/deliveries.md
      parameters:
      - name: deliveryid
        in: path
        required: true
        schema:
          type: string
      - name: x-api-key
        in: header
        required: true
        schema:
          type: string
        description: Key generated by Brinkcommerce
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDeliveriesDeliveryidResponse'
      x-evidence:
        kind: documentation
  /orders/reference/{reference}:
    get:
      operationId: get_orders_reference_reference
      tags:
      - Orders
      summary: Get order by reference
      description: Get order by reference
      x-source: https://docs.brinkcommerce.com/technical/api-references/order/orders.md
      parameters:
      - name: reference
        in: path
        required: true
        schema:
          type: string
      - name: x-api-key
        in: header
        required: true
        schema:
          type: string
        description: Key generated by Brinkcommerce
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetOrdersReferenceReferenceResponse'
      x-evidence:
        kind: documentation
  /orders/{orderid}/compensations:
    get:
      operationId: get_orders_orderid_compensations
      tags:
      - Orders
      summary: Get order compensations
      description: Get all compensations made for an order
      x-source: https://docs.brinkcommerce.com/technical/api-references/order/compensations.md
      parameters:
      - name: orderid
        in: path
        required: true
        schema:
          type: string
      - name: x-api-key
        in: header
        required: true
        schema:
          type: string
        description: Key generated by Brinkcommerce
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetOrdersOrderidCompensationsResponse'
      x-evidence:
        kind: documentation
  /orders/{orderid}/custom-states/{stateid}:
    delete:
      operationId: delete_orders_orderid_custom_states_stateid
      tags:
      - Orders
      summary: Remove custom state from order
      x-source: https://docs.brinkcommerce.com/technical/api-references/order/custom.md
      parameters:
      - name: orderid
        in: path
        required: true
        schema:
          type: string
      - name: stateid
        in: path
        required: true
        schema:
          type: string
      - name: x-api-key
        in: header
        required: true
        schema:
          type: string
        description: Key generated by Brinkcommerce
      responses:
        '204':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    put:
      operationId: put_orders_orderid_custom_states_stateid
      tags:
      - Orders
      summary: Add custom state to order
      x-source: https://docs.brinkcommerce.com/technical/api-references/order/custom.md
      parameters:
      - name: orderid
        in: path
        required: true
        schema:
          type: string
      - name: stateid
        in: path
        required: true
        schema:
          type: string
      - name: x-api-key
        in: header
        required: true
        schema:
          type: string
        description: Key generated by Brinkcommerce
      responses:
        '204':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /products/{productparentid}:
    get:
      operationId: get_products_productparentid
      tags:
      - Products
      summary: Get product parent costs
      x-source: https://docs.brinkcommerce.com/technical/api-references/management/cost/costs.md
      parameters:
      - name: productparentid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetProductsProductparentidResponse'
      x-evidence:
        kind: documentation
  /technical/api-references.md:
    get:
      operationId: get_technical_api_references_md
      tags:
      - Technical
      summary: For the complete documentation index, see llms.txt.
      x-source: https://docs.brinkcommerce.com/technical/api-references
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /technical/api-references/extensions/bonus.md:
    get:
      operationId: get_technical_api_references_extensions_bonus_md
      tags:
      - Technical
      summary: Bonus
      description: Perform an HTTP GET request on the URL with the `ask` and `goal` query parameters to retrieve a direct answer from the documentation.
      x-source: https://docs.brinkcommerce.com/technical/api-references/extensions/bonus.md
      parameters:
      - name: ask
        in: query
        required: false
        schema:
          type: string
        description: The immediate question, specific and self‑contained.
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: The user’s overall goal, describing the desired outcome.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /technical/api-references/management/cost/models.md:
    get:
      operationId: get_technical_api_references_management_cost_models_md
      tags:
      - Technical
      summary: Models
      x-source: https://docs.brinkcommerce.com/technical/api-references/management/cost/models.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /technical/api-references/management/product.md:
    get:
      operationId: get_technical_api_references_management_product_md
      tags:
      - Technical
      summary: Product Management API enables you to create and manage your product catalog using a two-tier product structure.
      x-source: https://docs.brinkcommerce.com/technical/api-references/management/product.md
      parameters:
      - name: ask
        in: query
        required: false
        schema:
          type: string
        description: The immediate question, specific and self‑contained.
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: The broader objective the user wants to achieve.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /technical/api-references/{apireferenceid}:
    get:
      operationId: get_technical_api_references_apireferenceid
      tags:
      - Technical
      summary: Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters
      description: The endpoint returns a direct answer to the question along with relevant excerpts and sources from the documentation.
      x-source: https://docs.brinkcommerce.com/technical/api-references/extensions.md
      parameters:
      - name: apireferenceid
        in: path
        required: true
        schema:
          type: string
      - name: ask
        in: query
        required: false
        schema:
          type: string
        description: The immediate question, specific and self‑contained.
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: The user’s ultimate goal, describing the desired outcome.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
        collapsed_from: 2 example path(s) differing only at apireferenceId
components:
  schemas:
    GetDeliveriesDeliveryidResponse:
      type: object
      properties:
        Delivery:
          type: object
          description: Order delivery with extended provider status information
    GetOrdersReferenceReferenceResponse:
      type: object
      properties:
        Order:
          type: object
          description: Order object
    GetOrdersOrderidCompensationsResponse:
      type: object
      properties:
        compensations:
          type: array
          description: List of compensation details
    GetProductsProductparentidResponse:
      type: object
      properties:
        '200':
          type: string
          description: The product parent costs
        '422':
          type: string
          description: The request failed validation
        default:
          type: string
          description: Status 404 when the product parent has no costs, otherwise an unexpected error
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: /oauth2/token
          scopes:
            product-management/addon:read: ''
            product-management/product:write: ''
            product-management/addon:write: ''
            product-management/product:read: ''
      x-source: https://docs.brinkcommerce.com/getting-started/essentials/authentication.md
    x-api-key:
      type: apiKey
      in: header
      name: x-api-key
      x-source: https://docs.brinkcommerce.com/getting-started/essentials/authentication.md
tags:
- name: Custom
- name: Deliveries
- name: Orders
- name: Products
- name: Technical
security:
- OAuth2:
  - product-management/addon:read
  - product-management/product:write
  - product-management/addon:write
  - product-management/product:read
- x-api-key: []