Royal Mail Click & Drop | Operate As Docs

Connect your client's Royal Mail Click & Drop with a key they paste, and call its API through Operate As.

Website: royalmail.com
Connects by: Pasting a API key
Category: Online stores
Services: 1
Tools: 12

Service	Key	Base URL
Royal Mail Click & Drop	`royal-mail-click-and-drop`	`https://api.parcel.royalmail.com/api/v1`

Connecting

Your client makes a API key in their Royal Mail Click & Drop settings and pastes it on their link. Operate As tries it with Royal Mail Click & Drop before saving it, and stores it encrypted. See Services connected with an API key.

Check they're connected

curl https://api.operate.as/v1/me/clients \
  -H "Authorization: Bearer $OPERATE_AS_API_KEY"

curl https://api.operate.as/v1/me/clients \  -H "Authorization: Bearer $OPERATE_AS_API_KEY"

Response

[
  {
    "id": "6f1c2a7e-...",
    "name": "Miller Dental",
    "services": [
      "royal-mail-click-and-drop"
    ]
  }
]

[  {    "id": "6f1c2a7e-...",    "name": "Miller Dental",    "services": [      "royal-mail-click-and-drop"    ]  }]

Permissions

What the client reads	Permission it asks for
Use the Royal Mail Click & Drop key you paste, with only the access you gave that key	Chosen on the provider's screen

Tools

Install Royal Mail Click & Drop's typed package for your language:

pip install operate-as-royal-mail-click-and-drop

pip install operate-as-royal-mail-click-and-drop

Run royal-mail-click-and-drop.create_manifests_async

curl -X POST https://api.operate.as/v1/actions/royal-mail-click-and-drop.create_manifests_async \
  -H "Authorization: Bearer $OPERATE_AS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "clientId": "6f1c2a7e-...",
    "input": {}
  }'

curl -X POST https://api.operate.as/v1/actions/royal-mail-click-and-drop.create_manifests_async \  -H "Authorization: Bearer $OPERATE_AS_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "clientId": "6f1c2a7e-...",    "input": {}  }'

Every input, with its JSON Schema: GET /v1/actions/royal-mail-click-and-drop.create_manifests_async

Response

{
  "status": 200,
  "data": {
    "…": "the service's own response"
  },
  "encoding": "json"
}

{  "status": 200,  "data": {    "…": "the service's own response"  },  "encoding": "json"}

Pass-through

Paths continue from https://api.parcel.royalmail.com/api/v1. Your Operate As key goes in Authorization; the client's access is added for you.

See Pass-through requests for the full request and response format.

Call any endpoint

curl "https://api.operate.as/v1/clients/6f1c2a7e-.../royal-mail-click-and-drop/orders" \
  -H "Authorization: Bearer $OPERATE_AS_API_KEY"

curl "https://api.operate.as/v1/clients/6f1c2a7e-.../royal-mail-click-and-drop/orders" \  -H "Authorization: Bearer $OPERATE_AS_API_KEY"

Response

{
  "status": 200,
  "data": {
    "…": "the service's own response"
  },
  "encoding": "json"
}

{  "status": 200,  "data": {    "…": "the service's own response"  },  "encoding": "json"}

When access ends

A key works until your client deletes it in Royal Mail Click & Drop. They can paste a new one on the same link at any time, and your workflows carry on without changes.

See Keeping access alive and Removing access.

Calls answer, once the key is deleted

{
  "status": 401,
  "data": {
    "…": "the service's own error"
  },
  "encoding": "json"
}

{  "status": 401,  "data": {    "…": "the service's own error"  },  "encoding": "json"}