cancelSelfShipAppointment

Cancels a self-ship appointment slot against a shipment.

Usage Plan:

Rate (requests per second)	Burst
2	30

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

Request

Path Params

inboundPlanId

string

required

Identifier of an inbound plan.

>= 38 characters<= 38 characters

Match pattern:

^[a-zA-Z0-9-]*$

shipmentId

string

required

Identifier of a shipment. A shipment contains the boxes and units being inbounded.

>= 38 characters<= 38 characters

Match pattern:

^[a-zA-Z0-9-]*$

Body Params application/json

The `cancelSelfShipAppointment` request.

reasonComment

enum<string>

optional

Reason for cancelling or rescheduling a self-ship appointment.

Allowed values:

APPOINTMENT_REQUESTED_BY_MISTAKEVEHICLE_DELAYSLOT_NOT_SUITABLEOUTSIDE_CARRIER_BUSINESS_HOURSUNFAVOURABLE_EXTERNAL_CONDITIONSPROCUREMENT_DELAYSHIPPING_PLAN_CHANGEDINCREASED_QUANTITYOTHER

Example

{
    "reasonComment": "OTHER"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢202Accepted

application/json

CancelSelfShipAppointment 202 response

Headers

x-amzn-RequestId

string

optional

Unique request reference identifier.

x-amzn-RateLimit-Limit

string

optional

Your rate limit (requests per second) for this operation.

Body

The `CancelSelfShipAppointment` response.

operationId

string

required

UUID for the given operation.

>= 36 characters<= 38 characters

Match pattern:

^[a-zA-Z0-9-]*$

Example

{
    "operationId": "stringstringstringstringstringstring"
}

🟠400Bad Request

🟠403Forbidden

🟠404Record Not Found

🟠413413

🟠415415

🟠429429

🔴500Server Error

🔴503Service Unavailable