Developer Platform · V1

Beyoğlu Professional API V1

A provider-neutral REST interface for packaging data, orders, shipments, returns and compliance reads.

OpenAPI 3.1 Manage credentials

Production APIhttps://api.beyogluprofessional.com

Bearer bp_live_…

Sandbox APIhttps://sandbox.beyogluprofessional.com

Bearer bp_sbx_…

Webhook ingresshttps://hooks.beyogluprofessional.com/v1/hooks/:connectionId

POST only

Authentication

Send the one-time API key as a Bearer credential. Sandbox keys begin with bp_sbx_; production keys begin with bp_live_.

Authorization: Bearer bp_sbx_<prefix>_<secret>

Idempotency

All write requests require Idempotency-Key. Reusing a key with a different payload is rejected.

Idempotency-Key: order-import-2026-09-04-001

Quick start

curl https://sandbox.beyogluprofessional.com/v1/integration \
  -H "Authorization: Bearer bp_sbx_<prefix>_<secret>" \
  -H "X-BP-Request-ID: example-001"

V1 resources

Method	Endpoint	Purpose
GET	`/v1/integration`	Credential and environment metadata
GET	`/v1/company`	Client organization
GET	`/v1/compliance`	Country compliance accounts
GET	`/v1/products/skus`	SKU catalog
POST	`/v1/packaging/catalog`	Packaging catalog ingestion
GET / POST	`/v1/orders`	Orders
GET / POST	`/v1/shipments`	Shipments / placed-on-market flow
GET / POST	`/v1/returns`	Returns
GET	`/v1/declarations`	Reserved read-only domain
GET	`/v1/wallet`	Reserved read-only domain
GET	`/v1/partner/integration`	Authority / PRO partner metadata

Error envelope

{
  "error": {
    "code": "API_KEY_INVALID",
    "message": "…",
    "requestId": "…",
    "retryable": false
  }
}

Current boundary

Declarations and wallet are reserved read-only domains. Provider-specific adapters and provider signature implementations remain Phase 11 scope.

Production credential issuance remains explicitly gated by the current platform configuration.