/tickets/print

Flow

After a successful cart checkout, this API will enable the 3rd party vendor to retrieve the digital tickets

Description

The Print API can be used first time to retrieve the ticket.

Request

/tickets/print

Accepts collection of tokens (represents tickets) to be printed

HEADERS

RCO	Multitude	Key	Type	Description
R	1	User-Agent	String	An identifying string in Product/Version format, where Version is a SemVer-compliant string, that uniquely identifies your application.
R	1	Authorization	String	It's required to use the "Bearer" authentication scheme to transmit the access token.
R	1	Accept	String	The only supported response type for this endpoint is application/json.
O	0-1	Accept-Encoding	String	gzip compression is supported.
R	1	Content-Type	String	PThe only supported request type for this endpoint is application/json.
R	1	PAC-Application-ID	String	The application identifier for which API access has been authorized; this value is typically expressed in reverse domain notation and is bound to an API key provided by Paciolan during provisioning.
R	1	PAC-API-Key	String	The API key provided by Paciolan for this application.
R	1	PAC-Channel-Code	String	The channel partner identifier issued to your organization by the Paciolan Partner Services team partner on-boarding.
R	1	Request-ID	String	The integrator's external request ID for support traceablility and issue debugging. This string should be a UUID V4 value.

Request Body Object

RCO	Multitude	Property	Type	Description
R	1	externalOrderId	String	External Order ID
R	1-30	tokens	Array	Array of Tokens

Validations

1. If request payload contains tokens belonging to more than 1 organization ID then we reject as BAD_REQUEST

Response

Returns ticket retrieval URL per token

HEADERS

Property	Type	Description
Request-ID	String	The same ID provided in the header of the request call returned back.
Content-Type	String	Supported type is application/json.

Response Object

Property	Type	Description
tickets	Array of Objects	Successful Tokens
→ token	String	Token value
→ applePassUrl	String	Apple Pass
→ googlePassUrl	String	Text file containing the JWT needed to append to https://pay.google.com/gp/v/save/{JWT} to receive the pass for Google Wallet.
failure	Array of Objects	Failed Tokens
→ token	String	Token value
→ type	String	Error type that has occurred
→ appErrorCode	String	Internal error code used for support. Depending on type returned, this code may be needed to handle error response differently
→ developerMessage	String	Developer Message

Error Response Object

Property	Type	Description
error	Object	Error details
→ type	String	Error type that has occurred
→ appErrorCode	String	Internal error code used for support. Depending on type returned, this code may be needed to handle error response differently
→ developerMessage	String	Generic description of error that occured

Error Types

Error Type	Error Desc	App Error Code	HTTP Status Code	HTTP Status Desc	Retry Possible	Retry Count	Ultimate action	MS Error Level
INVALID_TOKEN	Token is invalid	MS-422	422	Unprocessable Content	No	0	Caller to analyze	ERROR
TOKEN_NOT_FOUND	Token does not exist	MS-404	404	Not Found	No	0	Caller to analyze	ERROR
TOO_MANY_TOKENS	The request payload cannot contain more than 30 allowed tokens	MS-422	422	Unprocessable Content	No	0	Caller to analyze	ERROR
MULTIPLE_CLIENT_IDS	The request payload cannot contain more than 1 dataaccountIds (in tokens)	MS-422	422	Unprocessable Content	No	0	Caller to analyze	ERROR

Examples

Request

curl -X POST --compressed 'https://link-sandbox.paciolan.info/v1/tickets/print' \
  -H 'User-Agent: MyApplication/1.0' \
  -H 'Authorization: Bearer <BearerToken>'
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'PAC-Application-ID: com.mycompany.myapp' \
  -H 'PAC-API-Key: <ApiKey>' \
  -H 'PAC-Channel-Code: my-application' \
  -H 'Request-ID: <RequestID>' \
  -d '{
   "externalOrderId": "123456",
   "tokens": [
      "ewr9u3095u3ru3u493sf",
      "392u904hfiuhdsifhru32"
    ]
}'

Responses

Success Response

< HTTP/1.1 200

{
  "tickets": [
    {
      "token": "ewr9u3095u3ru3u493sf",
      "applePassUrl": "https://ticketdelivery.eveneue.net/tickets/F19/F02/3u328u39hfisudfisfhw.pkpass",
      "googlePassUrl": "https://ticketdelivery.eveneue.net/tickets/F19/F02/3u328u39hfisudfisfhw.txt",
      "ownerId": "135792"
    },
    {
      "token": "392u904hfiuhdsifhru32",
      "applePassUrl": "https://ticketdelivery.eveneue.net/tickets/F19/F02/3u328u39hfisudfisfhx.pkpass",
      "googlePassUrl": "https://ticketdelivery.eveneue.net/tickets/F19/F02/3u328u39hfisudfisfhx.txt",
      "ownerId": "135792"
    }
  ]
 }

Partial Success

< HTTP/1.1 207

{
  "tickets": [
    {
      "token": "ewr9u3095u3ru3u493sf",
      "applePassUrl": "https://ticketdelivery.eveneue.net/tickets/F19/F02/3u328u39hfisudfisfhw.pkpass",
      "googlePassUrl": "https://ticketdelivery.eveneue.net/tickets/F19/F02/3u328u39hfisudfisfhw.txt",
      "ownerId": "135792"
    },
    {
      "token": "392u904hfiuhdsifhru32",
      "applePassUrl": "https://ticketdelivery.eveneue.net/tickets/F19/F02/3u328u39hfisudfisfhw.pkpass",
      "googlePassUrl": "https://ticketdelivery.eveneue.net/tickets/F19/F02/3u328u39hfisudfisfhx.txt",
      "ownerId": "135792"
    }
  ],
  "failure": [
    {
      "token": "jr3rjo34r3oi4roiw38",
      "type": "TOKEN_NOT_FOUND",
      "appErrorCode": "MS-404",
      "developerMessage": "Token not found",
      "ownerId": "135792"
    },
    {
      "token": "j435u485eihfdiuhfirow",
      "type": "INVALID_TOKEN",
      "appErrorCode": "MS-422",
      "developerMessage": "Token is invalid",
      "ownerId": "135792"
    }
  ]
}

Full Failure

< HTTP/1.1 422

{
  "error": {
     "type":"UNPROCESSABLE_ENTITY",
     "appErrorCode": "MS-422",
     "developerMessage":"Unable to process the request."
  },
  "failure": [
    {
      "token": "jr3rjo34r3oi4roiw38",
      "type": "TOKEN_NOT_FOUND",
      "appErrorCode": "MS-404",
      "developerMessage": "Token not found",
      "ownerId": "135792"
    },
    {
      "token": "j435u485eihfdiuhfirow",
      "type": "INVALID_TOKEN",
      "appErrorCode": "MS-422",
      "developerMessage": "Token is invalid",
      "ownerId": "135792"
    }
  ]
}

Too Many Request for tokens

< HTTP/1.1 422

{
   "error":{
      "type":"TOO_MANY_TOKENS",
      "appErrorCode": "MS-422",
      "developerMessage":"The request payload cannot contain more than 30 allowed tokens",
   }
 }