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.
publickey: **************************
privatekey: ****************************
coll_postcode text
Required
Enter the collection postcode.
deli_postcode text
Required
Enter the delivery postcode.
items array
Required
Options Property | Description |
---|---|
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 Property | Description |
---|---|
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.