System Status

Orders

Orders Orders handle the purchases of end customers. You can create, retrieve, update, and list all orders.

Returns a list of orders

get

Get all orders.

Query parameters
createdTimestring · date-timeOptional

A filter on the list based on the createdTime field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options:

  • gt–return values where the createdTime field is after this timestamp
  • gte–return values where the createdTime field is after or equal to this timestamp
  • lt–return values where the createdTime field is before this timestamp
  • lte–return values where the createdTime field is before or equal to this timestamp
updatedTimestring · date-timeOptional

A filter on the list based on the updatedTime field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options:

  • gt–return values where the updatedTime field is after this timestamp
  • gte–return values where the updatedTime field is after or equal to this timestamp
  • lt–return values where the updatedTime field is before this timestamp
  • lte–return values where the updatedTime field is before or equal to this timestamp
endingBeforestringOptional

A cursor for use in pagination. The endingBefore parameter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with xyz your subsequent calls can include endingBefore=xyz in order to fetch the previous page of the list.

startingAfterstringOptional

A cursor for use in pagination. The startingAfter parameter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with xyz, your subsequent calls can include startingAfter=xyz in order to fetch the next page of the list.

limitinteger · min: 1 · max: 100Optional

A limit on the number of objects returned. Limit can range between 1 and 100, and the default is 10.

idsstring[]Optional

Only return objects with these IDs.

upstreamIdsstring[]Optional

Only return objects with these upstreamIds.

totalAmountstringOptional

A filter on the list based on the totalAmount field. The value can be a string or it can be a dictionary with the following options: - gt - return values where the amount field is greater than this amount - gte - return values where the amount field is greater than or equal to this amount - lt - return values where the amount field is less than this amount - lte - return values where the amount field is less than or equal to this amount

statestringOptional

Only return objects in the given state

customerIdstringOptional

Only return orders for the given customer

applicationIdstringOptional

Only return orders for the given application

emailstringOptional

Only return orders with the given email

currencystringOptional

Only return orders in the given currency

skuIdstringOptional

Only return orders containing this sku

in_reviewstring · date-timeOptional

A filter on the list based on the order stateTransitions in_review field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options:

  • gt - return values where the stateTransitions in_review field is after this timestamp
  • gte - return values where the stateTransitions in_review field is after or equal to this timestamp
  • lt - return values where the stateTransitions in_review field is before this timestamp
  • lte - return values where the stateTransitions in_review field is before or equal to this timestamp
pending_paymentstring · date-timeOptional

A filter on the list based on the order stateTransitions pending_payment field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options:

  • gt - return values where the stateTransitions pending_payment field is after this timestamp
  • gte - return values where the stateTransitions pending_payment field is after or equal to this timestamp
  • lt - return values where the stateTransitions pending_payment field is before this timestamp
  • lte - return values where the stateTransitions pending_payment field is before or equal to this timestamp
acceptedstring · date-timeOptional

A filter on the list based on the order stateTransitions accepted field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options:

  • gt - return values where the stateTransitions accepted field is after this timestamp
  • gte - return values where the stateTransitions accepted field is after or equal to this timestamp
  • lt - return values where the stateTransitions accepted field is before this timestamp
  • lte - return values where the stateTransitions accepted field is before or equal to this timestamp
blockedstring · date-timeOptional

A filter on the list based on the order stateTransitions blocked field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options:

  • gt - return values where the stateTransitions blocked field is after this timestamp
  • gte - return values where the stateTransitions blocked field is after or equal to this timestamp
  • lt - return values where the stateTransitions blocked field is before this timestamp
  • lte - return values where the stateTransitions blocked field is before or equal to this timestamp
cancelledstring · date-timeOptional

A filter on the list based on the order stateTransitions cancelled field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options:

  • gt - return values where the stateTransitions cancelled field is after this timestamp
  • gte - return values where the stateTransitions cancelled field is after or equal to this timestamp
  • lt - return values where the stateTransitions cancelled field is before this timestamp
  • lte - return values where the stateTransitions cancelled field is before or equal to this timestamp
fulfilledstring · date-timeOptional

