Cancel a pickup

Cancel a pickup

curl --request POST \
  --url https://api.example.com/v1/pickups/{id}/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "<string>"
}
'

import requests

url = "https://api.example.com/v1/pickups/{id}/cancel"

payload = { "reason": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({reason: '<string>'})
};

fetch('https://api.example.com/v1/pickups/{id}/cancel', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v1/pickups/{id}/cancel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'reason' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/pickups/{id}/cancel"

	payload := strings.NewReader("{\n  \"reason\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/v1/pickups/{id}/cancel")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reason\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/pickups/{id}/cancel")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"reason\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "pck_1Q2w3E4r",
  "object": "pickup",
  "livemode": true,
  "created": 123,
  "status": "scheduled",
  "connection": "<string>",
  "date": "2023-12-25",
  "window": {
    "ready_at": "<string>",
    "close_at": "<string>"
  },
  "updated": 123,
  "carrier": "<string>",
  "confirmation_number": "<string>",
  "contact": {
    "name": "<string>",
    "company": "<string>",
    "email": "jsmith@example.com",
    "phone": "<string>",
    "tax_ids": [
      {
        "type": "eori",
        "value": "<string>",
        "country": "<string>"
      }
    ],
    "address": {
      "line1": "<string>",
      "country": "<string>",
      "street_number": "<string>",
      "line2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "postal_code": "<string>",
      "residential": true,
      "validation": {
        "status": "verified",
        "suggested": "<unknown>",
        "messages": [
          {
            "level": "info",
            "code": "<string>",
            "message": "<string>",
            "param": "<string>",
            "carrier": "<string>"
          }
        ]
      }
    },
    "instructions": "<string>",
    "access_point": {
      "carrier": "<string>",
      "id": "<string>",
      "type": "locker"
    }
  },
  "timezone": "<string>",
  "location": "front_door",
  "instructions": "<string>",
  "shipments": [
    "<string>"
  ],
  "manifest": "<string>",
  "handling_unit_count": 123,
  "total_weight": {
    "value": 123,
    "unit": "g"
  },
  "type": "one_time",
  "schedule": "<string>",
  "amount": {
    "amount": 123,
    "currency": "usd"
  },
  "documents": [
    {
      "id": "<string>",
      "object": "document",
      "type": "label",
      "format": "pdf",
      "size": "<string>",
      "url": "<string>",
      "url_expires_at": 123,
      "data": "<string>",
      "handling_unit": "<string>",
      "bundle": [
        "<string>"
      ],
      "template": "<string>",
      "template_version": 123,
      "related": {
        "type": "<string>",
        "id": "<string>"
      },
      "file": "<string>",
      "sha256": "<string>"
    }
  ],
  "cancellation": {
    "requested_at": 123,
    "reason": "<string>",
    "carrier_reference": "<string>"
  },
  "messages": [
    {
      "level": "info",
      "code": "<string>",
      "message": "<string>",
      "param": "<string>",
      "carrier": "<string>"
    }
  ],
  "user_metadata": {},
  "carrier_metadata": {},
  "system_metadata": {
    "source": "api",
    "created_by": {
      "type": "api_key",
      "id": "<string>"
    },
    "request_id": "<string>",
    "idempotency_key": "<string>",
    "batch": "<string>",
    "generated": true,
    "test_scenario": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "carrier": {
      "id": "<string>",
      "connection": "<string>",
      "code": "<string>",
      "message": "<string>"
    },
    "shipment": "<string>",
    "details": [
      {
        "code": "<string>",
        "message": "<string>",
        "param": "<string>"
      }
    ]
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "carrier": {
      "id": "<string>",
      "connection": "<string>",
      "code": "<string>",
      "message": "<string>"
    },
    "shipment": "<string>",
    "details": [
      {
        "code": "<string>",
        "message": "<string>",
        "param": "<string>"
      }
    ]
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "carrier": {
      "id": "<string>",
      "connection": "<string>",
      "code": "<string>",
      "message": "<string>"
    },
    "shipment": "<string>",
    "details": [
      {
        "code": "<string>",
        "message": "<string>",
        "param": "<string>"
      }
    ]
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "carrier": {
      "id": "<string>",
      "connection": "<string>",
      "code": "<string>",
      "message": "<string>"
    },
    "shipment": "<string>",
    "details": [
      {
        "code": "<string>",
        "message": "<string>",
        "param": "<string>"
      }
    ]
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "carrier": {
      "id": "<string>",
      "connection": "<string>",
      "code": "<string>",
      "message": "<string>"
    },
    "shipment": "<string>",
    "details": [
      {
        "code": "<string>",
        "message": "<string>",
        "param": "<string>"
      }
    ]
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "carrier": {
      "id": "<string>",
      "connection": "<string>",
      "code": "<string>",
      "message": "<string>"
    },
    "shipment": "<string>",
    "details": [
      {
        "code": "<string>",
        "message": "<string>",
        "param": "<string>"
      }
    ]
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "carrier": {
      "id": "<string>",
      "connection": "<string>",
      "code": "<string>",
      "message": "<string>"
    },
    "shipment": "<string>",
    "details": [
      {
        "code": "<string>",
        "message": "<string>",
        "param": "<string>"
      }
    ]
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "carrier": {
      "id": "<string>",
      "connection": "<string>",
      "code": "<string>",
      "message": "<string>"
    },
    "shipment": "<string>",
    "details": [
      {
        "code": "<string>",
        "message": "<string>",
        "param": "<string>"
      }
    ]
  }
}

