Skip to main content
POST
Record an accepted return of a serialized unit

Authorizations

X-API-Key
string
header
required

Body

application/json

An accepted return of one serialized unit.

gtin
string<gtin>
required

GTIN-8/12/13/14 of the returned unit. Normalized to GTIN-14; check digit is validated.

Pattern: ^[0-9]{8}$|^[0-9]{12,14}$
serial
string
required

GS1 AI(21) serial number of the returned unit.

Required string length: 1 - 255
Pattern: ^[^\x00]{1,255}$
event_time
string<date-time> | null

When the return was accepted. Defaults to the time of the request; one earlier than the unit's latest recorded event is refused with 422.

biz_location
string | null

EPCIS bizLocation of the return desk (an SGLN URN or Digital Link URI).

Required string length: 1 - 255
Pattern: ^[^\x00]{1,255}$
return_reference
string | null

Return authorization identifier, recorded as an rma business transaction on the event.

Required string length: 1 - 255
Pattern: ^[^\x00]{1,255}$

Response

Created

The return event just recorded.

event_id
string
required

eventID of the EPCIS return event, retrievable from /events/{eventID}.

gtin
string
required

Normalized GTIN-14 of the returned unit.

serial
string
required

GS1 AI(21) serial number of the returned unit.

returned_at
string<date-time>
required

Event time of the recorded return.

lot
string | null

GS1 AI(10) lot identifier recorded for this unit, when known.

sold_at
string<date-time> | null

Event time of the sale this return reverses, when this organization recorded one.

sale_transaction_reference
string | null

bizTransaction identifier carried on the sale event, scoped to this organization.