Checkouts
Last updated
Last updated
The Checkouts resource handles an end customer's checkout flow. You can create, retrieve, update, and delete individual checkouts and list all checkouts.
Get all checkouts.
/checkouts
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:
createdTime[gt]=2020-09-22T12:09:44ZA 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:
updatedTime[gt]=2020-09-22T12:09:44ZA 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.
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.
A limit on the number of objects returned. Limit can range between 1 and 100, and the default is 10.
Only return objects with these IDs.
Only return objects with these upstreamIds.
Only return checkouts for the given customer
Only return checkouts for the given application
Only return checkouts with the given email
Only return checkouts in the given currency
A filter on the list based on the checkout totalAmount field. The value can be a string or it can be a dictionary with the following options:
totalAmount[gt]=20.99Only return checkouts with this locale
Only return checkouts with this charge type
Only return checkouts with this customer type
Only return checkouts with the given subscription identifier
Only return checkouts with the given browser IP
Creates a new checkout.
/checkouts
The identifier of the Customer associated with the Checkout.
5774321009The unique identifier of a Source.
src_a78cfeae-f7ae-4719-8e1c-d05ec04e4d37A three-letter ISO 4217 currency code.
USDThe customer's email address.
jsmith@digitalriver.comA designator that combines the two-letter ISO 639-1 language code with the ISO 3166-1 alpha-2 country code.
en-USAn arbitrary string identifier that can be used to track the application type.
68f72e0c-cb7d-48e1-93c8-998668ad0ff4The IP address of the browser used by the customer when placing the order.
111.111.111.111Represents the total amount of credit you are extending to the customer.
10The address from which a physical product is shipped.
The ship to addresss of the customer.
Customer billing information.
Represents the shipping amount, description, taxes, and service level.
The applied discount.
The applied discount.
If <code>true</code>, indicates that the prices supplied are tax inclusive.
trueRepresents the charge type.
merchant_initiatedcustomer_initiated, merchant_initiated, motoThe type of customer.
individualbusiness, individualKey-value pairs used to store additional data. Value can be string, boolean or integer types.
{"coupon":"iOS"}Used to create a tax estimate for the customer.
The user checkout identifier if it is different from the Digital River checkout identifier.
7765374748[{"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}]Retrieves the details of a checkout. Supply the unique identifier of the checkout.
/checkouts/{id}
Checkout ID
Updates an existing checkout.
/checkouts/{id}
Checkout ID
The identifier of the Customer associated with the Checkout.
5774321008The unique identifier of a Source.
src_a78cfeae-f7ae-4719-8e1c-d05ec04e4d37A three-letter ISO currency code.
USDThe customer's email address.
jsmith@digitalriver.comA designator that combines the two-letter ISO 639-1 language code with the ISO 3166-1 alpha-2 country code.
en_USThe IP address of the browser used by the customer when placing the order.
111.111.111.111An arbitrary string identifier that can be used to track the application type.
68f72e0c-cb7d-48e1-93c8-998668ad0ff4Represents the total amount of credit you are extending to the customer.
The ship to addresss of the customer.
Customer billing information.
The applied discount.
Represents the charge type.
merchant_initiatedcustomer_initiated, merchant_initiated, motoThe type of customer.
individualbusiness, individualRepresents the shipping amount, description, taxes, and service level.
Used to create a tax estimate for the customer.
The user checkout ID if it is different from the Digital River checkout ID.
7765374748Key-value pairs used to store additional data. Value can be string, boolean or integer types.
{"coupon":"iOS"}Permanently deletes a checkout. Supply the unique identifier of the checkout.
/checkouts/{id}
Checkout ID
No body