Sign in

v1

latestOpenAPI 3.0.0Apache License 2.02026-07-263171,5614.1 MB
Fulfillment Inbound v2024-03-20

scheduleSelfShipAppointment

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

post/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/selfShipAppointmentSlots/{slotId}/schedule

Path parameters

inboundPlanIdstring required

Identifier of an inbound plan.

shipmentIdstring required

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

slotIdstring required

An identifier to a self-ship appointment slot.

Request body

reasonComment'APPOINTMENT_REQUESTED_BY_MISTAKE' | 'VEHICLE_DELAY' | 'SLOT_NOT_SUITABLE' | 'OUTSIDE_CARRIER_BUSINESS_HOURS' | 'UNFAVOURABLE_EXTERNAL_CONDITIONS' | 'PROCUREMENT_DELAY' | 'SHIPPING_PLAN_CHANGED' | 'INCREASED_QUANTITY' | 'OTHER'

Reason for cancelling or rescheduling a self-ship appointment.

Example request

{
  "reasonComment": "OTHER"
}

Response

ScheduleSelfShipAppointment 200 response

Example response

{
  "selfShipAppointmentDetails": {
    "appointmentId": 1000,
    "appointmentSlotTime": {
      "endTime": "2023-03-09T13:15:30Z",
      "startTime": "2023-03-08T13:15:30Z"
    },
    "appointmentStatus": "ARRIVAL_SCHEDULED"
  }
}