Retrieve an order

get https://api.fastspring.com/orders/{order_id}

Retrieves the details of an order with the given order_id.

If you specify multiple order IDs in the request, the response will return an array with each order object.

Responses

Response body

object

order

string

Unique order ID.

string

Unique ID, same as order ID.

reference

string

External reference number.

buyerReference

string | null

Purchase order number used as a reference for the buyer.

ipAddress

string

IP address of the buyer.

completed

boolean

Indicates if the order is completed.

changed

int64

Timestamp in milliseconds of last change.

changedValue

int64

Unix timestamp in milliseconds for the changed value.

changedInSeconds

int32

Unix timestamp in seconds indicating the last change.

changedDisplay

string

Human-readable date format.

changedDisplayISO8601

date

Date in ISO 8601 format.

changedDisplayEmailEnhancements

string

Date in a format commonly used in emails.

changedDisplayEmailEnhancementsWithTime

string

Date and time in a format commonly used in emails.

language

string

Two-letter language code (ISO 639) of the order language.

live

boolean

Indicates if the order is a live order or a test order; 'true' indicates a live order and 'false' indicates a test order.

currency

string

Three-letter currency code (ISO 4217) used in the order.

payoutCurrency

string

Currency used for payouts.

quote

string

Sales estimate or proposal associated with the order. If no quote is applicable, this property returns a 'null' value.

invoiceUrl

string

URL of the associated invoice.

siteId

string

FastSpring-generated customer site or storefront ID.

account

string

FastSpring-generated customer account ID.

total

float

Total amount of the order.

totalDisplay

string

Display format of the total amount.

totalInPayoutCurrency

float

Total amount of the order in the payout currency.

totalInPayoutCurrencyDisplay

string

Display format of the total amount in the payout currency.

tax

float

Tax amount.

taxDisplay

string

Display format of the tax amount.

taxInPayoutCurrency

float

Tax amount of the order in the payout currency.

taxInPayoutCurrencyDisplay

string

Display format of the tax amount in the payout currency.

subtotal

float

Subtotal amount of the order.

subtotalDisplay

string

Display format of the subtotal amount.

subtotalInPayoutCurrency

float

Subtotal amount of the order in the payout currency.

subtotalInPayoutCurrencyDisplay

string

Display format of the subtotal amount in the payout currency.

discount

float

Total amount of all discounts associated with the order. This displays in the currency associated with the subscription instance.

discountDisplay

string

Total amount of all discounts associated with the order, formatted for display in the associated currency.

discountInPayoutCurrency

float

Total amount of all discounts associated with the order, in your disbursement currency.

discountInPayoutCurrencyDisplay

string

Total amount of all discounts associated with the order, formatted for display in your FastSpring disbursements currency.

discountWithTax

float

Discount amount, including tax.

discountWithTaxDisplay

string

Discount amount including tax, formatted for display in the transaction's currency.

discountWithTaxInPayoutCurrency

float

Discount amount including tax, in the currency of your FastSpring disbursements.

discountWithTaxInPayoutCurrencyDisplay

string

Discount amount including tax, formatted for display in the currency of your FastSpring disbursements.

billDescriptor

string

The description information sent to the payment account for display on the customer's statement.

payment

object

Details about the transaction's payment method.

type

string

Payment method used for the order, such as "paypal", "amazon", "applepay", "creditcard", "kakaopay", "test", "bank", "alipay", "purchase-order", or "free".

creditcard

string

Appears when payment.type = creditcard. Type of credit or debit card used for the order, such as "visa", "mastercard", "amex", "discover", "jcb", "carteblanche", "dinersclub", or "unionpay".

cardEnding

string

Appears when payment.type = bank. Type of bank transfer used to pay for the order, such as "wire", "brazilwire", "ideal", "giropay", "sofort", "ecard", "sepa", or "alipay".

bank

string

Appears when payment.type = creditcard. Last four digits of the card number used for the order.

customer

object

first

string

Customer first name.

last

string

Customer last name.

string

Customer email address.

phone

string

Customer phone number.

subscribed

boolean

Indicates if customer is subscribed to updates.

address

object

Address information associated with the order.

city

string

City, district, suburb, town, or village.

regionCode

string

Two-letter ISO code of the US state.

regionDisplay

string

State or region, formatted for display.

region

string

State or region.

postalCode

string

ZIP or postal code.

country

string

Two-letter country code.

display

string

String of address information formatted for display.

recipients

array of objects

Customer and gift recipient information. This differs from customer and address information on gift purchases.

recipients

object

recipient

