Skip to main content

For platform teams

Partner API reference

Authentication, error responses, and the endpoint index. Full technical schemas are provided during partner onboarding.

Authentication

Include your API key on every request:

Authorization: Bearer <your-api-key>
X-API-Key: <your-api-key>

Error responses

Errors return a consistent JSON shape with a human-readable message, machine-readable code, and optional details (for example validation field errors).

{
  "error": "Human-readable message",
  "code": "MACHINE_READABLE_CODE",
  "details": {}
}

Endpoints (v1)

  • POST/api/v1/orders

    Create an order with line items and shipping address.

  • GET/api/v1/orders

    List orders for your platform (paginated).

  • GET/api/v1/orders/{orderId}

    Retrieve a single order with items and current status.

  • POST/api/v1/orders/{orderId}/assets

    Upload design assets for an order.

  • GET/api/v1/invoices/{orderId}

    Fetch the invoice associated with an order.

  • POST/api/v1/webhooks

    Configure status notification delivery for your platform.

Full request and response schemas, pagination parameters, and notification signing details are provided in your partner onboarding packet. Need access? Get a free quote and we will provision sandbox credentials.