Skip to main content
PATCH
Update a location discount

Authorizations

x-api-key
string
header
required

Location/organization API key.

Path Parameters

location_id
string
required
discount_id
string
required

Body

application/json
name
string
Required string length: 1 - 160
description
string | null
code
string
Required string length: 1 - 128
image_url
string<uri> | null
enabled
boolean
default:true
visibility
enum<string>
default:public
Available options:
public,
promoted,
code_only,
negotiated
negotiation_difficulty
enum<string> | null
Available options:
easy,
medium,
hard
combinable
boolean
default:true
once_per_customer
boolean
default:true
starts_on
string<date> | null
ends_on
string<date> | null
minimum_order
object | null
first_order_only
boolean
default:false
required_items
object[]
benefit
object

Response

The updated location discount.

id
string
required
object
enum<string>
required
Available options:
discount
name
string
required
description
string | null
required
code
string
required
image_url
string<uri> | null
required
enabled
boolean
required
visibility
enum<string>
required
Available options:
public,
promoted,
code_only,
negotiated
negotiation_difficulty
enum<string> | null
required
Available options:
easy,
medium,
hard
combinable
boolean
required
once_per_customer
boolean
required
starts_on
string<date> | null
required
ends_on
string<date> | null
required
minimum_order
object | null
required
first_order_only
boolean
required
benefit
object
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
location_id
string
required
origin
object
required
required_items
object[]
required
mapping_status
enum<string>
required
Available options:
ready,
unresolved,
ambiguous