Flype Order API
    • Flype Order API
      • Shipments
        • Rates
        • Shipments Count
        • All Shipments
        • Bulk Order
        • Shipment Details
        • Shipment Last Status
        • Cancel Shipment
        • Get Shipping label
      • Webhook
        • Webhook: Shipment status updates (Flype → Your Server)
      • Schemas
        • ApiStatus
        • ErrorResponse
        • ShipmentsCountResponse
        • AllShipmentsRequest
        • ShipmentSummary
        • AllShipmentsResponse
        • BulkOrderRequest
        • BulkOrderResponse
        • SchedulePickupRequest
        • SchedulePickupResponse
        • City
        • GetCitiesResponse
        • ShipmentDetailsResponse
        • ShipmentLastStatusResponse
        • CancelShipmentResponse
        • LabelResponse
        • Country
        • CountriesResponse
        • ShipmentStatusWebhook
        • PlaceBulkItem
        • SuccessMessageResponse
        • PlaceBulkAddress
        • BooleanDataResponse
        • PlaceBulkPickupLocation
        • ShipmentAddress
        • PlaceBulkShipment
        • ShipmentRecipient
        • PlaceBulkAcceptedOrder
        • ShipmentRetailerAddress
        • PlaceBulkDeniedOrder
        • ShipmentRetailer
        • BulkOrderResponseData
        • ShipmentDriver
        • ShipmentStatusHistoryEntry
        • DeliverySettings
        • DropOffDetails
        • AllShipmentsItem
        • CitiesResponse
        • AirwayBillResponse
        • WebhookShipmentStatusUpdate
        • WebhookAckResponse
        • PlaceBulkDeliveryAddress
        • PlaceBulkRequest

    SchedulePickupRequest

    Conditional fields:
    If pickup is not already scheduled: provide (externalLocationId OR pickupLocation) + serviceType + merchantName.
    If pickup already scheduled: send only trackingNumber; other fields are ignored.

    {
        "trackingNumber": "string",
        "externalLocationId": "string",
        "pickupLocation": {
            "streetAddress1": "string",
            "streetAddress2": "string",
            "city": "string",
            "country": "string",
            "postalCode": "string",
            "latitude": 0,
            "longitude": 0
        },
        "serviceType": "SAME_DAY",
        "merchantName": "string"
    }
    Built with