QUICKSTART
API Quick Start
Authentication
SignString
Rate Limit
Body Envelope
Request Errors
CHANGELOG
Changelog
OTHER
Store Slug
Minimum Valid Parsing Result
Reference
API Overview
v1
Email Parses
Parse an email V2
post
Parse an email
post
Model
Envelope
Meta
v1
Error
v1
Primitive V2
Phone V2
v2
Store V2
v2
Address V2
v2
OrderItem V2
v2
Money V2
v2
Tracking V2
v2
Order V2
v2
Pickup V2
v2
PickupLocation V2
v2
PickupAddress V2
v2
OpeningHours V2
v2
OpeningHourPeriod V2
v2
EstimatedDeliveryDate
v2
EstimatedDeliveryDateTime
v2
ShippingMethod V2
v2
DateTime V2
v2
Header
v1
Primitive V1
Phone
v1
Store
v1
Address
v1
EstimatedDeliveryDate
v1
EstimatedDeliveryDateTime
v1
ShippingMethod
v1
OrderItem
v1
Money
v1
DateTime
v1
Tracking
v1
Order
v1
Support
Contact Support

PickupLocationV2

PickupLocationV2 or null

Pickup location. The order pickup point.

Example:
{"raw_address":"Amazon Locker - 123 Example Street, London, United Kingdom","address":{"phone":{"calling_code":"1","phone_number":"3105550199"},"postal_code":"SW1A 1AA","city":"London","state":{"name":"England","code":"GB-ENG"},"country_region":{"name":"United Kingdom","code":"GBR"}},"raw_opening_hours":"Monday - Saturday: 08:00 AM - 10:00 PM Sunday: 09:00 AM - 08:00 PM","opening_hours":{"sunday":[{"open":true,"from":"09:00","to":"20:00"}],"monday":[{"open":true,"from":"08:00","to":"22:00"}],"tuesday":[{"open":true,"from":"08:00","to":"22:00"}],"wednesday":[{"open":true,"from":"08:00","to":"22:00"}],"thursday":[{"open":true,"from":"08:00","to":"22:00"}],"friday":[{"open":true,"from":"08:00","to":"22:00"}],"saturday":[{"open":true,"from":"08:00","to":"22:00"}]}}
raw_address
string or null
required

Raw address text of the pickup location parsed from the email.

Example:
Amazon Locker - 123 Example Street, London, United Kingdom
address
PickupAddressV2 or null
required

Structured pickup address, enriched from raw_address.

Example:
{"phone":{"calling_code":"1","phone_number":"3105550199"},"postal_code":"SW1A 1AA","city":"London","state":{"name":"England","code":"GB-ENG"},"country_region":{"name":"United Kingdom","code":"GBR"}}
phone
PhoneV2 or null
required

The phone number object.

Example:
{"calling_code":"1","phone_number":"3105550199"}
postal_code
string or null
required

Postal code.

Example:
SW1A 1AA
city
string or null
required

City name.

Example:
London
state
object or null
required

State object.

country_region
object or null
required

Country region object.

raw_opening_hours
string or null
required

Raw opening hours text.

Example:
Monday - Saturday: 08:00 AM - 10:00 PM Sunday: 09:00 AM - 08:00 PM
opening_hours
OpeningHoursV2 or null
required

Opening hours information of the pickup location.

Example:
{"sunday":[{"open":true,"from":"09:00","to":"20:00"}],"monday":[{"open":true,"from":"08:00","to":"22:00"}],"tuesday":[{"open":true,"from":"08:00","to":"22:00"}],"wednesday":[{"open":true,"from":"08:00","to":"22:00"}],"thursday":[{"open":true,"from":"08:00","to":"22:00"}],"friday":[{"open":true,"from":"08:00","to":"22:00"}],"saturday":[{"open":true,"from":"08:00","to":"22:00"}]}
sunday
array[OpeningHourPeriodV2]
required

The OpeningHourPeriod model provides detailed information about a location's operating hours for a specific day. It includes the start and end times, and indicates whether the location is open on that particular day. When open is true and both from and to are null, it indicates the location operates 24 hours on that day.

monday
array[OpeningHourPeriodV2]
required

The OpeningHourPeriod model provides detailed information about a location's operating hours for a specific day. It includes the start and end times, and indicates whether the location is open on that particular day. When open is true and both from and to are null, it indicates the location operates 24 hours on that day.

tuesday
array[OpeningHourPeriodV2]
required

The OpeningHourPeriod model provides detailed information about a location's operating hours for a specific day. It includes the start and end times, and indicates whether the location is open on that particular day. When open is true and both from and to are null, it indicates the location operates 24 hours on that day.

wednesday
array[OpeningHourPeriodV2]
required

The OpeningHourPeriod model provides detailed information about a location's operating hours for a specific day. It includes the start and end times, and indicates whether the location is open on that particular day. When open is true and both from and to are null, it indicates the location operates 24 hours on that day.

thursday
array[OpeningHourPeriodV2]
required

The OpeningHourPeriod model provides detailed information about a location's operating hours for a specific day. It includes the start and end times, and indicates whether the location is open on that particular day. When open is true and both from and to are null, it indicates the location operates 24 hours on that day.

friday
array[OpeningHourPeriodV2]
required

The OpeningHourPeriod model provides detailed information about a location's operating hours for a specific day. It includes the start and end times, and indicates whether the location is open on that particular day. When open is true and both from and to are null, it indicates the location operates 24 hours on that day.

saturday
array[OpeningHourPeriodV2]
required

The OpeningHourPeriod model provides detailed information about a location's operating hours for a specific day. It includes the start and end times, and indicates whether the location is open on that particular day. When open is true and both from and to are null, it indicates the location operates 24 hours on that day.

Example
preparing...