GET api/{lang}/es/order/{id}

The order API returns the details of an order.

Resource URL

Tests Spanish: https://sandbox.weplann.com/api/es/order/{id}
Production Spanish: https://developer.weplann.com/api/es/order/{id}
Tests Portuguese: https://sandbox.weplann.com/api/pt/order/{id}
Production Portuguese: https://developer.weplann.com/api/pt/order/{id}

Request Parameters

Name Description Type Additional Information Mandatory
id The order details to return unique identifier Yes

Response Information

Name Description Type Additional Information
Id unique identifier
Reference The WePlann order reference. string
Confirmation Third party confirmation value. string
Status The current status of the order. string
IsValid Indicates if an error occurred during retrieval of order. boolean
Event Container about the event purchased.
 + Id The id of the event. uniqueidentifier
 + Tickets container of tickets purchased
 + + Code The ticket code. string
 + + Quantity The quantity of tickets purchased. integer
 + Email The customers email address. string
 + PhoneNumber The customers phone number. string
 + RemoteHost IP Address of the customer placing the order string
 + CallbackUrl A Url that you would like notifications to be sent. SEE YYYYYYY string
 + ExternalReference Your Order Number. string
 + TotalUsd container of price
 + + CurrencyCode string Will always be returned as USD
 + + Value decimal
 + Answers container of answers to questions
 + + Code The code of the question. string
 + + Value The answer to the question. string

Example Request

GET https://developer.weplann.com/api/es/order/eedca100-a345-4767-98a3-1b39e10bb45f 

Example Result (XML)

<Order xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.weplann.com" Id="eedca100-a345-4767-98a3-1b39e10bb45f">
	<Reference>TEST-21627-ES</Reference>
	<Status>waitsupplier</Status>
	<IsValid>true</IsValid>
	<Event Id="7729b545-2a90-4ef6-afd4-0ecc84f9f7b8">
		<TotalUsd CurrencyCode="USD">
			<Value>214.0000</Value>
		</TotalUsd>
		<TestMode>false</TestMode>
		<ExternalReference>XYZ 123</ExternalReference>
		<Email>johndoe@weplann.com</Email>
		<PhoneNumber>555-555-5555</PhoneNumber>
		<RemoteHost>75.132.65.57</RemoteHost>
		<Tickets>
			<Ticket Code="adult">
				<Quantity>2</Quantity>
			</Ticket>
		</Tickets>
		<Answers>
			<Answer>
				<Code>FirstName</Code>
				<Value>John</Value>
			</Answer>
			<Answer>
				<Code>LastName</Code>
				<Value>Doe</Value>
			</Answer>
			<Answer>
				<Code>FirstName</Code>
				<Value>Jane</Value>
			</Answer>
			<Answer>
				<Code>LastName</Code>
				<Value>Doe</Value>
			</Answer>
		</Answers>
	</Event>
</Order>

Example Result (JSON)

{
	"id" : "eedca100-a345-4767-98a3-1b39e10bb45f",
	"reference" : "TEST-21627-ES",
	"confirmation" : null,
	"status" : "waitsupplier",
	"isValid" : true,
	"errors" : null,
	"event" : {
		"id" : "7729b545-2a90-4ef6-afd4-0ecc84f9f7b8",
		"apiKey" : null,
		"totalUsd" : {
			"currencyCode" : "USD",
			"value" : 214.0000
		},
		"testMode" : false,
		"externalReference" : "XYZ 123",
		"email" : "johndoe@weplann.com",
		"phoneNumber" : "555-555-5555",
		"remoteHost" : "75.132.65.57",
		"callbackUrl" : null,
		"tickets" : [
			{
				"code" : "adult",
				"quantity" : 2
			}
		],
		"answers" : [
			{
				"code" : "FirstName",
				"value" : "John"
			},
			{
				"code" : "LastName",
				"value" : "Doe"
			},
			{
				"code" : "FirstName",
				"value" : "Jane"
			},
			{
				"code" : "LastName",
				"value" : "Doe"
			}
		]
	}
}