Learn how to integrate your E-Commerce system with Doorhub On Demand service. You can learn more about the service from our website.
Please look into the getting started guide. (link here)
This api is for placing an on demand order for the store.
Method | URI | Headers |
---|---|---|
POST | https://doorhub.io/api/v1/orders/services/on-demand | Authorization: Bearer {token} / Api Key |
{primary} Example of a request
{
"storeId": 638,
"pickupStreet": "Krumtappen",
"pickupBuildingNo": "2",
"pickupPostCode": "2500",
"pickupCity": "Valby",
"pickupState": "Copenhagen",
"pickupFloor": "s.th",
"pickupName": "QC Store",
"pickupFirstName": "QC",
"pickupLastName": "Store",
"pickupPhone": "82726353",
"pickupEmail": "store1@email.com",
"pickupInstructions": "Any things from customer",
"dropOffStreet": "Heimdalsgade",
"dropOffBuildingNo": "42",
"dropOffPostCode": "2200",
"dropOffCity": "Copenhagen",
"dropOffState": "Copenhagen",
"dropOffFloor": "2.th",
"dropOffFirstName": "Shah Md",
"dropOffLastName": "Alam",
"dropOffPhone": "+459817262",
"dropOffWrapPhone": "+45330330",
"dropOffEmail": "customer@email.com",
"dropOffTime": "2021-03-04T12:12:21+01:00",
"dropOffInstructions": "Any things from customer",
"ownerRef": "asdasd",
"isAsap": false,
"cashOnDelivery": false,
"packages": [
{
"name": "Monitor",
"length": 20.4,
"width": 12,
"height": 5,
"weight": 11,
"isFragile": true
},
{
"name": "accessories",
"size": "small",
"weight": 5,
"isFragile": false
},
{
"name": "small items",
"size": "small",
"isFragile": true
},
{
"size": "small",
}
]
}
Parameters | Type | Status | Description |
---|---|---|---|
storeId | integer | required,if ownerId not present | The store id provided by Doorhub. Example: 123 |
ownerId | integer/string | required,if storeId not present | Your own store id. Example: "AD-123" |
pickupStreet | string | optional | pickupStreet what the pickup address street name. Example: "Krumtappen". |
pickupBuildingNo | string | optional | pickupBuildingNo which means the house / building number of the pickup address. Example: "2". |
pickupPostCode | string | optional | pickupPostCode is the post code of the pickup address. Example: "2500". |
pickupCity | string | optional | pickupCity is the city name of the pickup address. Example: "valby". |
pickupState | string | optional | pickupState is the state / region name of the pickup address. Example: "copenhagen". |
dropOffStreet | string | required | dropOffStreet what is the drop off street, usually the customer street name. Example: "Heimdalsgade". |
dropOffBuildingNo | string | required | dropOffBuildingNo which means the house / building number of the drop off address. Example: "42". |
dropOffPostCode | string | required | dropOffPostCode is the post code of the drop off address.. Example: "2200". |
dropOffCity | string | required | dropOffCity is the city name of the drop off address. Example: "copenhagen". |
dropOffState | string | optional | dropOffState is the state / region name of the drop off address. Example: "copenhagen". |
{success} Example of response [200]
{
"message": "Order created successfully",
"data": {
"orderStatus": "Waiting",
"store": {
"id": 503,
"address": ""
},
"order": {
"id": 234866,
"orderRef": "DDR503-0007",
"ownerRef": "138474635-123",
"sourceAddress": "",
"isAsap": false,
"packageSize": "small",
"dropOffTime": "",
"cashOnDelivery": false,
"instructions": "",
"instructionsForPartner": ""
}
}
}