XOMNI: Experience Omni-Channel

Last Updated: February 19, 2016

This API allows a client application to generate an OmniTicket for a wishlist. Client app may use this ticket for sharing the wishlist through a QR code.

Request

HTTP Method Resource URI
GET https://{tenantName}.api.xomni.com/omniplay/wishlist/ticket?wishlistUniqueKey={wishlistUniqueKey}

URI Parameters

Parameter Name Description Type Conditions
wishlistUniqueKey Unique key of the wishlist. String

Request Headers

Header Field Name Description
PIIToken
Includes the base64-encoded “Personally Identifiable Information” data.
Sample: dXNlcm5hbWU6SW5uQXBwc1VzZXI7cGFzc3dvcmQ6SW5uQXBwc1Bhc3M=
Accept
Includes minor version header.
Sample: application/vnd.xomni.api-v4-0, */*
Authorization
Access or identity token taken from oauth APIs.
Sample: Bearer dc8f1dcdbe454da8a25621839a93569337522968019e4bd7becd6e01285444da

Response

{
    "Data": {
        "Ticket": "Wbda570b0-cf86-4c86-830c-ac9445faf208"
    }
}

Response Body Description

Parameter Name Description Type
Data.Ticket OmniTicket for the current PII User. String

OmniTicket’s first char is a type identifier. Ex: ‘W’ prefix points to a wishlist, ‘P’ prefix points to a PII Session. Rest of OmniTicket is a GUID. You should use this GUID as an OmniTicket.

Response Headers

Header Field Name Description
Content-Type
Content type of the response entity. The value of this header is always application/json.

Status Codes

A successful operation returns status code 200 (OK) for GET operations. Possible response status codes are as listed below:

Status Code Description
400 (Bad Request) Invalid wishlist unique key.
403 (Forbidden) Not authorized for the ticket generation.
404 (Not Found) Wishlist could not be found.