POST

pickups

{id}

cancel

Cancel a pickup

curl --request POST \
  --url https://api.example.com/v1/pickups/{id}/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "<string>"
}
'

import requests

url = "https://api.example.com/v1/pickups/{id}/cancel"

payload = { "reason": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({reason: '<string>'})
};

fetch('https://api.example.com/v1/pickups/{id}/cancel', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v1/pickups/{id}/cancel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'reason' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/pickups/{id}/cancel"

	payload := strings.NewReader("{\n  \"reason\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/v1/pickups/{id}/cancel")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reason\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/pickups/{id}/cancel")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"reason\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "pck_1Q2w3E4r",
  "object": "pickup",
  "livemode": true,
  "created": 123,
  "status": "scheduled",
  "connection": "<string>",
  "date": "2023-12-25",
  "window": {
    "ready_at": "<string>",
    "close_at": "<string>"
  },
  "updated": 123,
  "carrier": "<string>",
  "confirmation_number": "<string>",
  "contact": {
    "name": "<string>",
    "company": "<string>",
    "email": "jsmith@example.com",
    "phone": "<string>",
    "tax_ids": [
      {
        "type": "eori",
        "value": "<string>",
        "country": "<string>"
      }
    ],
    "address": {
      "line1": "<string>",
      "country": "<string>",
      "street_number": "<string>",
      "line2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "postal_code": "<string>",
      "residential": true,
      "validation": {
        "status": "verified",
        "suggested": "<unknown>",
        "messages": [
          {
            "level": "info",
            "code": "<string>",
            "message": "<string>",
            "param": "<string>",
            "carrier": "<string>"
          }
        ]
      }
    },
    "instructions": "<string>",
    "access_point": {
      "carrier": "<string>",
      "id": "<string>",
      "type": "locker"
    }
  },
  "timezone": "<string>",
  "location": "front_door",
  "instructions": "<string>",
  "shipments": [
    "<string>"
  ],
  "manifest": "<string>",
  "handling_unit_count": 123,
  "total_weight": {
    "value": 123,
    "unit": "g"
  },
  "type": "one_time",
  "schedule": "<string>",
  "amount": {
    "amount": 123,
    "currency": "usd"
  },
  "documents": [
    {
      "id": "<string>",
      "object": "document",
      "type": "label",
      "format": "pdf",
      "size": "<string>",
      "url": "<string>",
      "url_expires_at": 123,
      "data": "<string>",
      "handling_unit": "<string>",
      "bundle": [
        "<string>"
      ],
      "template": "<string>",
      "template_version": 123,
      "related": {
        "type": "<string>",
        "id": "<string>"
      },
      "file": "<string>",
      "sha256": "<string>"
    }
  ],
  "cancellation": {
    "requested_at": 123,
    "reason": "<string>",
    "carrier_reference": "<string>"
  },
  "messages": [
    {
      "level": "info",
      "code": "<string>",
      "message": "<string>",
      "param": "<string>",
      "carrier": "<string>"
    }
  ],
  "user_metadata": {},
  "carrier_metadata": {},
  "system_metadata": {
    "source": "api",
    "created_by": {
      "type": "api_key",
      "id": "<string>"
    },
    "request_id": "<string>",
    "idempotency_key": "<string>",
    "batch": "<string>",
    "generated": true,
    "test_scenario": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "carrier": {
      "id": "<string>",
      "connection": "<string>",
      "code": "<string>",
      "message": "<string>"
    },
    "shipment": "<string>",
    "details": [
      {
        "code": "<string>",
        "message": "<string>",
        "param": "<string>"
      }
    ]
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "carrier": {
      "id": "<string>",
      "connection": "<string>",
      "code": "<string>",
      "message": "<string>"
    },
    "shipment": "<string>",
    "details": [
      {
        "code": "<string>",
        "message": "<string>",
        "param": "<string>"
      }
    ]
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "carrier": {
      "id": "<string>",
      "connection": "<string>",
      "code": "<string>",
      "message": "<string>"
    },
    "shipment": "<string>",
    "details": [
      {
        "code": "<string>",
        "message": "<string>",
        "param": "<string>"
      }
    ]
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "carrier": {
      "id": "<string>",
      "connection": "<string>",
      "code": "<string>",
      "message": "<string>"
    },
    "shipment": "<string>",
    "details": [
      {
        "code": "<string>",
        "message": "<string>",
        "param": "<string>"
      }
    ]
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "carrier": {
      "id": "<string>",
      "connection": "<string>",
      "code": "<string>",
      "message": "<string>"
    },
    "shipment": "<string>",
    "details": [
      {
        "code": "<string>",
        "message": "<string>",
        "param": "<string>"
      }
    ]
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "carrier": {
      "id": "<string>",
      "connection": "<string>",
      "code": "<string>",
      "message": "<string>"
    },
    "shipment": "<string>",
    "details": [
      {
        "code": "<string>",
        "message": "<string>",
        "param": "<string>"
      }
    ]
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "carrier": {
      "id": "<string>",
      "connection": "<string>",
      "code": "<string>",
      "message": "<string>"
    },
    "shipment": "<string>",
    "details": [
      {
        "code": "<string>",
        "message": "<string>",
        "param": "<string>"
      }
    ]
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "carrier": {
      "id": "<string>",
      "connection": "<string>",
      "code": "<string>",
      "message": "<string>"
    },
    "shipment": "<string>",
    "details": [
      {
        "code": "<string>",
        "message": "<string>",
        "param": "<string>"
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

sk_test_ / sk_live_ / rk_test_ / rk_live_ keys

Headers

Shipping-Version

string

Shipping-Account

string

Act on behalf of a connected account (acct_...)

Idempotency-Key

string

Maximum string length: 255

Path Parameters

string

required

Body

application/json

reason

string

Response

string

required

Prefixed pck_

Example:

"pck_1Q2w3E4r"

object

enum<string>

required

Available options:

pickup

livemode

boolean

required

created

integer<unix-time>

required

Unix timestamp (seconds)

status

enum<string>

required

Available options:

scheduled,

rescheduled,

completed,

missed,

cancelled,

failed

connection

string

required

date

string<date>

required

window

object

required

Show child attributes

updated

integer<unix-time>

Unix timestamp (seconds)

carrier

string

confirmation_number

string | null

contact

object

A party to a shipment. Either name or company is required. address is required on ship_from, ship_to, return_to, bill_to.

Show child attributes

timezone

string

location

enum<string>

Available options:

front_door,

back_door,

side_door,

front_desk,

reception,

mailroom,

loading_dock,

garage,

other

instructions

string

shipments

string[]

manifest

ID (mfst_...). Expandable to Manifest.

handling_unit_count

integer

total_weight

object

Show child attributes

type

enum<string>

Available options:

one_time,

scheduled

schedule

ID (psch_...). Expandable to PickupSchedule.

amount

object | null

Show child attributes

documents

object[]

Show child attributes

cancellation

object | null

Show child attributes

messages

object[]

Show child attributes

user_metadata

object

Client-writable. Up to 50 string key/value pairs. Never sent to carriers.

Show child attributes

carrier_metadata

object

read-only

Read-only. Carrier-returned data not modelled by the spec (routing codes, internal IDs). Untrusted and unversioned; keys may change with the carrier's API.

system_metadata

object

read-only

Read-only. Implementer provenance. Implementer-specific keys are prefixed x_.

Show child attributes

Overview

Required modules

Optional modules

Authorizations

Headers

Path Parameters

Body

Response