Delivery

>>>

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. 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

Validations:

  • Must be a Integer
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

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
>>>

POST /api/v3/delivery/locations
Get all delivery locations for a shop

Params

Param name Description
shop
required

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

Validations:

  • Must be a String
page
optional

Page number for pagination (default: 1)

Validations:

  • Must be a Integer
per_page
optional

Items per page (default: 50, max: 100)

Validations:

  • Must be a Integer
shopping_cart
optional

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

Returns

Code: 200

Description:

Delivery locations information

Param name Description
data
required

Array of location objects

Validations:

  • Must be an Array of nested elements
data[id]
required

Location ID

Validations:

  • Must be a Integer
data[name]
required

Location name

Validations:

  • Must be a String
data[address1]
optional

Address line 1

Validations:

  • Must be a String
data[address2]
optional

Address line 2

Validations:

  • Must be a String
data[city]
optional

City

Validations:

  • Must be a String
data[zip]
optional

ZIP/Postal code

Validations:

  • Must be a String
data[province]
optional

Province/State

Validations:

  • Must be a String
data[country]
optional

Country

Validations:

  • Must be a String
data[country_code]
optional

Country code

Validations:

  • Must be a String
data[province_code]
optional

Province/State code

Validations:

  • Must be a String
data[delivery_enabled]
required

Whether delivery is enabled for this location

Validations:

  • Must be one of: true, false, 1, 0.
pagy
required

Pagination metadata

Validations:

  • Must be a Hash

Code: 404

Description:

Shop not found

Param name Description

Code: 422

Description:

Invalid parameters

Param name Description