Order Payload Reference: Channel-Specific Fields and Shared Object Schemas

This article extends the Webhooks documentation with a detailed reference to channel-specific order fields and the shared sub-object schemas used across Neuro order payloads.

Last updated 7 months ago

Data Structures Inside the Webhooks Payloads

When you have finished wiring up webhooks, the natural next question is, “what exactly is in the order payload I’m receiving?” This article picks up where the Webhook guide ends and serves as a field‑level reference for the data structures inside those payloads.

It starts with Channel-Specific Order Fields (Section 1), showing how each sales channel contributes additional metadata to an order via the ‎`channel_specific` object and a small set of merged top‑level fields (such as ‎`order_access_url` and ‎`ioss_number`). You can see, per channel, which fields are available, when they are present, and how values like ‎`shipping_method` are derived.

From there, Section 2 covers the Shared Sub-Object Schemas that appear consistently across payloads, including customers, addresses, payment details, order line items, fulfilments, returns, and more. Together, these sections give you a precise, implementation-ready map of the order JSON your integrations will consume.

This article is the second part of a two‑part guide. In the first instalment we covered how to configure and consume Neuro webhooks; here, we focus entirely on the shape of the data they deliver. If you need a refresher on setting up endpoints, event types, or retry behaviour, refer back to the Webhooks: Complete Field Reference (Practical Guide), then return here for a detailed, field‑by‑field tour of the order payload.

1. Channel-Specific Order Fields

In addition to the standard order fields, each channel merges additional fields into the order payload. These appear in two places:

channel_specific - an object containing channel meta data. Built from the order's meta_fields and orderMeta records.
Top-level merged fields - fields like order_access_url and ioss_number that are merged directly into the root of the order JSON.

1.1 Merged Top-Level Fields by Channel

These fields appear at the root level of the order JSON (not inside channel_specific):

Channel	Extra Top-Level Fields
Shopify	`order_access_url`
Amazon SP	`ioss_number`, `order_access_url` (conditional, based on marketplace)
WooCommerce	`order_access_url`
Magento	`order_access_url`
eBay	`order_access_url`, `ioss_number`
Etsy	`order_access_url`
BigCommerce	`order_access_url`
OpenCart	`order_access_url`
PrestaShop	`order_access_url`
BtoB Wave	`order_access_url`
VisualSoft	`ioss_number`
TikTok Shop	—
OnBuy	—
ReCharge	—
Linnworks	—
DC Ecommerce	—

2. Shipping Method by Channel

Channel	`shipping_method` value	Source
Shopify	Human-readable title (e.g. "Standard Shipping")	Comma-joined `shipping_lines[].title`
Amazon SP	Service level code (e.g. "Std UK Dom_2")	`ShipServiceLevel`. Category in `channel_specific.shipment_service_level_category`
WooCommerce	Method title (e.g. "Royal Mail Tracked 24")	`shipping_lines[0].method_title`
Magento	Description or method code	`shipping_description` if "Use Shipping Method Description" is ON; otherwise raw method code
eBay	Service identifier (e.g. "UK_RoyalMailSecondClassStandard")	`ShippingServiceSelected.ShippingService`
Etsy	As provided by Etsy	Etsy shipping data
BigCommerce	As provided by BigCommerce	BigCommerce shipping data
OpenCart	As provided by OpenCart	OpenCart shipping data
PrestaShop	As provided by PrestaShop	PrestaShop carrier name
VisualSoft	As provided by VisualSoft	VisualSoft shipping data

3. Specific Fields - Per Channel Detail

Below is every field that can appear inside channel_specific for each channel, with conditions for when each field is included.

Shopify

{
  "channel_specific": {
    "order_number": "1042",
    "tags": ["VIP", "wholesale", "gift_message:Happy Birthday!"],
    "shipping_code": "shopify-Standard Shipping-4.99",
    "total_weight": 500,
    "is_pos_order": false,
    "ioss_number": "IM1234567890",
    "pudo_id": "PUDO-12345",
    "what3words_address": {
      "shipping_words": "filled.count.soap",
      "billing_words": "index.home.raft",
      "shipping_lat": "51.520847",
      "shipping_long": "-0.195521",
      "billing_lat": "51.520847",
      "billing_long": "-0.195521",
      "shipping_nearest_place": "London",
      "billing_nearest_place": "London"
    }
  }
}

