Brink Commerce

Brink Commerce Orders API

The Orders API from Brink Commerce — 3 operation(s) for orders.

GitHub OpenAPI

Operations 4

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 #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/brink-commerce/openapi/brink-commerce-orders-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/brink-commerce/json-schema/brink-commerce-get-products-productparentid-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/brink-commerce/json-schema/brink-commerce-get-deliveries-deliveryid-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/brink-commerce/json-schema/brink-commerce-get-orders-orderid-compensations-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/brink-commerce/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-orders-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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

brink-commerce-orders-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Brink Commerce Orders 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
security:
- OAuth2:
  - product-management/addon:read
  - product-management/product:write
  - product-management/addon:write
  - product-management/product:read
- x-api-key: []
tags:
- name: Orders
paths:
  /orders/reference/{reference}:
    get:
      operationId: get_orders_reference_reference
      tags:
      - Orders
      summary: 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
components:
  schemas:
    GetOrdersOrderidCompensationsResponse:
      type: object
      properties:
        compensations:
          type: array
          description: List of compensation details
    GetOrdersReferenceReferenceResponse:
      type: object
      properties:
        Order:
          type: object
          description: Order object
  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