object

notes

array

Internal order notes. You can add notes within the app.

notes

items

array of objects

List of items in the order.

items

object

product

string

Unique identifier for the product.

quantity

integer

Quantity of the product ordered.

display

string

Display name of the product.

sku

string

Stock keeping unit (SKU) identifier if available.

imageUrl

string

URL link to the product image.

shortDisplay

string

Abbreviated or short display name for the product.

subtotal

number

Subtotal amount for this product in the base currency.

subtotalDisplay

string

Formatted display for subtotal.

subtotalInPayoutCurrency

number

Subtotal amount in payout currency.

subtotalInPayoutCurrencyDisplay

string

Formatted display for subtotal in payout currency.

discount

number

Discount amount for the product in base currency.

discountDisplay

string

Formatted display for the discount amount.

discountInPayoutCurrency

number

Discount amount in payout currency.

discountInPayoutCurrencyDisplay

string

Formatted display for the discount amount in payout currency.

isAddon

boolean

Indicates if the item is an add-on product.

fulfillments

object

Details about the fulfillment of the item.

Has additional fields

driver

object

Driver information for cross-sell or upsell features.

withholdings

object

Details on withholdings applicable to the item.

proratedItemChangeAmount

number

Prorated change amount for the item in base currency.

proratedItemChangeAmountDisplay

string

Formatted display for prorated change amount.

proratedItemChangeAmountInPayoutCurrency

number

Prorated change amount in payout currency.

proratedItemChangeAmountInPayoutCurrencyDisplay

string

Formatted display for prorated change amount in payout currency.

proratedItemProratedCharge

number

Prorated charge amount in base currency.

proratedItemProratedChargeDisplay

string

Formatted display for prorated charge amount.

proratedItemProratedChargeInPayoutCurrency

number

Prorated charge amount in payout currency.

proratedItemProratedChargeInPayoutCurrencyDisplay

string

Formatted display for prorated charge amount in payout currency.

proratedItemCreditAmount

number

Prorated credit amount in base currency.

proratedItemCreditAmountDisplay

string

Formatted display for prorated credit amount.

proratedItemCreditAmountInPayoutCurrency

number

Prorated credit amount in payout currency.

proratedItemCreditAmountInPayoutCurrencyDisplay

string

Formatted display for prorated credit amount in payout currency.

proratedItemTaxAmount

number

Prorated tax amount in base currency.

proratedItemTaxAmountDisplay

string

Formatted display for prorated tax amount.

proratedItemTaxAmountInPayoutCurrency

number

Prorated tax amount in payout currency.

proratedItemTaxAmountInPayoutCurrencyDisplay

string

Formatted display for prorated tax amount in payout currency.

proratedItemTotal

number

Total prorated amount in base currency.

proratedItemTotalDisplay

string

Formatted display for prorated total amount.

proratedItemTotalInPayoutCurrency

number

Total prorated amount in payout currency.

proratedItemTotalInPayoutCurrencyDisplay

string

Formatted display for prorated total amount in payout currency.

action

string

The action performed by the API.

result

string

The result of the action (e.g., success or error).

Language

Credentials

Basic

base64


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.fastspring.com/orders/order_id \
3
     --header 'accept: application/json'


xxxxxxxxxx
138
}
1
{
2
  "order": "abcDEFgHiJklM1N-3OP9q",
3
  "id": "abcDEFgHiJklM1N-3OP9q",
4
  "reference": "ABC1234567-8910-11121D",
5
  "buyerReference": null,
6
  "ipAddress": "00.000.00.000",
7
  "completed": true,
8
  "changed": 1723838225894,
9
  "changedValue": 1723838225894,
10
  "changedInSeconds": 1723838225,
11
  "changedDisplay": "8/16/24",
12
  "changedDisplayISO8601": "2024-08-16",
13
  "changedDisplayEmailEnhancements": "Aug 16, 2024",
14
  "changedDisplayEmailEnhancementsWithTime": "Aug 16, 2024 07:57:05 PM",
15
  "language": "en",
16
  "live": false,
17
  "currency": "USD",
18
  "payoutCurrency": "USD",
19
  "quote": null,
20
  "invoiceUrl": "https://yourexamplestore.onfastspring.com/account/order/YES191015-1265-35113/invoice",
21
  "siteId": "LDN5SX4KBZCI2",
22
  "account": "abcDEFgHiJklM1N-3OP9q",
23
  "total": 10,
24
  "totalDisplay": "$10.00",
25
  "totalInPayoutCurrency": 10,

200OK

400Bad Request