Skip to main content
POST
/
api
/
public
/
apps
/
{appId}
/
events
/
fulfillment
Fulfillment event
curl --request POST \
  --url https://api.vambe.me/api/public/apps/{appId}/events/fulfillment \
  --header 'Content-Type: application/json' \
  --header 'x-vambe-signature: <x-vambe-signature>' \
  --header 'x-vambe-timestamp: <x-vambe-timestamp>' \
  --data '
{
  "fulfillment": {
    "order_external_id": "<string>",
    "fulfillment_external_id": "<string>",
    "tracking_number": "<string>",
    "delivery_address": {
      "recipient_name": "<string>",
      "phone": "<string>",
      "address_line_1": "<string>",
      "address_line_2": "<string>",
      "city": "<string>",
      "region": "<string>",
      "country": "<string>",
      "postal_code": "<string>"
    }
  }
}
'
Push a shipment/fulfillment update. The shipment is linked to its order even if the fulfillment arrives before the order webhook (it is backfilled when the order lands).
Every webhook must be signed: send x-vambe-signature (hex HMAC-SHA256 of ${x-vambe-timestamp}.${rawBody} using the app signing secret) and x-vambe-timestamp (unix epoch seconds). Requests older than 5 minutes are rejected.

Headers

​
x-vambe-timestamp
string
required

Unix epoch seconds when the request was signed. Requests older than 5 minutes are rejected.

​
x-vambe-signature
string
required

Hex HMAC-SHA256 of ${x-vambe-timestamp}.${rawBody} using the app signing secret.

Path Parameters

​
appId
string
required

Body

application/json
​
fulfillment
object
required
​
external_store_id
string
​
event_id
string

Response

201 - undefined