Storyous Public APIs
  1. Delivery API
Storyous Public APIs
  • Introduction
  • Merchants API
    • Get merchant and all its places
  • Menu API
    • Get a menu tree
    • Get time-based menu
    • Get Remaining amounts of time-based menu
  • Bills API
    • Get list of payment bills
    • Get detail of a payment bill
  • Delivery API
    • Create an order through delivery API
      POST
    • Get status of delivery order
      GET
  • Deskview API
    • Get list of desks
    • Get list of sections
    • Get desk view of a place
  • Features API
    • Get list of merchants/places with a feature
  • Hotel accounts integration API
    • Provide list of accounts
    • Write consumed items to hotel account
  • Stocks API
    • Get list of stocks
    • Get list of items
    • Get list of stock ups
    • Get detail of stock up
    • Create new stock up
    • Modify stock up
    • Delete stock up
    • Get list of stock takings
    • Get detail of stock taking
    • Create new stock taking
    • Modify stock taking
    • Delete stock taking
    • Get suppliers
  • Loyalty API
    • Introduction
    • Get benefit offer
    • Report offer validation error
    • Report benefit usage
    • Get loyalty benefit usages
    • Mark benefit usages as synchronized
  • DataSync
    • Webhook receiving endpoint
      • Receive new or updated records
    • Data domains
      • Stock management
        • Stocks domain
        • StockItemCategories domain
        • StockItems domain
        • StockMovements domain
      • Sales and costs
        • Bills domain
        • BillCosts domain
        • TerminalTransactions domain
        • PaymentTypes domain
        • Loyalty domain
      • Desks
        • DeskSections domain
        • Desks domain
      • Menu
        • ItemCategories domain
        • Items domain
        • PlaceITems domain
      • Merchants
        • Merchants domain
        • Places domain
        • Persons domain
  • Schemas
    • Schemas
      • Loyalty api
        • BalanceBenefitOfferRequest
        • ThirdPartyLoyaltyOfferRequest
        • LoyaltyOfferValidationError
        • LoyaltyBenefitUsagesPayload
        • BenefitInput
        • PaidItem
        • Applied Benefits
        • PaymentByBalance
        • UsedBalance
        • LoyaltyOfferResponse
        • MenuProductDefinition
        • UsedGeneralDiscount
      • Desk
      • Section
  1. Delivery API

Create an order through delivery API

POST
https://api.storyous.com/delivery/orders/{merchantPlaceId}
Notification webhooks
Notification webhooks have no retry logic and can be missed in some cases. They are good for speed up communication in 99 % of cases, but a periodicall call of Get status of delivery order has to be implemented in order to achieve reliable solution.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params

Header Params

Body Params application/json

Examples

Responses

🟢200Success
application/json
Order has been accepted.
Body

🟠409Bad Request
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.storyous.com/delivery/orders/5a75b658f60a3c15009312f1-5a75b658f60a3c15009312f2' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "externalId": "someOrderId",
    "deliveryType": "",
    "timing": {
        "asSoonAsPossible": false,
        "requestedDeliveryTime": "2016-01-01T13:30:00Z",
        "requestedPickupTime": "2016-01-01T13:30:00Z",
        "autoDeclineAfter": "2016-01-01T13:10:00Z"
    },
    "customer": {
        "name": "John Doe",
        "deliveryAddress": "Myslíkova 31, Praha 2",
        "deliveryAddressParts": {
            "street": "Přeloučská",
            "streetNumber": "13",
            "city": "Praha",
            "country": "Czech republic",
            "countryCode": "CZ",
            "zip": "18600",
            "latitude": 3.67865,
            "longitude": -12.67865
        },
        "phoneNumber": "+420 777 123 456",
        "email": "john.doe@gmail.com"
    },
    "alreadyPaid": false,
    "originalOrderProvider": "someproviderName",
    "paymentAlreadyFiscalized": false,
    "deliveryProvider": "null",
    "items": [
        {
            "itemId": "123",
            "count": 1,
            "unitPriceWithVat": 199.5,
            "note": "extra cheese",
            "additions": [
                {
                    "additionId": "123abc",
                    "countPerMainItem": 1,
                    "unitPriceWithVat": 199.5
                }
            ]
        }
    ],
    "note": "Lorem Ipsum",
    "deliveryNote": "Leave it before the doors",
    "discountWithVat": 199.5,
    "deliveryFeeWithVat": 199.5,
    "packageFeeWithVat": 69.2,
    "serviceFeeWithVat": 199.5,
    "deskId": "1234",
    "checkId": "1234",
    "tipWithVat": 33.4,
    "autoConfirm": true,
    "notification": {
        "confirm": "https://your-service.com/api/storyous-order/999/confirm",
        "dispatch": "https://your-service.com/api/storyous-order/999/dispatch",
        "decline": "https://your-service.com/api/storyous-order/999/decline"
    }
}'
Response Response Example
200 - Success
{
    "orderId": "55af539409393f3d00000054",
    "externalId": "someOrderId",
    "state": "NEW",
    "_version": 2,
    "_lastModifiedAt": "2016-01-01T13:30:00.000Z"
}
Previous
Get detail of a payment bill
Next
Get status of delivery order
Built with