Fulfillments create

Webhookfulfillments/create

Triggered for any shipping action.

Requires the order access scope. Minimum supported version: 202007.

Request headers

X-Shoplazza-Topicstring
The event that triggered this delivery, e.g. orders/create
Example: orders/create
X-Shoplazza-Hmac-Sha256string

Base64-encoded HMAC-SHA256 signature of the request body, generated with your app's Client Secret. Use it to verify the request comes from Shoplazza

X-Shoplazza-Shop-Domainstring
The domain of the store that generated the event
Example: example.myshoplaza.com
X-Shoplazza-Api-Versionstring
The API version used to serialize the payload
Example: 2025-06
X-Shoplazza-Deduplication-IDstring

Deduplication ID for this delivery. It stays the same across retries of the same event—use it for idempotency

Request body

Schema

• fulfillment object

  idstring

  Fulfillment ID

  order_idstring

  Order ID

  statusstring

  Fulfillment record status

  created_atstring

  Creation time (i.e. shipment time)

  updated_atstring

  Last update time

  tracking_companystring

  Logistics company name. See tracking_items for multiple tracking numbers

  tracking_company_codestring

  Logistics company code. See tracking_items for multiple tracking numbers

  tracking_numberstring

  Tracking number. See tracking_items for multiple tracking numbers

  tracking_urlstring

  Tracking URL. See tracking_items for multiple tracking numbers

  tracking_items object[]

  List of tracking items, supporting multiple tracking numbers

  Array [

  tracking_companystring

  Logistics company name

  tracking_company_codestring

  Logistics company code

  tracking_numberstring

  Tracking number

  tracking_urlstring

  Tracking URL

  ]

  line_items object[]

  Products shipped in this fulfillment

  Array [

  idstring

  Line item ID

  product_idstring

  Product ID

  product_titlestring

  Product title

  product_handlestring

  Product handle

  product_urlstring

  Product URL

  variant_idstring

  Variant ID

  variant_titlestring

  Variant title

  skustring

  Variant SKU

  spustring

  Product SPU

  quantityinteger

  Quantity purchased

  shipped_quantityinteger

  Quantity shipped in this fulfillment

  pricestring

  Product unit price

  compare_at_pricestring

  Product compare-at unit price

  totalstring

  Line total (unit price x quantity)

  duty_pricestring

  Total duty

  payment_discount_pricestring

  Allocated payment discount amount

  discount_applicationsstring

  Discount details

  fulfillment_statusstring

  Fulfillment status

  requires_shippingboolean

  Whether the item requires shipping

  weightstring

  Product weight

  weight_unitstring

  Weight unit

  imagestring

  Product image URL

  notestring

  Product note

  vendorstring

  Vendor

  custom_propertiesobject

  Custom properties of the product

  properties object[]

  Variant option properties

  Array [

  namestring

  Option property name (e.g., Color)

  valuestring

  Option property value (e.g., Red)

  ]

  main_currency_prices object

  Amounts in the primary-market currency

  actual_ratestring

  Exchange rate of the primary-market currency against the order currency (e.g., 7.25 means 1 unit of the primary-market currency equals 7.25 units of the order currency)

  compare_at_pricestring

  The compare-at (original) unit price converted to the primary-market currency

  pricestring

  The unit selling price converted to the primary-market currency

  totalstring

  The line total (unit price x quantity) converted to the primary-market currency

  refund_quantityintegerdeprecated

  Quantity of the most recent refund request (refund events only). (Deprecated: do not use.)

  refund_totalstringdeprecated

  Cumulative refunded item amount (refund events only). (Deprecated: do not use.)

  ]

Example

{
  "fulfillment": {
    "id": "string",
    "order_id": "string",
    "status": "string",
    "created_at": "string",
    "updated_at": "string",
    "tracking_company": "string",
    "tracking_company_code": "string",
    "tracking_number": "string",
    "tracking_url": "string",
    "tracking_items": [
      {
        "tracking_company": "string",
        "tracking_company_code": "string",
        "tracking_number": "string",
        "tracking_url": "string"
      }
    ],
    "line_items": [
      {
        "id": "string",
        "product_id": "string",
        "product_title": "string",
        "product_handle": "string",
        "product_url": "string",
        "variant_id": "string",
        "variant_title": "string",
        "sku": "string",
        "spu": "string",
        "quantity": 0,
        "shipped_quantity": 0,
        "price": "string",
        "compare_at_price": "string",
        "total": "string",
        "duty_price": "string",
        "payment_discount_price": "string",
        "discount_applications": "string",
        "fulfillment_status": "string",
        "requires_shipping": true,
        "weight": "string",
        "weight_unit": "string",
        "image": "string",
        "note": "string",
        "vendor": "string",
        "custom_properties": {},
        "properties": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "main_currency_prices": {
          "actual_rate": "string",
          "compare_at_price": "string",
          "price": "string",
          "total": "string"
        }
      }
    ]
  }
}