Order Details

IMPORTANT: The response keys may be modified and/or additional keys may be added. If you will be utilizing this endpoint, please setup your code to accommodate for these possibilities.

Service End Point -orderDetail

This API endpoint is used to securely retrieve the order details and status of an order completed via the Zonos Checkout™.

HTTPS Request

HTTP Method POST
End Point URL https://api.iglobalstores.com/v2/orderDetail
Protocol HTTPS
Message Format JSON
Accept HTTP Header Accept: application/json
Content-Type HTTP Header Content-Type: application/json

Request Parameters

Message Format JSON

Example request

{
  "store": "999",
  "secret": "f5bde245-f55e-414d-b722-80b25161c12c",
  "orderId": "999-99999"
}

Request JSON Definitions

secret

Required

API secret GUID provided by Zonos.

String

orderId

Optional if passing referenceId parameter.

The iGlobal order id. Can be passed with or without your store id and hyphen (Example: 123-45678 or 45678).

Note: After order completion and payment, the customer will be redirected to an Order Completion / Order Thank You page hosted on your domain. The URL will contain a querystring parameter “orderId” that will contain this value.

Integer / String

referenceId

Optional if passing “orderId” parameter.

This parameter is used to lookup an order’s data by the unique “referenceId” passed in the “createTempCart” API Service endpoint. This parameter should be left off or null when intending to lookup the order detail based on “orderId” parameter.

String

Error HTTP Responses

HTTP Response Codes Response Body Example/Description
415 - Unsupported media type HTML Entity. HTTP “Content-Type” header is invalid.
406 - Not Acceptable HTML Entity. HTTP “Accept” header is invalid.
400 - Bad Request “error”:”orderId: 999-99999 is not a valid orderId”
400 - Bad Request “error”:”Could not find an order with orderId: 999-99999”
400 - Bad Request “error”:”Invalid security credentials”
400 - Bad Request “error”:”Invalid post body”
400 - Bad Request “error”:”Parameter orderId or referenceId is required”
400 - Bad Request “error”:”Cannot specify both Parameters orderId and referenceId”
400 - Bad Request “error”:”No order found with orderId: 999-99999”
400 - Bad Request “error”:”Parameter store required”
400 - Bad Request “error”:”No order found with referenceId: 999999 for storeId: 999”
400 - Bad Request “error”:”referenceId: 999999 for storeId: 999 has been duplicated”
400 - Bad Request “error”:”Couldn’t retrieve order with referenceId: 999999”
500 - Internal Server Error “error”:”Couldn’t process order details”

Response JSON Definitions

error

This parameter is present only when an error has occurred and will contain an error description.

String

order

A map of the order details.

JSON String

order.orderId

The order’s identification number in the Zonos System.

String

order.orderDate

The order creation timestamp millis in UTC/GMT.

Millis

order.orderDateString

The order creation timestamp string in UTC/GMT.

String

order.testOrder

Indicates if the order is a test order.

boolean

order.orderStatus

The status/state of the order in the Zonos System.

For more details on orderStatus usage, please review the Order Retrieval API usage documentation here.

Additional information on the order statuses can be found in the documentation for the “updateVendorOrder” API Service endpoint here.

String

order.orderStatusDate

The timestamp millis in UTC/GMT of the most recent orderStatus change in the Zonos System.

Millis

order.orderStatusDateString

The timestamp string in UTC/GMT of the most recent orderStatus change in the Zonos System.

String

order.referenceId

Unique referenceId associated with the order through the “createTempCart” API service endpoint.

String

order.merchantOrderId

MerchantOrderId associated with the order through the “updateMerchantOrderId” API service endpoint.

String

order.misc1

order.misc2

order.misc3

order.misc4

order.misc5

order.misc6

Additional values associated with the order through the “createTempCart” API service endpoint.

String

order.boxCount

This field describes the boxes that will be used to ship the order that was passed into the createTempCart request

String

order.name

order.company

order.email

order.phone

order.altPhone

order.countryCode

order.countryName

order.address1

order.address2

order.address3

order.city

order.state

order.zip

Destination / shipping address for the order. The values were entered into the Zonos Checkout, or were passed to the order through the redirect to the Zonos Checkout.

String

order.billingName

order.billingCompany

order.billingEmail

order.billingPhone

order.billingAltPhone

order.billingCountryCode

order.billingCountryName

order.billingAddress1

order.billingAddress2

order.billingAddress3

order.billingCity

order.billingState

order.billingZip

Billing address for the order. The values were entered into the Zonos Checkout.

String

order.birthDate

order.nationalIdentifier

Additional international billing address information for the order when required. The values were entered into the Zonos Checkout.

String

order.cslListMatch

Consolidated Screening List (CSL) Match. A boolean that indicates when the customer information has produced a match in the US Consolidated Screening List and should be reviewed for possible denied party affiliation.

boolean

order.foreignCurrencyCode

The currency code that the order payment settled in.

String

order.itemsTotal

Items / Product Total in USD.

Positive floating point, two decimal places / Integer

order.itemsTotalForeign

Items / Product Total in the settled currency.

Positive floating point, two decimal places / Integer

order.shippingTotal

Shipping total in USD.

Positive floating point, two decimal places / Integer

order.shippingTotalForeign

Shipping total in the settled currency.

Positive floating point, two decimal places / Integer

order.quotedDutyTaxes

Duty/Tax quoted in the Zonos Checkout. Displayed in USD.

