Inventory Transactions

Inventory Transactions

Initiates workflow to process an inventory transaction

This method will auto-generate an ID and create a new inventory transaction. If an ID is specified for the inventory transaction, an error will be thrown.

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

Request Body schema: application/json

The inventory transaction that you would like to be saved.

id
required
string (ID) /^[\w|-]+$/

The unique, string identifier of this inventory transaction

type
required
string (Type)

The type of inventory

Enum: "adjustment" "backorder" "commitment" "fulfillment" "purchase order" "receipt" "reservation" "return" "transfer"
date
string <date-time> (Date)

The date of the transaction

product_inventory_id
required
string (Product Inventory)

The ID of the product inventory to which this transaction is tied

warehouse_id
required
string (Warehouse)

The ID of the warehouse for this product inventory

product_type
required
string (Product Type)

The type of product holding this inventory

product_id
required
string (Product)

The ID of the product holding this inventory

product_sku
string (Product Sku)

The product SKU (optional)

bin_id
string (Bin)

The bin for this inventory

quantity
required
integer (Quantity)

The quantity of this transaction

invoice_number
string (Invoice Number)

Invoice number for receipts/purchase orders

notes
string (Notes)

Any important notes

is_defective
boolean (Is Defective)

Whether or not this is a defective transaction

shipment_id
string (Shipment)

The shipment that generated this transaction

inventory_receipt_id
string (Inventory Receipt)

Self referencing inventory receipt for adjustments

Array of objects
order_id
required
string (Order)

The order responsible for this transaction

order_line_item_id
required
string (Order Line Item)

The order line item responsible for this transaction

return_id
required
string (Return)

The return responsible for this transaction

return_line_item_id
required
string (Return Line Item)

The return line item responsible for this transaction

unit_cost
number <double> (Unit Cost)

The unit cost

total_cost
number <double> (Total Cost)

The total cost of the receipt

quantity_received
required
number <float> (Quantity Received)

The quantity received of a purchase order

purchase_order_id
required
string (Purchase Order)

For receipts, the purchase order

transfer_id
string (Transfer)

The ID of the transfer

starting_quantity
required
number <float> (Starting Quantity)

For receipts, the starting quantity

ending_quantity
required
number <float> (Ending Quantity)

For receipts, the ending quantity

cogs_quantity_remaining
number <float> (Cogs Quantity Remaining)

For receipts, the COGS quantity remaining

target_product_inventory_id
string (Target Product Inventory)

For transfers, the target warehouse

target_warehouse_id
required
string (Target Warehouse)

For transfers, the ID of the target warehouse

target_bin_id
string (Target Bin)

For transfers, the target bin

cancelled_commitment_id
string (Cancelled Commitment)

Self referencing inventory commitment for cancellations

