XOMNI: Experience Omni-Channel

Last Updated: February 19, 2016

This API provides a way to create a new passbook template.

Request

{
    "UniqueName":"34ab4379-3258-4d8c-ad63-a60361bd90db",
    "Name":"711275b7-870e-4c8f-98ce-b3e2a664cecb",
    "LogoText":"76ce4551-2602-475b-847a-856f58b9dffa",
    "BarcodeType":1,
    "FormatVersion":"1",
    "BackgroundColor":"27062e1a-5ca4-4613-8c4b-3fc7d151fe3f",
    "ForegroundColor":"0a712aaf-1f1f-42e1-a44a-3d63efd809d9",
    "IconImageAssetId":1002,
    "IconRetinaImageAssetId":1003,
    "LogoImageAssetId":1004,
    "LogoRetinaImageAssetId":1005,
    "StripImageAssetId":1006,
    "StripRetinaImageAssetId":1007,
    "Description":"1fb09ea3-61f8-4280-9921-ee5c5402814a",
    "LabelColor":"5cd84de8-ecc2-4082-ba88-75947e7812d8",
    "SupressStripShine":true,
    "PassbookAssociatedStoreIdentifier":1,
    "BarcodeMessageFormat":"0cc79fec-916a-4a4a-aac1-fb685b84ae23",
    "BackFieldLabel1":"01f5ba66-ce5e-420a-82f8-d3ca766fbf58",
    "BackFieldLabel2":"941bb66a-08ea-455f-a26c-991c1e605dc0",
    "BackFieldLabel3":"35241de6-be66-49f2-b461-a5d29c7eedcc",
    "BackFieldPlaceholder1":"e4ca423c-f2ab-49d3-b5fc-4ec87d87723b",
    "BackFieldPlaceholder2":"904db34b-f1c9-4c70-bbb1-98cd377b01f1",
    "BackFieldPlaceholder3":"1be45ef0-3006-4d00-954a-bacb490d7b47",
    "CurrencyId":1002
}
HTTP Method Resource URI
POST https://{tenantName}.api.xomni.com/private/passbook/template

Request Body Description

Parameter Name Description Type Conditions
Id The unique ID of the Passbook template. Number
Required.
Required.
Required.
Required.
Required.
Required.
Required.
Required
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
CurrencyId Passbook currency ID (see Currency APIs documentation for details). Number

Request Headers

Header Field Name Description
Content-Type
Content type of the response entity. The value of this header is always application/json.
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

{
    "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",
   "Currency":{
       "Id":3,
       "Description":"test",
       "CurrencySymbol":"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
Description Passbook description. String
PassbookBodyFormat Body content of the passbook. String
SupressStripShine Passbook “suppressstripshine” Boolean property. Boolean
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
Currency.Id This is the unique ID for the currency. Number
Currency.Description Description of the currency. String
Currency.CurrencySymbol Currency symbol of the currency String
StripRetinaImage.PublicUrl Public URI of the icon image asset. String
StripRetinaImage.Id Unique ID of the icon image asset. Number
StripRetinaImage.FileName File name of the icon image asset. String
StripRetinaImage.MimeType Mime type of the icon image asset. String
StripRetinaImage.FileBody File body of the icon image asset. Array
StripImage.PublicUrl Public URI of the icon image asset. String
StripImage.Id Unique ID of the icon image asset. Number
StripImage.FileName File name of the icon image asset. String
StripImage.MimeType Mime type of the icon image asset. String
StripImage.FileBody File body of the icon image asset. Array
LogoRetinaImage.PublicUrl Public URI of the icon image asset. String
LogoRetinaImage.Id Unique ID of the icon image asset. Number
LogoRetinaImage.FileName File name of the icon image asset. String
LogoRetinaImage.MimeType Mime type of the icon image asset. String
LogoRetinaImage.FileBody File body of the icon image asset. Array
LogoImage.PublicUrl Public URI of the icon image asset. String
LogoImage.Id Unique ID of the icon image asset. Number
LogoImage.FileName File name of the icon image asset. String
LogoImage.MimeType Mime type of the icon image asset. String
LogoImage.FileBody File body of the icon image asset. Array
IconRetinaImage.PublicUrl Public URI of the icon image asset. String
IconRetinaImage.Id Unique ID of the icon image asset. Number
IconRetinaImage.FileName File name of the icon image asset. String
IconRetinaImage.MimeType Mime type of the icon image asset. String
IconRetinaImage.FileBody File body of the icon image asset. Array
IconImage.PublicUrl Public URI of the icon image asset. String
IconImage.Id Unique ID of the icon image asset. Number
IconImage.FileName File name of the icon image asset. String
IconImage.MimeType Mime type of the icon image asset. String
IconImage.FileBody File body of the icon image asset. Array

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 POST operations. Possible response status codes are as listed below:

Status Code Description
404 (Not Found) The given Passbook template already exists.