GET orders/{orderId}

Gets an order.

Request Information

» Parameters

Name	Description	Additional information
orderId	The ID of the order.	Define this parameter in the request URI.

» Expands

Name	Description	Usage
account	This will retrieve the related account.	GET orders/{orderId}?expand=account
orderLineItems	This will retrieve the related list of order line items.	GET orders/{orderId}?expand=orderlineitems
paymentOption	This will retrieve the related payment option.	GET orders/{orderId}?expand=paymentoption
paymentType	This will retrieve the related payment type.	GET orders/{orderId}?expand=paymenttype
shippingOption	This will retrieve the latest shipping option.	GET orders/{orderId}?expand=shippingoption

Response Information

» Response Body Formats

If this endpoint supports expands, they will be included in the sample response body below. However, please note that expands are NOT included in the response body by default. Expands are only included in the response body if they came through as part of the request.

application/json

Sample:

	{
  "Order": {
    "Account": {
      "AccountId": 11521,
      "AccountProfileCode": null,
      "AccountType": null,
      "AccountTypeId": 0,
      "Addresses": [],
      "CompanyName": "Your Company",
      "CreateDate": "2013-04-29T10:49:32.657",
      "CreateUser": null,
      "ReferralCommissionType": null,
      "Custom1": null,
      "Custom2": null,
      "Custom3": null,
      "Description": "Site Administrator Account",
      "Email": "znodeadmin1@test.com",
      "EmailOptIn": true,
      "EnableCustomerPricing": false,
      "ExternalId": null,
      "GiftCardHistoryList": null,
      "IsActive": true,
      "Orders": [],
      "ParentAccountId": null,
      "ProfileId": 1,
      "Profiles": [],
      "ReferralAccountId": null,
      "ReferralCommission": null,
      "ReferralCommissionTypeId": null,
      "ReferralStatus": null,
      "Source": null,
      "SubAccountLimit": null,
      "TaxId": null,
      "UpdateDate": "2013-09-21T11:59:19.74",
      "UpdateUser": null,
      "User": null,
      "AddressModel": null,
      "UserId": "8086a820-d3f6-4763-ae07-ce84ab85e2e7",
      "WebServiceDownloadDate": null,
      "Website": null,
      "WishList": [],
      "BaseUrl": null,
      "IsUserInRole": false,
      "UserName": null,
      "RoleName": null,
      "ErrorCode": null,
      "FullName": null,
      "PhoneNumber": null,
      "FirstName": null,
      "LastName": null,
      "MiddleName": null,
      "LoginName": null,
      "ExternalAccountNum": null,
      "StartDate": "0001-01-01T00:00:00",
      "EndDate": "0001-01-01T00:00:00",
      "PortalId": null,
      "UserType": null,
      "IsEmailSentFailed": false,
      "IsSinglePageCheckoutUser": false,
      "TrackingLink": null
    },
    "AccountId": 11521,
    "AdditionalInstructions": "",
    "BillingCity": "Fake City",
    "BillingCompanyName": "Your Company",
    "BillingCountryCode": "US",
    "BillingEmail": "znodeadmin1@test.com",
    "BillingEmailId": null,
    "BillingFirstName": "Site",
    "BillingLastName": "Admin",
    "BillingPhoneNumber": "1-888-Your-Store",
    "BillingPostalCode": "12345",
    "BillingStateCode": "SD",
    "BillingStreetAddress1": "123 Fake Street",
    "BillingStreet": null,
    "BillingStreet1": null,
    "BillingStreetAddress2": "",
    "CardAuthorizationCode": "",
    "CardExpiration": "",
    "CardTransactionId": "",
    "CardTypeId": null,
    "CouponCode": null,
    "CreateDate": null,
    "CreatedBy": null,
    "Custom1": null,
    "Custom2": null,
    "Custom3": "XXXX",
    "DiscountAmount": 6.00,
    "ExternalId": null,
    "Gst": 0.00,
    "Hst": 0.00,
    "ModifiedBy": null,
    "ModifiedDate": null,
    "OrderDate": "2013-09-18T12:18:56.94",
    "OrderId": 2,
    "OrderLineItems": [
      {
        "AppliedPromotion": null,
        "AutoGeneratedTracking": false,
        "CouponsApplied": null,
        "CreateDate": "2013-09-18T12:18:56.89",
        "CreatedBy": "znodeadmin1",
        "Custom1": null,
        "Custom2": null,
        "Custom3": null,
        "Description": "Packaging - Gift Basket",
        "DiscountAmount": 3.00,
        "DownloadLink": null,
        "ExternalId": null,
        "Gst": 0.00,
        "Hst": 0.00,
        "IsRecurringBilling": null,
        "ModifiedBy": null,
        "ModifiedDate": null,
        "Name": "Strawberry",
        "OrderId": 2,
        "OrderLineItemId": 2,
        "OrderLineItemRelationshipTypeId": null,
        "OrderLineItemStateId": null,
        "OrderShipment": null,
        "OrderShipmentId": 1,
        "ParentOrderLineItemId": null,
        "PaymentStatusId": null,
        "Price": 2.95,
        "ProductNumber": "st3245",
        "PromotionDescription": null,
        "Pst": 0.00,
        "Quantity": 2,
        "RecurringBillingAmount": null,
        "RecurringBillingCycles": null,
        "RecurringBillingFrequency": null,
        "RecurringBillingPeriod": null,
        "ReturnDate": null,
        "SalesTax": 0.00,
        "ShipDate": null,
        "ShippingCost": 4.00,
        "ShipSeparately": false,
        "Sku": "st3245",
        "TrackingNumber": null,
        "TransactionNumber": null,
        "Vat": 0.00,
        "Weight": null,
        "ProductNum": null,
        "ShipName": null,
        "ShippingAddress": null,
        "Order": null,
        "DigitalAsset": null
      }
    ],
    "OrderStateId": 50,
    "PaymentOption": {
      "DisplayOrder": 1,
      "EnableAmericanExpress": true,
      "EnableDiscover": true,
      "EnableMasterCard": true,
      "EnableRecurringPayments": null,
      "EnableVault": null,
      "EnableVisa": true,
      "IsActive": true,
      "IsRmaCompatible": null,
      "Partner": null,
      "PaymentGateway": null,
      "PaymentGatewayId": 1,
      "PaymentGatewayPassword": "",
      "PaymentGatewayUsername": "73BPkIVFnu65hHKjxRDZ0lTxmyNsV9hT",
      "PaymentOptionId": 24,
      "PaymentType": null,
      "PaymentTypeId": 2,
      "PreAuthorize": false,
      "ProfileId": null,
      "ProfileName": null,
      "TestMode": true,
      "TransactionKey": "FguRet0ahGXzM5kICiVYqxQWLHiW+1T+",
      "Vendor": null,
      "IsExists": null,
      "AdditionalFee": null
    },
    "PaymentOptionId": 24,
    "PaymentStatusId": 10,
    "PaymentType": {
      "Description": "Google Checkout",
      "IsActive": true,
      "Name": "Google Checkout",
      "PaymentTypeId": 3
    },
    "PaymentTypeId": 2,
    "PortalId": 1,
    "PromotionDescription": null,
    "Pst": 0.00,
    "PurchaseOrderNumber": "123",
    "ReceiptHtml": null,
    "IsOffsitePayment": false,
    "ReferralAccountId": null,
    "ReturnDate": null,
    "SalesTax": 0.00,
    "ShipDate": null,
    "ShippingCost": 4.00,
    "ShippingOption": {
      "CountryCode": "US",
      "Description": "Custom Flat Rate",
      "CustomErrorMessage": null,
      "DisplayOrder": 1,
      "ExternalId": null,
      "HandlingCharge": 2.50,
      "ActiveInd": true,
      "ProfileId": 7,
      "ShippingCode": "FLAT",
      "ShippingId": 9,
      "PortalId": 0,
      "ShippingType": null,
      "ShippingTypeId": 1,
      "ShippingRule": null,
      "ShippingServiceCodeId": 0,
      "ShippingServiceCode": null,
      "ShippingtypeName": null,
      "ProfileName": null,
      "ClassName": null,
      "UserType": null
    },
    "ShippingOptionId": null,
    "SubTotal": 15.90,
    "TaxCost": 0.00,
    "Total": 13.90,
    "TrackingNumber": null,
    "Vat": 0.00,
    "WebServiceDownloadDate": null,
    "OrderShipment": {
      "OrderShipmentId": 0,
      "ShipName": null,
      "ShippingOptionId": null,
      "ShipToCity": null,
      "ShipToCompanyName": null,
      "ShipToCountryCode": null,
      "ShipToEmail": null,
      "ShipToFirstName": null,
      "ShipToLastName": null,
      "ShipToPhoneNumber": null,
      "ShipToPostalCode": null,
      "ShipToStateCode": null,
      "ShipToStreetAddress1": null,
      "ShipToStreetAddress2": null,
      "AddressId": 0,
      "Quantity": 0,
      "TaxCost": 0.0,
      "ShippingCost": 0.0,
      "ShippingName": null
    },
    "ShippingID": null,
    "OrderStatus": null,
    "ShippingTypeName": null,
    "PaymentStatusName": null,
    "PaymentSettingId": null,
    "GiftAmount": 0.0,
    "PaymentMethod": null,
    "PromoCode": null,
    "OrderLineItemList": {
      "OrdersLineItems": [],
      "PageIndex": null,
      "PageSize": null,
      "TotalResults": null,
      "TotalPages": null
    },
    "OrderShipmentId": 0,
    "ShipName": null,
    "ShipToCity": null,
    "ShipToCompanyName": null,
    "ShipToCountryCode": null,
    "ShipToEmailId": null,
    "ShipToFirstName": null,
    "ShipToLastName": null,
    "ShipToPhoneNumber": null,
    "ShipToPostalCode": null,
    "ShipToStateCode": null,
    "ShipToStreet": null,
    "ShipToStreet1": null,
    "AddressId": 0,
    "Quantity": 0,
    "ShippingName": null,
    "RefundCardNumber": null,
    "ExpirationDate": null,
    "Month": 0,
    "Year": 0,
    "SecurityCode": null,
    "RefundAmount": 0.0,
    "ErrorMessage": null,
    "TrackingText": null,
    "rmaRequestList": {
      "RMARequests": [],
      "PageIndex": null,
      "PageSize": null,
      "TotalResults": null,
      "TotalPages": null
    },
    "PaymentTypeName": null
  },
  "OrderDownloadData": {},
  "EmailSentMessage": null,
  "ErrorCode": null,
  "ErrorMessage": null,
  "HasError": false
}