Merchant schemas

This section contains the schemas for the Merchant settings API.

Response schema for merchant settings

Name	Type	Required	Description
store_name	string	true	none
company_name	string	false	none
contact_name	string	true	none
contact_phone	string	true	none
preparation_time	string	true	The time in minutes to allow for an order to be prepared for carrier pickup
address_1	string	true	none
suburb	string	true	none
state	string	true	none
postcode	string	true	none
country_code	string	true	none
website_url	string	false	The URL of the merchant website
webhook_url	string	false	URL to use for sending order status
supports_landed_cost_quoting	string	false	Whether the merchant supports landed cost quoting

Request schema for merchant settings

Name	Type	Required	Description
store_name	string	false	none
company_name	string	false	none
contact_name	string	false	none
contact_phone	string	false	none
preparation_time	string	false	The time in minutes the store needs to prepare an order for carrier pickup
address_1	string	false	none
suburb	string	false	none
state	string	false	none
postcode	string	false	none
website_url	string	false	The URL of the merchant website
webhook_url	string	false	URL to use for sending order status

Schema for merchant settings operating hours

Name	Type	Required	Description
working_days	WorkingDay[]	false	The operating hours of your store for each day of the week

Schema for working_day

Name	Type	Required	Description
day	enum	false	The day of the week in lowercase. Possible values are monday, tuesday, wednesday, thursday, friday, saturday, sunday.
beginning_of_workday	string	false	The start time of the workday in HH:MM format
end_of_workday	string	false	The end time of the workday in HH:MM format
is_open	boolean	false	Whether the store is open on the given day. Use true for open, false for closed.

Response schema for 403

Name	Type	Required	Description
error	string	true	Error code returned by Shippit
error_description	string	false	Human-readable description of the error