Field	Type	Always Sent?	Condition / Notes
`order_number`	string	Yes	Shopify's display order number (e.g. "#1042"). Always present.
`tags`	array of strings	Yes	Shopify order tags (comma-separated on Shopify) merged with `note_attributes` (formatted as `"name:value"`). The `what3words address` note attribute is excluded. Always present (may be empty array).
`shipping_code`	string	Yes	Code from the first shipping line (e.g. `"shopify-Standard Shipping-4.99"`). Always present (may be empty string).
`total_weight`	number	Yes	Total order weight in grams as reported by Shopify. Always present (defaults to 0).
`is_pos_order`	boolean	Yes	`true` if the order originated from Shopify POS (Point of Sale); `false` otherwise. Always present.
`ioss_number`	string	No	Only present when the Xendo plugin is active OR `fetch_order_meta_fields` is enabled on the channel, and the Shopify order has an `ioss_number` meta field.
`pudo_id`	string	No	Only present when `fetch_pudo_id` is enabled on the channel AND the Shopify order has a matching PUDO meta field (configured via `pudo_id_mappings`). Used for parcel pick-up/drop-off points.
`what3words_address`	object	No	Only present when `use_what3words` is enabled on the channel. Contains What3Words location data. See What3Words Object.
(additional meta fields)	varies	No	When `fetch_order_meta_fields` is enabled on the channel, all Shopify order meta fields (from the GraphQL API) are merged into `channel_specific` as `key: value` pairs. The exact fields depend on what Shopify apps/customisations the merchant has installed.

Amazon SP

{
  "channel_specific": {
    "is_prime": false,
    "fulfillment_channel": "MFN",
    "ship_service_level": "Std UK Dom_2",
    "shipment_service_level_category": "Standard",
    "earliest_ship_date": "2026-01-15T00:00:00Z",
    "latest_ship_date": "2026-01-17T23:59:59Z",
    "earliest_delivery_date": "2026-01-18T00:00:00Z",
    "latest_delivery_date": "2026-01-22T23:59:59Z",
    "ioss": "ioss",
    "is_bopis": false,
    "bopis_store": "Amazon Fresh London"
  }
}

Field	Type	Always Sent	Condition / Notes
`is_prime`	boolean	Yes	`true` if the order is an Amazon Prime order. Always present.
`fulfillment_channel`	string	Yes	`"MFN"` (Merchant Fulfilled) or `"AFN"` (Amazon FBA). Always present.
`ship_service_level`	string	Yes	Amazon's ship service level code (e.g. `"Std UK Dom_2"`, `"Exp UK Dom_1"`). Always present.
`shipment_service_level_category`	string	Yes	Broader category: `"Standard"`, `"Expedited"`, `"FreeEconomy"`, `"NextDay"`, `"SameDay"`, etc. Always present.
`earliest_ship_date`	datetime / null	Yes	Earliest date the order should be shipped. Always present (may be null).
`latest_ship_date`	datetime / null	Yes	Latest date the order should be shipped. Always present (may be null).
`earliest_delivery_date`	datetime / null	Yes	Earliest expected delivery date. Always present (may be null).
`latest_delivery_date`	datetime / null	Yes	Latest expected delivery date. Always present (may be null).
`ioss`	string	Yes	IOSS identifier key. Always present.
`is_bopis`	boolean	Yes	`true` if the order is a Buy Online Pick-up In Store (BOPIS / ISPU) order. Always present.
`bopis_store`	string	No	Only present when `is_bopis` is `true`. Contains the pick-up store name (from the shipping address name).

WooCommerce

{
  "channel_specific": {
    "what3words_address": {
      "shipping_words": "filled.count.soap",
      "billing_words": "index.home.raft",
      "shipping_lat": "51.520847",
      "shipping_long": "-0.195521",
      "billing_lat": "51.520847",
      "billing_long": "-0.195521",
      "shipping_nearest_place": "London",
      "billing_nearest_place": "London"
    }
  }
}

Field	Type	Always Sent?	Condition / Notes
`what3words_address`	object	No	Only present when the WooCommerce order contains What3Words data in `meta_data` (keys `_shipping_w3w`, `_billing_w3w`, etc.). Populated from the WooCommerce What3Words plugin fields. See What3Words Object.

