Order created

Sent when one of your Bob Shop orders is paid. An unpaid or zero-value order is not sent.

Example payload

{
    "channel_id": 1234,
    "webhook_payload": {
        "orderId": 1234567,
        "enabled": true,
        "sellerUserId": 123,
        "sellersOrderStatus": "",
        "totalAmount": "100.00",
        "totalAmountTaxAmount": "15.00",
        "totalPaidAmount": "135.00",
        "buyersShippingAmount": "20.00",
        "orderItems": [
            {
                "orderItemId": 123456,
                "tradeId": 689438827,
                "tradeTitle": "Demo Product",
                "tradersReference": "SKU-ABC123",
                "quantity": 1,
                "itemAmount": "100.00",
                "totalOrderItemTaxAmount": "15.00",
                "productVariantOptions": [
                    { "name": "Size", "value": "Large" }
                ]
            }
        ],
        "paymentTransactions": [
            {
                "paymentTransactionId": 12345,
                "paymentMethod": "EFT",
                "time": "2023-12-27T17:23:04Z",
                "paidAmount": "135.00"
            }
        ],
        "smallOrderCharge": null,
        "delivery": {
            "firstName": "John",
            "lastName": "Doe",
            "building": "Example House",
            "address1": "1 Example Street",
            "address2": "",
            "suburb": "Example Park",
            "city": "Pretoria",
            "province": "Gauteng",
            "zipCode": "0001",
            "country": "South Africa",
            "telephone1": "0123456789",
            "telephone2": ""
        },
        "buyer": {
            "userId": 123,
            "alias": "JD",
            "firstName": "John",
            "lastName": "Doe",
            "emailAddress": "[email protected]",
            "mobileNumber": "0123456789",
            "telephone1": "0123456789",
            "telephone2": "",
            "address1": "1 Example Street",
            "address2": "",
            "zipCode": "0001",
            "country": "South Africa",
            "createdTime": "2014-11-03T16:18:54Z",
            "status": "ENABLED",
            "negativeUserReviews": 1,
            "positiveUserReviews": 20
        }
    }
}

Fields

Field	Meaning
channel_id	The Bob Sync channel the order relates to.
orderId	The Bob Shop order number. Use it to de-duplicate retries.
enabled	Whether the order is active. Always true, since only paid orders are sent.
sellerUserId	Your Bob Shop seller ID.
Amount fields (totalAmount, totalPaidAmount, itemAmount, buyersShippingAmount, tax fields)	Strings, with a thousands separator from 1,000 up, for example "5,440.00". Remove the separator before converting to a number.
orderItems[].tradeId	The Bob Shop listing number the item was bought from.
orderItems[].tradersReference	The sku you supplied for the variant. This is your key for matching the sale back to your own stock.
orderItems[].quantity	How many units sold. Subtract this in your own system.
orderItems[].productVariantOptions	The options of the variant that sold, for example Size: Large. Sent as null when the item has no options.
paymentTransactions	Sent as null when not applicable.
smallOrderCharge	Sent as null unless a small-order charge applies. When it does, an object with tradeTitle, quantity, itemAmount and ItemAmountTaxAmount.

Fields not listed are not sent: no order timestamps, shipping method names, order notes, trade images or item dimensions.