Attributes

To ensure your pickup, delivery and shipping orders are processed correctly (tagged, notifications sent, appear in our dashboard) they must contain the correct attributes attached. Below we have documented the required attributes for each checkout method.

Adding attributes

The best way of adding these attributes to an order is by using Shopify's Cart API https://shopify.dev/docs/themes/ajax-api/reference/cart#post-cart-update-js.

If you are building a mobile app or using a headless commerce solution then you may prefer the Draft Orders API https://shopify.dev/docs/admin-api/rest/reference/orders/draftorder.

Pickup orders

Date and times must be provided in the format(s) listed shown below

Attribute name	Example
Checkout-Method	pickup
Pickup-Location-Id	100001
Pickup-Location-Company	Zapiet NY
Pickup-Location-Address-Line-1	5th Avenue
Pickup-Location-Address-Line-2
Pickup-Location-City	New York
Pickup-Location-Region	New York
Pickup-Location-Postal-Code	10001
Pickup-Location-Country	United States
Pickup-Date	2021-05-13
Pickup-Time	13:00 / 1:00 PM
Custom-Attribute-1
Custom-Attribute-2
Custom-Attribute-3

Delivery orders

Date and times must be provided in the format(s) shown below

Attribute name	Example
Checkout-Method	delivery
Delivery-Location-Id	10002
Delivery-Date	2021-05-13
Delivery-Time	13:00 - 14:00 / 1:00 PM - 2:00PM
Custom-Attribute-1
Custom-Attribute-2
Custom-Attribute-3

Shipping orders

Date must be provided in the format shown below

Attribute name	Example
Checkout-Method	shipping
Shipping-Date	2021-05-13