Sync order (HW order)

PUT

https://api.storyous.com/orders/{orderId}

Called by IS when an HW order is created or its state changes.

Request

Authorization

API Key

Add parameter in header

x-api-router-secret

Example:

x-api-router-secret: ********************

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Order synced

Body

🟠400

🟠404

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://api.storyous.com/orders/' \
--header 'x-api-router-secret: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "orderId": "string",
    "placeId": "string",
    "merchantId": "string",
    "state": "new",
    "paymentType": "onInvoice",
    "billingProvider": "chargebee",
    "stubInvoice": {
        "currency": "CZK",
        "lines": [
            {
                "name": "string",
                "quantity": 0,
                "unitPrice": 0,
                "unitName": "ks",
                "vatRate": 0,
                "isHw": true,
                "productId": "string"
            }
        ]
    },
    "shortTermRental": {
        "period": "string",
        "shortTermRentalTill": "2019-08-24T14:15:22.123Z",
        "communicatedReturnDateTime": "2019-08-24T14:15:22.123Z"
    }
}'

Response Example

{
    "status": "OK"
}

Sync place-level feature

Get merchant billing info