Merchant settings

The merchant settings API allows you to query the current settings for your merchant account and to make updates to this via API.

Get merchant settings

GET /merchant

Returns an object representing your merchant account settings.

Body

{
  "store_name": "New Store Name",
  "company_name": "Harold Pty Ltd",
  "contact_name": "Robert",
  "contact_phone": "0400000000",
  "shipping_cart_method_name": "",
  "preparation_time": 60,
  "website_url": "www.haroldsharpoons.com.au",
  "address_1": "110 Rex Road",
  "suburb": "Sydney",
  "state": "NSW",
  "postcode": "2000"
}

Update merchant settings

PATCH /merchant

Given an object with the desired settings to update, updates the Merchant settings on Shippit.

Body

{
  "merchant": {
    "store_name": "New Store Name"
  }
}

Properties

Name Type Required Restrictions Description
merchant Merchant true none Fields to update on a merchant account.

Get merchant settings operating hours

GET /merchants/settings/locations/operating_hours

Returns an object representing your merchant operating hours settings.

Update merchant settings operating hours

PUT /merchants/settings/locations/operating_hours

Given an object with the desired settings to update, updates the merchant operating hours settings on Shippit.

Body

{
  "working_days": [
    {
        "day": "monday",
        "beginning_of_workday": "09:00",
        "end_of_workday": "17:00",
        "is_open": true
    },
    {
        "day": "tuesday",
        "beginning_of_workday": "09:00",
        "end_of_workday": "17:00",
        "is_open": true
    },
    {
        "day": "wednesday",
        "beginning_of_workday": "09:00",
        "end_of_workday": "17:00",
        "is_open": true
    },
    {
        "day": "thursday",
        "beginning_of_workday": "09:00",
        "end_of_workday": "17:00",
        "is_open": true
    },
    {
        "day": "friday",
        "beginning_of_workday": "09:00",
        "end_of_workday": "17:00",
        "is_open": true
    },
    {
        "day": "saturday",
        "beginning_of_workday": "09:00",
        "end_of_workday": "17:00",
        "is_open": false
    },
    {
        "day": "sunday",
        "beginning_of_workday": "00:00",
        "end_of_workday": "17:00",
        "is_open": false
    }
  ]
}

Properties

Name Type Required Restrictions Description
working_days WorkingDay[] true none Fields to update on a merchant operating hours settings