Sign in
latestOpenAPI 3.0.12026-08-101292701.1 MB

f21981db32be

Orders

Creates a new order

Creates a new order. For more details, refer to Converting a checkout to an order.

post/orders

Request body

checkoutIdstring

The unique identifier of a Checkout.

customerIdstring

The identifier of the Customer associated with the Checkout.

sourceIdstring

The unique identifier of a Source.

currencystring

A three-letter ISO 4217 currency code.

emailstring email

The customer's email address.

language'ar' | 'cs' | 'da' | 'de' | 'el' | 'en' | 'en-us' | 'en-gb' | 'es' | 'es-419' | 'fi' | 'fr' | 'fr-ca' | 'hu' | 'it' | 'ja' | 'ko' | 'nl' | 'false' | 'pl' | 'pt' | 'pt-br' | 'ru' | 'sk' | 'sv' | 'th' | 'tr' | 'zh' | 'zh-hk' | 'zh-tw'

The assigned language.

localestring

A designator that combines the two-letter ISO 639-1 language code with the ISO 3166-1 alpha-2 country code.

invoiceAttributeIdstring

The unique identfier of the invoice attribute.

applicationIdstring

An arbitrary string identifier that can be used to track the application type.

browserIpstring

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

taxInclusiveboolean

If <code>true</code>, indicates that the prices supplied are tax inclusive.

chargeType'customer_initiated' | 'merchant_initiated' | 'moto'

Represents the charge type.

customerType'business' | 'individual'

The type of customer.

metadataMetadata

Key-value pairs used to store additional data. Value can be string, boolean or integer types.

upstreamIdstring

Any identifier that you want to associate with the resource. For tracking purposes, we recommend you provide the universally unique identifier (UUID) that identifies the corresponding order in your system. Unlike <code>metadata</code>, you can use this value as a query parameter in <code>GET</code> requests.

Example request

{
  "checkoutId": "5823594809",
  "customerId": "5774321009",
  "sourceId": "src_a78cfeae-f7ae-4719-8e1c-d05ec04e4d37",
  "currency": "USD",
  "email": "jsmith@digitalriver.com",
  "language": "en",
  "locale": "en_IE",
  "invoiceAttributeId": "95f72e0c-cb7d-48e1-93c8-998668ad0ff4",
  "applicationId": "68f72e0c-cb7d-48e1-93c8-998668ad0ff4",
  "browserIp": "111.111.111.111",
  "shipFrom": {
    "address": {
      "line1": "10380 Bren Rd W",
      "city": "Minnetonka",
      "postalCode": "55129",
      "state": "MN",
      "country": "US"
    },
    "additionalAddressInfo": {
      "neighborhood": "Centro",
      "division": "営業部",
      "phoneticName": "ヤマダ タロ"
    }
  },
  "shipTo": {
    "address": {
      "line1": "10380 Bren Rd W",
      "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",
      "division": "営業部",
      "phoneticName": "ヤマダ タロ"
    }
  },
  "billTo": {
    "address": {
      "line1": "10380 Bren Rd W",
      "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",
      "division": "営業部",
      "phoneticName": "ヤマダ タロ"
    }
  },
  "organization": {
    "id": "123456789"
  },
  "shippingChoice": {
    "id": "100067660336",
    "amount": 5.95,
    "description": "USPS: Priority (1 day delivery)",
    "serviceLevel": "Standard Ground",
    "shippingTerms": "DDP"
  },
  "discount": {
    "amountOff": 5.95,
    "percentOff": 100
  },
  "billingOptimization": {
    "subscriptionId": "13763570010",
    "segmentId": "22070943100",
    "renewalAttemptNumber": 1,
    "trackingId": "39784"
  },
  "items": [
    {
      "skuId": "5823594809",
      "price": 9.99,
      "discount": {
        "amountOff": 10
      }
    },
    {
      "skuId": "5823594809",
      "price": 9.99,
      "quantity": 2,
      "discount": {
        "amountOff": 10
      }
    },
    {
      "skuId": "9234276173",
      "price": 9.99,
      "quantity": 2
    }
  ],
  "shippingDiscount": {
    "amountOff": 5.95,
    "percentOff": 100
  },
  "taxInclusive": true,
  "taxIdentifiers": [
    {
      "id": "028af316-2d82-4113-8c5d-72eb82d5d025"
    }
  ],
  "chargeType": "merchant_initiated",
  "customerType": "individual",
  "metadata": {
    "coupon": "iOS"
  },
  "purchaseLocation": {
    "country": "US",
    "state": "MN",
    "postalCode": "55364"
  },
  "disclosures": [
    {
      "type": "termsOfSale",
      "entityName": "Digital River Inc.",
      "entityId": "DR_INC-ENTITY",
      "localizedText": "Terms of Sale",
      "url": "https://store.digitalriver.com/store/defaults/en_US/DisplayDRTermsAndConditionsPage/eCommerceProvider.Digital%20River%20Inc."
    }
  ],
  "upstreamId": "7765374748"
}

