Skip to main content
PATCH
Update an item by your code

Authorizations

Authorization
string
header
required

The store's API key (xfp_test_… on the sandbox, xfp_live_… on live). XFaster creates it and shows it once. An integrator key (one key for a POS company) also sends X-XFaster-Store.

Headers

Idempotency-Key
string

Any unique string. Repeating a request with the same key within 24 hours returns the first answer instead of acting twice.

Example:

"5f0c3d1e-8b6a-4e1f-9c2d-7a1b0e4f6d21"

Path Parameters

external_id
string
required

Body

application/json
available
boolean

On or off. Customers stop seeing an item the moment it is off.

off_until
string<date-time>

With "available false" - XFaster switches it back on at this time.

price
integer

Agorot, VAT included. Restaurants use whole shekels.

sale_price
integer | null

The shelf promotion price in agorot, below price. null ends the sale.

stock
integer

Markets only - the quantity on the shelf.

Required range: 0 <= x <= 1000000

Response

The item

id
integer
Example:

3062

external_id
string | null
category_id
integer | null
name
string
price
integer
Example:

6000

discount
object | null
sale_price
integer | null
Example:

5500

available
boolean
off_until
string<date-time> | null
barcode
string | null
unit
string | null
by_weight
boolean
stock
integer | null

null where the store doesn't count stock (restaurants)

option_groups
object[]
addon_ids
integer[]