Retrieve an order (synchronous API)

Get an order details

get

Retrieves the details of an order.

Authorizations

SystemApiKey

AuthorizationstringRequired

For system access use case, use API key/secret in the Authorization header, the API key should be set up with sufficient role.

Path parameters

orderIdstringRequired

The identifier of the Order.

Responses

200

Successful response.

application/json

400

• Bad request.

application/json

401

• Please verify your API key and secret (if applicable) is correct.

404

• Order was not found or not transferred or in open state.

application/json

get

/v1/orders/{orderId}

HTTPcURLJavaScriptPython

GET /v1/orders/{orderId} HTTP/1.1
Host: api.digitalriver.com
Authorization: Basic username:password
Accept: */*

{
  "id": "1067669580082",
  "totalItemsInCart": 1,
  "testOrder": false,
  "sendEmail": false,
  "locale": "en_US",
  "currency": "USD",
  "taxExempt": false,
  "shopperLoginType": "Anonymous",
  "shopperId": "42317897435",
  "softDescriptor": "",
  "orderState": "Completed",
  "lineItems": [],
  "pricing": {
    "total": {
      "value": 122
    },
    "subTotal": {
      "value": 100
    },
    "subtotalWithDiscount": {
      "value": 100
    },
    "shippingAndHandling": {
      "value": 0
    },
    "discount": {
      "value": 0
    },
    "tax": {
      "value": 22
    },
    "importTaxAndDuty": {
      "value": 0
    },
    "fees": {
      "value": 0
    }
  },
  "businessEntityCode": "DR_IRELAND-ENTITY",
  "paymentMethods": [],
  "shippingMethod": {
    "code": 265200,
    "description": "Standard"
  },
  "billingAddress": {
    "title": "title",
    "firstName": "firstName",
    "lastName": "lastName",
    "line1": "line1",
    "line2": "line2",
    "city": "city",
    "postalCode": "00187",
    "country": "IT",
    "countryName": "Italy",
    "phoneNumber": "06 6780691",
    "emailAddress": "[email protected]",
    "companyName": "companyName",
    "countrySubdivision": "countrySubdivision",
    "countyName": "countyName",
    "phoneticFirstName": "phoneticFirstName",
    "phoneticLastName": "phoneticLastName",
    "division": "division"
  },
  "shippingAddress": {
    "title": "title",
    "firstName": "firstName",
    "lastName": "lastName",
    "line1": "line1",
    "line2": "line2",
    "city": "city",
    "postalCode": "00187",
    "country": "IT",
    "countryName": "Italy",
    "phoneNumber": "06 6780691",
    "emailAddress": "[email protected]",
    "companyName": "companyName",
    "countrySubdivision": "countrySubdivision",
    "countyName": "countyName",
    "phoneticFirstName": "phoneticFirstName",
    "phoneticLastName": "phoneticLastName",
    "division": "division"
  },
  "taxRegistrations": [],
  "taxInclusive": false,
  "submissionDate": {
    "offset": {
      "totalSeconds": 0,
      "id": "Z",
      "rules": {
        "fixedOffset": true,
        "transitions": [],
        "transitionRules": []
      }
    },
    "nano": 0,
    "year": 2023,
    "monthValue": 2,
    "dayOfMonth": 27,
    "hour": 20,
    "minute": 36,
    "second": 2,
    "month": "FEBRUARY",
    "dayOfWeek": "MONDAY",
    "dayOfYear": 58
  },
  "requestToBeForgotten": {
    "offset": {
      "totalSeconds": 0,
      "id": "Z",
      "rules": {
        "fixedOffset": true,
        "transitions": [],
        "transitionRules": []
      }
    },
    "nano": 0,
    "year": 2023,
    "monthValue": 2,
    "dayOfMonth": 28,
    "hour": 22,
    "minute": 38,
    "second": 6,
    "month": "FEBRUARY",
    "dayOfWeek": "TUESDAY",
    "dayOfYear": 59
  }
}