XOMNI: Experience Omni-Channel

Last Updated: May 05, 2016

This API provides a way to fetch a Passbook template by its ID.

Request

HTTP Method Resource URI
GET https://{tenantName}.api.xomni.com/private/passbook/template?id={id}

URI Parameters

Parameter Name Description Type Conditions
id The unique ID of the passbook template. Number

Request Headers

Header Field Name Description
Authorization
Access or identity token taken from oauth APIs.
Sample: Bearer dc8f1dcdbe454da8a25621839a93569337522968019e4bd7becd6e01285444da
Accept
Includes minor version header.
Sample: application/vnd.xomni.api-v4-1, */*

Response

{
    "Id":1,
    "UniqueName":"e8db49c0-2299-4ed3-a6fa-92655a7f0df5",
    "Name":"68ab5ad0-86ae-4c9a-98fd-c7738ae52ac9",
    "LogoText":"f1a618c8-72eb-4027-a70f-d165072c8036",
    "BarcodeType":1,
    "FormatVersion":"1",
    "BackgroundColor":"96038d84-bc83-4a4c-9c83-93b5c49a080e",
    "ForegroundColor":"30119bf8-140e-4d93-a8b2-972615389589",
    "IconImage":{
        "Id":1,
        "FileName":"c4503fec-1fe1-48c5-a644-31fd53c4da49",
        "MimeType":"image/jpeg",
        "FileBody":null,
        "PublicUrl":"http://127.0.0.1:10000/tenantassetspubliccontainer/320ddeb9-de96-4010-9c4d-eef50b78ecbd"
    },
   "IconRetinaImage":{
       "Id":2,
       "FileName":"6bf5057d-5714-49c0-9335-5849b6e555e2",
       "MimeType":"image/jpeg",
       "FileBody":null,
       "PublicUrl":"http://127.0.0.1:10000/tenantassetspubliccontainer/cc84c084-16ea-489d-a1b1-1f17b04438b8"
   },
   "LogoImage":{
       "Id":3,
       "FileName":"0d69684c-23b1-4ecf-8ac5-301b11540cb1",
       "MimeType":"image/jpeg",
       "FileBody":null,
       "PublicUrl":"http://127.0.0.1:10000/tenantassetspubliccontainer/b72a91ae-8305-4359-aee8-e9dcf8674e26"
   },
   "LogoRetinaImage":{
       "Id":4,
       "FileName":"97e4f77c-14d2-41e5-95fd-5483987de072",
       "MimeType":"image/jpeg",
       "FileBody":null,
       "PublicUrl":"http://127.0.0.1:10000/tenantassetspubliccontainer/fb6aae65-853d-4c30-8a6f-d9f217a17bc5"
   },
   "StripImage":{
       "Id":5,
       "FileName":"4dc7b539-620c-4249-acad-b29e673617bb",
       "MimeType":"image/jpeg",
       "FileBody":null,
       "PublicUrl":"http://127.0.0.1:10000/tenantassetspubliccontainer/9ce21688-3dbe-4a0a-96df-e776f619b5f0"
   },
   "StripRetinaImage":{
       "Id":6,
       "FileName":"bbfe89c1-71ea-44a3-8199-11c4b11b989a",
       "MimeType":"image/jpeg",
       "FileBody":null,
       "PublicUrl":"http://127.0.0.1:10000/tenantassetspubliccontainer/fb11d6a7-8ba8-4c2d-8467-5dc41b82f1bc"
   },
   "Description":"b94227d3-05e5-4c18-806c-ee8c8d485c4a",
   "LabelColor":"3b04de63-3160-4468-9055-b964afb80310",
   "SupressStripShine":true,
   "PassbookAssociatedStoreIdentifier":1,
   "BarcodeMessageFormat":"4613614c-4edf-4978-99ea-32203f7bc41d",
   "BackFieldLabel1":"ef611c27-3914-4a85-82f2-7b2b3c17c408",
   "BackFieldLabel2":"00bdba89-9902-47a9-88dc-ac247eec9474",
   "BackFieldLabel3":"a1967e22-aac4-48d9-a843-aeb64c48dac8",
   "BackFieldPlaceholder1":"13cdfb9f-e03b-4572-8c0d-d8a43f306f06",
   "BackFieldPlaceholder2":"537ab0ad-abe4-4cd5-b943-066dcfdb0456",
   "BackFieldPlaceholder3":"63200e7c-a8ce-4c06-8fd8-fe31e8795682",
   "PriceType":{
       "Id":3,
       "Description":"test",
       "PriceTypeSymbol":"test"
       "DataBag":"test"
   }
}

Response Body Description

Parameter Name Description Type
Id The unique ID of the Passbook template. Number
UniqueName The unique name of the Passbook template. String
Name The name of the Passbook template. String
LogoText Passbook Logo text. String
BarcodeType Passbook barcode type (see Passbook Barcode Type APIs for possible values). Number
FormatVersion Passbook format version. String
BackgroundColor Passbook background color (in RGB format). String
ForegroundColor Passbook foreground color (in RGB format). String
IconImageAssetId Passbook icon image asset (see Tenant Assets API documentation for details). Number
IconRetinaImageAssetId Passbook icon retina image asset (see Tenant Assets API documentation for details). Number
LogoImageAssetId Passbook icon retina image asset ID (see Tenant Assets API documentation for uploading). Number
LogoRetinaImageAssetId Passbook logo retina image asset ID (see Tenant Assets API documentation for uploading). Number
StripImageAssetId Passbook strip image asset ID (see Tenant Assets API documentation for uploading). Number
StripRetinaImageAssetId Passbook strip retina image asset ID (see Tenant Assets API documentation for uploading). Number
Description Passbook description. String
PassbookBodyFormat Body content of the passbook. String
SupressStripShine Passbook “suppressstripshine” Boolean property. Unknown
PassbookAssociatedStoreIdentifier Passbook associated store identifier. Number
BarcodeMessageFormat Passbook barcode message format. String
BackFieldLabel1 Passbook back field label. String
BackFieldLabel2 Passbook back field label. String
BackFieldLabel3 Passbook back field label. String
BackFieldPlaceholder1 Passbook back field place holder. String
BackFieldPlaceholder2 Passbook back field place holder. String
BackFieldPlaceholder3 Passbook back field place holder. String
PriceTypeId PriceType ID (see PriceType APIs documentation for details). Number

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
404 (Not Found) No Passbook template has been found for the given Passbook template ID.