Commerce (Orders & Inventory) (v1-2025-04-18)

The Orders & Inventory, or Commerce, API is focused on the processing and fulfillment of Orders. Additionally, you can use this API to manage your inventory, merchandise, and online store.

Like most of the other Rhythm apps, the Commerce API includes endpoints for Query Definitions. These endpoints are commonly used to retrieve saved queries, which can then be executed using the Query endpoints of the System API.

Download OpenAPI description
Languages
Servers
Mock server

https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/

https://commerce.api.rhythmsoftware.com/

Cancellation Fees

Cancellation Fees

Operations

Cancellations

Cancellations

Operations

Carts

Carts

Operations

Coupon Code Gen Processes

Coupon Code Gen Processes

Operations

Coupon Codes

Coupon Codes

Operations

Coupons

Coupons

Operations

Discount Products

Discount Products

Operations

Entitlement Types

Entitlement Types

Operations

Entitlements

Entitlements

Operations

Inventory Transactions

Inventory Transactions

Operations

Merchandise

Merchandise

Operations

Orders

Orders

Operations

Returns a list of records with the specified coupon_id

Request

Returns a list of records with the specified coupon_id

Path
tenantIdstringrequired

The tenant

coupon_typestringrequired

The type of coupon

coupon_idstringrequired

The coupon_id to use to for record lookup

Query
fieldsstring

The fields that you want to retrieve; if omitted, the entire object is returned

exclusiveStartKeystring

If paging, this allows you to return the next set of results

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/orders/{tenantId}/coupon/{coupon_type}/{coupon_id}?exclusiveStartKey=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The records were retrieved successfully

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
Countinteger
ItemsArray of objects(Order)
LastEvaluatedKeystring
Response
application/json
{ "Count": 0, "Items": [ {} ], "LastEvaluatedKey": "string" }

Returns a list of records with the specified coupon_code_id

Request

Returns a list of records with the specified coupon_code_id

Path
tenantIdstringrequired

The tenant

coupon_code_idstringrequired

The coupon_code_id to use to for record lookup

Query
fieldsstring

The fields that you want to retrieve; if omitted, the entire object is returned

exclusiveStartKeystring

If paging, this allows you to return the next set of results

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/orders/{tenantId}/couponCodeUsages/{coupon_code_id}?exclusiveStartKey=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The records were retrieved successfully

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
Countinteger
ItemsArray of objects(CouponUsage)
LastEvaluatedKeystring
Response
application/json
{ "Count": 0, "Items": [ {} ], "LastEvaluatedKey": "string" }

Returns a list of records with the specified coupon id

Request

Returns a list of records with the specified coupon id

Path
tenantIdstringrequired

The tenant

coupon_typestringrequired

The coupon_type to use to for record lookup

coupon_idstringrequired

The coupon_id to use to for record lookup

Query
fieldsstring

The fields that you want to retrieve; if omitted, the entire object is returned

exclusiveStartKeystring

If paging, this allows you to return the next set of results

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/orders/{tenantId}/couponUsages/{coupon_type}/{coupon_id}?exclusiveStartKey=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The records were retrieved successfully

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
Countinteger
ItemsArray of objects(CouponUsage)
LastEvaluatedKeystring
Response
application/json
{ "Count": 0, "Items": [ {} ], "LastEvaluatedKey": "string" }

Product Categories

Product Categories

Operations

Product Confirmation Emails

Product Confirmation Emails

Operations

Product Inventories

Product Inventories

Operations

Query Definitions

Query Definitions

Operations

Returns

Returns

Operations

Settings

Settings

Operations

Shared Modifier Options

Shared Modifier Options

Operations

Shared Variant Options

Shared Variant Options

Operations

Shipments

Shipments

Operations

Shipping Configurations

Shipping Configurations

Operations

Shipping Products

Shipping Products

Operations

Statistics

Statistics

Operations

Stores

Stores

Operations

Tax Classes

Tax Classes

Operations

Tax Configurations

Tax Configurations

Operations

Tax Products

Tax Products

Operations

Warehouse Bins

Warehouse Bins

Operations

Warehouses

Warehouses

Operations