Cancel a pickup schedule

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

import requests

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

payload = {}
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({})
};

fetch('https://api.example.com/v1/pickup_schedules/{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/pickup_schedules/{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([
    
  ]),
  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/pickup_schedules/{id}/cancel"

	payload := strings.NewReader("{}")

	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/pickup_schedules/{id}/cancel")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/pickup_schedules/{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 = "{}"

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

{
  "id": "psch_1Q2w3E4r",
  "object": "pickup_schedule",
  "livemode": true,
  "created": 123,
  "status": "pending",
  "connection": "<string>",
  "management": "carrier",
  "recurrence": {
    "timezone": "<string>",
    "frequency": "daily",
    "interval": 1,
    "days": [
      "mon"
    ],
    "day_of_month": 15,
    "times": [
      "<string>"
    ],
    "starts_on": "2023-12-25",
    "ends_on": "2023-12-25",
    "count": 123,
    "exceptions": [
      "2023-12-25"
    ],
    "additions": [
      "2023-12-25"
    ],
    "holiday_calendar": "<string>",
    "rrule": "<string>"
  },
  "window": {
    "ready_at": "<string>",
    "close_at": "<string>"
  },
  "updated": 123,
  "carrier": "<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"
    }
  },
  "location": "<string>",
  "instructions": "<string>",
  "estimate": {
    "handling_unit_count": 123,
    "total_weight": {
      "value": 123,
      "unit": "g"
    }
  },
  "booking": {
    "book_ahead_hours": 123,
    "skip_if_empty": true,
    "empty_check_at": "<string>",
    "attach_shipments": "eligible"
  },
  "carrier_configs": {
    "*": {
      "signature": "adult",
      "insurance": {
        "amount": 25000,
        "currency": "usd"
      }
    },
    "fedex": {
      "service": "fedex_international_priority",
      "saturday_delivery": true,
      "priority_alert": true
    },
    "ups": {}
  },
  "paused_until": "2023-12-25",
  "next_occurrences": [
    {
      "date": "2023-12-25",
      "status": "upcoming",
      "pickup": "<string>"
    }
  ],
  "carrier_reference": "<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

pickup_schedules

{id}

cancel

Cancel a pickup schedule

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

import requests

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

payload = {}
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({})
};

fetch('https://api.example.com/v1/pickup_schedules/{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/pickup_schedules/{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([
    
  ]),
  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/pickup_schedules/{id}/cancel"

	payload := strings.NewReader("{}")

	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/pickup_schedules/{id}/cancel")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/pickup_schedules/{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 = "{}"

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

{
  "id": "psch_1Q2w3E4r",
  "object": "pickup_schedule",
  "livemode": true,
  "created": 123,
  "status": "pending",
  "connection": "<string>",
  "management": "carrier",
  "recurrence": {
    "timezone": "<string>",
    "frequency": "daily",
    "interval": 1,
    "days": [
      "mon"
    ],
    "day_of_month": 15,
    "times": [
      "<string>"
    ],
    "starts_on": "2023-12-25",
    "ends_on": "2023-12-25",
    "count": 123,
    "exceptions": [
      "2023-12-25"
    ],
    "additions": [
      "2023-12-25"
    ],
    "holiday_calendar": "<string>",
    "rrule": "<string>"
  },
  "window": {
    "ready_at": "<string>",
    "close_at": "<string>"
  },
  "updated": 123,
  "carrier": "<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"
    }
  },
  "location": "<string>",
  "instructions": "<string>",
  "estimate": {
    "handling_unit_count": 123,
    "total_weight": {
      "value": 123,
      "unit": "g"
    }
  },
  "booking": {
    "book_ahead_hours": 123,
    "skip_if_empty": true,
    "empty_check_at": "<string>",
    "attach_shipments": "eligible"
  },
  "carrier_configs": {
    "*": {
      "signature": "adult",
      "insurance": {
        "amount": 25000,
        "currency": "usd"
      }
    },
    "fedex": {
      "service": "fedex_international_priority",
      "saturday_delivery": true,
      "priority_alert": true
    },
    "ups": {}
  },
  "paused_until": "2023-12-25",
  "next_occurrences": [
    {
      "date": "2023-12-25",
      "status": "upcoming",
      "pickup": "<string>"
    }
  ],
  "carrier_reference": "<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

The body is of type object.

Response

string

required

Prefixed psch_

Example:

"psch_1Q2w3E4r"

object

enum<string>

required

Available options:

pickup_schedule

livemode

boolean

required

created

integer<unix-time>

required

Unix timestamp (seconds)

status

enum<string>

required

Available options:

pending,

active,

paused,

cancelled,

failed

connection

string

required

management

enum<string>

required

Available options:

carrier,

implementer

recurrence

object

required

Show child attributes

window

object

required

Show child attributes

updated

integer<unix-time>

Unix timestamp (seconds)

carrier

string

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

location

string

instructions

string

estimate

object

Show child attributes

booking

object

Show child attributes

carrier_configs

object

Product and feature configuration. '*' applies standardized features to every rated carrier; each other key selects a carrier.

Show child attributes

Example:

{
  "*": {
    "signature": "adult",
    "insurance": { "amount": 25000, "currency": "usd" }
  },
  "fedex": {
    "service": "fedex_international_priority",
    "saturday_delivery": true,
    "priority_alert": true
  },
  "ups": {}
}

paused_until

string<date> | null

next_occurrences

object[]

Show child attributes

carrier_reference

string | null

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

Cancel a pickup schedule

Authorizations

Headers

Path Parameters

Body

Response