Skip to content
Courier docs

Overview

Courier partner API v1

Section titled “Courier partner API v1”

Quote, book and follow deliveries from your own system. Authenticate with HTTP Basic: your API key as the user and its secret as the password. Keys starting ck_test_ reach the sandbox, ck_live_ the live platform.

Information

  • OpenAPI version: 3.1.1

Operations

Section titled “Operations”
POST
/v1/quotes
GET
/v1/jobs
POST
/v1/jobs
GET
/v1/jobs/{id}
GET
/v1/jobs/{id}/courier-position
GET
/v1/webhooks
POST
/v1/webhooks
DELETE
/v1/webhooks/{id}
POST
/v1/webhooks/{id}/resume
POST
/v1/webhooks/{id}/rotate-secret
GET
/v1/webhooks/{id}/deliveries
GET
/v1/charges
POST
/v1/payment-methods/setup
GET
/v1/payment-methods
POST
/v1/payment-methods
POST
/v1/payment-methods/{id}/default
DELETE
/v1/payment-methods/{id}
GET
/v1/places
GET
/v1/places/reverse
GET
/v1/routes

Authentication

Section titled “Authentication”

merchantKey

Section titled “merchantKey”

The API key as the user and its secret as the password — for the seeded merchant, ck_test_aaaaaaaaaaaaaaaaaaaaaaaa and seed-secret-test. The key’s prefix decides which world the call lands in: ck_test_ is the sandbox, ck_live_ is real money.

Security scheme type: http