API documentation

Params

Param name	Description
shop required	Shopify domain of the store. Example: test-store.myshopify.com Validations: Must be a String
location_id required	Bird Location ID Validations: Must be a Integer
start_date required	Start date in YYYY-MM-DD format Validations: Must be a String
end_date required	End date in YYYY-MM-DD format Validations: Must be a String
shopping_cart required	Array of shopping cart items Validations: Must be an Array of nested elements
shopping_cart[variant_id] required	Variant ID Validations: Must be a String
shopping_cart[quantity] required	Quantity of the product Validations: Must be a Integer
shopping_cart[sku] optional	SKU (required if product overrides configured based on SKUs) Validations: Must be a String
shopping_cart[tags] optional	Product tags (required if product overrides configured based on tags) Validations: Must be an array of any type
shopping_cart[product_id] required	Product ID Validations: Must be a String

Pickup calendar availability

Param name	Description
calendar required	Array of available date and time slots Validations: Must be an array of any type
current_ts optional	Current timestamp in shop timezone (if cart_checkout_validation is enabled) Validations: Must be a String

Param name

Description

calendar
required

Array of available date and time slots

Validations:

current_ts
optional

Current timestamp in shop timezone (if cart_checkout_validation is enabled)

Validations:

Shop, location, or config not found

Param name	Description

Invalid parameters

Param name	Description