When no What3Words data is present, channel_specific may be null or an empty object.

Magento

{
  "channel_specific": {
    "increment_id": "000000045",
    "gift_message": "Happy Birthday!",
    "customer_group_id": "1",
    "what3words_address": {
      "shipping_words": "filled.count.soap",
      "billing_words": null,
      "shipping_lat": "51.520847",
      "shipping_long": "-0.195521",
      "billing_lat": null,
      "billing_long": null,
      "shipping_nearest_place": "London",
      "billing_nearest_place": null
    },
    "invoice_created": true
  }
}

Field	Type	Always Sent?	Condition / Notes
`increment_id`	string	Yes	Magento's order increment ID. Always present (may be empty string).
`gift_message`	string	Yes	Gift message from `extension_attributes.gift_message.message`. Always present (empty string if no gift message).
`customer_group_id`	string	Yes	Magento customer group ID. Always present (may be empty string).
`what3words_address`	object	No	Only present when `use_what3words` is enabled on the channel. Populated from Magento's What3Words extension attributes. See What3Words Object.
`invoice_created`	boolean	No	Only present when `auto_create_invoices` is enabled on the channel AND Magento reports `total_invoiced == grand_total`. Indicates the order has been fully invoiced on Magento.

eBay

{
  "channel_specific": {
    "buyer_user_id": "john_doe_123",
    "selling_manager_sales_record_number": "5678",
    "ioss_number": "IM1234567890"
  }
}

Field	Type	Always Sent?	Condition / Notes
`buyer_user_id`	string	Yes	eBay buyer's user ID. Always present (may be empty string).
`selling_manager_sales_record_number`	string / null	Yes	eBay Selling Manager sales record number. Always present (may be null if not using Selling Manager).
`ioss_number`	string	No	Only present when the eBay transaction contains an `eBayCollectAndRemitTaxes.eBayReference` value (for EU IOSS orders).

Etsy

{ 
    "channel_specific": 
    { "tags": ["gift", "custom-engraving"] 
    } 
}

Field	Type	Always Sent?	Condition / Notes
`tags`	array of strings	Yes	Etsy order tags. Always present (may be empty array). Trimmed and deduplicated.

BigCommerce

{
  "channel_specific": {
    "what3words_address": {
      "shipping_words": "filled.count.soap",
      "billing_words": null,
      "shipping_lat": "51.520847",
      "shipping_long": "-0.195521",
      "billing_lat": null,
      "billing_long": null,
      "shipping_nearest_place": "London",
      "billing_nearest_place": null
    }
  }
}

Field	Type	Always Sent?	Condition / Notes
`what3words_address`	object	No	Only present when `use_what3words` is enabled on the channel. See What3Words Object.

When no What3Words data is present, channel_specific will be null.

OpenCart

{
  "channel_specific": {
    "what3words_address": {
      "shipping_words": "filled.count.soap",
      "billing_words": null,
      "shipping_lat": "51.520847",
      "shipping_long": "-0.195521",
      "billing_lat": null,
      "billing_long": null,
      "shipping_nearest_place": "London",
      "billing_nearest_place": null
    }
  }
}

Field	Type	Always Sent?	Condition / Notes
`what3words_address`	object	No	Only present when `use_what3words` is enabled on the channel. See What3Words Object.

When no What3Words data is present, channel_specific will be null.

PrestaShop

PrestaShop does not populate channel_specific. The field will be null.

VisualSoft

{
  "channel_specific": {
    "tags": ["express", "gift-wrap"],
    "eori_number": "GB123456789000",
    "ioss_number": "IM1234567890"
  }
}

Field	Type	Always Sent?	Condition / Notes
`tags`	array of strings	Yes	Order tags. Always present (may be empty array).
`eori_number`	string	No	Only present when the VisualSoft order contains a `CUSTOMER.EORI_NUMBER` value.
`ioss_number`	string	Yes	From `TAX_COLLECTION_ID`. Always present (may be empty string).

BtoB Wave

{
  "channel_specific": {
    "custom_field_1": "value_1",
    "custom_field_2": "value_2"
  }
}

