Returns

Returns

Processes a return

This method will auto-generate an ID and create a new return. If an ID is specified for the return, 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 return that you would like to be saved.

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

The unique, string identifier of this return

number
required
integer (Number)

The unique, string identifier of this return

business_unit_id
required
string (Business Unit)

The business unit the return should be in

batch_id
required
string (Batch)

The batch the return should be in

currency_code
string (Currency Code)

The return currency

currency_symbol
string (Currency Symbol)

The cancellation currency symbol

base_currency_code
string (Base Currency Code)
base_currency_symbol
string (Base Currency Symbol)
date
string <date-time> (Date)

The date of the return

order_id
required
string (Order)

The order being returned

required
Array of objects non-empty
ignore_payment_gateway_errors
boolean (Ignore Payment Gateway Errors)

Whether or not the return should be processed, even if the payment gateway has an error

do_not_perform_electronic_refund
boolean (Do Not Perform Electronic Refund)

If set, the refund process will NOT perform an electronic refund

action
required
string (Action)

What to do with payments made on the order

Enum: "issue refund" "issue credit"
notes
string (Notes)

Any refund notes

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 return was saved successfully.
400The return you supplied was invalid.
401Unauthorized.
403Forbidden.
404The resource could not be found
409The return could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to add return based on tenant limits.
500General server error.
post/returns/{tenantId}
Request samples
    1 more
    Python
application/json
{
  • "id": "string",
  • "number": 0,
  • "business_unit_id": "string",
  • "batch_id": "string",
  • "currency_code": "string",
  • "currency_symbol": "string",
  • "base_currency_code": "string",
  • "base_currency_symbol": "string",
  • "date": "2019-08-24T14:15:22Z",
  • "order_id": "string",
  • "line_items": [
    ],
  • "ignore_payment_gateway_errors": true,
  • "do_not_perform_electronic_refund": true,
  • "action": "issue refund",
  • "notes": "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"
}

Returns a return from the system by its ID.

This method will look up a return 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 return 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 return was retrieved successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The return could not be found.
429Limit exceeded... unable to retrieve return based on tenant limits.
500General server error.
get/returns/{tenantId}/{id}
Request samples
curl -i -X GET \
  'https://commerce.api.756794052567.rhythmsoftware.com/returns/:tenantId/:id?fields=string&consistentRead=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "number": 0,
  • "business_unit_id": "string",
  • "batch_id": "string",
  • "currency_code": "string",
  • "currency_symbol": "string",
  • "base_currency_code": "string",
  • "base_currency_symbol": "string",
  • "date": "2019-08-24T14:15:22Z",
  • "order_id": "string",
  • "line_items": [
    ],
  • "ignore_payment_gateway_errors": true,
  • "do_not_perform_electronic_refund": true,
  • "action": "issue refund",
  • "notes": "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 return with the specified ID.

This method will update an existing return 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 return to update.

Request Body schema: application/json

The updated return that will be saved.

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

The unique, string identifier of this return

number
required
integer (Number)

The unique, string identifier of this return

business_unit_id
required
string (Business Unit)

The business unit the return should be in

batch_id
required
string (Batch)

The batch the return should be in

currency_code
string (Currency Code)

The return currency

currency_symbol
string (Currency Symbol)

The cancellation currency symbol

base_currency_code
string (Base Currency Code)
base_currency_symbol
string (Base Currency Symbol)
date
string <date-time> (Date)

The date of the return

order_id
required
string (Order)

The order being returned

required
Array of objects non-empty
ignore_payment_gateway_errors
boolean (Ignore Payment Gateway Errors)

Whether or not the return should be processed, even if the payment gateway has an error

do_not_perform_electronic_refund
boolean (Do Not Perform Electronic Refund)

If set, the refund process will NOT perform an electronic refund

action
required
string (Action)

What to do with payments made on the order

Enum: "issue refund" "issue credit"
notes
string (Notes)

Any refund notes

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 return was updated successfully.
400The return supplied was not valid.
401Unauthorized.
403Forbidden.
404The return could not be found.
409The return could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve return based on tenant limits.
500General server error.
put/returns/{tenantId}/{id}
Request samples
    1 more
    Python
