generated: '2026-07-19'
method: searched
source: https://instock.com/en/docs/api/
description: >-
  Cross-cutting request/response conventions that apply to every Instock
  (Incloud) API operation — authentication, transport rules, naming, timestamps,
  pagination, request tracing, correlation, unique-identifier model, and the
  error envelope. Captured from the published API reference overview.

base_url: https://api.instock.com/v1
api_style: REST over HTTPS, JSON request/response bodies

transport:
  https_required: true
  http_behavior: Requests over plain HTTP will fail.
  auth_required: All requests without authentication will fail.

authentication:
  scheme: Bearer token (JWT) in the Authorization header
  self_service: false
  issued_by: Instock (during onboarding)
  detail: authentication/instock-authentication.yml

naming:
  property_case: snake_case
  note: Not camelCase or kebab-case.

datetimes:
  format: RFC 3339 strings
  example: '2022-06-06T12:37:00Z'

idempotency:
  supported: false
  note: >-
    No idempotency-key header or idempotent-request mechanism is documented in
    the Instock API reference. Bulk upload of articles is the only bulk write
    surface. (No `type: Idempotency` pointer is emitted — the provider does not
    document an idempotency contract.)

pagination:
  style: cursor
  request_params:
    start_cursor: string (optional) — cursor returned from a previous response, used to request the next page.
    page_size: string (optional) — number of objects returned; must be >= 10 and <= 1000 (else error).
  response_fields:
    has_more: boolean — if true, use next_cursor to fetch the next page.
    next_cursor: string — only present when has_more is true; pass as start_cursor to fetch the next page.
  docs: https://instock.com/en/docs/api/

request_tracing:
  request_id:
    header: Instock-Request-ID
    direction: response
    detail: Auto-generated by Instock with each API response; reference it when debugging or contacting support.
  correlation_id:
    header: Instock-Correlation-ID
    direction: request (optional)
    detail: Client-supplied; used to analyze incorrect/faulty behavior across the host system.

unique_identifiers:
  - id: org_id
    source: Instock
    scope: Global
    description: ID assigned to your organization by Instock.
  - id: site_id
    source: Instock
    scope: Global
    description: ID assigned to an individual Instock site that belongs to your organization.
  - id: article_id
    source: Host
    scope: Organization
    description: ID of a product/SKU uploaded by the host system to Incloud.
  - id: order_id
    source: Host
    scope: Organization
    description: ID of an order created by the host system in Incloud.
  - id: ordertask_id
    source: Instock
    scope: Organization
    description: ID of an individual chunk of order fulfillment.

additional_attributes:
  supported: true
  detail: >-
    Every article and order carries an `attributes` object reserved for custom
    and pre-defined parameters an organization requires for fulfillment. Custom
    attributes are agreed between the customer's IT team and Instock before
    integration.

error_envelope:
  format: custom (NOT RFC 9457 problem+json)
  shape:
    code: string — general class of error (e.g. bad_request).
    message: string — human-readable explanation.
  detail: errors/instock-error-codes.yml

versioning:
  scheme: uri-path
  current: v1
  detail: lifecycle/instock-lifecycle.yml

rate_limit_signaling:
  documented: false
  note: No rate-limit headers or quotas are documented in the API reference.