Field	Type	Always Sent?	Condition / Notes
(extra_fields)	varies	No	All fields from the BtoB Wave order's `extra_fields` object are mapped directly into `channel_specific`. The exact fields depend on the merchant's BtoB Wave configuration. Will be `null` if no extra fields exist.

TikTok Shop

{
  "channel_specific": {
    "package_ids": ["PKG-001", "PKG-002"],
    "tags": ["Late shipment"]
  }
}

Field	Type	Always Sent?	Condition / Notes
`package_ids`	array of strings	Yes	TikTok Shop package IDs associated with the order. Always present.
`tags`	array of strings	No	Only present when one or more order items have a `sku_cancel_reason` of `"Late shipment"`. Contains the cancellation reason tags.

OnBuy

{ 
    "channel_specific": 
    { 
        "site_id": "2000", 
        "site_name": "OnBuy UK" 
    } 
}

Field	Type	Always Sent?	Condition / Notes
`site_id`	string	No	Only present when the OnBuy order data contains `site_id`. Identifies which OnBuy marketplace site the order came from.
`site_name`	string	No	Only present when the OnBuy order data contains `site_name`. Human-readable site name.

When neither field is present, channel_specific will be null.

ReCharge

{
  "channel_specific": {
    "shopify_id": "5001234567890",
    "shopify_cart_token": "abc123def456",
    "shopify_customer_id": "cust_789",
    "shopify_order_id": "ord_456",
    "shopify_order_number": "1042",
    "order_number": "RC-10234",
    "shipping_code": "standard",
    "tags": ["subscription", "recurring"]
  }
}

Field	Type	Always Sent?	Condition / Notes
`shopify_id`	string	Yes	The linked Shopify order ID. Always present (empty if not available).
`shopify_cart_token`	string	Yes	Shopify cart token. Always present (empty if not available).
`shopify_customer_id`	string	Yes	Shopify customer ID. Always present (empty if not available).
`shopify_order_id`	string	Yes	Shopify order ID reference. Always present (empty if not available).
`shopify_order_number`	string	Yes	Shopify order number. Always present (empty if not available).
`order_number`	string	Yes	ReCharge order number. Always present.
`shipping_code`	string	Yes	Shipping code from the first shipping line. Always present (may be empty).
`tags`	array of strings	No	Only present when the ReCharge order has tags. Comma-separated tags are split into an array.

Note: Empty values for shopify_* fields are filtered out — only non-empty values are included.

Linnworks

{ 
    "channel_specific": 
    { "tags": ["Priority", "Express"] 
    } 
}

Field	Type	Always Sent?	Condition / Notes
`tags`	array of strings	No	Only present when `include_order_identifiers_as_tag` is enabled on the channel. Contains Linnworks order identifier tags.

When tags are not enabled, channel_specific will be null.

DC Ecommerce

{
  "channel_specific": {
    "shopify_order_id": "5001234567890",
    "tags": ["wholesale", "attr_key: attr_value"]
  }
}

Field	Type	Always Sent?	Condition / Notes
`shopify_order_id`	string	Yes	The linked Shopify order ID. Always present (may be empty).
`tags`	array of strings	Yes	Order tags merged with `custom_attributes` (formatted as `"key: value"`). Always present (may be empty array).

What3Words Object

When a channel has What3Words integration enabled, the what3words_address object contains:

{
  "shipping_words": "filled.count.soap",
  "billing_words": "index.home.raft",
  "shipping_lat": "51.520847",
  "shipping_long": "-0.195521",
  "billing_lat": "51.520847",
  "billing_long": "-0.195521",
  "shipping_nearest_place": "London",
  "billing_nearest_place": "London"
}

Field	Type	Description
`shipping_words`	string / null	What3Words address for shipping location
`billing_words`	string / null	What3Words address for billing location
`shipping_lat`	string / null	Shipping latitude
`shipping_long`	string / null	Shipping longitude
`billing_lat`	string / null	Billing latitude
`billing_long`	string / null	Billing longitude
`shipping_nearest_place`	string / null	Nearest named place to shipping address
`billing_nearest_place`	string / null	Nearest named place to billing address

Supported on:
Shopify, WooCommerce, Magento, BigCommerce, OpenCart

2. Shared Sub-Object Schemas