sys_product_type_id
string (Sys Product Type)
Array of objects (Custom Field Values)
sys_deleted_by_id
string (Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_version
number <float> (Sys Version)

A number representing the version of this record in the database

sys_created_at
required
string <date-time> (Sys Created At)

The date/time that this record was created, expressed in ISO-8601 date format

sys_last_modified_at
required
string <date-time> (Sys Last Modified At)

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_created_by_id
required
string (Sys Created By)

The ID of the user that created this record

sys_last_modified_by_id
required
string (Sys Last Modified By)

The ID of the user that last modified this record

sys_external_id
string (Sys External)

The ID that a record has from an external system or data import

sys_locked
boolean (Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_bulk_load_pk
string (Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_at
string (Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_id
string (Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_record_no
number <float> (Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_file
string (Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_last_bulk_data_operation_id
string (Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_version
string (Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_directive
string (Sys Directive)

Means for passing directive information into an object processing logic

sys_calculated_field_error
string (Sys Calculated Field Error)

The error associated with the calculated field

sys_snapshot_base_version
number <float> (Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_has_files_in_s3
boolean (Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_configuration_snapshot_id
string (Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_last_security_context
object (Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

Array of objects
Responses
200The inventory transaction was saved successfully.
400The inventory transaction you supplied was invalid.
401Unauthorized.
403Forbidden.
404The resource could not be found
409The inventory transaction could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to add inventory transaction based on tenant limits.
500General server error.
post/inventoryTransactions/{tenantId}/process
Request samples
    1 more
    Python
application/json
{
  • "id": "string",
  • "type": "adjustment",
  • "date": "2019-08-24T14:15:22Z",
  • "product_inventory_id": "string",
  • "warehouse_id": "string",
  • "product_type": "string",
  • "product_id": "string",
  • "product_sku": "string",
  • "bin_id": "string",
  • "quantity": 0,
  • "invoice_number": "string",
  • "notes": "string",
  • "is_defective": true,
  • "shipment_id": "string",
  • "inventory_receipt_id": "string",
  • "related_transactions": [
    ],
  • "order_id": "string",
  • "order_line_item_id": "string",
  • "return_id": "string",
  • "return_line_item_id": "string",
  • "unit_cost": 0,
  • "total_cost": 0,
  • "quantity_received": 0,
  • "purchase_order_id": "string",
  • "transfer_id": "string",
  • "starting_quantity": 0,
  • "ending_quantity": 0,
  • "cogs_quantity_remaining": 0,
  • "target_product_inventory_id": "string",
  • "target_warehouse_id": "string",
  • "target_bin_id": "string",
  • "cancelled_commitment_id": "string",
  • "sys_product_type_id": "string",
  • "custom_field_values": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}
Response samples
application/json
{
  • "notification_publishKey": "string",
  • "notification_subscribeKey": "string",
  • "notification_channel": "string",
  • "executionArn": "string",
  • "start_date": "2019-08-24T14:15:22Z"
}

Initiates workflow to warm up inventory transactions

Request
Security:
knox-authorizer
Responses
200Success
400The request was not valid
401Unauthorized
403Forbidden
404The resource could not be found
429Request limit exceeded... please try your request again in a few seconds
500An internal server error occured.
post/inventoryTransactions/warmUpStepFunctions
Request samples
curl -i -X POST \
  https://commerce.api.756794052567.rhythmsoftware.com/inventoryTransactions/warmUpStepFunctions \
  -H 'Authorization: YOUR_API_KEY_HERE'

Returns a inventory transaction from the system by its ID.

This method will look up a inventory transaction by the specified ID and return it back.

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the inventory transaction to return.

query Parameters
fields
string

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

consistentRead
string

Indicates the API should force a consistent read on the data source.

Responses
200The inventory transaction was retrieved successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The inventory transaction could not be found.
429Limit exceeded... unable to retrieve inventory transaction based on tenant limits.
500General server error.
get/inventoryTransactions/{tenantId}/{id}
Request samples
curl -i -X GET \
  'https://commerce.api.756794052567.rhythmsoftware.com/inventoryTransactions/:tenantId/:id?fields=string&consistentRead=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "type": "adjustment",
  • "date": "2019-08-24T14:15:22Z",
  • "product_inventory_id": "string",
  • "warehouse_id": "string",
  • "product_type": "string",
  • "product_id": "string",
  • "product_sku": "string",
  • "bin_id": "string",
  • "quantity": 0,
  • "invoice_number": "string",
  • "notes": "string",
  • "is_defective": true,
  • "shipment_id": "string",
  • "inventory_receipt_id": "string",
  • "related_transactions": [
    ],
  • "order_id": "string",
  • "order_line_item_id": "string",
  • "return_id": "string",
  • "return_line_item_id": "string",
  • "unit_cost": 0,
  • "total_cost": 0,
  • "quantity_received": 0,
  • "purchase_order_id": "string",
  • "transfer_id": "string",
  • "starting_quantity": 0,
  • "ending_quantity": 0,
  • "cogs_quantity_remaining": 0,
  • "target_product_inventory_id": "string",
  • "target_warehouse_id": "string",
  • "target_bin_id": "string",
  • "cancelled_commitment_id": "string",
  • "sys_product_type_id": "string",
  • "custom_field_values": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}

Updates a inventory transaction with the specified ID.

This method will update an existing inventory transaction with the specified ID.

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the inventory transaction to update.

Request Body schema: application/json

The updated inventory transaction that will be saved.

id
required
string (ID) /^[\w|-]+$/

The unique, string identifier of this inventory transaction

type
required
string (Type)

The type of inventory

Enum: "adjustment" "backorder" "commitment" "fulfillment" "purchase order" "receipt" "reservation" "return" "transfer"
date
string <date-time> (Date)

The date of the transaction

product_inventory_id
required
string (Product Inventory)

The ID of the product inventory to which this transaction is tied

warehouse_id
required
string (Warehouse)

The ID of the warehouse for this product inventory

product_type
required
string (Product Type)

The type of product holding this inventory

product_id
required
string (Product)

The ID of the product holding this inventory

product_sku
string (Product Sku)

The product SKU (optional)

bin_id
string (Bin)

The bin for this inventory

quantity
required
integer (Quantity)

The quantity of this transaction

invoice_number
string (Invoice Number)

Invoice number for receipts/purchase orders

notes
string (Notes)

Any important notes

is_defective
boolean (Is Defective)

Whether or not this is a defective transaction

shipment_id
string (Shipment)

The shipment that generated this transaction

inventory_receipt_id
string (Inventory Receipt)

Self referencing inventory receipt for adjustments

Array of objects
order_id
required
string (Order)

The order responsible for this transaction

order_line_item_id
required
string (Order Line Item)

The order line item responsible for this transaction

return_id
required
string (Return)

The return responsible for this transaction

return_line_item_id
required
string (Return Line Item)

The return line item responsible for this transaction

unit_cost
number <double> (Unit Cost)

The unit cost

total_cost
number <double> (Total Cost)

The total cost of the receipt

quantity_received
required
number <float> (Quantity Received)

The quantity received of a purchase order

purchase_order_id
required
string (Purchase Order)

For receipts, the purchase order

transfer_id
string (Transfer)

The ID of the transfer

starting_quantity
required
number <float> (Starting Quantity)

For receipts, the starting quantity

ending_quantity
required
number <float> (Ending Quantity)

For receipts, the ending quantity

cogs_quantity_remaining
number <float> (Cogs Quantity Remaining)

For receipts, the COGS quantity remaining

target_product_inventory_id
string (Target Product Inventory)

For transfers, the target warehouse

target_warehouse_id
required
string (Target Warehouse)

For transfers, the ID of the target warehouse

target_bin_id
string (Target Bin)

For transfers, the target bin

cancelled_commitment_id
string (Cancelled Commitment)

Self referencing inventory commitment for cancellations

sys_product_type_id
string (Sys Product Type)
Array of objects (Custom Field Values)
sys_deleted_by_id
string (Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_version
number <float> (Sys Version)

A number representing the version of this record in the database

sys_created_at
required
string <date-time> (Sys Created At)

The date/time that this record was created, expressed in ISO-8601 date format

sys_last_modified_at
required
string <date-time> (Sys Last Modified At)

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_created_by_id
required
string (Sys Created By)

The ID of the user that created this record

sys_last_modified_by_id
required
string (Sys Last Modified By)

The ID of the user that last modified this record

sys_external_id
string (Sys External)

The ID that a record has from an external system or data import

sys_locked
boolean (Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_bulk_load_pk
string (Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_at
string (Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_id
string (Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_record_no
number <float> (Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_file
string (Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_last_bulk_data_operation_id
string (Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_version
string (Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_directive
string (Sys Directive)

Means for passing directive information into an object processing logic

sys_calculated_field_error
string (Sys Calculated Field Error)

The error associated with the calculated field

sys_snapshot_base_version
number <float> (Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_has_files_in_s3
boolean (Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_configuration_snapshot_id
string (Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_last_security_context
object (Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

Array of objects
Responses
200The inventory transaction was updated successfully.
400The inventory transaction supplied was not valid.
401Unauthorized.
403Forbidden.
404The inventory transaction could not be found.
409The inventory transaction could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve inventory transaction based on tenant limits.
500General server error.
put/inventoryTransactions/{tenantId}/{id}
Request samples
    1 more
    Python
application/json
{
  • "id": "string",
  • "type": "adjustment",
  • "date": "2019-08-24T14:15:22Z",
  • "product_inventory_id": "string",
  • "warehouse_id": "string",
  • "product_type": "string",
  • "product_id": "string",
  • "product_sku": "string",
  • "bin_id": "string",
  • "quantity": 0,
  • "invoice_number": "string",
  • "notes": "string",
  • "is_defective": true,
  • "shipment_id": "string",
  • "inventory_receipt_id": "string",
  • "related_transactions": [
    ],
  • "order_id": "string",
  • "order_line_item_id": "string",
  • "return_id": "string",
  • "return_line_item_id": "string",
  • "unit_cost": 0,
  • "total_cost": 0,
  • "quantity_received": 0,
  • "purchase_order_id": "string",
  • "transfer_id": "string",
  • "starting_quantity": 0,
  • "ending_quantity": 0,
  • "cogs_quantity_remaining": 0,
  • "target_product_inventory_id": "string",
  • "target_warehouse_id": "string",
  • "target_bin_id": "string",
  • "cancelled_commitment_id": "string",
  • "sys_product_type_id": "string",
  • "custom_field_values": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}
Response samples
application/json
{
  • "id": "string",
  • "type": "adjustment",
  • "date": "2019-08-24T14:15:22Z",
  • "product_inventory_id": "string",
  • "warehouse_id": "string",
  • "product_type": "string",
  • "product_id": "string",
  • "product_sku": "string",
  • "bin_id": "string",
  • "quantity": 0,
  • "invoice_number": "string",
  • "notes": "string",
  • "is_defective": true,
  • "shipment_id": "string",
  • "inventory_receipt_id": "string",
  • "related_transactions": [
    ],
  • "order_id": "string",
  • "order_line_item_id": "string",
  • "return_id": "string",
  • "return_line_item_id": "string",
  • "unit_cost": 0,
  • "total_cost": 0,
  • "quantity_received": 0,
  • "purchase_order_id": "string",
  • "transfer_id": "string",
  • "starting_quantity": 0,
  • "ending_quantity": 0,
  • "cogs_quantity_remaining": 0,
  • "target_product_inventory_id": "string",
  • "target_warehouse_id": "string",
  • "target_bin_id": "string",
  • "cancelled_commitment_id": "string",
  • "sys_product_type_id": "string",
  • "custom_field_values": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}

Partially updates a inventory transaction with the specified ID.

This method will patch an existing inventory transaction with the specified ID, using the HTTP PATCH specification.

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the inventory transaction to patch.

Request Body schema: application/json

The patch directives conforming to RFC 6902.

Array
op
required
string (Op)

The operation

Enum: "add" "remove" "replace" "move" "copy" "test"
path
required
string (Path)

The JSON path

value
string (Value)
Responses
200The inventory transaction was patched successfully.
400The JSON patch directive you supplied was not valid.
401Unauthorized.
403Forbidden.
404The inventory transaction could not be found.
409The inventory transaction could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve inventory transaction based on tenant limits.
500General server error.
patch/inventoryTransactions/{tenantId}/{id}
Request samples
    1 more
    Python
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "string",
  • "type": "adjustment",
  • "date": "2019-08-24T14:15:22Z",
  • "product_inventory_id": "string",
  • "warehouse_id": "string",
  • "product_type": "string",
  • "product_id": "string",
  • "product_sku": "string",
  • "bin_id": "string",
  • "quantity": 0,
  • "invoice_number": "string",
  • "notes": "string",
  • "is_defective": true,
  • "shipment_id": "string",
  • "inventory_receipt_id": "string",
  • "related_transactions": [
    ],
  • "order_id": "string",
  • "order_line_item_id": "string",
  • "return_id": "string",
  • "return_line_item_id": "string",
  • "unit_cost": 0,
  • "total_cost": 0,
  • "quantity_received": 0,
  • "purchase_order_id": "string",
  • "transfer_id": "string",
  • "starting_quantity": 0,
  • "ending_quantity": 0,
  • "cogs_quantity_remaining": 0,
  • "target_product_inventory_id": "string",
  • "target_warehouse_id": "string",
  • "target_bin_id": "string",
  • "cancelled_commitment_id": "string",
  • "sys_product_type_id": "string",
  • "custom_field_values": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}

Returns a list of records with the specified order_id

Returns a list of records with the specified order_id

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

order_id
required
string

The order_id to use to for record lookup

query Parameters
fields
string

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

exclusiveStartKey
string

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

Responses
200The records were retrieved successfully
400The request was not valid.
401Unauthorized.
403Forbidden
404Unable to locate records
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
get/inventoryTransactions/{tenantId}/order/{order_id}
Request samples
curl -i -X GET \
  'https://commerce.api.756794052567.rhythmsoftware.com/inventoryTransactions/:tenantId/order/:order_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Returns a list of records with the specified open_purchase_order_id

Returns a list of records with the specified open_purchase_order_id

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

product_type
required
string

Produc type

product_id
required
string

Product ID

query Parameters
fields
string

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

exclusiveStartKey
string

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

Responses
200The records were retrieved successfully
400The request was not valid.
401Unauthorized.
403Forbidden
404Unable to locate records
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
get/inventoryTransactions/{tenantId}/openPurchaseOrders/{product_type}/{product_id}
Request samples
curl -i -X GET \
  'https://commerce.api.756794052567.rhythmsoftware.com/inventoryTransactions/:tenantId/openPurchaseOrders/:product_type/:product_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Returns a list of records with the specified product_inventory_id

Returns a list of records with the specified product_inventory_id

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

product_inventory_id
required
string

The product_inventory_id to use to for record lookup

query Parameters
fields
string

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

exclusiveStartKey
string

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

Responses
200The records were retrieved successfully
400The request was not valid.
401Unauthorized.
403Forbidden
404Unable to locate records
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
get/inventoryTransactions/{tenantId}/productInventory/{product_inventory_id}
Request samples
curl -i -X GET \
  'https://commerce.api.756794052567.rhythmsoftware.com/inventoryTransactions/:tenantId/productInventory/:product_inventory_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Execute Batch Operations

TAllows you to perform up to 100 parallel patch/delete operations

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

Request Body schema: application/json

The batch request

Array of objects
Responses
200Request completed successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The inventory transaction could not be found.
429Limit exceeded... unable to retrieve inventory transaction based on tenant limits.
500General server error.
post/inventoryTransactions/{tenantId}/batch
Request samples
    1 more
    Python
application/json
{
  • "operations": [
    ]
}
Response samples
application/json
{
  • "success_count": 0,
  • "error_count": 0,
  • "results": [
    ]
}