API Documentation

  • Home
  • Developer
  • API Documentation
Light
Dark
System

Authentication

To access the API, you'll need to include the API keys in the request headers.

You can locate the API keys within the admin portal. Navigate to the "Business Accounts" section, then click on "Business Settings," where you'll find the keys necessary for access.

API key authentication header example

publickey: **************************

privatekey: ****************************

Generate Price API

To get automated price for the booking form. This will generate the price for developer who want to use it on other platform.
POST

Params:

  • coll_postcode text

    Required

    Enter the collection postcode.

  • deli_postcode text

    Required

    Enter the delivery postcode.

  • items array

    Required

    Options PropertyDescription
    item_name text

    required: true    		Input the name of item 

    item_qty integer

    required: true

    		Input the item quantity 

    item_length float

    required: true

    		Input item length
    item_width float

    required: true    		Input item width
    item_height float

    required: true    		Input item height
    item_weight float

    required: true    		Input item weight
    item_boxes integer

    required: false    		Is the item is inside the boxes 
    then it will increase the price of 
    additional service according to size
    listed_item boolean

    required: false    		Meaning is the item is searched from our 
    items data base. See the Get Items api document

    Note: Item category will be automatically generate when item size is added and it will show price according to the size of items

  • coll_floor_option integer

    To add the list of floor option you will need to see the get additional service api doc.

  • deli_floor_option integer

    To add the list of floor option you will need to see the get additional service api doc.

  • additionalOptions array

    To get the additional service list you need to see the get additional service api doc

    Options PropertyDescription
    option_title text

    required: true    		The title of the additional service.

    option_value float

    required: true

    		Input the item quantity 
    add_option_value float/bool

    required: false    		If customer select the value this option added to array
    it is also checking that value is added or not.

    Note: The keys of the additional options are the ID of the option so it is needed to get price.

  • discountCode text

    To get discount on the order. 

Get Items API

To search the listed items on the system.
GET

Params:

  • searchTerm text

    Required

    Use this to search items like “Chair”, “Table” etc

Get Service / Additional Options API

To get the list of extra service for booking form.
GET

Params:

  • type text

    Required

    Only “standard”, “collection”, “delivery” are required

Create Order API

This process will create an order in the system and generate a Stripe checkout link, which will redirect the customer to the payment page. Once the payment is completed, the user will be directed to a success page.
POST

Params:

  • Customer none

    Required

    Options PropertyDescription
    customer_firstName text

    required: true    		Input the first name

    customer_lastName text

    required: false

    		Input the last name 

    customer_email text

    required: true

    		Input email
    customer_phone text

    required: true    		Input phone

  • Collection none

    Required

    Options PropertyDescription
    coll_postcode text

    required: true    		Input postcode

    coll_address text

    required: true

    		Input address 

    coll_fname  text

    required: true

    		Input first name
    coll_lname text

    required: false    		Input last name
    coll_email text

    required: true    		Input email
    coll_city text

    required: false    		Input city (It is auto generated if UK postcode entered)
    coll_region text

    required: false    		Input region (It is auto generated if UK postcode entered)
    coll_country text

    required: false    		Input country (It is auto generated if UK postcode entered)
    coll_time_from text

    required: false    		Input open time from (00:00) 
    coll_time_to text

    required: false    		Input open time to(00:00) 
    coll_note text

    required: false    		Input extra note
    coll_location text

    required: false    		Input location or url
    coll_safe_place text

    required: false    		Input safe place

  • Delivery none

    Required

    Options PropertyDescription
    deli_postcode text

    required: true    		Input postcode

    deli_address text

    required: true

    		Input address 

    deli_fname  text

    required: true

    		Input first name
    deli_lname text

    required: false    		Input last name
    deli_email text

    required: true    		Input email
    deli_phone text

    required: false    		Input city (It is auto generated if UK postcode entered)
    deli_region text

    required: false    		Input region (It is auto generated if UK postcode entered)
    deli_country text

    required: false    		Input country (It is auto generated if UK postcode entered)
    deli_time_from text

    required: false    		Input open time from (00:00) 
    deli_time_to text

    required: false    		Input open time to(00:00) 
    coll_note text

    required: false    		Input extra note
    deli_location text

    required: false    		Input location or url
    deli_safe_place text

    required: false    		Input safe place

  • items array

    Required

    Options PropertyDescription

    item_id integer

    required: true

    		Input the item ID if it is a listed item; if the item is not listed, enter "0".
    item_name text

    required: true    		Input the name of item 

    item_qty integer

    required: true

    		Input the item quantity 

    item_length float

    required: true

    		Input item length
    item_width float

    required: true    		Input item width
    item_height float

    required: true    		Input item height
    item_weight float

    required: true    		Input item weight
    item_boxes integer

    required: false    		Is the item is inside the boxes 
    then it will increase the price of 
    additional service according to size
    item_actual_price float

    required: required    		Input the actual price of the item.
    listed_item boolean

    required: false    		Meaning is the item is searched from our 
    items data base. See the Get Items api document

  • additionalOptions array

    Required

    To get the additional service list you need to see the get additional service api doc

    Options PropertyDescription
    option_title text

    required: true    		The title of the additional service.

    option_value float

    required: true

    		Input the item quantity 
    add_option_value float/bool

    required: false    		If the customer selects a value, it will be added to an array. The system also verifies whether the value has been successfully added.

    Note: The keys of the additional options are the ID of the option so it is needed to get price.

  • Booking Options none

    Options PropertyDescription
    coll_floor_option integer

    required: false

     

    To set the ID indicating which floor the collection is on, you'll need to retrieve the floor options from the "Get Service / Additional Options" API.

    deli_floor_option integer

    required: false

     

    To set the ID indicating which floor the delivery is on, you'll need to retrieve the floor options from the "Get Service / Additional Options" API.

    park_options array

    required: false    		Need to put select multiple option to send it like array. like for example ['No', 'NearBy (Both)', 'NearBy (Collection)', 'NearBy (Delivery)']
    entrance_options array

    required: false    		Need to put select multiple option to send it like array. like for example ['No', 'Only on collection', 'Only on delivery', 'Both']
    coll_floor_lift_option bool

    required: false    		Select if collection building has a lift to collect from
    deli_floor_lift_option bool

    required: false    		Select if delivery building has a lift to deliver to

  • Dates none

    Required

    Options PropertyDescription
    coll_date text

    required: true

     

    To set the collection date, you'll need to retrieve the dates from the "Get Route Date" API.

    Formats
    2022-10-01 to 2022-10-02
    2022-10-01to2022-10-02
    2022-10-01,2022-10-02

    Note: System will convert the valid date to array to attach it to order

    deli_date text

    required: true

     

    To set the delivery date, you'll need to retrieve the dates from the "Get Route Date" API.

    Formats
    2022-10-01 to 2022-10-02
    2022-10-01to2022-10-02
    2022-10-01,2022-10-02

    Note: System will convert the valid date to array to attach it to order

  • successUrl text

    Required

    To set the URL for successful payment redirection, specify the link where the user should be redirected after the payment is successfully completed.

  • currentUrl text

    Required

    To set the URL for current location redirection, provide the link where the user should be redirected if the payment fails or if the user wants to go back.

Get Route Dates API

To retrieve available dates based on the entered collection or delivery postcode, refer to the route schedule to see the scheduled dates for that area.
GET

Params:

  • postcode text

    Required

    To enter the postcode of the location