Customer Object

{
  "id": 12345,
  "customer_uuid": "cust-uuid-0001",
  "company_id": 1,
  "name": "Jane Smith",
  "email": "jane.smith@example.com",
  "created_at": "2025-06-10T08:00:00.000000Z",
  "updated_at": "2026-01-15T14:32:00.000000Z"
}

Field	Type	Description
`id`	integer	Internal customer ID
`customer_uuid`	string (UUID)	Customer UUID
`company_id`	integer	Company / account ID
`name`	string	Customer full name
`email`	string	Customer email (empty if hidden by account settings)
`created_at`	datetime	Customer created
`updated_at`	datetime	Customer last updated

Address Object

{
  "id": "addr-uuid-001",
  "name": "Jane Smith",
  "company_name": "Acme Ltd",
  "address_line_one": "123 High Street",
  "address_line_two": "Floor 2",
  "address_line_three": "",
  "long_address": "123 High Street, Floor 2",
  "county": "Greater London",
  "city": "London",
  "country_iso_code": "GB",
  "zip": "EC1A 1BB",
  "phone": "+441234567890"
}

Field	Type	Description
`id`	string (UUID)	Address UUID
`name`	string	Recipient name
`company_name`	string	Company name
`address_line_one`	string	Address line 1
`address_line_two`	string	Address line 2
`address_line_three`	string	Address line 3
`long_address`	string	Concatenated full address (may be trimmed by character limit settings)
`county`	string	County / state / province
`city`	string	City
`country_iso_code`	string	ISO 3166-1 alpha-2 country code
`zip`	string	Postal / ZIP code
`phone`	string	Phone number

Payment Details Object

{
  "vat_id": "",
  "vat_type": "",
  "tax_rate": "20.00",
  "tax_total": "8.33",
  "shipping_total": "4.99",
  "discount_total": "0.00",
  "discount_total_exc_tax": "0.00",
  "order_subtotal": "41.65",
  "order_subtotal_exc_tax": "33.32",
  "order_total": "46.64",
  "payment_method": "shopify_payments",
  "payment_ref": "ch_3ABC123",
  "payment_currency": "GBP",
  "coupon_code": "",
  "coupon_total": "0.00",
  "coupon_total_exc_tax": "0.00"
}

Field	Type	Description
`vat_id`	string	Customer VAT ID
`vat_type`	string	VAT type
`tax_rate`	string (decimal)	Tax rate percentage
`tax_total`	string (decimal)	Total tax amount
`shipping_total`	string (decimal)	Shipping cost
`discount_total`	string (decimal)	Total discount (inc tax)
`discount_total_exc_tax`	string (decimal)	Total discount (exc tax)
`order_subtotal`	string (decimal)	Order subtotal (inc tax)
`order_subtotal_exc_tax`	string (decimal)	Order subtotal (exc tax)
`order_total`	string (decimal)	Final order total
`payment_method`	string	Payment method
`payment_ref`	string	Payment reference / transaction ID
`payment_currency`	string	Three-letter currency code
`coupon_code`	string	Applied coupon code
`coupon_total`	string (decimal)	Coupon discount amount (inc tax)
`coupon_total_exc_tax`	string (decimal)	Coupon discount amount (exc tax)

Order Line Item Object

{
  "id": "item-uuid-0001",
  "remote_id": "li_123456",
  "sku": "WIDGET-BLU-M",
  "channel_product_id": "cp-uuid-0001",
  "master_product_id": "mp-uuid-0001",
  "matched_sku": "WIDGET-BLU-M",
  "quantity": 1,
  "refunded_quantity": 0,
  "name": "Blue Widget (Medium)",
  "unit_price": "20.83",
  "unit_price_exc_tax": "16.66",
  "unit_discount": "0.00",
  "total_discount": "0.00",
  "unit_tax_rate": "20.02",
  "unit_tax_value": "4.17",
  "total_tax_value": "4.17",
  "total_price": "20.83",
  "is_tax_included": true,
  "options": null,
  "image_url": "https://cdn.example.com/widget-blue.jpg",
  "file_url": null,
  "notes": null,
  "kit": [
    { "quantity": 1, "sku": "WIDGET-RED-S", "name": "Red Widget (Small)" }
  ]
}