A filter on the list based on the order stateTransitions fulfilled field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options:

  • gt - return values where the stateTransitions fulfilled field is after this timestamp
  • gte - return values where the stateTransitions fulfilled field is after or equal to this timestamp
  • lt - return values where the stateTransitions fulfilled field is before this timestamp
  • lte - return values where the stateTransitions fulfilled field is before or equal to this timestamp
completestring · date-timeOptional

A filter on the list based on the order stateTransitions complete field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options:

  • gt - return values where the stateTransitions complete field is after this timestamp
  • gte - return values where the stateTransitions complete field is after or equal to this timestamp
  • lt - return values where the stateTransitions complete field is before this timestamp
  • lte - return values where the stateTransitions complete field is before or equal to this timestamp
returnedstring · date-timeOptional

A filter on the list based on the order stateTransitions returned field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options:

  • gt - return values where the stateTransitions returned field is after this timestamp
  • gte - return values where the stateTransitions returned field is after or equal to this timestamp
  • lt - return values where the stateTransitions returned field is before this timestamp
  • lte - return values where the stateTransitions returned field is before or equal to this timestamp
fraudStatestringOptional

Only return orders in the given fraudState

fraudStateTransitions.blockedstring · date-timeOptional

A filter on the list based on the order fraudStateTransitions blocked field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options:

  • gt - return values where the fraudStateTransitions blocked field is after this timestamp
  • gte - return values where the fraudStateTransitions blocked field is after or equal to this timestamp
  • lt - return values where the fraudStateTransitions blocked field is before this timestamp
  • lte - return values where the fraudStateTransitions blocked field is before or equal to this timestamp
fraudStateTransitions.review_openedstring · date-timeOptional

A filter on the list based on the order fraudStateTransitions review_opened field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options:

  • gt - return values where the fraudStateTransitions review_opened field is after this timestamp
  • gte - return values where the fraudStateTransitions review_opened field is after or equal to this timestamp
  • lt - return values where the fraudStateTransitions review_opened field is before this timestamp
  • lte - return values where the fraudStateTransitions review_opened field is before or equal to this timestamp
fraudStateTransitions.passedstring · date-timeOptional

A filter on the list based on the order fraudStateTransitions passed field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options:

  • gt - return values where the fraudStateTransitions passed field is after this timestamp
  • gte - return values where the fraudStateTransitions passed field is after or equal to this timestamp
  • lt - return values where the fraudStateTransitions passed field is before this timestamp
  • lte - return values where the fraudStateTransitions passed field is before or equal to this timestamp
browserIpstringOptional

Only return checkouts with this browser IP

chargeTypestringOptional

Only return orders with this charge type

subscriptionIdstringOptional

Only return orders with this subscription identifier

refundedAmountstringOptional

Only return orders with this refunded amount

localestringOptional

Only return checkouts with this locale

customerTypestringOptional

Only return checkouts with this customer type

Responses
200

200 OK

