Schedule Inbound Delivery

Request

Schedule a Pending Inbound Delivery

Description

This endpoint allows you to schedule a previously unscheduled (PENDING) inbound delivery by providing slot times and attendees. The inbound will transition from PENDING to BOOKED and the full scheduling workflow (ASN creation, calendar booking, notifications) will be triggered.

Use Cases

Scheduling a delivery that was created without dates - Setting delivery times for a pending inbound after coordination with the warehouse

Security

OAuth2

Path

idstringrequired

Bodyapplication/json

attendeesArray of strings(List of attendees who will be present for the delivery )required

Optional: If provided, attendees will be associated with the inbound

slot_end_atstring, (date-time)(End time of the delivery slot )required

Required: Must be after slot_start_at

slot_start_atstring, (date-time)(Start time of the delivery slot )required

Required: Must be a valid future timestamp

curl -i -X POST \
  'https://developer-docs.quiqup.com/_mock/openapi/api/fulfilment/inbounds/{id}/schedule' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "attendees": [
      "string"
    ],
    "slot_end_at": "2019-08-24T14:15:22Z",
    "slot_start_at": "2019-08-24T14:15:22Z"
  }'

Responses

Success response

Bodyapplication/json

asn_idstring(ASN (Advance Shipment Notice) ID )

inbound_idstring(Unique identifier for the inbound booking )required

statusstring(InboundStatus represents the status of an inbound booking )required

Response

{
  "asn_id": "string",
  "inbound_id": "string",
  "status": "string"
}