Field	Type	Description
`id`	string (UUID)	Neuro order item UUID
`remote_id`	string	Line item ID on the channel
`sku`	string	Product SKU from the channel
`channel_product_id`	string (UUID)	Neuro channel product UUID
`master_product_id`	string (UUID)	Neuro main product UUID
`matched_sku`	string	Matched SKU in Neuro (used for product linking)
`quantity`	integer	Quantity ordered
`refunded_quantity`	integer	Quantity refunded
`name`	string	Product name (falls back to SKU if empty)
`unit_price`	string (decimal)	Unit price (inc or exc tax — see `is_tax_included`)
`unit_price_exc_tax`	string (decimal)	Unit price excluding tax
`unit_discount`	string (decimal)	Discount per unit
`total_discount`	string (decimal)	Total discount for line
`unit_tax_rate`	string (decimal)	Calculated tax rate percentage
`unit_tax_value`	string (decimal)	Tax amount per unit
`total_tax_value`	string (decimal)	Total tax for line
`total_price`	string (decimal)	Total line price
`is_tax_included`	boolean	Whether `unit_price` includes tax
`options`	object / null	Variant options (decoded JSON — e.g. `{ "Color": "Blue", "Size": "M" }`)
`image_url`	string	Product image URL
`file_url`	string / null	Digital file URL (if applicable)
`notes`	string / null	Line item notes
`kit`	array	Only present for kit products. Array of `{ quantity, sku, name }` for component items.

Fulfilment Object

When an order has a fulfilment, the fulfillment field in order payloads contains:

{
  "id": "ff-uuid-0001",
  "order_id": "f7e6d5c4-1111-2222-3333-444444444444",
  "order_primary_reference_id": null,
  "order_remote_id": "5678901234",
  "order_remote_alt_id": "ALT-12345",
  "courier": {
    "id": "cc-uuid-0001",
    "name": "Royal Mail",
    "custom_name": "RM Tracked 24"
  },
  "shipping_method": "Royal Mail Tracked 24",
  "shipping_tracking_code": "JD012345678GB",
  "tracking_url": "https://www.royalmail.com/track-your-item#/tracking-results/JD012345678GB",
  "fulfillment_date": "2026-01-16T10:00:00.000000Z",
  "sync_status": 2,
  "items": [
    {
      "sku": "WIDGET-BLU-M",
      "quantity": 1
    }
  ],
  "order_items": [
    {
      "remote_id": "li_123456",
      "sku": "WIDGET-BLU-M",
      "quantity": 1
    }
  ]
}

Return Object

{
  "id": "ret-uuid-0001",
  "return_date": "2026-01-20T12:00:00.000000Z",
  "sync_status": 2,
  "items": [
    {
      "sku": "WIDGET-BLU-M",
      "quantity": 1,
      "reason": "Defective"
    }
  ]
}

Field	Type	Description
`id`	string (UUID)	Return UUID
`return_date`	datetime	When the return was created
`sync_status`	integer	Sync status code
`items`	array	Return items (present when items exist)

Courier Object

{
  "id": "cc-uuid-0001",
  "name": "Royal Mail",
  "custom_name": "RM Tracked 24"
}

Field	Type	Description
`id`	string (UUID)	Channel courier UUID
`name`	string	Courier name
`custom_name`	string	Custom display name

Dimensions Object

{
  "weight": 0.35,
  "weight_unit": "kg",
  "length": 30,
  "length_unit": "cm",
  "width": 25,
  "width_unit": "cm",
  "height": 2,
  "height_unit": "cm"
}

Field	Type	Description
`weight`	float	Item weight
`weight_unit`	string	Weight unit (`kg`, `g`, `lb`, `oz`)
`length`	float	Item length
`length_unit`	string	Length unit (`cm`, `in`)
`width`	float	Item width
`width_unit`	string	Width unit
`height`	float	Item height
`height_unit`	string	Height unit

Export (Customs) Object

{
  "hs_code": "6109.10.00",
  "country_of_origin": "GB",
  "customs_description": "Cotton T-Shirt"
}

Field	Type	Description
`hs_code`	string	Harmonised System tariff code
`country_of_origin`	string	ISO country code of manufacture
`customs_description`	string	Short description for customs declaration