application/json
get
GET /orders HTTP/1.1
Host: api.digitalriver.com
Accept: */*

{
  "hasMore": true,
  "data": [
    {
      "id": "ord_5823594809",
      "createdTime": "2025-09-15T21:04:45.282Z",
      "customerId": "cus_5774321009",
      "currency": "usd",
      "email": "[email protected]",
      "locale": "en_US",
      "browserIp": "111.111.111.111",
      "applicationId": "68f72e0c-cb7d-48e1-93c8-998668ad0ff4",
      "shipFrom": {
        "address": {
          "line1": "10380 Bren Rd W",
          "line2": "text",
          "city": "Minnetonka",
          "postalCode": "55129",
          "state": "MN",
          "country": "US"
        },
        "additionalAddressInfo": {
          "neighborhood": "Centro",
          "division": "営業部",
          "phoneticName": "ヤマダ タロ"
        }
      },
      "shipTo": {
        "address": {
          "line1": "10380 Bren Rd W",
          "line2": "text",
          "city": "Minnetonka",
          "postalCode": "55129",
          "state": "MN",
          "country": "US"
        },
        "name": "John Smith",
        "phone": "952-111-1111",
        "email": "[email protected]",
        "organization": "Digital River",
        "additionalAddressInfo": {
          "neighborhood": "Centro",
          "division": "営業部",
          "phoneticName": "ヤマダ タロ"
        }
      },
      "subtotal": 1094.5,
      "totalTax": 82.76,
      "importerOfRecordTax": true,
      "totalFees": 0,
      "totalDuty": 0,
      "totalDiscount": 0,
      "totalShipping": 5.76,
      "totalAmount": 1180.26,
      "discount": {
        "amountOff": 5.95
      },
      "availableToRefundAmount": 18.58,
      "refundedAmount": 1,
      "cancelledAmount": 1,
      "capturedAmount": 1,
      "items": [
        [
          {
            "skuId": "sku_5823594809",
            "amount": 18.58,
            "discount": {
              "percentOff": 10
            }
          },
          {
            "skuId": "sku_9234276173",
            "amount": 18.58,
            "quantity": 2
          }
        ]
      ],
      "requestToBeForgotten": true,
      "shippingChoice": {
        "amount": 5.95,
        "taxAmount": 0.1,
        "description": "USPS: Priority (1 day delivery)",
        "serviceLevel": "SG"
      },
      "state": "created",
      "stateTransitions": {
        "accepted": "2025-09-15T21:04:45.282Z",
        "pending_payment": "2025-09-15T21:04:45.282Z",
        "in_review": "2025-09-15T21:04:45.282Z",
        "complete": "2025-09-15T21:04:45.282Z",
        "cancelled": "2025-09-15T21:04:45.282Z",
        "fulfilled": "2025-09-15T21:04:45.282Z",
        "blocked": "2025-09-15T21:04:45.282Z",
        "returned": "2025-09-15T21:04:45.282Z"
      },
      "fraudState": "passed",
      "fraudStateTransitions": {
        "blocked": "2025-09-15T21:04:45.282Z",
        "in_review": "2025-09-15T21:04:45.282Z",
        "passed": "2025-09-15T21:04:45.282Z"
      },
      "cancelReason": "fraud",
      "charges": [
        {
          "id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
          "createdTime": "2025-09-15T21:04:45.282Z",
          "currency": "USD",
          "amount": 1180.26,
          "state": "pending",
          "orderId": "9986340012",
          "sourceId": "9986340012",
          "failureCode": "a failure code",
          "failureMessage": "a failure message",
          "paymentSessionId": "8cecaa32-f692-44cc-b103-4cf24dc93913",
          "cancels": [
            {
              "id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
              "createdTime": "2025-09-15T21:04:45.282Z",
              "updatedTime": "2025-09-15T21:04:45.282Z",
              "amount": 1180.26,
              "state": "pending",
              "failureCode": "text",
              "failureMessage": "text"
            }
          ],
          "captures": [
            {
              "id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
              "createdTime": "2025-09-15T21:04:45.282Z",
              "updatedTime": "2025-09-15T21:04:45.282Z",
              "amount": 1180.26,
              "state": "pending",
              "failureCode": "text",
              "failureMessage": "text"
            }
          ],
          "captured": false,
          "refunds": [
            {
              "id": "ref_5823594809",
              "createdTime": "2025-09-15T21:04:45.282Z",
              "orderId": "ord_6645940010",
              "currency": "USD",
              "type": "shipping",
              "amount": 9.99,
              "refundedAmount": 9.99,
              "items": [
                [
                  {
                    "type": "shipping",
                    "skuId": "sku_9234276173",
                    "quantity": 1,
                    "amount": 5.95
                  }
                ]
              ],
              "reason": "requested_by_customer",
              "failureReason": "expired_or_canceled_card",
              "state": "created",
              "tokenInformation": {
                "token": "bb3f0f17-567a-4c87-8cbd-76d93a750709",
                "expiresTime": "2025-09-15T21:04:45.282Z"
              },
              "expiresTime": "2025-09-15T21:04:45.282Z",
              "liveMode": false,
              "metadata": {
                "coupon": "iOS"
              }
            }
          ],
          "refunded": false,
          "type": "customer_initiated",
          "liveMode": true
        }
      ],
      "paymentSessionId": "ps_8cecaa32-f692-44cc-b103-4cf24dc93913",
      "liveMode": true,
      "metadata": {
        "coupon": "iOS"
      },
      "sellingEntity": {
        "id": "DR_IRELAND-ENTITY",
        "name": "Digital River Ireland"
      },
      "purchaseLocation": {
        "country": "US",
        "state": "MN",
        "postalCode": "55364"
      },
      "customerType": "individual",
      "upstreamId": "0916805858",
      "updatedTime": "2025-09-15T21:04:45.282Z"
    }
  ]
}

Creates a new order

post

Creates a new order.

Body
one ofOptional
or
Responses
201

201 Created

application/json
post
POST /orders HTTP/1.1
Host: api.digitalriver.com
Content-Type: application/json
Accept: */*
Content-Length: 1435

