API Reference

Webhook Payloads

These are the payloads for the respective webhook topics

Topic: order_fulfillable

{
  order: {
    id: "65820634daf0b556858ed591",
    orderNo: 19618657,
    createdAt: "2023-12-19T21:08:06.162Z",
    status: "sent_to_fulfiller",
    statusHistory: [{
        status: "created",
        updatedAt: "2023-12-19T21:08:06.162Z",
    }, {
        status: "on_fulfillment_queue",
        updatedAt: "2023-12-19T21:08:07.281Z",
    }, {
        status: "sent_to_fulfiller",
        updatedAt: "2023-12-19T21:11:08.119Z",
    }],
    financialStatus: "authorized",
    user: {
        id: "6132b96601ceceabe344dcad",
        email: "[email protected]",
        telephoneNumber: "01234567890",
    },
    shippingAddress: {
        firstName: "Elena",
        lastName: "Wu",
        addressLine1: "1460 Broadway",
        addressLine2: "",
        city: "New York",
        state: "NY",
        postalCode: "10036",
        country: "USA",
        telephoneNumber: "01234567890",
    },
    orderVariants: [{
        id: "658205f64570533aa7548cac",
        quantity: 2,
        fulfilledQuantity: 2,
        variant: {
            id: "65698ded25d03cf922c80f93",
            sku: "MY120123A",
            upc: "9090008008883",
            name: "Bounty Paper Towels",
        }
    }],
    fulfillments: [{
        id: "6582063809abb2706f670f36",
        createdAt: "2023-12-19T21:11:08.124Z",
        fulfillmentMethod: "carrier_delivery",
        fulfillerLocation: "60d56d8e7c88cefd11e7dfc6",
        fulfillerVariants: [{
            quantity: 1,
            variant: "65698ded25d03cf922c80f93",
            orderVariant: "658205f64570533aa7548cac",
        }],
        specialInstructions: "Ring the doorbell, do not knock",
        status: "in_transit",
        statusHistory: [{
            status: "order_placed",
            updatedAt: "2023-12-19T21:11:08.124Z",
        }, {
            status: "received_by_fulfiller",
            updatedAt: "2023-12-19T21:11:08.134Z",
        }, {
            status: "preparing_items",
            updatedAt: "2023-12-19T21:11:09.124Z",
        }, {
            status: "preparing_items_complete",
            updatedAt: "2023-12-19T21:11:18.124Z",
        }, {
            status: "in_transit",
            updatedAt: "2023-12-19T21:12:58.124Z",
        }],

        externalOrderId: "21396",
        externalOrderStatus: "Being Delivered",

        shipments: [{
            carrier: "ups",
            carrierReferenceId: "UPS1234567"
            trackingNumber: "123456666",
            trackingUrl: "https://www.ups.com/track?loc=en_US&tracknum=123456666&requester=ST/",
            shippingDate: "2023-12-19T21:11:08.119Z",
            shipmentVariants: [{
                quantity: 1,
                variant: "65698ded25d03cf922c80f93",
            }],
        }],
    }],
  }
}

Topic: order_cancelled

{
  order: {
    id: "65820634daf0b556858ed591";
  }
}