Kit Item Object

{
  "id": "mp-uuid-3001",
  "sku": "WIDGET-RED-S",
  "quantity": 1,
  "name": "Red Widget (Small)"
}

Field	Type	Description
`id`	string (UUID)	Component product UUID
`sku`	string	Component SKU
`quantity`	integer	Quantity per kit
`name`	string	Component product title

Channel Product Object

See Section 13 for the full field reference.

Plugin Product Object

See Section 15 for the full field reference.

Plugin Object

{
  "id": "plg-uuid-0001",
  "name": "Whistl 3PL",
  "provider_type": "whistl",
  "push_orders": true,
  "use_max_order_limit": false,
  "max_order_limit": 0,
  "max_order_sent_days": 30,
  "max_order_status": 0,
  "is_active": true,
  "is_connected": true,
  "push_order_cancellation_data": false,
  "last_push_order_cancellation_data_at": null
}

Field	Type	Description
`id`	string (UUID)	Plugin UUID
`name`	string	Plugin display name
`provider_type`	string	Plugin type identifier
`push_orders`	boolean	Whether the plugin pushes orders
`use_max_order_limit`	boolean	Whether a max order limit is enforced
`max_order_limit`	integer	Maximum orders per push
`max_order_sent_days`	integer	Max age of orders to push (days)
`max_order_status`	integer	Max order status code for pushing
`is_active`	boolean	Whether the plugin is active
`is_connected`	boolean	Whether the plugin is connected
`push_order_cancellation_data`	boolean	Whether cancellation data is pushed
`last_push_order_cancellation_data_at`	datetime / null	When cancellation data was last pushed

Order Fulfilment Item Object

{
  "remote_id": "li_123456",
  "sku": "WIDGET-BLU-M",
  "quantity": 1
}

Field	Type	Description
`remote_id`	string	Line item remote ID
`sku`	string	Product SKU
`quantity`	integer	Fulfilled quantity

Invoice Line Item Object

{
  "id": "invl-uuid-0001",
  "product_nominal_code": "4000",
  "product": {},
  "sku": "WIDGET-BLU-M",
  "description": "Blue Widget (Medium) x1",
  "tax_type": "standard",
  "quantity": 1,
  "unit_price": "16.66",
  "price": "20.83",
  "discount_total": "0.00",
  "tax_total": "4.17"
}

Field	Type	Description
`id`	string (UUID)	Invoice line UUID
`product_nominal_code`	string	Nominal / accounting code
`product`	object	Full Product Object (when loaded)
`sku`	string	Product SKU
`description`	string	Line description
`tax_type`	string	Tax type
`quantity`	integer	Quantity
`unit_price`	string (decimal)	Unit price (exc tax)
`price`	string (decimal)	Unit price (inc tax)
`discount_total`	string (decimal)	Discount on line
`tax_total`	string (decimal)	Tax on line

All data in this document is fictitious. No real customer, order, address, or product data is used.

Was this helpful?

Still need help? Share an idea

Data Structures Inside the Webhooks Payloads

1. Channel-Specific Order Fields

1.1 Merged Top-Level Fields by Channel

Channel

Extra Top-Level Fields

2. Shipping Method by Channel

Channel

shipping_method value

Source

3. Specific Fields - Per Channel Detail

Shopify

Field

Type

Always Sent?

Condition / Notes

Amazon SP

Field

Type

Always Sent

Condition / Notes

WooCommerce

Field

Type

Always Sent?

Condition / Notes

Magento

Field

Type

Always Sent?

Condition / Notes

eBay

Field

Type

Always Sent?

Condition / Notes

Etsy

Field

Type

Always Sent?

Condition / Notes

BigCommerce

Field

Type

Always Sent?

Condition / Notes

OpenCart

Field

Type

Always Sent?

Condition / Notes

PrestaShop

VisualSoft

Field

Type

Always Sent?

Condition / Notes

BtoB Wave

Field

Type

Always Sent?

Condition / Notes

TikTok Shop

Field

Type

Always Sent?

Condition / Notes

OnBuy

Field

Type

Always Sent?

Condition / Notes

ReCharge

Field

Type

Always Sent?

Condition / Notes

Linnworks

Field

Type

Always Sent?

`shipping_method` value