{
  "customerId": "5774321009",
  "sourceId": "src_a78cfeae-f7ae-4719-8e1c-d05ec04e4d37",
  "currency": "USD",
  "email": "[email protected]",
  "locale": "en_US",
  "applicationId": "68f72e0c-cb7d-48e1-93c8-998668ad0ff4",
  "browserIp": "111.111.111.111",
  "shipFrom": {
    "address": {
      "line1": "10380 Bren Rd W",
      "line2": "text",
      "city": "Minnetonka",
      "postalCode": "55129",
      "state": "MN",
      "country": "US"
    },
    "additionalAddressInfo": {
      "neighborhood": "Centro",
      "division": "営業部",
      "phoneticName": "ヤマダ タロ"
    }
  },
  "shipTo": {
    "address": {
      "line1": "10380 Bren Rd W",
      "line2": "text",
      "city": "Minnetonka",
      "postalCode": "55129",
      "state": "MN",
      "country": "US"
    },
    "name": "John Smith",
    "phone": "952-111-1111",
    "email": "[email protected]",
    "organization": "Digital River",
    "additionalAddressInfo": {
      "neighborhood": "Centro",
      "division": "営業部",
      "phoneticName": "ヤマダ タロ"
    }
  },
  "shippingChoice": {
    "amount": 5.95,
    "description": "USPS: Priority (1 day delivery)",
    "serviceLevel": "SG"
  },
  "discount": {
    "percentOff": 100
  },
  "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
    }
  ],
  "shippingDiscount": {
    "percentOff": 100
  },
  "taxInclusive": true,
  "chargeType": "merchant_initiated",
  "customerType": "individual",
  "metadata": {
    "coupon": "iOS"
  },
  "purchaseLocation": {
    "country": "US",
    "state": "MN",
    "postalCode": "55364"
  },
  "upstreamId": "7765374748"
}
{
  "id": "ord_5823594809",
  "createdTime": "2025-09-15T21:04:45.282Z",
  "customerId": "cus_5774321009",
  "currency": "usd",
  "email": "[email protected]",
  "locale": "en_US",
  "browserIp": "111.111.111.111",
  "applicationId": "68f72e0c-cb7d-48e1-93c8-998668ad0ff4",
  "shipFrom": {
    "address": {
      "line1": "10380 Bren Rd W",
      "line2": "text",
      "city": "Minnetonka",
      "postalCode": "55129",
      "state": "MN",
      "country": "US"
    },
    "additionalAddressInfo": {
      "neighborhood": "Centro",
      "division": "営業部",
      "phoneticName": "ヤマダ タロ"
    }
  },
  "shipTo": {
    "address": {
      "line1": "10380 Bren Rd W",
      "line2": "text",
      "city": "Minnetonka",
      "postalCode": "55129",
      "state": "MN",
      "country": "US"
    },
    "name": "John Smith",
    "phone": "952-111-1111",
    "email": "[email protected]",
    "organization": "Digital River",
    "additionalAddressInfo": {
      "neighborhood": "Centro",
      "division": "営業部",
      "phoneticName": "ヤマダ タロ"
    }
  },
  "subtotal": 1094.5,
  "totalTax": 82.76,
  "importerOfRecordTax": true,
  "totalFees": 0,
  "totalDuty": 0,
  "totalDiscount": 0,
  "totalShipping": 5.76,
  "totalAmount": 1180.26,
  "discount": {
    "amountOff": 5.95
  },
  "availableToRefundAmount": 18.58,
  "refundedAmount": 1,
  "cancelledAmount": 1,
  "capturedAmount": 1,
  "items": [
    [
      {
        "skuId": "sku_5823594809",
        "amount": 18.58,
        "discount": {
          "percentOff": 10
        }
      },
      {
        "skuId": "sku_9234276173",
        "amount": 18.58,
        "quantity": 2
      }
    ]
  ],
  "requestToBeForgotten": true,
  "shippingChoice": {
    "amount": 5.95,
    "taxAmount": 0.1,
    "description": "USPS: Priority (1 day delivery)",
    "serviceLevel": "SG"
  },
  "state": "created",
  "stateTransitions": {
    "accepted": "2025-09-15T21:04:45.282Z",
    "pending_payment": "2025-09-15T21:04:45.282Z",
    "in_review": "2025-09-15T21:04:45.282Z",
    "complete": "2025-09-15T21:04:45.282Z",
    "cancelled": "2025-09-15T21:04:45.282Z",
    "fulfilled": "2025-09-15T21:04:45.282Z",
    "blocked": "2025-09-15T21:04:45.282Z",
    "returned": "2025-09-15T21:04:45.282Z"
  },
  "fraudState": "passed",
  "fraudStateTransitions": {
    "blocked": "2025-09-15T21:04:45.282Z",
    "in_review": "2025-09-15T21:04:45.282Z",
    "passed": "2025-09-15T21:04:45.282Z"
  },
  "cancelReason": "fraud",
  "charges": [
    {
      "id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
      "createdTime": "2025-09-15T21:04:45.282Z",
      "currency": "USD",
      "amount": 1180.26,
      "state": "pending",
      "orderId": "9986340012",
      "sourceId": "9986340012",
      "failureCode": "a failure code",
      "failureMessage": "a failure message",
      "paymentSessionId": "8cecaa32-f692-44cc-b103-4cf24dc93913",
      "cancels": [
        {
          "id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
          "createdTime": "2025-09-15T21:04:45.282Z",
          "updatedTime": "2025-09-15T21:04:45.282Z",
          "amount": 1180.26,
          "state": "pending",
          "failureCode": "text",
          "failureMessage": "text"
        }
      ],
      "captures": [
        {
          "id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
          "createdTime": "2025-09-15T21:04:45.282Z",
          "updatedTime": "2025-09-15T21:04:45.282Z",
          "amount": 1180.26,
          "state": "pending",
          "failureCode": "text",
          "failureMessage": "text"
        }
      ],
      "captured": false,
      "refunds": [
        {
          "id": "ref_5823594809",
          "createdTime": "2025-09-15T21:04:45.282Z",
          "orderId": "ord_6645940010",
          "currency": "USD",
          "type": "shipping",
          "amount": 9.99,
          "refundedAmount": 9.99,
          "items": [
            [
              {
                "type": "shipping",
                "skuId": "sku_9234276173",
                "quantity": 1,
                "amount": 5.95
              }
            ]
          ],
          "reason": "requested_by_customer",
          "failureReason": "expired_or_canceled_card",
          "state": "created",
          "tokenInformation": {
            "token": "bb3f0f17-567a-4c87-8cbd-76d93a750709",
            "expiresTime": "2025-09-15T21:04:45.282Z"
          },
          "expiresTime": "2025-09-15T21:04:45.282Z",
          "liveMode": false,
          "metadata": {
            "coupon": "iOS"
          }
        }
      ],
      "refunded": false,
      "type": "customer_initiated",
      "liveMode": true
    }
  ],
  "paymentSessionId": "ps_8cecaa32-f692-44cc-b103-4cf24dc93913",
  "liveMode": true,
  "metadata": {
    "coupon": "iOS"
  },
  "sellingEntity": {
    "id": "DR_IRELAND-ENTITY",
    "name": "Digital River Ireland"
  },
  "purchaseLocation": {
    "country": "US",
    "state": "MN",
    "postalCode": "55364"
  },
  "customerType": "individual",
  "upstreamId": "0916805858",
  "updatedTime": "2025-09-15T21:04:45.282Z"
}