Response

201 Created

idstring

The unique identifier for the order.

checkoutIdstring

The unique identifier of the checkout submitted to create the order.

createdTimestring date-time

Time at which the order was created.

customerIdstring

The identifier of the customer associated with this order.

currencystring

A three-letter ISO currency code.

emailstring email

The customer's email address.

language'ar' | 'cs' | 'da' | 'de' | 'el' | 'en' | 'en-us' | 'en-gb' | 'es' | 'es-419' | 'fi' | 'fr' | 'fr-ca' | 'hu' | 'it' | 'ja' | 'ko' | 'nl' | 'false' | 'pl' | 'pt' | 'pt-br' | 'ru' | 'sk' | 'sv' | 'th' | 'tr' | 'zh' | 'zh-hk' | 'zh-tw'

The assigned language.

localestring

A designator that combines the two-letter ISO 639-1 language code with the ISO 3166-1 alpha-2 country code.

browserIpstring

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

applicationIdstring

An arbitrary string identifier that can be used to track the application type.

subtotalnumber double

Represents the total order amount exclusive of tax.

totalTaxnumber double

Represents the total tax amount.

totalImporterTaxnumber double

Represents the total tax amount from the importer of record.

importerOfRecordTaxboolean nullable

If <code>true</code>, indicates that the tax amount is paid by the importer of record.

totalFeesnumber double

Represents the total fee amount.

totalDutynumber double

Represents the total duty amount.

totalDiscountnumber double

Represents the total discount amount.

totalShippingnumber double

Represents the total shipping amount.

totalAmountnumber double

Represents the total charge amount.

availableToRefundAmountnumber double nullable

The available to refund amount at the order-level.

refundedAmountnumber double

Represents the total payment amount refunded.

cancelledAmountnumber double

Represents the total payment amount cancelled.

capturedAmountnumber double

Represents the total payment amount captured.

requestToBeForgottenboolean

If <code>true</code> indicates a user placing an order has requested this order be forgotten.

state'accepted' | 'blocked' | 'pending_payment' | 'in_review' | 'dispute' | 'cancelled' | 'fulfilled' | 'complete' | 'returned'

The current order state.

fraudState'blocked' | 'review_opened' | 'passed'

The fraud review state.

cancelReasonstring

Indicates the reason for the cancellation.

liveModeboolean

Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode.

metadataMetadata

Key-value pairs used to store additional data. Value can be string, boolean or integer types.

customerType'business' | 'individual'

The type of customer.

chargeType'customer_initiated' | 'merchant_initiated' | 'moto'

Represents the charge type.

upstreamIdstring nullable

The upstream identifier.

updatedTimestring date-time

Time at which the order was created.

Example response

