The Checkout object

The Checkout object contains the checkout information for an order.

Attributes

Description

id string

Unique identifier of the checkout.

createdTime datetime

The time when the checkout was created.

customerId string

The ID of a customer.

sourceId string

Unique identifier of a source.

currency string

Three-letter ISO currency code.

email string

The customer email address.

browserIp string

The IP address of the browser used by the customer when placing the order.

shipFrom

object

Contains the ship-from information.

shipFrom[].address object

Contains the ship-from address.

shipFrom[].address.line1 string

The first line of the ship-from address.

shipFrom[].address.line2 string

The second line of the ship-from address.

shipFrom[].address.city string

City or town.

shipFrom[].address.postalCode string

ZIP or postal code.

shipFrom[].address.state string

State/County/Province/Region.

shipFrom[].address.country string

Two-letter country code.

shipTo object

Contains the ship-to information.

shipTo[].address object

Contains the ship-to address.

shipTo[].address.line1 string

The first line of the ship-to address.

shipTo[].address.line2 string

The second line of the ship-to address.

shipTo[].address.city string

City or town.

shipTo[].address.postalCode string

ZIP or postal code.

shipTo[].address.state string

State/County/Province/Region.

shipTo[].address.country string

Two-letter country code.

name string

The customer's name.

phone string

The customer's phone number.

email string

The customer's email.

organization string

The customer's organization.

additionalAddressInfo object

Contains additional shipping address information.

additionalAddressInfo.neighborhood string

Used for Brazilian bairros.

subtotal string

Represents the total order amount exclusive of tax.

totalTax string

Represents the total tax amount.

totalFees string

Represents the total fee amount.

totalDuty string

Represents the total duty amount.

totalDiscount string

Represents the total discount amount.

totalShipping string

Represents the total shipping amount.

totalAmount string

Represents the total charge amount.

items object

Contains the item information.

items[].skuId string

The unique identifier of the SKU.

items[].price string

The price of the item.

items[].amount number

Represents the total charge amount for the item.

discount[]

object

Represents the total discount amount for the item.

discount[].quantity

string

The number of items.

discount[].amountOff

string

The amount off for the discount.

shippingChoice object

Contains shipping choice information.

shippingChoice.amount number

Represents the shipping choice amount.

shippingChoice.description string

A string that describes the shipping choice.

shippingChoice.serviceLevel string

The service level for the shipping choice.

paymentSessionId string

Tracks the process of collecting a payment.

liveMode boolean

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

purchaseLocation object

The location where the item was purchased.

upstreamId string

The user checkout ID if it is different from the Digital River checkout ID.

The Checkout object
{
"customerId": "5774321009",
"sourceId": "src_a78cfeae-f7ae-4719-8e1c-d05ec04e4d37",
"currency": "USD",
"email": "jsmith@digitalriver.com",
"locale": "en_US",
"browserIp": "111.111.111.111",
"shipFrom": {
"address": {
"line1": "10380 Bren Rd W",
"line2": "string",
"city": "Minnetonka",
"postalCode": "55129",
"state": "MN",
"country": "US"
},
"additionalAddressInfo": {
"neighborhood": "Centro"
}
},
"shipTo": {
"address": {
"line1": "10380 Bren Rd W",
"line2": "string",
"city": "Minnetonka",
"postalCode": "55129",
"state": "MN",
"country": "US"
},
"name": "John Smith",
"phone": "952-111-1111",
"email": "jsmith@digitalriver.com",
"organization": "Digital River",
"additionalAddressInfo": {
"neighborhood": "Centro"
}
},
"items": [
{
"skuId": "5823594809",
"price": 9.99,
"discount": {
"quantity:1": null,
"amountOff": 10
}
},
{
"skuId": "5823594809",
"price": 9.99,
"quantity": 2,
"discount": {
"quantity:2": null,
"amountOff": 10
}
},
{
"skuId": "9234276173",
"price": 9.99,
"quantity": 2
}
],
"taxInclusive": true,
"chargeType": "merchant_initiated",
"customerType": "individual",
"purchaseLocation": {
"country": "US",
"state": "MN",
"postalCode": "55364"
},
"upstreamId": "7765374748"
}