Gets an order by ID

get

Retrieves the details of an order. Supply the unique identifier of the order you would like to retrieve.

Path parameters
idstringRequired

Order ID

Responses
200

OK.

application/json
get
GET /orders/{id} HTTP/1.1
Host: api.digitalriver.com
Accept: */*

{
  "id": "ord_5823594809",
  "createdTime": "2025-09-15T21:04:45.282Z",
  "customerId": "cus_5774321009",
  "currency": "usd",
  "email": "[email protected]",
  "locale": "en_US",
  "browserIp": "111.111.111.111",
  "applicationId": "68f72e0c-cb7d-48e1-93c8-998668ad0ff4",
  "shipFrom": {
    "address": {
      "line1": "10380 Bren Rd W",
      "line2": "text",
      "city": "Minnetonka",
      "postalCode": "55129",
      "state": "MN",
      "country": "US"
    },
    "additionalAddressInfo": {
      "neighborhood": "Centro",
      "division": "営業部",
      "phoneticName": "ヤマダ タロ"
    }
  },
  "shipTo": {
    "address": {
      "line1": "10380 Bren Rd W",
      "line2": "text",
      "city": "Minnetonka",
      "postalCode": "55129",
      "state": "MN",
      "country": "US"
    },
    "name": "John Smith",
    "phone": "952-111-1111",
    "email": "[email protected]",
    "organization": "Digital River",
    "additionalAddressInfo": {
      "neighborhood": "Centro",
      "division": "営業部",
      "phoneticName": "ヤマダ タロ"
    }
  },
  "subtotal": 1094.5,
  "totalTax": 82.76,
  "importerOfRecordTax": true,
  "totalFees": 0,
  "totalDuty": 0,
  "totalDiscount": 0,
  "totalShipping": 5.76,
  "totalAmount": 1180.26,
  "discount": {
    "amountOff": 5.95
  },
  "availableToRefundAmount": 18.58,
  "refundedAmount": 1,
  "cancelledAmount": 1,
  "capturedAmount": 1,
  "items": [
    [
      {
        "skuId": "sku_5823594809",
        "amount": 18.58,
        "discount": {
          "percentOff": 10
        }
      },
      {
        "skuId": "sku_9234276173",
        "amount": 18.58,
        "quantity": 2
      }
    ]
  ],
  "requestToBeForgotten": true,
  "shippingChoice": {
    "amount": 5.95,
    "taxAmount": 0.1,
    "description": "USPS: Priority (1 day delivery)",
    "serviceLevel": "SG"
  },
  "state": "created",
  "stateTransitions": {
    "accepted": "2025-09-15T21:04:45.282Z",
    "pending_payment": "2025-09-15T21:04:45.282Z",
    "in_review": "2025-09-15T21:04:45.282Z",
    "complete": "2025-09-15T21:04:45.282Z",
    "cancelled": "2025-09-15T21:04:45.282Z",
    "fulfilled": "2025-09-15T21:04:45.282Z",
    "blocked": "2025-09-15T21:04:45.282Z",
    "returned": "2025-09-15T21:04:45.282Z"
  },
  "fraudState": "passed",
  "fraudStateTransitions": {
    "blocked": "2025-09-15T21:04:45.282Z",
    "in_review": "2025-09-15T21:04:45.282Z",
    "passed": "2025-09-15T21:04:45.282Z"
  },
  "cancelReason": "fraud",
  "charges": [
    {
      "id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
      "createdTime": "2025-09-15T21:04:45.282Z",
      "currency": "USD",
      "amount": 1180.26,
      "state": "pending",
      "orderId": "9986340012",
      "sourceId": "9986340012",
      "failureCode": "a failure code",
      "failureMessage": "a failure message",
      "paymentSessionId": "8cecaa32-f692-44cc-b103-4cf24dc93913",
      "cancels": [
        {
          "id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
          "createdTime": "2025-09-15T21:04:45.282Z",
          "updatedTime": "2025-09-15T21:04:45.282Z",
          "amount": 1180.26,
          "state": "pending",
          "failureCode": "text",
          "failureMessage": "text"
        }
      ],
      "captures": [
        {
          "id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
          "createdTime": "2025-09-15T21:04:45.282Z",
          "updatedTime": "2025-09-15T21:04:45.282Z",
          "amount": 1180.26,
          "state": "pending",
          "failureCode": "text",
          "failureMessage": "text"
        }
      ],
      "captured": false,
      "refunds": [
        {
          "id": "ref_5823594809",
          "createdTime": "2025-09-15T21:04:45.282Z",
          "orderId": "ord_6645940010",
          "currency": "USD",
          "type": "shipping",
          "amount": 9.99,
          "refundedAmount": 9.99,
          "items": [
            [
              {
                "type": "shipping",
                "skuId": "sku_9234276173",
                "quantity": 1,
                "amount": 5.95
              }
            ]
          ],
          "reason": "requested_by_customer",
          "failureReason": "expired_or_canceled_card",
          "state": "created",
          "tokenInformation": {
            "token": "bb3f0f17-567a-4c87-8cbd-76d93a750709",
            "expiresTime": "2025-09-15T21:04:45.282Z"
          },
          "expiresTime": "2025-09-15T21:04:45.282Z",
          "liveMode": false,
          "metadata": {
            "coupon": "iOS"
          }
        }
      ],
      "refunded": false,
      "type": "customer_initiated",
      "liveMode": true
    }
  ],
  "paymentSessionId": "ps_8cecaa32-f692-44cc-b103-4cf24dc93913",
  "liveMode": true,
  "metadata": {
    "coupon": "iOS"
  },
  "sellingEntity": {
    "id": "DR_IRELAND-ENTITY",
    "name": "Digital River Ireland"
  },
  "purchaseLocation": {
    "country": "US",
    "state": "MN",
    "postalCode": "55364"
  },
  "customerType": "individual",
  "upstreamId": "0916805858",
  "updatedTime": "2025-09-15T21:04:45.282Z"
}

Updates an existing order

post

Updates an existing order.

Path parameters
idstringRequired

Order ID

Body
requestToBeForgottenbooleanOptional

If true, indicates the user who placed the order has requested this order be forgotten.

Default: falseExample: true
metadataany ofOptional
or
or
Responses
200

200 OK

application/json
post
POST /orders/{id} HTTP/1.1
Host: api.digitalriver.com
Content-Type: application/json
Accept: */*
Content-Length: 57

