Close

PlayHQ Webhook Documentation

Merchandise Orders

Last update: 18 minutes ago by Nazar32Reading time: 2 min

Data to be included in file

Field Name in File	Field Description	Sample Data	Field Type	Size	IsNullable	Comments
id	Merchandise Order Line Item UUID	9f7f5a82-f7bb-11ea-adc1-0242ac120002	UUID		No	Each Merchandise Order Line Item UUID will be unique in this file.
merchandiseOrderId	Merchandise Order UUID	ed6e7051-ee4b-4c58-82cd-9fe34a2609ff	UUID		No	Because there may be multiple merchandise order line items in a single order, the Merchandise Order UUID may be repeated in the file
numericalOrderId	Numerical order Id assigned to an order	12345678	Integer		No	This is the “user friendly” Id for the order
registrationId	UUID of the registration that the merchandise order is associated with	75g9e86a-f73c-11ea-adc1-0242ac120002	UUID		No	As with the Merchandise Order UUID, there may be multiple merchandise order line items in a single order, and the Registration UUID may be repeated in the file, as a result
productVariantId	UUID of the registration that the merchandise order is associated with	3e8363e4-f38e-4199-b247-c28347401326	UUID		No	Because product variants will be purchased by many different registrants, the Product Variant UUID may be repeated in the file
quantity	Quantity of the product variant selected by the registrant	2	Integer		No
orderDate	Date/time the merchandise order was completed	2020-08-27T06:29:54.400000000Z	String		No	String is an ISO 8601 DateTime in UTC timezone
shippingAddress	Shipping Address for order item	123 St.	String		Yes	This will only be populated for a row if the product that the product variant is related to has a fulfilmentMethod = “Delivery”; else this field will be null
shippingSuburb	Shipping Suburb for order item	Hillarys	String		Yes	This will only be populated for a row if the product that the product variant is related to has a fulfilmentMethod = “Delivery”; else this field will be null
shippingPostcode	Shipping Postcode for order item	6025	String		Yes	This will only be populated for a row if the product that the product variant is related to has a fulfilmentMethod = “Delivery”; else this field will be null
shippingState	Shipping State for order item	WA	String		Yes	This will only be populated for a row if the product that the product variant is related to has a fulfilmentMethod = “Delivery”; else this field will be null
shippingCountry	Shipping Country for order item	Australia	String		Yes	This will only be populated for a row if the product that the product variant is related to has a fulfilmentMethod = “Delivery”; else this field will be null
createdAt	Date/time the merchandise order was created	2020-08-27T06:29:54.400000000Z	String		No	String is an ISO 8601 DateTime in UTC timezone
updatedAt	Date/time the merchandise order was last updated	2020-08-27T06:29:54.400000000Z	String		No	String is an ISO 8601 DateTime in UTC timezone

Webhooks — Previous

Webhook Structure

Next — Data Warehouse Integration Solution