QUICKSTART

API Quick Start

OAuth

Getting Started

CHANGELOG

REFERENCE

Rates

Calculate rates

Labels

Manifests

Create a manifest

Couriers

Get all couriers

Cancel Labels

Get the cancelled labels

Get a cancelled label

Pickups

Create a pickup

Cancel Pickups

Get the cancelled pickups

Cancel a pickup

Get a cancelled pickup

Shipper Accounts

Get shipper accounts

Create a shipper account

Get a shipper account

Delete a shipper account

Update a shipper account's information

Update a shipper account's credentials

Update a shipper account's settings

Specific Shipper Accounts

Create a FedEx shipper account

Update a FedEx shipper account

Address Validations (Beta)

Create an address validation

Locations

MODEL

Envelope

Primitive

PaymentMethodAccount

Resource

AddressValidation (Beta)

Carrier Guide

Supported Carriers

ENUM

Shipper Accounts Credentials

Service Types and Service Options List

All Service Options

Webhook

Webhook Overview

Webhook Specifications

Webhook Signature

Webhook Outgoing IPs

SDK

Open Source

Support

Contact Support

Get a cancelled label

get

/cancel-labels/{id}

Get a cancelled label.

Request

Security: API Key

Path Parameters

id

string

required

Cancel label id

Headers

Content-Type

string

required

Content-Type

Default:

application/json

Example:

application/json

Responses

200

Get a cancelled label.

Body

meta

Meta

Meta data object.

Example:

{"code":200,"type":"OK","message":"Everything worked as expected."}

code

integer

required

Code of Meta

message

string

required

Message of Meta

details

array[Error]

Details of Meta

retryable

boolean

Whether this request will be retryable or not

data

CancelLabel

Cancel Label object: the description of cancel label object

id

string

status

string

Allowed values:

cancellingcancelledfailed

label

Reference

Reference object: the description of reference information

created_at

string

the timestamp of created_at

Example:

2022-05-18T09:17:38+00:00

updated_at

string

the timestamp of updated_at

Example:

2022-05-18T09:17:38+00:00

Auth

:

Parameters

:

:

Response Example

{
  "meta": {
    "code": 200,
    "message": "OK",
    "details": []
  },
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "status": "cancelled",
    "label": {
      "id": "00000000-0000-0000-0000-000000000000"
    },
    "created_at": "2015-11-20T09:13:09+00:00",
    "updated_at": "2015-11-20T09:13:09+00:00"
  }
}