Webhook: Consignment

consignment_create

This webhook is fired when a Consignment record is created

Attribute	Type	Description
id	String	The identifier of this Consignment
type	String	Either shippable or nonshippable
vendor_id	String	The identifier of the Vendor that owns this Consignment
numeric_id	Integer	A Fulfiller-scoped sequential ID for systems that require it
order_id	String	The id of the Order that this Consignment was created from
fulfiller	Fulfiller	The fulfiller of this Consignment (populated only on shippable consignments)
purchases	Array	The list of Purchases contained within this Consignment
customer	Customer	The Customer
shipping_address	Address	The shipping address (populated only on shippable consignments)
tax_mode	String	The tax collection mode applied for the consignment

This webhook is fired when a Consignment record is updated

Attribute	Type	Description
id	String	The identifier of this Consignment
type	String	Either shippable or nonshippable
vendor_id	String	The identifier of the Vendor that owns this Consignment
numeric_id	Integer	A Fulfiller-scoped sequential ID for systems that require it
order_id	String	The id of the Order that this Consignment was created from
fulfiller	Fulfiller	The fulfiller of this Consignment (populated only on shippable consignments)
purchases	Array	The list of Purchases contained within this Consignment
customer	Customer	The Customer
shipping_address	Address	The shipping address (populated only on shippable consignments)
tax_mode	String	The tax collection mode applied for the consignment

The Customer who has purchased the goods within this Order

Attribute	Type	Description
id	String	This Customer's identifier
email	String	This Customer's email address
first_name	String	This Customer's first name
last_name	String	This Customer's last name
cpf_number	String	This Customer's CPF number
orders_count	Integer	The count of orders this Customer has placed, at the point of placing this order, inclusive of this order
created_at	DateTime	The timestamp when this Customer was added or created
updated_at	DateTime	The timestamp when this Customer was last updated

A physical address. Used for Billing or Shipping purposes

Attribute	Type	Description
name	String	A name for this Address
address1	String	The first line of this Address
address2	String	The second line of this Address
company	String	An optional company name at this Address
city	String	The postal city for this Address
state	String	The State, Region or County of this Address
zip	String	The ZIP or Postal Code of this Address
country	String	The country of this Address
phone	String	A contact phone number for this Address

A Fulfiller is the party responsible for the despatch of the items within the order

Attribute	Type	Description
id	String	The identifier of this Fulfiller
name	String	The name of the Fulfiller

An item purchased within this Order

Attribute	Type	Description
id	String	The identifier of this Purchase
product_id	String	The identifier of the Product being bought
variant_id	String	The identifier of the Variant of the Product being bought - e.g. a Red version
external_id	String	If this variant is linked to an external source, this is the id for that
vendor_id	String	The identifier of the Vendor - the party who has sold the Product
status	String	The status of this Purchase - e.g. Shipped, or Pending
financial_status	String	The financial status of this Purchase - e.g. Authorized or Captured
sku	String	The SKU of the Variant being bought
released_at	DateTime	An optional timestamp of the release date if this purchase is for a pre-order item
list_price	Money	The advertised price of this Purchase, this could have been discounted - check sale_price for the price paid
sale_price	Money	The actual price paid for this item, including discounts
tax	Money	The sales tax paid on this item
discount	Money	The amount of discount applied to this item
shipment_id	String	The identifier of the Shipment this item was dispatched within, if present
consignment_id	String	The identifier of the Consignment this item is awaiting dispatch within, if present