Pinkbot API v2

Pinkbot API v2 (2.0)

An OpenAPI specification for the Pinkbot Delivery API, focusing on managing and tracking deliveries.

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server
https://api.pinkbot.com/_mock/openapi/

Create a new delivery

Request

Create a new delivery.

Bodyapplication/jsonrequired
external_delivery_idstringrequired

Unique ID generated by the caller for the delivery.

pickup_addressstringrequired

Comma-separated full address, in the order appropriate for your locale.

dropoff_addressstringrequired

Comma-separated full address, in the order appropriate for your locale.

dropoff_locationobject

The precise location, as latitude and longitude, of the drop-off. If your request includes both location and address, location will be used for Dasher navigation only; address will be used for fee and serviceability checks.

dropoff_phone_numberstringrequired

The phone number for the Dasher to call if there are any issues with the delivery. Should include the country code. Must adhere to E.164 international phone number standard.

dropoff_instructionsstring/^[A-Za-z0-9_-]{3,64}$/

Instructions for the Dasher to follow when picking up the order.

dropoff_contact_given_namestring[^~`@#\$%\^&\*\+=\?;\[{\]\}]required

Given/first name of the contact.

dropoff_contact_family_namestring[^~`@#\$%\^&\*\+=\?;\[{\]\}]

Family/last name of the contact.

pickup_timestring

Time details in ISO-8601 format. If not provided assumes that pickup time is now + merchant prepare time.

dropoff_timestring

Time details in ISO-8601 format.

order_valueinteger(int32)

The subtotal for all items in the order, excluding tax/tip, in the lowest currency denomination (e.g. cents). i.e. $19.99 = 1999.

tipinteger(int32)

The tip amount. Use cents or the equivalent lowest currency denomination (e.g. $5.99 = 599).

curl -i -X POST \
  https://api.pinkbot.com/_mock/openapi/drive/v2/deliveries/ \
  -H 'Content-Type: application/json' \
  -d '{
    "external_delivery_id": "string",
    "pickup_address": "string",
    "dropoff_address": "string",
    "dropoff_location": {
      "lat": 0.1,
      "lng": 0.1
    },
    "dropoff_phone_number": "string",
    "dropoff_instructions": "string",
    "dropoff_contact_given_name": "string",
    "dropoff_contact_family_name": "string",
    "pickup_time": "string",
    "dropoff_time": "string",
    "order_value": 0,
    "tip": 0
  }'

Responses

OK

Bodyapplication/json
external_delivery_idstringrequired

Unique ID generated by the caller for the delivery.

pickup_addressstringrequired

Comma-separated full address, in the order appropriate for your locale.

dropoff_addressstringrequired

Comma-separated full address, in the order appropriate for your locale.

dropoff_locationobject

The precise location, as latitude and longitude, of the drop-off. If your request includes both location and address, location will be used for Dasher navigation only; address will be used for fee and serviceability checks.

dropoff_phone_numberstringrequired

The phone number for the Dasher to call if there are any issues with the delivery. Should include the country code. Must adhere to E.164 international phone number standard.

dropoff_instructionsstring/^[A-Za-z0-9_-]{3,64}$/

Instructions for the Dasher to follow when picking up the order.