Positive floating point, two decimal places / Integer

order.quotedDutyTaxesForeign

Duty/Tax quoted in the Zonos Checkout. Displayed in settled currency.

Positive floating point, two decimal places / Integer

order.dutyTaxesTotal

Duty/Tax total in USD.

Positive floating point, two decimal places / Integer

order.quotedDutyTaxesForeign

Duty/Tax total in settled currency.

Positive floating point, two decimal places / Integer

order.dutyTaxesBreakdown

A map of the duty/tax breakdown.

Note* If applicable, IPF (International Processing Fee) are not included.

JSON String

order.dutyTaxesBreakdown.vatTax

Vat/tax amount in USD. Does not include the vat/tax on dispursement fee.

Positive floating point, two decimal places / Integer

order.dutyTaxesBreakdown.duty

Duty amount in USD.

Positive floating point, two decimal places / Integer

order.dutyTaxesBreakdown.dispursementFee

Disbursement fee amount in USD.

Positive floating point, two decimal places / Integer

order.dutyTaxesBreakdown.brokerageFee

Brokerage fee amount in USD.

Positive floating point, two decimal places / Integer

order.dutyTaxesBreakdown.prepaymentFee

Prepayment fee amount in USD.

Positive floating point, two decimal places / Integer

order.dutyTaxesBreakdown.vatOnDispursementFee

Vat/tax amount on dispursement fee in USD.

Positive floating point, two decimal places / Integer

order.grandTotal

Grand total in USD.

Positive floating point, two decimal places / Integer

order.grandTotalForeign

Grand total in settled currency.

Positive floating point, two decimal places / Integer

order.paymentProcessing

A map of the paymentProcessing details. Some parameters may not be applicable to your account and will be excluded from the response.

JSON String

order.paymentProcessing.paymentGateway

Payment gateway name.

If iGlobal is processing the payment, will indicate “iGlobal_CC” or “iGlobal_PayPal”.

String

order.paymentProcessing.cardType

Credit Card Brand.

If iGlobal is processing the payment, this node is excluded from the response.

String

order.paymentProcessing.transactionId

Payment transactionId.

If iGlobal is processing the payment, this node is excluded from the response.

String

order.paymentProcessing.transactionType

Indicates the transaction type. “AUTH_CAPTURE” or “AUTH_ONLY”.

If iGlobal is processing the payment, this node is excluded from the response.

String

order.paymentProcessing.captureDate

The date of payment capture in millis if available.

If iGlobal is processing the payment, this node is excluded from the response.

Millis

order.paymentProcessing.captureDateString

The date of payment capture as string if available.

If iGlobal is processing the payment, this node is excluded from the response.

String

order.paymentProcessing.lastFour

The last four numbers of the billing credit card number.

If iGlobal is processing the payment, this node is excluded from the response.

String

order.customerSelectedShippingName

Shipping option display name inside the Zonos Checkout.

String

order.shippingCarrierServiceLevel

Carrier and service level identifier for the selected shipping option.

String

order.trackingNumber

Tracking number generated for the shipment. If applicable.

String

order.shippingInstructions

Customizable instructions for the shipping service level.

String

order.optInEmail

Indicates that the customer selected the checkbox for “sign up for our newsletter” inside the Zonos Checkout.

Applicable only if you have chosen to display this checkbox on the checkout page.

boolean

order.poNumber

A purchase order number for the order specified inside the Zonos Checkout. Used when purchase orders are enabled.

String

order.carrierAccountType

A visitor’s own shipping carrier account type. For example, UPS, FedEx, DHL, etc. Used when visitor carrier accounts are enabled.

String

order.carrierAccountNumber

A visitor’s own shipping carrier account number. Used when visitor carrier accounts are enabled.

String

order.carrierAccountShippingMethod

The selected shipping method on the visitor’s own shipping carrier account. Used when visitor carrier accounts are enabled.

String

order.shipComplete

Indicates whether the order should ship in multiple parts.

boolean

order.itemsCount

Count of order line items.

Integer

order.items

A list of item maps. The item map contains details about the item that were passed to the Zonos Checkout upon temp cart creation.

JSON String

For more details on item properties, please review the documentation on the “createTempCart” API service endpoint. CHECKOUT CART CREATION API

order.items[index].quantity

Integer

order.items[index].itemNonShippable

boolean

order.items[index].unitPrice

order.items[index].weight

order.items[index].length

order.items[index].width

order.items[index].height

Positive floating point, two decimal places / Integer

order.items[index].description

order.items[index].imageURL

order.items[index].sku

order.items[index].productId

order.items[index].weightUnits

order.items[index].countryOfOrigin

order.items[index].itemURL

order.items[index].itemBrand

order.items[index].itemCategory

order.items[index].itemHSCode

order.items[index].itemCustomization

order.items[index].itemDescriptionLong

order.items[index].itemDescriptionDetailed

order.items[index].itemFabricContent

order.items[index].itemColor

order.items[index].itemLtlClass

order.items[index].itemMaterial

String

order.notes

A list of note maps. The not map contains details about the order note.

JSON String

order.notes[index].createdByUser

String

order.notes[index].customerNote

A boolean indicating if this was a customer created note about the order, shipping, etc.

boolean

order.notes[index].dateCreated

Millis

order.notes[index].dateCreatedString

String

order.notes[index].flagged

A boolean indicating if this note was flagged as important.

boolean

order.notes[index].note

The note content.

String