application/json
{
  • "id": "string",
  • "number": 0,
  • "business_unit_id": "string",
  • "batch_id": "string",
  • "currency_code": "string",
  • "currency_symbol": "string",
  • "base_currency_code": "string",
  • "base_currency_symbol": "string",
  • "date": "2019-08-24T14:15:22Z",
  • "order_id": "string",
  • "line_items": [
    ],
  • "ignore_payment_gateway_errors": true,
  • "do_not_perform_electronic_refund": true,
  • "action": "issue refund",
  • "notes": "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",
  • "number": 0,
  • "business_unit_id": "string",
  • "batch_id": "string",
  • "currency_code": "string",
  • "currency_symbol": "string",
  • "base_currency_code": "string",
  • "base_currency_symbol": "string",
  • "date": "2019-08-24T14:15:22Z",
  • "order_id": "string",
  • "line_items": [
    ],
  • "ignore_payment_gateway_errors": true,
  • "do_not_perform_electronic_refund": true,
  • "action": "issue refund",
  • "notes": "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 return with the specified ID.

This method will patch an existing return 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 return 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 return was patched successfully.
400The JSON patch directive you supplied was not valid.
401Unauthorized.
403Forbidden.
404The return could not be found.
409The return could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve return based on tenant limits.
500General server error.
patch/returns/{tenantId}/{id}
Request samples
    1 more
    Python
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "string",
  • "number": 0,
  • "business_unit_id": "string",
  • "batch_id": "string",
  • "currency_code": "string",
  • "currency_symbol": "string",
  • "base_currency_code": "string",
  • "base_currency_symbol": "string",
  • "date": "2019-08-24T14:15:22Z",
  • "order_id": "string",
  • "line_items": [
    ],
  • "ignore_payment_gateway_errors": true,
  • "do_not_perform_electronic_refund": true,
  • "action": "issue refund",
  • "notes": "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 return from the system by its ID.

This method will delete a return 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 return to delete.

Responses
200The return was deleted successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The return could not be found.
409The return could not be deleted because other objects refers to/depends on this one.
429Limit exceeded... unable to delete return based on tenant limits.
500General server error.
delete/returns/{tenantId}/{id}
Request samples
curl -i -X DELETE \
  https://commerce.api.756794052567.rhythmsoftware.com/returns/:tenantId/:id \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
"string"

Sends out a preview of the CRC notification email

Sends out a preview of the CRC notification email

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

Request Body schema: application/json

The domain_name to use to for record lookup

cancellation_id
string (Cancellation)
object (Email Template)
destination_email_address
required
string (Destination Email Address)
order_id
string (Order)
order_item_line_number
number <float> (Order Item Line Number)
coupon_type
required
string (Coupon Type)
coupon_id
required
string (Coupon)
return_id
string (Return)
shipment_id
required
string (Shipment)
Responses
200The record was retrieved successfully
400The request was not valid.
401Unauthorized
403Forbidden
404Unable to locate any organizations with the specified domain
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
post/returns/{tenantId}/previewEmail
Request samples
    1 more
    Python
application/json
{
  • "cancellation_id": "string",
  • "email_template": {
    },
  • "destination_email_address": "string",
  • "order_id": "string",
  • "order_item_line_number": 0,
  • "coupon_type": "string",
  • "coupon_id": "string",
  • "return_id": "string",
  • "shipment_id": "string"
}

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/returns/warmUpStepFunctions
Request samples
curl -i -X POST \
  https://commerce.api.756794052567.rhythmsoftware.com/returns/warmUpStepFunctions \
  -H 'Authorization: YOUR_API_KEY_HERE'

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/returns/{tenantId}/order/{order_id}
Request samples
curl -i -X GET \
  'https://commerce.api.756794052567.rhythmsoftware.com/returns/:tenantId/order/:order_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 return could not be found.
429Limit exceeded... unable to retrieve return based on tenant limits.
500General server error.
post/returns/{tenantId}/batch
Request samples
    1 more
    Python
application/json
{
  • "operations": [
    ]
}
Response samples
application/json
{
  • "success_count": 0,
  • "error_count": 0,
  • "results": [
    ]
}