commerce

Set delivery & collection settings

Configure collection and delivery for checkout: the settings an agent needs before a shop can sell.

At least one of offers_collection / offers_delivery must be true.

Fees are given in rands and stored in cents; named delivery areas (configured in the dashboard) replace the flat fee entirely while any exist.

put/api/v1/commerce/fulfilment

Request

  • Base URL: https://app.blueticked.com
  • URL: https://app.blueticked.com/api/v1/commerce/fulfilment
  • Auth: HTTP bearer

Request body

offers_collectionboolean
offers_deliveryboolean
delivery_fee_randsnumber
delivery_free_over_randsnumber
collection_notestring
delivery_notestring

Example request

{
  "offers_collection": true,
  "offers_delivery": true,
  "delivery_fee_rands": 60,
  "delivery_free_over_rands": 500,
  "collection_note": "Shop 23, Bellville Mall (Mon to Fri, 09:00 to 17:00)",
  "delivery_note": "Courier, 2 to 3 working days anywhere in SA"
}

Response

Success

okboolean required

Example response

{
  "ok": true,
  "settings": {
    "offers_collection": true,
    "offers_delivery": true,
    "delivery_fee_cents": 6000
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.