Fulfillment Webhook

Fulfillment Webhook details

Format of Fulfillment Webhook

For the 'Fulfillment/Complete' webhook the call will is made for the entire order once it's been fulfilled. A status field of either 'Complete' or 'Partial'. If the order is too big to send in a single request, multiple calls will be made with different line items.

{
  "orderId": "ORD_123213212",
  "partnerOrderId": "ABC123",
  "webhookStatus": "Complete",
  "shippingDetails": {
    "deliveryType": "code",
    "giftCards": [
      {
        "lineItemId": "LNE_343493912AB",
        "partnerLineItemId": "DEF123",
        "CardNumber": "432343123432343",
        "PIN": "13222"
      }
    ]
  }
}

Send Webhook URL when sending the order

The fulfillment webhook is set when the order is created. The format of the webhook can include a Path id or Query strings. TOTUS will send the entire path when making the webhook call.

{
  "partnerOrderId": "A33433",
  "lineItems": [
    {
      "partnerLineItemId": "BCD54234ADF",
      "productId": "SKU123",
      "quantity": 4,
      "loadValue": 50,
      "delivery": {
        "deliveryType": "Codes"
      }
    }
  ],
  "webhook": {
    "fulfillmentURL": "https://mywebhook.example.com/fulfillment/A33433?partnerid=123&partnerid2=94333"
  }
}