{
  "requestToBeForgotten": true,
  "metadata": {
    "coupon": "iOS"
  }
}
{
  "id": "ord_5823594809",
  "createdTime": "2025-09-15T21:04:45.282Z",
  "customerId": "cus_5774321009",
  "currency": "usd",
  "email": "[email protected]",
  "locale": "en_US",
  "browserIp": "111.111.111.111",
  "applicationId": "68f72e0c-cb7d-48e1-93c8-998668ad0ff4",
  "shipFrom": {
    "address": {
      "line1": "10380 Bren Rd W",
      "line2": "text",
      "city": "Minnetonka",
      "postalCode": "55129",
      "state": "MN",
      "country": "US"
    },
    "additionalAddressInfo": {
      "neighborhood": "Centro",
      "division": "営業部",
      "phoneticName": "ヤマダ タロ"
    }
  },
  "shipTo": {
    "address": {
      "line1": "10380 Bren Rd W",
      "line2": "text",
      "city": "Minnetonka",
      "postalCode": "55129",
      "state": "MN",
      "country": "US"
    },
    "name": "John Smith",
    "phone": "952-111-1111",
    "email": "[email protected]",
    "organization": "Digital River",
    "additionalAddressInfo": {
      "neighborhood": "Centro",
      "division": "営業部",
      "phoneticName": "ヤマダ タロ"
    }
  },
  "subtotal": 1094.5,
  "totalTax": 82.76,
  "importerOfRecordTax": true,
  "totalFees": 0,
  "totalDuty": 0,
  "totalDiscount": 0,
  "totalShipping": 5.76,
  "totalAmount": 1180.26,
  "discount": {
    "amountOff": 5.95
  },
  "availableToRefundAmount": 18.58,
  "refundedAmount": 1,
  "cancelledAmount": 1,
  "capturedAmount": 1,
  "items": [
    [
      {
        "skuId": "sku_5823594809",
        "amount": 18.58,
        "discount": {
          "percentOff": 10
        }
      },
      {
        "skuId": "sku_9234276173",
        "amount": 18.58,
        "quantity": 2
      }
    ]
  ],
  "requestToBeForgotten": true,
  "shippingChoice": {
    "amount": 5.95,
    "taxAmount": 0.1,
    "description": "USPS: Priority (1 day delivery)",
    "serviceLevel": "SG"
  },
  "state": "created",
  "stateTransitions": {
    "accepted": "2025-09-15T21:04:45.282Z",
    "pending_payment": "2025-09-15T21:04:45.282Z",
    "in_review": "2025-09-15T21:04:45.282Z",
    "complete": "2025-09-15T21:04:45.282Z",
    "cancelled": "2025-09-15T21:04:45.282Z",
    "fulfilled": "2025-09-15T21:04:45.282Z",
    "blocked": "2025-09-15T21:04:45.282Z",
    "returned": "2025-09-15T21:04:45.282Z"
  },
  "fraudState": "passed",
  "fraudStateTransitions": {
    "blocked": "2025-09-15T21:04:45.282Z",
    "in_review": "2025-09-15T21:04:45.282Z",
    "passed": "2025-09-15T21:04:45.282Z"
  },
  "cancelReason": "fraud",
  "charges": [
    {
      "id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
      "createdTime": "2025-09-15T21:04:45.282Z",
      "currency": "USD",
      "amount": 1180.26,
      "state": "pending",
      "orderId": "9986340012",
      "sourceId": "9986340012",
      "failureCode": "a failure code",
      "failureMessage": "a failure message",
      "paymentSessionId": "8cecaa32-f692-44cc-b103-4cf24dc93913",
      "cancels": [
        {
          "id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
          "createdTime": "2025-09-15T21:04:45.282Z",
          "updatedTime": "2025-09-15T21:04:45.282Z",
          "amount": 1180.26,
          "state": "pending",
          "failureCode": "text",
          "failureMessage": "text"
        }
      ],
      "captures": [
        {
          "id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
          "createdTime": "2025-09-15T21:04:45.282Z",
          "updatedTime": "2025-09-15T21:04:45.282Z",
          "amount": 1180.26,
          "state": "pending",
          "failureCode": "text",
          "failureMessage": "text"
        }
      ],
      "captured": false,
      "refunds": [
        {
          "id": "ref_5823594809",
          "createdTime": "2025-09-15T21:04:45.282Z",
          "orderId": "ord_6645940010",
          "currency": "USD",
          "type": "shipping",
          "amount": 9.99,
          "refundedAmount": 9.99,
          "items": [
            [
              {
                "type": "shipping",
                "skuId": "sku_9234276173",
                "quantity": 1,
                "amount": 5.95
              }
            ]
          ],
          "reason": "requested_by_customer",
          "failureReason": "expired_or_canceled_card",
          "state": "created",
          "tokenInformation": {
            "token": "bb3f0f17-567a-4c87-8cbd-76d93a750709",
            "expiresTime": "2025-09-15T21:04:45.282Z"
          },
          "expiresTime": "2025-09-15T21:04:45.282Z",
          "liveMode": false,
          "metadata": {
            "coupon": "iOS"
          }
        }
      ],
      "refunded": false,
      "type": "customer_initiated",
      "liveMode": true
    }
  ],
  "paymentSessionId": "ps_8cecaa32-f692-44cc-b103-4cf24dc93913",
  "liveMode": true,
  "metadata": {
    "coupon": "iOS"
  },
  "sellingEntity": {
    "id": "DR_IRELAND-ENTITY",
    "name": "Digital River Ireland"
  },
  "purchaseLocation": {
    "country": "US",
    "state": "MN",
    "postalCode": "55364"
  },
  "customerType": "individual",
  "upstreamId": "0916805858",
  "updatedTime": "2025-09-15T21:04:45.282Z"
}
PreviousFulfillmentsNextPayouts

Last updated