Skip to content
Bottle

Save the business surcharge rule

PUT
/order-surcharge
curl --request PUT \
  --url https://example.com/order-surcharge \
  --header 'Content-Type: application/json' \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token> \
  --data '{ "enabled": true, "name": "example", "amountPence": 1, "priceIncludesVat": true, "appliesTo": "all_orders", "chargeBy": "per_order", "customerRule": "everyone", "gasTypeIds": [], "productIds": [] }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
enabled
required
boolean
name
required
string
>= 1 characters <= 120 characters
amountPence
required
integer
<= 10000000
priceIncludesVat
required
boolean
appliesTo
string
default: all_orders
Allowed values: all_orders all_cylinders gas_types products
chargeBy
string
default: per_order
Allowed values: per_order per_item
customerRule
string
default: everyone
Allowed values: everyone chosen everyone_except manual
gasTypeIds
Array<string>
default: <= 200 items
productIds
Array<string>
default: <= 500 items

Responses

Section titled “Responses”

200

Section titled “200”

Order surcharge settings

Media typeapplication/json
object
enabled
required
boolean
name
required
string
>= 1 characters <= 120 characters
amountPence
required
integer
<= 10000000
priceIncludesVat
required
boolean
appliesTo
string
default: all_orders
Allowed values: all_orders all_cylinders gas_types products
chargeBy
string
default: per_order
Allowed values: per_order per_item
customerRule
string
default: everyone
Allowed values: everyone chosen everyone_except manual
gasTypeIds
Array<string>
default: <= 200 items
productIds
Array<string>
default: <= 500 items
updatedAt
required
string format: date-time

Example 

{
  "appliesTo": "all_orders",
  "chargeBy": "per_order",
  "customerRule": "everyone",
  "gasTypeIds": [],
  "productIds": []
}

401

Section titled “401”

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

403

Section titled “403”

Not permitted

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

422

Section titled “422”

Invalid surcharge settings

Media typeapplication/json
object
error
required
string
Allowed values: validation
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string

Example 

{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}