Skip to main content
POST
Erase a shopper

Authorizations

Authorization
string
header
required

Store-specific secret generated in Website & sales. Never expose in browser code.

Body

application/json

Send at least one field. A browser that called identify is found through emailHash only.

orderIds
string[]

The store's order IDs, as sent to the Orders API.

Maximum array length: 100

Stable identifier, trimmed before validation.

Required string length: 1 - 200
emailHash
string

SHA-256, as 64 lowercase hex characters, of the buyer's email with leading and trailing spaces removed and made lowercase. The same value window.sideshift.identify sends; no key or salt. Send hashes only; a raw email, phone, customerEmail or customerPhone field returns 400.

Pattern: ^[0-9a-f]{64}$
phoneHash
string

SHA-256, as 64 lowercase hex characters, of '+' followed by only the digits of the buyer's phone number, with its country code.

Pattern: ^[0-9a-f]{64}$
customerId
string

The store's own ID for the buyer's customer account. Not an email.

Pattern: ^[A-Za-z0-9_-]{1,64}$
visitorIds
string[]

SideShift visitor IDs the store holds for the shopper.

Maximum array length: 100
Pattern: ^[a-zA-Z0-9_-]{16,128}$

Response

Erased. Counts only.

orders
integer
required

Named orders deleted.

Required range: x >= 0
orderIdentities
integer
required

Stored buyer identities deleted.

Required range: x >= 0
visitors
integer
required

Visitors whose pixel events were deleted.

Required range: x >= 0
conversions
integer
required

Named events (such as registered) deleted.

Required range: x >= 0