{
  "id": "ord_5823594809",
  "checkoutId": "5823594809",
  "createdTime": "2018-04-25T20:36:00Z",
  "customerId": "cus_5774321009",
  "currency": "usd",
  "email": "jsmith@digitalriver.com",
  "language": "en",
  "locale": "en_IE",
  "browserIp": "111.111.111.111",
  "applicationId": "68f72e0c-cb7d-48e1-93c8-998668ad0ff4",
  "taxIdentifiers": [
    {
      "id": "5774321009",
      "createdTime": "2018-04-25T20:36:00Z",
      "customerId": "5774321009",
      "type": "de",
      "value": "DE123456789",
      "state": "pending",
      "stateTransitions": {
        "pending": "2018-04-25T20:36:00Z",
        "verified": "2018-04-25T20:36:00Z",
        "not_valid": "2018-04-25T20:36:00Z"
      },
      "verifiedName": ".",
      "verifiedAddress": ".",
      "updatedTime": "2018-04-25T20:36:00Z"
    }
  ],
  "invoiceAttributes": {
    "id": "1234",
    "type": "cn_business_general",
    "customerId": "5678",
    "atttributes": [
      {
        "invoiceTitle": "Invoice title",
        "regAccount": "87654",
        "regAddress": "123 Example st.",
        "regBank": "Bank",
        "regPhone": "8005551234"
      }
    ],
    "createdTime": "2018-04-25T20:36:00Z",
    "updatedTime": "2018-04-25T20:36:00Z"
  },
  "shipFrom": {
    "address": {
      "line1": "10380 Bren Rd W",
      "city": "Minnetonka",
      "postalCode": "55129",
      "state": "MN",
      "country": "US"
    },
    "additionalAddressInfo": {
      "neighborhood": "Centro",
      "division": "営業部",
      "phoneticName": "ヤマダ タロ"
    }
  },
  "shipTo": {
    "address": {
      "line1": "10380 Bren Rd W",
      "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",
      "division": "営業部",
      "phoneticName": "ヤマダ タロ"
    }
  },
  "billTo": {
    "address": {
      "line1": "10380 Bren Rd W",
      "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",
      "division": "営業部",
      "phoneticName": "ヤマダ タロ"
    }
  },
  "organization": {
    "id": "123456789"
  },
  "subtotal": 1094.5,
  "totalTax": 82.76,
  "totalImporterTax": 82.76,
  "importerOfRecordTax": true,
  "totalShipping": 5.76,
  "totalAmount": 1180.26,
  "discount": {
    "amountOff": 5.95,
    "percentOff": 100
  },
  "availableToRefundAmount": 18.58,
  "items": [
    {
      "id": "100067660336",
      "skuId": "sku_5823594809",
      "productDetails": {
        "id": "100067660336",
        "skuGroupId": "wireless-keyboards",
        "name": "Keyboard",
        "description": "Top rated keyboard",
        "itemBreadcrumb": "Sports & Outdoors > Exercise & Fitness > Wearable Technology > Fitness Trackers",
        "url": "https://producturl.com",
        "countryOfOrigin": "US",
        "image": "https://imageurl.com",
        "weight": 20.5,
        "weightUnit": "oz",
        "partNumber": "SWG1224J10L",
        "partnerAccountId": "00g6atnynbl2wFsFG357"
      },
      "logisticsOptions": {
        "deliveryOptions": [
          "[\"direct_delivery_only\",\"additional_handling\"]"
        ],
        "dangerousGoods": [
          "nimh_battery"
        ]
      },
      "subscriptionInfo": {
        "freeTrial": true,
        "autoRenewal": true,
        "terms": "Please accept these terms.",
        "planId": "654321",
        "subscriptionId": "665430999",
        "billingAgreementId": "cfeba2ac-d532-49e4-99f4-7a433507facf",
        "startTime": "2020-05-21T00:00:00Z",
        "endTime": "2021-05-20T11:59:59Z"
      },
      "fees": {
        "details": [
          {
            "type": "battery",
            "amount": 3,
            "perUnitAmount": 1.5,
            "id": "asdkj1h239lkj123j9123"
          }
        ],
        "amount": 4.5,
        "taxAmount": 1.2
      },
      "quantity": 2,
      "state": "created",
      "amount": 18.58,
      "availableToRefundAmount": 18.58,
      "sellerTaxIdentifier": "IE6426071C",
      "tax": {
        "rate": 0.0675,
        "amount": 89
      },
      "importerTax": {
        "amount": 12.34
      },
      "duties": {
        "amount": 12.34
      },
      "discount": {
        "amountOff": 5.95,
        "percentOff": 100,
        "quantity": 1
      },
      "shipFrom": {
        "address": {
          "line1": "10380 Bren Rd W",
          "city": "Minnetonka",
          "postalCode": "55129",
          "state": "MN",
          "country": "US"
        },
        "additionalAddressInfo": {
          "neighborhood": "Centro",
          "division": "営業部",
          "phoneticName": "ヤマダ タロ"
        }
      },
      "shipping": {
        "amount": 5.99,
        "taxAmount": 1.99
      },
      "metadata": {
        "coupon": "iOS"
      }
    }
  ],
  "billingOptimization": {
    "subscriptionId": "13763570010",
    "segmentId": "22070943100",
    "renewalAttemptNumber": 1,
    "trackingId": "39784"
  },
  "requestToBeForgotten": true,
  "shippingChoice": {
    "id": "100067660336",
    "amount": 5.95,
    "taxAmount": 0.1,
    "description": "USPS: Priority (1 day delivery)",
    "serviceLevel": "Standard Ground",
    "shippingTerms": "DDP"
  },
  "state": "created",
  "fraudState": "passed",
  "cancelReason": "fraud",
  "payment": {
    "sources": [
      {
        "id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
        "clientSecret": "52199c06-b261-4786-8609-d0a84185a0d2_2b72614b-77f6-4801-bd48-8982e314fdd5",
        "createdTime": "2018-04-25T20:36:00Z",
        "type": "creditCard",
        "currency": "USD",
        "amount": 1180.26,
        "reusable": true,
        "owner": {
          "firstName": "John",
          "lastName": "Smith",
          "email": "jsmith@digitalriver.com",
          "organization": "Digital River",
          "upstreamId": "55129-54673",
          "address": {
            "line1": "10380 Bren Rd W",
            "city": "Minnetonka",
            "postalCode": "55129",
            "state": "MN",
            "country": "US"
          },
          "additionalAddressInfo": {
            "neighborhood": "Centro",
            "division": "営業部",
            "phoneticName": "ヤマダ タロ"
          }
        },
        "creditCard": {
          "lastFourDigits": "3119",
          "expirationMonth": 3,
          "expirationYear": 2023,
          "brand": "Visa"
        },
        "googlePay": {
          "lastFourDigits": "3119",
          "expirationMonth": 2,
          "expirationYear": 2022,
          "brand": "Visa"
        },
        "payPal": {
          "redirect": {
            "redirectUrl": "https://api.digitalriver.com:443/payments/redirects/e626ec65-24d6-46fb-b632-10b90f4c4912?apiKey=pk_test_6cb0fe9ce3124093a9ad906f6c589e2d",
            "returnUrl": "https://mypage.com/success",
            "cancelUrl": "https://mypage.com/cancel"
          },
          "directDebit": {
            "token": "EC-53H39048EL439164J"
          }
        },
        "payPalBilling": {
          "redirect": {
            "redirectUrl": "https://api.digitalriver.com:443/payments/redirects/e626ec65-24d6-46fb-b632-10b90f4c4912?apiKey=pk_test_6cb0fe9ce3124093a9ad906f6c589e2d",
            "returnUrl": "https://mypage.com/success",
            "cancelUrl": "https://mypage.com/cancel"
          },
          "directDebit": {
            "token": "EC-53H39048EL439164J"
          }
        },
        "payPalCredit": {
          "redirect": {
            "redirectUrl": "https://api.digitalriver.com:443/payments/redirects/e626ec65-24d6-46fb-b632-10b90f4c4912?apiKey=pk_test_6cb0fe9ce3124093a9ad906f6c589e2d",
            "returnUrl": "https://mypage.com/success",
            "cancelUrl": "https://mypage.com/cancel"
          },
          "directDebit": {
            "token": "EC-53H39048EL439164J"
          }
        },
        "directDebit": {
          "redirect": {
            "redirectUrl": "https://api.digitalriver.com:443/payments/redirects/75743f60-1023-470e-be48-b761260317af?apiKey=pk_test_6cb0fe9ce3124093a9ad906f6c589e2d",
            "returnUrl": "https://mypage.com/success"
          }
        },
        "wireTransfer": {
          "accountHolder": "Netgiro Payments AB",
          "bankName": "ABN AMRO Bank N.V.",
          "city": "Prague",
          "country": "ES",
          "referenceId": "DR1651067521",
          "accountNumber": "0100037259",
          "additionalBankInformation": "Codigo de oficina: 0001 Codigo de entidad: 0156 Digitos de control: 09",
          "iban": "ES35 0156 0001 0901 0003 7259",
          "swiftCode": "string"
        },
        "payCo": {
          "redirectUrl": "https://api.digitalriver.com:443/payments/redirects/75743f60-1023-470e-be48-b761260317af?apiKey=pk_test_6cb0fe9ce3124093a9ad906f6c589e2d",
          "returnUrl": "https://mypage.com/success"
        },
        "bPay": {
          "accountHolder": "Global Collect BV",
          "bankName": "Commonwealth Bank",
          "city": "Sydney",
          "country": "Australia",
          "referenceId": "12345678",
          "accountNumber": "87654321",
          "billId": "112233",
          "customerPaymentReference": "443322",
          "swiftCode": "CTBAAU2S"
        },
        "onlineBanking": {
          "bankCode": "86"
        },
        "klarnaCredit": {
          "shipping": {
            "recipient": "John Doe",
            "phoneNumber": "5559895326",
            "address": {
              "line1": "10380 Bren Road West",
              "city": "Minnetonka",
              "state": "MN",
              "country": "US",
              "postalCode": "55343"
            },
            "email": "jdoe@yahoo.com"
          },
          "token": "1111222233334444"
        },
        "klarnaCreditRecurring": {
          "returnUrl": "https://example.org/return",
          "cancelUrl": "https://example.org/cancel"
        },
        "konbini": {
          "storeId": "33334444",
          "receiptNumber": "8675309",
          "printableInvoiceUrl": "https://printableinvoice.com",
          "storeName": "Seven Eleven",
          "localizedStoreName": "セブン‐イレブン",
          "storeLogoUrl": "https://storelogo.com"
        },
        "giftCard": {
          "cardCurrency": "USD",
          "conversionRate": 1,
          "lastFourDigits": 8139
        },
        "flow": "standard",
        "state": "chargeable",
        "metadata": {
          "coupon": "iOS"
        },
        "customerId": "5823594809",
        "paymentSessionId": "8cecaa32-f692-44cc-b103-4cf24dc93913"
      }
    ],
    "charges": [
      {
        "id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
        "createdTime": "2018-04-25T20:36:00Z",
        "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": "2018-04-25T20:36:00Z",
            "updatedTime": "2018-04-25T20:36:00Z",
            "amount": 1180.26,
            "state": "pending"
          }
        ],
        "captures": [
          {
            "id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
            "createdTime": "2018-04-25T20:36:00Z",
            "updatedTime": "2018-04-25T20:36:00Z",
            "amount": 1180.26,
            "state": "pending"
          }
        ],
        "refunds": [
          {
            "id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
            "createdTime": "2018-04-25T20:36:00Z",
            "updatedTime": "2018-04-25T20:36:00Z",
            "amount": 1180.26,
            "state": "pending"
          }
        ],
        "liveMode": true
      }
    ],
    "session": {
      "id": "5823594809",
      "amountContributed": 10.5,
      "amountRemainingToBeContributed": 5.5,
      "clientSecret": "f93b4a5a-6971-4a50-b752-58636f9cfa07_35436acd-7d47-41df-8e5",
      "state": "requires_confirmation",
      "nextAction": {
        "action": "redirect",
        "data": {
          "redirectUrl": "https://api.digitalriver.com:443/payments/redirects/3fab742c-a7e8-4a90-8951-86d071fa070d?apiKey=pk_test_a45b91ba4f984df7a229b2ab5941ce1c",
          "sourceId": "9c00d78c-dbad-4303-b366-7e0a49c322e7",
          "sourceClientSecret": "9c00d78c-dbad-4303-b366-7e0a49c322e7_246ed54a-0dfc-41f0-9e98-14036adf642e",
          "sessionId": "f61e26be-5f38-4f39-9ae9-0b3cbff6a14e",
          "fingerprintToken": "fingerprintToken123",
          "challengeToken": "challengeToken123",
          "originKey": "originKey123"
        }
      }
    }
  },
  "disclosures": {
    "type": "termsOfSale",
    "entityName": "Digital River Inc.",
    "entityId": "DR_INC-ENTITY",
    "localizedText": "Terms of Sale",
    "url": "https://store.digitalriver.com/store/defaults/en_US/DisplayDRTermsAndConditionsPage/eCommerceProvider.Digital%20River%20Inc."
  },
  "metadata": {
    "coupon": "iOS"
  },
  "sellingEntity": {
    "id": "C5_INC-ENTITY",
    "name": "DR globalTech Inc."
  },
  "purchaseLocation": {
    "country": "US",
    "state": "MN",
    "postalCode": "55364"
  },
  "customerType": "individual",
  "chargeType": "merchant_initiated",
  "upstreamId": "0916805858",
  "updatedTime": "2018-04-25T20:37:00Z"
}