POST /api/v3/delivery/calendar
Get delivery calendar availability

Params

Param name Description
shop
required

Shopify domain of the store. Example: test-store.myshopify.com

Validations:

  • Must be a String
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
zip_code
optional

Postal/ZIP code. Provide either zip_code, address, or coordinates (only one required)

Validations:

  • Must be a String
address
optional

Full address. Provide either zip_code, address, or coordinates (only one required)

Validations:

  • Must be a String
coordinates
optional

Coordinates object. Provide either zip_code, address, or coordinates (only one required)

Validations:

  • Must be a Hash
coordinates[latitude]
required

Latitude coordinate

Validations:

  • Must be a Float
coordinates[longitude]
required

Longitude coordinate

Validations:

  • Must be a Float
location_id
optional

Bird Location ID (this app’s internal location identifier, returned as data[].id by /api/v3/delivery/locations — NOT your Shopify location ID). If provided, takes precedence over geographic params (zip_code, address, coordinates)

Validations:

  • Must be a Integer

Returns

Code: 200

Description:

Delivery calendar availability

Param name Description
location_id
required

Bird Location ID (this app’s internal location identifier — NOT your Shopify location ID) resolved from the geographic params or echoed from the request

Validations:

  • Must be a Integer
calendar
required

Available slots grouped by date. Empty array when no slots are available.

Validations:

  • Must be an Array of nested elements
calendar[date]
required

Slot date in YYYY-MM-DD format

Validations:

  • Must be a String
calendar[slots]
optional

Time slots available on this date

Validations:

  • Must be an Array of nested elements
calendar[slots][from]
optional

Slot start time in 24-hour HH:MM format (shop local time)

Validations:

  • Must be a String
calendar[slots][to]
optional

Slot end time in 24-hour HH:MM format (shop local time)

Validations:

  • Must be a String
current_ts
optional

Current time in the shop timezone, formatted as ‘YYYY-MM-DD HH:MM:SS’ (no UTC offset). Present only when cart_checkout_validation is enabled; null otherwise.

Validations:

  • Must be a String

Code: 404

Description:

Shop or config not found

Param name Description

Code: 422

Description:

Invalid parameters - must provide exactly one of: zip_code, address, or coordinates

Param name Description