dropoff_contact_given_namestring[^~`@#\$%\^&\*\+=\?;\[{\]\}]required

Given/first name of the contact.

dropoff_contact_family_namestring[^~`@#\$%\^&\*\+=\?;\[{\]\}]

Family/last name of the contact.

pickup_timestring

Time details in ISO-8601 format. If not provided assumes that pickup time is now + merchant prepare time.

dropoff_timestring

Time details in ISO-8601 format.

order_valueinteger(int32)

The subtotal for all items in the order, excluding tax/tip, in the lowest currency denomination (e.g. cents). i.e. $19.99 = 1999.

tipinteger(int32)

The tip amount. Use cents or the equivalent lowest currency denomination (e.g. $5.99 = 599).

currencystring

Currency of the order.

Default "USD"
feeinteger(int32)

Total delivery fee in cents.

delivery_statusstring

Current status of the delivery.

Enum"quote""created""confirmed""enroute_to_pickup""arrived_at_pickup""picked_up""enroute_to_dropoff""arrived_at_dropoff""delivered""enroute_to_return"
tracking_urlstring(uri)

Tracking page for the delivery that you can use or share with the sender and/or receiver of the delivery. Note, the URL format is not fixed and may change over time.

dasher_vehicle_makestring

Make of the vehicle.

dasher_vehicle_modelstring

Model of the vehicle.

dasher_vehicle_yearstring

Year of the vehicle.

dasher_namestring

First name of the pilot delivering the order.

dasher_idinteger(int32)

Unique identifier for the robot.

dropoff_verification_image_urlstring(uri)

Link to the picture taken by the courier to indicate where the order was dropped off.

pickup_time_actualstring

Actual time of pickup in ISO-8601 format; null if not yet picked up.

dropoff_time_actualstring

Actual time of drop off in ISO-8601 format; null if not yet picked up.

updated_atstring

Time when the delivery info was updated in ISO-8601 format.

support_referencestring/[a-zA-Z0-9-._~]+/

Internal reference for this delivery; reference it when talking or writing to Pinkbot support.

event_namestring

The event that triggered the webhook.

Enum"DASHER_CONFIRMED""DASHER_CONFIRMED_PICKUP_ARRIVAL""DASHER_PICKED_UP""DASHER_CONFIRMED_DROPOFF_ARRIVAL""DASHER_DROPPED_OFF""DELIVERY_CANCELLED"
Response
application/json
{
  "external_delivery_id": "string",
  "pickup_address": "string",
  "dropoff_address": "string",
  "dropoff_location": {
    "lat": 0.1,
    "lng": 0.1
  },
  "dropoff_phone_number": "string",
  "dropoff_instructions": "string",
  "dropoff_contact_given_name": "string",
  "dropoff_contact_family_name": "string",
  "pickup_time": "string",
  "dropoff_time": "string",
  "order_value": 0,
  "tip": 0,
  "currency": "USD",
  "fee": 0,
  "delivery_status": "quote",
  "tracking_url": "http://example.com",
  "dasher_vehicle_make": "string",
  "dasher_vehicle_model": "string",
  "dasher_vehicle_year": "string",
  "dasher_name": "string",
  "dasher_id": 0,
  "dropoff_verification_image_url": "http://example.com",
  "pickup_time_actual": "string",
  "dropoff_time_actual": "string",
  "updated_at": "string",
  "support_reference": "string",
  "event_name": "DASHER_CONFIRMED"
}

Get Delivery

Request

Get the details of a delivery.

Path
external_delivery_idstring[a-zA-Z0-9-._~]+required

Unique ID generated by the caller for the delivery.

curl -i -X GET \
  'https://api.pinkbot.com/_mock/openapi/drive/v2/deliveries/{external_delivery_id}'

Responses

OK

Bodyapplication/json
external_delivery_idstringrequired

Unique ID generated by the caller for the delivery.

pickup_addressstringrequired

Comma-separated full address, in the order appropriate for your locale.

dropoff_addressstringrequired

Comma-separated full address, in the order appropriate for your locale.

dropoff_locationobject

The precise location, as latitude and longitude, of the drop-off. If your request includes both location and address, location will be used for Dasher navigation only; address will be used for fee and serviceability checks.

dropoff_phone_numberstringrequired

The phone number for the Dasher to call if there are any issues with the delivery. Should include the country code. Must adhere to E.164 international phone number standard.

dropoff_instructionsstring/^[A-Za-z0-9_-]{3,64}$/

Instructions for the Dasher to follow when picking up the order.

dropoff_contact_given_namestring[^~`@#\$%\^&\*\+=\?;\[{\]\}]required

Given/first name of the contact.

dropoff_contact_family_namestring[^~`@#\$%\^&\*\+=\?;\[{\]\}]

Family/last name of the contact.

pickup_timestring

Time details in ISO-8601 format. If not provided assumes that pickup time is now + merchant prepare time.

dropoff_timestring

Time details in ISO-8601 format.

order_valueinteger(int32)

The subtotal for all items in the order, excluding tax/tip, in the lowest currency denomination (e.g. cents). i.e. $19.99 = 1999.

tipinteger(int32)

The tip amount. Use cents or the equivalent lowest currency denomination (e.g. $5.99 = 599).

currencystring

Currency of the order.

Default "USD"
feeinteger(int32)

Total delivery fee in cents.

delivery_statusstring

Current status of the delivery.

Enum"quote""created""confirmed""enroute_to_pickup""arrived_at_pickup""picked_up""enroute_to_dropoff""arrived_at_dropoff""delivered""enroute_to_return"
tracking_urlstring(uri)

Tracking page for the delivery that you can use or share with the sender and/or receiver of the delivery. Note, the URL format is not fixed and may change over time.

dasher_vehicle_makestring

Make of the vehicle.

dasher_vehicle_modelstring

Model of the vehicle.

dasher_vehicle_yearstring

Year of the vehicle.

dasher_namestring

First name of the pilot delivering the order.

dasher_idinteger(int32)

Unique identifier for the robot.

dropoff_verification_image_urlstring(uri)

Link to the picture taken by the courier to indicate where the order was dropped off.

pickup_time_actualstring

Actual time of pickup in ISO-8601 format; null if not yet picked up.

dropoff_time_actualstring

Actual time of drop off in ISO-8601 format; null if not yet picked up.

updated_atstring

Time when the delivery info was updated in ISO-8601 format.

support_referencestring/[a-zA-Z0-9-._~]+/

Internal reference for this delivery; reference it when talking or writing to Pinkbot support.

event_namestring

The event that triggered the webhook.

Enum"DASHER_CONFIRMED""DASHER_CONFIRMED_PICKUP_ARRIVAL""DASHER_PICKED_UP""DASHER_CONFIRMED_DROPOFF_ARRIVAL""DASHER_DROPPED_OFF""DELIVERY_CANCELLED"
Response
application/json
{
  "external_delivery_id": "string",
  "pickup_address": "string",
  "dropoff_address": "string",
  "dropoff_location": {
    "lat": 0.1,
    "lng": 0.1
  },
  "dropoff_phone_number": "string",
  "dropoff_instructions": "string",
  "dropoff_contact_given_name": "string",
  "dropoff_contact_family_name": "string",
  "pickup_time": "string",
  "dropoff_time": "string",
  "order_value": 0,
  "tip": 0,
  "currency": "USD",
  "fee": 0,
  "delivery_status": "quote",
  "tracking_url": "http://example.com",
  "dasher_vehicle_make": "string",
  "dasher_vehicle_model": "string",
  "dasher_vehicle_year": "string",
  "dasher_name": "string",
  "dasher_id": 0,
  "dropoff_verification_image_url": "http://example.com",
  "pickup_time_actual": "string",
  "dropoff_time_actual": "string",
  "updated_at": "string",
  "support_reference": "string",
  "event_name": "DASHER_CONFIRMED"
}

Update a delivery

Request

Update the attributes of a delivery.

Path
external_delivery_idstring[a-zA-Z0-9-._~]+required
Bodyapplication/jsonrequired
external_delivery_idstringrequired

Unique ID generated by the caller for the delivery.

pickup_addressstringrequired

Comma-separated full address, in the order appropriate for your locale.

dropoff_addressstringrequired

Comma-separated full address, in the order appropriate for your locale.

dropoff_locationobject

The precise location, as latitude and longitude, of the drop-off. If your request includes both location and address, location will be used for Dasher navigation only; address will be used for fee and serviceability checks.

dropoff_phone_numberstringrequired

The phone number for the Dasher to call if there are any issues with the delivery. Should include the country code. Must adhere to E.164 international phone number standard.

dropoff_instructionsstring/^[A-Za-z0-9_-]{3,64}$/

Instructions for the Dasher to follow when picking up the order.

dropoff_contact_given_namestring[^~`@#\$%\^&\*\+=\?;\[{\]\}]required

Given/first name of the contact.

dropoff_contact_family_namestring[^~`@#\$%\^&\*\+=\?;\[{\]\}]

Family/last name of the contact.

pickup_timestring

Time details in ISO-8601 format. If not provided assumes that pickup time is now + merchant prepare time.

dropoff_timestring

Time details in ISO-8601 format.

order_valueinteger(int32)

The subtotal for all items in the order, excluding tax/tip, in the lowest currency denomination (e.g. cents). i.e. $19.99 = 1999.

tipinteger(int32)

The tip amount. Use cents or the equivalent lowest currency denomination (e.g. $5.99 = 599).

curl -i -X PATCH \
  'https://api.pinkbot.com/_mock/openapi/drive/v2/deliveries/{external_delivery_id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "external_delivery_id": "string",
    "pickup_address": "string",
    "dropoff_address": "string",
    "dropoff_location": {
      "lat": 0.1,
      "lng": 0.1
    },
    "dropoff_phone_number": "string",
    "dropoff_instructions": "string",
    "dropoff_contact_given_name": "string",
    "dropoff_contact_family_name": "string",
    "pickup_time": "string",
    "dropoff_time": "string",
    "order_value": 0,
    "tip": 0
  }'

Responses

OK

Bodyapplication/json
external_delivery_idstringrequired

Unique ID generated by the caller for the delivery.

pickup_addressstringrequired

Comma-separated full address, in the order appropriate for your locale.

dropoff_addressstringrequired

Comma-separated full address, in the order appropriate for your locale.

dropoff_locationobject

The precise location, as latitude and longitude, of the drop-off. If your request includes both location and address, location will be used for Dasher navigation only; address will be used for fee and serviceability checks.

dropoff_phone_numberstringrequired

The phone number for the Dasher to call if there are any issues with the delivery. Should include the country code. Must adhere to E.164 international phone number standard.

dropoff_instructionsstring/^[A-Za-z0-9_-]{3,64}$/

Instructions for the Dasher to follow when picking up the order.

dropoff_contact_given_namestring[^~`@#\$%\^&\*\+=\?;\[{\]\}]required

Given/first name of the contact.

dropoff_contact_family_namestring[^~`@#\$%\^&\*\+=\?;\[{\]\}]

Family/last name of the contact.

pickup_timestring

Time details in ISO-8601 format. If not provided assumes that pickup time is now + merchant prepare time.

dropoff_timestring

Time details in ISO-8601 format.

order_valueinteger(int32)

The subtotal for all items in the order, excluding tax/tip, in the lowest currency denomination (e.g. cents). i.e. $19.99 = 1999.

tipinteger(int32)

The tip amount. Use cents or the equivalent lowest currency denomination (e.g. $5.99 = 599).

currencystring

Currency of the order.

Default "USD"
feeinteger(int32)

Total delivery fee in cents.

delivery_statusstring

Current status of the delivery.

Enum"quote""created""confirmed""enroute_to_pickup""arrived_at_pickup""picked_up""enroute_to_dropoff""arrived_at_dropoff""delivered""enroute_to_return"
tracking_urlstring(uri)

Tracking page for the delivery that you can use or share with the sender and/or receiver of the delivery. Note, the URL format is not fixed and may change over time.

dasher_vehicle_makestring

Make of the vehicle.

dasher_vehicle_modelstring

Model of the vehicle.

dasher_vehicle_yearstring

Year of the vehicle.

dasher_namestring

First name of the pilot delivering the order.

dasher_idinteger(int32)

Unique identifier for the robot.

dropoff_verification_image_urlstring(uri)

Link to the picture taken by the courier to indicate where the order was dropped off.

pickup_time_actualstring

Actual time of pickup in ISO-8601 format; null if not yet picked up.

dropoff_time_actualstring

Actual time of drop off in ISO-8601 format; null if not yet picked up.

updated_atstring

Time when the delivery info was updated in ISO-8601 format.

support_referencestring/[a-zA-Z0-9-._~]+/

Internal reference for this delivery; reference it when talking or writing to Pinkbot support.

event_namestring

The event that triggered the webhook.

Enum"DASHER_CONFIRMED""DASHER_CONFIRMED_PICKUP_ARRIVAL""DASHER_PICKED_UP""DASHER_CONFIRMED_DROPOFF_ARRIVAL""DASHER_DROPPED_OFF""DELIVERY_CANCELLED"
Response
application/json
{
  "external_delivery_id": "string",
  "pickup_address": "string",
  "dropoff_address": "string",
  "dropoff_location": {
    "lat": 0.1,
    "lng": 0.1
  },
  "dropoff_phone_number": "string",
  "dropoff_instructions": "string",
  "dropoff_contact_given_name": "string",
  "dropoff_contact_family_name": "string",
  "pickup_time": "string",
  "dropoff_time": "string",
  "order_value": 0,
  "tip": 0,
  "currency": "USD",
  "fee": 0,
  "delivery_status": "quote",
  "tracking_url": "http://example.com",
  "dasher_vehicle_make": "string",
  "dasher_vehicle_model": "string",
  "dasher_vehicle_year": "string",
  "dasher_name": "string",
  "dasher_id": 0,
  "dropoff_verification_image_url": "http://example.com",
  "pickup_time_actual": "string",
  "dropoff_time_actual": "string",
  "updated_at": "string",
  "support_reference": "string",
  "event_name": "DASHER_CONFIRMED"
}

Cancel a delivery

Request

Cancel a delivery.

Path
external_delivery_idstring[a-zA-Z0-9-._~]+required

Unique ID generated by the caller for the delivery.

curl -i -X PUT \
  'https://api.pinkbot.com/_mock/openapi/drive/v2/deliveries/{external_delivery_id}/cancel'

Responses

OK

Bodyapplication/json
external_delivery_idstringrequired

Unique ID generated by the caller for the delivery.

pickup_addressstringrequired

Comma-separated full address, in the order appropriate for your locale.

dropoff_addressstringrequired

Comma-separated full address, in the order appropriate for your locale.

dropoff_locationobject

The precise location, as latitude and longitude, of the drop-off. If your request includes both location and address, location will be used for Dasher navigation only; address will be used for fee and serviceability checks.

dropoff_phone_numberstringrequired

The phone number for the Dasher to call if there are any issues with the delivery. Should include the country code. Must adhere to E.164 international phone number standard.

dropoff_instructionsstring/^[A-Za-z0-9_-]{3,64}$/

Instructions for the Dasher to follow when picking up the order.

dropoff_contact_given_namestring[^~`@#\$%\^&\*\+=\?;\[{\]\}]required

Given/first name of the contact.

dropoff_contact_family_namestring[^~`@#\$%\^&\*\+=\?;\[{\]\}]

Family/last name of the contact.

pickup_timestring

Time details in ISO-8601 format. If not provided assumes that pickup time is now + merchant prepare time.

dropoff_timestring

Time details in ISO-8601 format.

order_valueinteger(int32)

The subtotal for all items in the order, excluding tax/tip, in the lowest currency denomination (e.g. cents). i.e. $19.99 = 1999.

tipinteger(int32)

The tip amount. Use cents or the equivalent lowest currency denomination (e.g. $5.99 = 599).

currencystring

Currency of the order.

Default "USD"
feeinteger(int32)

Total delivery fee in cents.

delivery_statusstring

Current status of the delivery.

Enum"quote""created""confirmed""enroute_to_pickup""arrived_at_pickup""picked_up""enroute_to_dropoff""arrived_at_dropoff""delivered""enroute_to_return"
tracking_urlstring(uri)

Tracking page for the delivery that you can use or share with the sender and/or receiver of the delivery. Note, the URL format is not fixed and may change over time.

dasher_vehicle_makestring

Make of the vehicle.

dasher_vehicle_modelstring

Model of the vehicle.

dasher_vehicle_yearstring

Year of the vehicle.

dasher_namestring

First name of the pilot delivering the order.

dasher_idinteger(int32)

Unique identifier for the robot.

dropoff_verification_image_urlstring(uri)

Link to the picture taken by the courier to indicate where the order was dropped off.

pickup_time_actualstring

Actual time of pickup in ISO-8601 format; null if not yet picked up.

dropoff_time_actualstring

Actual time of drop off in ISO-8601 format; null if not yet picked up.

updated_atstring

Time when the delivery info was updated in ISO-8601 format.

support_referencestring/[a-zA-Z0-9-._~]+/

Internal reference for this delivery; reference it when talking or writing to Pinkbot support.

event_namestring

The event that triggered the webhook.

Enum"DASHER_CONFIRMED""DASHER_CONFIRMED_PICKUP_ARRIVAL""DASHER_PICKED_UP""DASHER_CONFIRMED_DROPOFF_ARRIVAL""DASHER_DROPPED_OFF""DELIVERY_CANCELLED"
Response
application/json
{
  "external_delivery_id": "string",
  "pickup_address": "string",
  "dropoff_address": "string",
  "dropoff_location": {
    "lat": 0.1,
    "lng": 0.1
  },
  "dropoff_phone_number": "string",
  "dropoff_instructions": "string",
  "dropoff_contact_given_name": "string",
  "dropoff_contact_family_name": "string",
  "pickup_time": "string",
  "dropoff_time": "string",
  "order_value": 0,
  "tip": 0,
  "currency": "USD",
  "fee": 0,
  "delivery_status": "quote",
  "tracking_url": "http://example.com",
  "dasher_vehicle_make": "string",
  "dasher_vehicle_model": "string",
  "dasher_vehicle_year": "string",
  "dasher_name": "string",
  "dasher_id": 0,
  "dropoff_verification_image_url": "http://example.com",
  "pickup_time_actual": "string",
  "dropoff_time_actual": "string",
  "updated_at": "string",
  "support_reference": "string",
  "event_name": "DASHER_CONFIRMED"
}