scheduleSelfShipAppointment

post https://sellingpartnerapi-na.amazon.com/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/selfShipAppointmentSlots/{slotId}/schedule

Confirms or reschedules a self-ship appointment slot against a shipment. Only available in the following marketplaces: MX, BR, EG, SA, AE, IN.

Usage Plan:

Rate (requests per second)	Burst
2	2

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

Path Params

inboundPlanId

string

required

length between 38 and 38

Identifier of an inbound plan.

shipmentId

string

required

length between 38 and 38

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

slotId

string

required

length between 38 and 38

An identifier to a self-ship appointment slot.

Body Params

The body of the request to scheduleSelfShipAppointment.

reasonComment

string

Reason for cancelling or rescheduling a self-ship appointment.

Show Details

APPOINTMENT_REQUESTED_BY_MISTAKE	-
VEHICLE_DELAY	-
SLOT_NOT_SUITABLE	-
OUTSIDE_CARRIER_BUSINESS_HOURS	-
UNFAVOURABLE_EXTERNAL_CONDITIONS	-
PROCUREMENT_DELAY	-
SHIPPING_PLAN_CHANGED	-
INCREASED_QUANTITY	-
OTHER	-

Responses

Language


xxxxxxxxxx
1
curl --request POST \
2
     --url https://sellingpartnerapi-na.amazon.com/inbound/fba/2024-03-20/inboundPlans/inboundPlanId/shipments/shipmentId/selfShipAppointmentSlots/slotId/schedule \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'


xxxxxxxxxx
10
 
1
{
2
  "selfShipAppointmentDetails": {
3
    "appointmentId": 1000,
4
    "appointmentSlotTime": {
5
      "endTime": "2023-03-09T13:15:30Z",
6
      "startTime": "2023-03-08T13:15:30Z"
7
    },
8
    "appointmentStatus": "ARRIVAL_SCHEDULED"
9
  }
10
}

x-amzn-RequestId	Unique request reference identifier.
x-amzn-RateLimit-Limit	Your rate limit (requests per second) for this operation.

200ScheduleSelfShipAppointment 200 response

400Request has missing or invalid parameters and cannot be parsed.

403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.

404The resource specified does not exist.

413The request size exceeded the maximum accepted size.

415The request payload is in an unsupported format.

429The frequency of requests was greater than allowed.

500An unexpected condition occurred that prevented the server from fulfilling the request.

503Temporary overloading or maintenance of the server.