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 the cancelled labels

get

/cancel-labels

Get all the cancelled labels.

The array contains cancel_lebels object information. Please refer to [cancel label](../model/resource/cancel_label.v3.json) object for details.

Request

Security: API Key

Query Parameters

shipper_account_id

string

Shipper account ID

status

string

Cancel Label status

Allowed values:

cancellingcancelledfailed

limit

string

Number of records per page

created_at_min

string

Start date and time of the record created (format YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS+00:00, default: 24hrs ago)

created_at_max

string

End date and time of the record created (format YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS+00:00, default: NOW())

next_token

string

Next token

Headers

Content-Type

string

required

Content-Type

Default:

application/json

Example:

application/json

Responses

200

Get cancelled labels object.

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

object

next_token

string

limit

integer

created_at_min

string

created_at_max

string

cancel_labels

array[CancelLabel]

The array contains cancel_lebels object information. Please refer to cancel label object for details.

Auth

:

Parameters

:

:

:

:

:

:

:

Response Example

{
  "meta": {
    "code": 200,
    "message": "OK",
    "details": []
  },
  "data": {
    "next_token": "eyJjcmVhdGVkX2F0IjoiMjAxNS0000000000Njo1MjozNC4zNjFaIiwiaWQiOiIwNGZlNDgz0000000000QxYzItYWUxOC1kNTEzZjNmMWNmMWEiLCJ1c2Vy0000000000RjNDY4NTAtNjIyNS00ZTBiLTg5ZTQtZTM3N2M3YWM5ZDk4In0=",
    "limit": 20,
    "created_at_min": "2022-02-26T08:58:59+00:00",
    "created_at_max": "2022-02-27T08:58:59+00:00",
    "cancel-labels": [
      {
        "id": "0e37b87a-684e-43cd-aaba-f0718e066519",
        "status": "cancelled",
        "label": {
          "id": "166218cd-3e0a-4753-ac26-89ddabcd1dda"
        },
        "created_at": "2022-02-27T08:55:13+00:00",
        "updated_at": "2022-02-27T08:55:14+00:00"
      },
      {
        "id": "d05971fb-fddf-4243-ad58-7f34401b1da9",
        "status": "cancelled",
        "label": {
          "id": "0426d03a-ae0d-4818-801c-4e92b31450da"
        },
        "created_at": "2022-02-27T08:52:35+00:00",
        "updated_at": "2022-02-27T08:52:37+00:00"
      }
    ]
  }
}