Introduction
Guides
API Reference
SPI CRM v2
SPI CRM v1
SPI Events
SPI Gift Card
SPI Insurance
SPI Payment
SPI Product Recommendations
SPI Product Search
SPI RFID
SPI Tax Free
Journals v3
Purchase Prices v3
Shipments v3

SPI RFID

Create Sell Transaction

post /transactions/sell

Update state to sold for items specified by the provided identifiers.

REQUEST BODY
object
TransactionSell
posthttps://rfid.example.com/transactions/sell
{
  "store_id": "STR-001",
  "identifiers": [
    "011234567890123421123",
    "011234567890123421124"
  ],
  "timestamp": "2025-03-14T16:54:46.000Z"
}
HTTP Status Code Summary
204Transactions has been added
400Bad request
404Not found
429Too many requests
500Internal server error

Create Return Transaction

post /transactions/return

Update state to returned for items specified by the provided identifiers.

REQUEST BODY
object
TransactionReturn
posthttps://rfid.example.com/transactions/return
{
  "store_id": "STR-001",
  "identifiers": [
    "011234567890123421123",
    "011234567890123421124"
  ],
  "timestamp": "2025-03-14T16:54:46.000Z"
}
HTTP Status Code Summary
204Transactions has been added
400Bad request
404Not found
429Too many requests
500Internal server error

Objects

Error
object

PROPERTIES
error_code
string
REQUIRED
error_data
REQUIRED
message
string
REQUIRED
request_id
string
REQUIRED
Example: { "error_code": "field-missing", "error_data": { "message": "Field missing" }, "request_id": "123e4567-e89b-12d3-a456-426614174123" }

Identifier
string

An electronic product code (EPC) formatted as GS1 element string.

Example: "011234567890123421123"

TransactionSell
object

PROPERTIES
store_id
string
REQUIRED

The external ID of the store that the transaction is made for.

Example: ""STR-001""
Min Length: 1
identifiers
array
(Identifier)
REQUIRED

List of identifiers formatted as GS1 element strings.

Example: "[ "011234567890123421123", "011234567890123421124" ]"
timestamp
string
REQUIRED

ISO8601 representation of the date/time for the transaction.

Example: ""2025-03-14T16:54:46.000Z""

TransactionReturn
object

PROPERTIES
store_id
string
REQUIRED

The external ID of the store that the transaction is made for.

Example: ""STR-001""
Min Length: 1
identifiers
array
(Identifier)
REQUIRED

List of identifiers formatted as GS1 element strings.

Example: "[ "011234567890123421123", "011234567890123421124" ]"
timestamp
string
REQUIRED

ISO8601 representation of the date/time for the transaction.

Example: ""2025-03-14T16:54:46.000Z""
Copyright © 2025 Sitoo AB. All rights reserved.