Centre-Door

The HTTP POST request to /parcel/logistics/centre-door endpoint is used to create a logistics order for pickup and delivery. The request body should include details such as pickup origin, destinations, and items to be delivered.

Request Body

• pickup_origin (object) - Details of the pickup origin including centre code, state code, country code, city, address, contacts, pickup note, pickup date, pickup time, and vehicle.

  • centre_code (string, optional) - Code of the pickup centre.

  • state_code (string) - Code of the state for pickup.

  • country_code (string) - Code of the country for pickup.

  • city (string) - City for pickup.

  • address (string) - Address for pickup.

  • contacts (object) - Contact details for pickup.

    • name (string) - Name of the contact person.

    • email (string) - Email of the contact person.

    • phone_number (string) - Phone number of the contact person.

    • phone_number_2 (string, optional) - Additional phone number of the contact person.

  • pickup_note (string, optional) - Note for pickup.

  • pickup_date (string, optional) - Date for pickup.

  • pickup_time (string, optional) - Time for pickup.

  • vehicle (string, optional) - Vehicle for pickup.

• destinations (array) - Array of destination details.

  • region (object) - Region coordinates for delivery.

    • latitude (number) - Latitude of the region.

    • longitude (number) - Longitude of the region.

  • state_code (string) - Code of the state for delivery.

  • country_code (string) - Code of the country for delivery.

  • city (string) - City for delivery.

  • address (string) - Address for delivery.

  • contacts (object) - Contact details for delivery.

    • name (string) - Name of the contact person.

    • email (string) - Email of the contact person.

    • phone_number (string) - Phone number of the contact person.

    • phone_number_2 (string, optional) - Additional phone number of the contact person.

  • delivery_note (string, optional) - Note for delivery.

  • items (array) - Array of items to be delivered.

    • name (string) - Name of the item.

    • width (string, optional) - Width of the item.

    • length (string, optional) - Length of the item.

    • height (string, optional) - Height of the item.

  • item_weight (number) - Weight of the item.

Response

The response is in the form of a JSON schema with the following properties:

• status (boolean) - Indicates the status of the request.

• message (string) - Message related to the request status.

• data (object) - Data object containing the details of the logistics order.

  • tracking_number (string) - Tracking number for the order.

  • status (string) - Status of the order.

  • total_amount (number) - Total amount for the order.

  • total_discount_amount (number) - Total discount amount for the order.

  • total_amount_payable (number) - Total amount payable for the order.

  • discount_type (string) - Type of discount applied.

  • discount_description (string) - Description of the discount.