Commerce

Sends out a preview of the CRC notification email

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

commerce-v1.json

commerce-v1.yaml

Servers

Mock server

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

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

Cancellation Fees

Operations

Cancellations

Operations

Carts

Operations

Coupon Code Gen Processes

Operations

Coupon Codes

Operations

Coupons

Operations

Discount Products

Operations

Entitlement Types

Operations

Entitlements

Operations

Inventory Transactions

Operations

Merchandise

Operations

Orders

Operations

Product Categories

Operations

Product Confirmation Emails

Operations

Product Inventories

Operations

Query Definitions

Operations

Returns

Operations

Settings

Operations

Shared Modifier Options

Operations

Shared Variant Options

Operations

Shipments

Operations

Initiates workflow to warm up inventory transactions

Request

curl -i -X POST \
  https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/shipments/warmUpStepFunctions \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Processes a shipment

Request

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

Path

tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The shipment that you would like to be saved.

carrier_integrationstring(Carrier Integration)

Enum"none""ups"

custom_field_valuesArray of objects(Custom Field Values)

datestring(date-time)(Date)

The date of the shipment

dimensionsobject(Dimensions)required

dimensions.depthnumber(float)(Depth)required

Depth in inches

dimensions.heightnumber(float)(Height)required

Height in inches

dimensions.widthnumber(float)(Width)required

Width in inches

idstring(ID)^[\w|-]+$required

The unique, string identifier of this shipment

line_itemsArray of objectsnon-emptyrequired

line_items[].order_line_item_idstring(Order Line Item)required

The order line item ID being fulfilled

line_items[].product_idstring(Product)required

The id of the product

line_items[].product_typestring(Product Type)required

The type of product

line_items[].quantityinteger(Quantity)required

The quantity of the order item

notesstring(Notes)

General notes

numbernumber(float)(Number)required

The unique, string identifier of this shipment

number_of_piecesnumber(float)(Number Of Pieces)

The number of pieces

order_idstring(Order)required

The order being fulfilled

packing_slip_notesstring(Packing Slip Notes)

Notes for the packing slip

send_email_confirmation_to_customerboolean(Send Email Confirmation To Customer)required

Whether or not the customer should be notified by email

shipping_addressobject(Address)required

A complete address

shipping_address.citystring(City)

The city of the address

shipping_address.countrystring(Country)

The country ISO code

shipping_address.country_namestring(Country Name)

The full name of hte country

shipping_address.countystring(County)

The county

shipping_address.latitudenumber(double)(Latitude)

shipping_address.line1string(Line 1)

The first line of the address

shipping_address.line2string(Line 2)

The second line of the address

shipping_address.line3string(Line 3)

The third line of the address

shipping_address.longitudenumber(double)(Longitude)

shipping_address.postal_codestring(Postal Code)

The zip/postal code

shipping_address.statestring(State)

The state/province of the address

shipping_address.time_zone_idstring(Time Zone)

shipping_label_uristring(Shipping Label Uri)

The shipping label, if applicable

shipping_method_descriptionstring(Shipping Method Description)required

User-friendly description for how the shipment was shipped

shipping_method_idstring(Shipping Method)

The shipping method ID from the order

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(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_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

sys_created_atstring(date-time)(Sys Created At)required

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(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_last_bulk_data_operation_idstring(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_versionstring(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_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(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_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

tracking_numberstring(Tracking Number)

The tracking number

ups_integrationobject(Ups Integration)required

ups_integration.packaging_codestring(Packaging Code)required

The UPS packaging code

ups_integration.service_codestring(Service Code)required

The UPS service code

weightobject(Weight)required

weight.ouncesnumber(float)(Ounces)required

Number of ounces

weight.poundsnumber(float)(Pounds)required

Number of pounds

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/shipments/{tenantId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "carrier_integration": "none",
    "custom_field_values": [
      {
        "boolean_value": true,
        "custom_field_id": "string",
        "file_url_value": "string",
        "list_value": [
          "string"
        ],
        "numeric_value": 0.1,
        "string_value": "string",
        "table_value": [
          {}
        ]
      }
    ],
    "date": "2019-08-24T14:15:22Z",
    "dimensions": {
      "depth": 0.1,
      "height": 0.1,
      "width": 0.1
    },
    "id": "string",
    "line_items": [
      {
        "order_line_item_id": "string",
        "product_id": "string",
        "product_type": "string",
        "quantity": 0
      }
    ],
    "notes": "string",
    "number": 0.1,
    "number_of_pieces": 0.1,
    "order_id": "string",
    "packing_slip_notes": "string",
    "send_email_confirmation_to_customer": true,
    "shipping_address": {
      "city": "string",
      "country": "string",
      "country_name": "string",
      "county": "string",
      "latitude": 0.1,
      "line1": "string",
      "line2": "string",
      "line3": "string",
      "longitude": 0.1,
      "postal_code": "string",
      "state": "string",
      "time_zone_id": "string"
    },
    "shipping_label_uri": "string",
    "shipping_method_description": "string",
    "shipping_method_id": "string",
    "sys_bulk_load_at": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_pk": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_calculated_field_error": "string",
    "sys_calculated_field_errors": [
      {
        "error": "string",
        "field": "string"
      }
    ],
    "sys_configuration_snapshot_id": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_deleted_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_has_files_in_s3": true,
    "sys_last_bulk_data_operation_id": "string",
    "sys_last_bulk_data_operation_sys_version": "string",
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_last_security_context": {},
    "sys_locked": true,
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1,
    "tracking_number": "string",
    "ups_integration": {
      "packaging_code": "string",
      "service_code": "string"
    },
    "weight": {
      "ounces": 0.1,
      "pounds": 0.1
    }
  }'

Responses

The shipment was saved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

executionArnstring(Executionarn)required

The arn of the execution

notification_channelstring(Notification Channel)

The id of the channel where progress updates will be posted

notification_publishKeystring(Notification Publishkey)

The publish key for the channel where progress updates will be posted

notification_subscribeKeystring(Notification Subscribekey)

The subscribe key for the channel where progress updates will be posted

start_datestring(date-time)(Start Date)

The start date of the execution

Response

application/json

{
  "executionArn": "string",
  "notification_channel": "string",
  "notification_publishKey": "string",
  "notification_subscribeKey": "string",
  "start_date": "2019-08-24T14:15:22Z"
}

Execute Batch Operations

Request

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

Path

tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The batch request

operationsArray of objects

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/shipments/{tenantId}/batch' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "operations": [
      {
        "id": null,
        "object": {},
        "operation": "create",
        "patch_directives": {
          "0": {
            "op": "add",
            "path": "string",
            "value": "string"
          }
        }
      }
    ]
  }'

Responses

Request completed successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

error_countnumber(float)(Error Count)

Number of error results

resultsArray of objects

success_countnumber(float)(Success Count)

Number of successful results

Response

application/json

{
  "error_count": 0.1,
  "results": [
    { … }
  ],
  "success_count": 0.1
}

Returns a list of records with the specified order_id

Request

Returns a list of records with the specified order_id

Path

tenantIdstringrequired

The tenant

order_idstringrequired

The order_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/shipments/{tenantId}/order/{order_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(Shipment)

LastEvaluatedKeystring

Response

application/json

{
  "Count": 0,
  "Items": [
    { … }
  ],
  "LastEvaluatedKey": "string"
}

Sends out a preview of the CRC notification email

Request

Sends out a preview of the CRC notification email

Path

tenantIdstringrequired

The tenant

Bodyapplication/jsonrequired

The domain_name to use to for record lookup

cancellation_idstring(Cancellation)

coupon_idstring(Coupon)required

coupon_typestring(Coupon Type)required

destination_email_addressstring(Destination Email Address)required

email_templateobject(Email Template)

order_idstring(Order)

order_item_line_numbernumber(float)(Order Item Line Number)

return_idstring(Return)

shipment_idstring(Shipment)required

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/shipments/{tenantId}/previewEmail' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "cancellation_id": "string",
    "coupon_id": "string",
    "coupon_type": "string",
    "destination_email_address": "string",
    "email_template": {
      "bcc": "string",
      "body": "string",
      "cc": "string",
      "from": "string",
      "from_name": "string",
      "reply_to": "string",
      "subject": "string"
    },
    "order_id": "string",
    "order_item_line_number": 0.1,
    "return_id": "string",
    "shipment_id": "string"
  }'

Responses

The record was retrieved successfully

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Gets all of the shipments in the system.

Request

This method will scan all shipments and and return them to the caller.

Path

tenantIdstringrequired

The id of the tenant being accessed.

Query

fieldsstring

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

exclusiveStartKeystring

The start key, if you're making a subsequent request

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

Responses

The shipmentswere retrieved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/jsonArray [

carrier_integrationstring(Carrier Integration)

Enum"none""ups"

custom_field_valuesArray of objects(Custom Field Values)

datestring(date-time)(Date)

The date of the shipment

dimensionsobject(Dimensions)required

dimensions.depthnumber(float)(Depth)required

Depth in inches

dimensions.heightnumber(float)(Height)required

Height in inches

dimensions.widthnumber(float)(Width)required

Width in inches

idstring(ID)^[\w|-]+$required

The unique, string identifier of this shipment

line_itemsArray of objectsnon-emptyrequired

line_items[].order_line_item_idstring(Order Line Item)required

The order line item ID being fulfilled

line_items[].product_idstring(Product)required

The id of the product

line_items[].product_typestring(Product Type)required

The type of product

line_items[].quantityinteger(Quantity)required

The quantity of the order item

notesstring(Notes)

General notes

numbernumber(float)(Number)required

The unique, string identifier of this shipment

number_of_piecesnumber(float)(Number Of Pieces)

The number of pieces

order_idstring(Order)required

The order being fulfilled

packing_slip_notesstring(Packing Slip Notes)

Notes for the packing slip

send_email_confirmation_to_customerboolean(Send Email Confirmation To Customer)required

Whether or not the customer should be notified by email

shipping_addressobject(Address)required

A complete address

shipping_address.citystring(City)

The city of the address

shipping_address.countrystring(Country)

The country ISO code

shipping_address.country_namestring(Country Name)

The full name of hte country

shipping_address.countystring(County)

The county

shipping_address.latitudenumber(double)(Latitude)

shipping_address.line1string(Line 1)

The first line of the address

shipping_address.line2string(Line 2)

The second line of the address

shipping_address.line3string(Line 3)

The third line of the address

shipping_address.longitudenumber(double)(Longitude)

shipping_address.postal_codestring(Postal Code)

The zip/postal code

shipping_address.statestring(State)

The state/province of the address

shipping_address.time_zone_idstring(Time Zone)

shipping_label_uristring(Shipping Label Uri)

The shipping label, if applicable

shipping_method_descriptionstring(Shipping Method Description)required

User-friendly description for how the shipment was shipped

shipping_method_idstring(Shipping Method)

The shipping method ID from the order

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(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_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

sys_created_atstring(date-time)(Sys Created At)required

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(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_last_bulk_data_operation_idstring(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_versionstring(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_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(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_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

tracking_numberstring(Tracking Number)

The tracking number

ups_integrationobject(Ups Integration)required

ups_integration.packaging_codestring(Packaging Code)required

The UPS packaging code

ups_integration.service_codestring(Service Code)required

The UPS service code

weightobject(Weight)required

weight.ouncesnumber(float)(Ounces)required

Number of ounces

weight.poundsnumber(float)(Pounds)required

Number of pounds

]

Response

application/json

[
  {
    "carrier_integration": "none",
    "custom_field_values": [ … ],
    "date": "2019-08-24T14:15:22Z",
    "dimensions": { … },
    "id": "string",
    "line_items": [ … ],
    "notes": "string",
    "number": 0.1,
    "number_of_pieces": 0.1,
    "order_id": "string",
    "packing_slip_notes": "string",
    "send_email_confirmation_to_customer": true,
    "shipping_address": { … },
    "shipping_label_uri": "string",
    "shipping_method_description": "string",
    "shipping_method_id": "string",
    "sys_bulk_load_at": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_pk": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_calculated_field_error": "string",
    "sys_calculated_field_errors": [ … ],
    "sys_configuration_snapshot_id": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_deleted_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_has_files_in_s3": true,
    "sys_last_bulk_data_operation_id": "string",
    "sys_last_bulk_data_operation_sys_version": "string",
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_last_security_context": {},
    "sys_locked": true,
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1,
    "tracking_number": "string",
    "ups_integration": { … },
    "weight": { … }
  }
]

Processes a shipment

Request

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

Path

tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The shipment that you would like to be saved.

carrier_integrationstring(Carrier Integration)

Enum"none""ups"

custom_field_valuesArray of objects(Custom Field Values)

datestring(date-time)(Date)

The date of the shipment

dimensionsobject(Dimensions)required

dimensions.depthnumber(float)(Depth)required

Depth in inches

dimensions.heightnumber(float)(Height)required

Height in inches

dimensions.widthnumber(float)(Width)required

Width in inches

idstring(ID)^[\w|-]+$required

The unique, string identifier of this shipment

line_itemsArray of objectsnon-emptyrequired

line_items[].order_line_item_idstring(Order Line Item)required

The order line item ID being fulfilled

line_items[].product_idstring(Product)required

The id of the product

line_items[].product_typestring(Product Type)required

The type of product

line_items[].quantityinteger(Quantity)required

The quantity of the order item

notesstring(Notes)

General notes

numbernumber(float)(Number)required

The unique, string identifier of this shipment

number_of_piecesnumber(float)(Number Of Pieces)

The number of pieces

order_idstring(Order)required

The order being fulfilled

packing_slip_notesstring(Packing Slip Notes)

Notes for the packing slip

send_email_confirmation_to_customerboolean(Send Email Confirmation To Customer)required

Whether or not the customer should be notified by email

shipping_addressobject(Address)required

A complete address

shipping_address.citystring(City)

The city of the address

shipping_address.countrystring(Country)

The country ISO code

shipping_address.country_namestring(Country Name)

The full name of hte country

shipping_address.countystring(County)

The county

shipping_address.latitudenumber(double)(Latitude)

shipping_address.line1string(Line 1)

The first line of the address

shipping_address.line2string(Line 2)

The second line of the address

shipping_address.line3string(Line 3)

The third line of the address

shipping_address.longitudenumber(double)(Longitude)

shipping_address.postal_codestring(Postal Code)

The zip/postal code

shipping_address.statestring(State)

The state/province of the address

shipping_address.time_zone_idstring(Time Zone)

shipping_label_uristring(Shipping Label Uri)

The shipping label, if applicable

shipping_method_descriptionstring(Shipping Method Description)required

User-friendly description for how the shipment was shipped

shipping_method_idstring(Shipping Method)

The shipping method ID from the order

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(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_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

sys_created_atstring(date-time)(Sys Created At)required

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(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_last_bulk_data_operation_idstring(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_versionstring(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_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(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_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

tracking_numberstring(Tracking Number)

The tracking number

ups_integrationobject(Ups Integration)required

ups_integration.packaging_codestring(Packaging Code)required

The UPS packaging code

ups_integration.service_codestring(Service Code)required

The UPS service code

weightobject(Weight)required

weight.ouncesnumber(float)(Ounces)required

Number of ounces

weight.poundsnumber(float)(Pounds)required

Number of pounds

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/shipments/{tenantId}/sync' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "carrier_integration": "none",
    "custom_field_values": [
      {
        "boolean_value": true,
        "custom_field_id": "string",
        "file_url_value": "string",
        "list_value": [
          "string"
        ],
        "numeric_value": 0.1,
        "string_value": "string",
        "table_value": [
          {}
        ]
      }
    ],
    "date": "2019-08-24T14:15:22Z",
    "dimensions": {
      "depth": 0.1,
      "height": 0.1,
      "width": 0.1
    },
    "id": "string",
    "line_items": [
      {
        "order_line_item_id": "string",
        "product_id": "string",
        "product_type": "string",
        "quantity": 0
      }
    ],
    "notes": "string",
    "number": 0.1,
    "number_of_pieces": 0.1,
    "order_id": "string",
    "packing_slip_notes": "string",
    "send_email_confirmation_to_customer": true,
    "shipping_address": {
      "city": "string",
      "country": "string",
      "country_name": "string",
      "county": "string",
      "latitude": 0.1,
      "line1": "string",
      "line2": "string",
      "line3": "string",
      "longitude": 0.1,
      "postal_code": "string",
      "state": "string",
      "time_zone_id": "string"
    },
    "shipping_label_uri": "string",
    "shipping_method_description": "string",
    "shipping_method_id": "string",
    "sys_bulk_load_at": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_pk": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_calculated_field_error": "string",
    "sys_calculated_field_errors": [
      {
        "error": "string",
        "field": "string"
      }
    ],
    "sys_configuration_snapshot_id": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_deleted_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_has_files_in_s3": true,
    "sys_last_bulk_data_operation_id": "string",
    "sys_last_bulk_data_operation_sys_version": "string",
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_last_security_context": {},
    "sys_locked": true,
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1,
    "tracking_number": "string",
    "ups_integration": {
      "packaging_code": "string",
      "service_code": "string"
    },
    "weight": {
      "ounces": 0.1,
      "pounds": 0.1
    }
  }'

Responses

The shipment was saved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

carrier_integrationstring(Carrier Integration)

Enum"none""ups"

custom_field_valuesArray of objects(Custom Field Values)

datestring(date-time)(Date)

The date of the shipment

dimensionsobject(Dimensions)required

dimensions.depthnumber(float)(Depth)required

Depth in inches

dimensions.heightnumber(float)(Height)required

Height in inches

dimensions.widthnumber(float)(Width)required

Width in inches

idstring(ID)^[\w|-]+$required

The unique, string identifier of this shipment

line_itemsArray of objectsnon-emptyrequired

line_items[].order_line_item_idstring(Order Line Item)required

The order line item ID being fulfilled

line_items[].product_idstring(Product)required

The id of the product

line_items[].product_typestring(Product Type)required

The type of product

line_items[].quantityinteger(Quantity)required

The quantity of the order item

notesstring(Notes)

General notes

numbernumber(float)(Number)required

The unique, string identifier of this shipment

number_of_piecesnumber(float)(Number Of Pieces)

The number of pieces

order_idstring(Order)required

The order being fulfilled

packing_slip_notesstring(Packing Slip Notes)

Notes for the packing slip

send_email_confirmation_to_customerboolean(Send Email Confirmation To Customer)required

Whether or not the customer should be notified by email

shipping_addressobject(Address)required

A complete address

shipping_address.citystring(City)

The city of the address

shipping_address.countrystring(Country)

The country ISO code

shipping_address.country_namestring(Country Name)

The full name of hte country

shipping_address.countystring(County)

The county

shipping_address.latitudenumber(double)(Latitude)

shipping_address.line1string(Line 1)

The first line of the address

shipping_address.line2string(Line 2)

The second line of the address

shipping_address.line3string(Line 3)

The third line of the address

shipping_address.longitudenumber(double)(Longitude)

shipping_address.postal_codestring(Postal Code)

The zip/postal code

shipping_address.statestring(State)

The state/province of the address

shipping_address.time_zone_idstring(Time Zone)

shipping_label_uristring(Shipping Label Uri)

The shipping label, if applicable

shipping_method_descriptionstring(Shipping Method Description)required

User-friendly description for how the shipment was shipped

shipping_method_idstring(Shipping Method)

The shipping method ID from the order

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(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_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

sys_created_atstring(date-time)(Sys Created At)required

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(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_last_bulk_data_operation_idstring(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_versionstring(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_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(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_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

tracking_numberstring(Tracking Number)

The tracking number

ups_integrationobject(Ups Integration)required

ups_integration.packaging_codestring(Packaging Code)required

The UPS packaging code

ups_integration.service_codestring(Service Code)required

The UPS service code

weightobject(Weight)required

weight.ouncesnumber(float)(Ounces)required

Number of ounces

weight.poundsnumber(float)(Pounds)required

Number of pounds

Response

application/json

{
  "carrier_integration": "none",
  "custom_field_values": [
    { … }
  ],
  "date": "2019-08-24T14:15:22Z",
  "dimensions": {
    "depth": 0.1,
    "height": 0.1,
    "width": 0.1
  },
  "id": "string",
  "line_items": [
    { … }
  ],
  "notes": "string",
  "number": 0.1,
  "number_of_pieces": 0.1,
  "order_id": "string",
  "packing_slip_notes": "string",
  "send_email_confirmation_to_customer": true,
  "shipping_address": {
    "city": "string",
    "country": "string",
    "country_name": "string",
    "county": "string",
    "latitude": 0.1,
    "line1": "string",
    "line2": "string",
    "line3": "string",
    "longitude": 0.1,
    "postal_code": "string",
    "state": "string",
    "time_zone_id": "string"
  },
  "shipping_label_uri": "string",
  "shipping_method_description": "string",
  "shipping_method_id": "string",
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "tracking_number": "string",
  "ups_integration": {
    "packaging_code": "string",
    "service_code": "string"
  },
  "weight": {
    "ounces": 0.1,
    "pounds": 0.1
  }
}

Returns a shipment from the system by its ID.

Request

This method will delete a shipment with the specified ID.

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the shipment to delete.

curl -i -X DELETE \
  'https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/shipments/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The shipment was deleted successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

string

Response

application/json

"string"

Returns a shipment from the system by its ID.

Request

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

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the shipment to return.

Query

fieldsstring

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

consistentReadstring

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

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

Responses

The shipment was retrieved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

carrier_integrationstring(Carrier Integration)

Enum"none""ups"

custom_field_valuesArray of objects(Custom Field Values)

datestring(date-time)(Date)

The date of the shipment

dimensionsobject(Dimensions)required

dimensions.depthnumber(float)(Depth)required

Depth in inches

dimensions.heightnumber(float)(Height)required

Height in inches

dimensions.widthnumber(float)(Width)required

Width in inches

idstring(ID)^[\w|-]+$required

The unique, string identifier of this shipment

line_itemsArray of objectsnon-emptyrequired

line_items[].order_line_item_idstring(Order Line Item)required

The order line item ID being fulfilled

line_items[].product_idstring(Product)required

The id of the product

line_items[].product_typestring(Product Type)required

The type of product

line_items[].quantityinteger(Quantity)required

The quantity of the order item

notesstring(Notes)

General notes

numbernumber(float)(Number)required

The unique, string identifier of this shipment

number_of_piecesnumber(float)(Number Of Pieces)

The number of pieces

order_idstring(Order)required

The order being fulfilled

packing_slip_notesstring(Packing Slip Notes)

Notes for the packing slip

send_email_confirmation_to_customerboolean(Send Email Confirmation To Customer)required

Whether or not the customer should be notified by email

shipping_addressobject(Address)required

A complete address

shipping_address.citystring(City)

The city of the address

shipping_address.countrystring(Country)

The country ISO code

shipping_address.country_namestring(Country Name)

The full name of hte country

shipping_address.countystring(County)

The county

shipping_address.latitudenumber(double)(Latitude)

shipping_address.line1string(Line 1)

The first line of the address

shipping_address.line2string(Line 2)

The second line of the address

shipping_address.line3string(Line 3)

The third line of the address

shipping_address.longitudenumber(double)(Longitude)

shipping_address.postal_codestring(Postal Code)

The zip/postal code

shipping_address.statestring(State)

The state/province of the address

shipping_address.time_zone_idstring(Time Zone)

shipping_label_uristring(Shipping Label Uri)

The shipping label, if applicable

shipping_method_descriptionstring(Shipping Method Description)required

User-friendly description for how the shipment was shipped

shipping_method_idstring(Shipping Method)

The shipping method ID from the order

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(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_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

sys_created_atstring(date-time)(Sys Created At)required

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(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_last_bulk_data_operation_idstring(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_versionstring(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_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(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_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

tracking_numberstring(Tracking Number)

The tracking number

ups_integrationobject(Ups Integration)required

ups_integration.packaging_codestring(Packaging Code)required

The UPS packaging code

ups_integration.service_codestring(Service Code)required

The UPS service code

weightobject(Weight)required

weight.ouncesnumber(float)(Ounces)required

Number of ounces

weight.poundsnumber(float)(Pounds)required

Number of pounds

Response

application/json

{
  "carrier_integration": "none",
  "custom_field_values": [
    { … }
  ],
  "date": "2019-08-24T14:15:22Z",
  "dimensions": {
    "depth": 0.1,
    "height": 0.1,
    "width": 0.1
  },
  "id": "string",
  "line_items": [
    { … }
  ],
  "notes": "string",
  "number": 0.1,
  "number_of_pieces": 0.1,
  "order_id": "string",
  "packing_slip_notes": "string",
  "send_email_confirmation_to_customer": true,
  "shipping_address": {
    "city": "string",
    "country": "string",
    "country_name": "string",
    "county": "string",
    "latitude": 0.1,
    "line1": "string",
    "line2": "string",
    "line3": "string",
    "longitude": 0.1,
    "postal_code": "string",
    "state": "string",
    "time_zone_id": "string"
  },
  "shipping_label_uri": "string",
  "shipping_method_description": "string",
  "shipping_method_id": "string",
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "tracking_number": "string",
  "ups_integration": {
    "packaging_code": "string",
    "service_code": "string"
  },
  "weight": {
    "ounces": 0.1,
    "pounds": 0.1
  }
}

Partially updates a shipment with the specified ID.

Request

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

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the shipment to patch.

Bodyapplication/jsonrequired

The patch directives conforming to RFC 6902.

Array [

opstring(Op)required

The operation

Enum"add""copy""move""remove""replace""test"

pathstring(Path)required

The JSON path

valuestring(Value)

]

curl -i -X PATCH \
  'https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/shipments/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "op": "add",
      "path": "string",
      "value": "string"
    }
  ]'

Responses

The shipment was patched successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

carrier_integrationstring(Carrier Integration)

Enum"none""ups"

custom_field_valuesArray of objects(Custom Field Values)

datestring(date-time)(Date)

The date of the shipment

dimensionsobject(Dimensions)required

dimensions.depthnumber(float)(Depth)required

Depth in inches

dimensions.heightnumber(float)(Height)required

Height in inches

dimensions.widthnumber(float)(Width)required

Width in inches

idstring(ID)^[\w|-]+$required

The unique, string identifier of this shipment

line_itemsArray of objectsnon-emptyrequired

line_items[].order_line_item_idstring(Order Line Item)required

The order line item ID being fulfilled

line_items[].product_idstring(Product)required

The id of the product

line_items[].product_typestring(Product Type)required

The type of product

line_items[].quantityinteger(Quantity)required

The quantity of the order item

notesstring(Notes)

General notes

numbernumber(float)(Number)required

The unique, string identifier of this shipment

number_of_piecesnumber(float)(Number Of Pieces)

The number of pieces

order_idstring(Order)required

The order being fulfilled

packing_slip_notesstring(Packing Slip Notes)

Notes for the packing slip

send_email_confirmation_to_customerboolean(Send Email Confirmation To Customer)required

Whether or not the customer should be notified by email

shipping_addressobject(Address)required

A complete address

shipping_address.citystring(City)

The city of the address

shipping_address.countrystring(Country)

The country ISO code

shipping_address.country_namestring(Country Name)

The full name of hte country

shipping_address.countystring(County)

The county

shipping_address.latitudenumber(double)(Latitude)

shipping_address.line1string(Line 1)

The first line of the address

shipping_address.line2string(Line 2)

The second line of the address

shipping_address.line3string(Line 3)

The third line of the address

shipping_address.longitudenumber(double)(Longitude)

shipping_address.postal_codestring(Postal Code)

The zip/postal code

shipping_address.statestring(State)

The state/province of the address

shipping_address.time_zone_idstring(Time Zone)

shipping_label_uristring(Shipping Label Uri)

The shipping label, if applicable

shipping_method_descriptionstring(Shipping Method Description)required

User-friendly description for how the shipment was shipped

shipping_method_idstring(Shipping Method)

The shipping method ID from the order

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(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_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

sys_created_atstring(date-time)(Sys Created At)required

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(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_last_bulk_data_operation_idstring(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_versionstring(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_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(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_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

tracking_numberstring(Tracking Number)

The tracking number

ups_integrationobject(Ups Integration)required

ups_integration.packaging_codestring(Packaging Code)required

The UPS packaging code

ups_integration.service_codestring(Service Code)required

The UPS service code

weightobject(Weight)required

weight.ouncesnumber(float)(Ounces)required

Number of ounces

weight.poundsnumber(float)(Pounds)required

Number of pounds

Response

application/json

{
  "carrier_integration": "none",
  "custom_field_values": [
    { … }
  ],
  "date": "2019-08-24T14:15:22Z",
  "dimensions": {
    "depth": 0.1,
    "height": 0.1,
    "width": 0.1
  },
  "id": "string",
  "line_items": [
    { … }
  ],
  "notes": "string",
  "number": 0.1,
  "number_of_pieces": 0.1,
  "order_id": "string",
  "packing_slip_notes": "string",
  "send_email_confirmation_to_customer": true,
  "shipping_address": {
    "city": "string",
    "country": "string",
    "country_name": "string",
    "county": "string",
    "latitude": 0.1,
    "line1": "string",
    "line2": "string",
    "line3": "string",
    "longitude": 0.1,
    "postal_code": "string",
    "state": "string",
    "time_zone_id": "string"
  },
  "shipping_label_uri": "string",
  "shipping_method_description": "string",
  "shipping_method_id": "string",
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "tracking_number": "string",
  "ups_integration": {
    "packaging_code": "string",
    "service_code": "string"
  },
  "weight": {
    "ounces": 0.1,
    "pounds": 0.1
  }
}

Updates a shipment with the specified ID.

Request

This method will update an existing shipment with the specified ID.

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the shipment to update.

Bodyapplication/jsonrequired

The updated shipment that will be saved.

carrier_integrationstring(Carrier Integration)

Enum"none""ups"

custom_field_valuesArray of objects(Custom Field Values)

datestring(date-time)(Date)

The date of the shipment

dimensionsobject(Dimensions)required

dimensions.depthnumber(float)(Depth)required

Depth in inches

dimensions.heightnumber(float)(Height)required

Height in inches

dimensions.widthnumber(float)(Width)required

Width in inches

idstring(ID)^[\w|-]+$required

The unique, string identifier of this shipment

line_itemsArray of objectsnon-emptyrequired

line_items[].order_line_item_idstring(Order Line Item)required

The order line item ID being fulfilled

line_items[].product_idstring(Product)required

The id of the product

line_items[].product_typestring(Product Type)required

The type of product

line_items[].quantityinteger(Quantity)required

The quantity of the order item

notesstring(Notes)

General notes

numbernumber(float)(Number)required

The unique, string identifier of this shipment

number_of_piecesnumber(float)(Number Of Pieces)

The number of pieces

order_idstring(Order)required

The order being fulfilled

packing_slip_notesstring(Packing Slip Notes)

Notes for the packing slip

send_email_confirmation_to_customerboolean(Send Email Confirmation To Customer)required

Whether or not the customer should be notified by email

shipping_addressobject(Address)required

A complete address

shipping_address.citystring(City)

The city of the address

shipping_address.countrystring(Country)

The country ISO code

shipping_address.country_namestring(Country Name)

The full name of hte country

shipping_address.countystring(County)

The county

shipping_address.latitudenumber(double)(Latitude)

shipping_address.line1string(Line 1)

The first line of the address

shipping_address.line2string(Line 2)

The second line of the address

shipping_address.line3string(Line 3)

The third line of the address

shipping_address.longitudenumber(double)(Longitude)

shipping_address.postal_codestring(Postal Code)

The zip/postal code

shipping_address.statestring(State)

The state/province of the address

shipping_address.time_zone_idstring(Time Zone)

shipping_label_uristring(Shipping Label Uri)

The shipping label, if applicable

shipping_method_descriptionstring(Shipping Method Description)required

User-friendly description for how the shipment was shipped

shipping_method_idstring(Shipping Method)

The shipping method ID from the order

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(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_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

sys_created_atstring(date-time)(Sys Created At)required

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(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_last_bulk_data_operation_idstring(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_versionstring(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_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(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_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

tracking_numberstring(Tracking Number)

The tracking number

ups_integrationobject(Ups Integration)required

ups_integration.packaging_codestring(Packaging Code)required

The UPS packaging code

ups_integration.service_codestring(Service Code)required

The UPS service code

weightobject(Weight)required

weight.ouncesnumber(float)(Ounces)required

Number of ounces

weight.poundsnumber(float)(Pounds)required

Number of pounds

curl -i -X PUT \
  'https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/shipments/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "carrier_integration": "none",
    "custom_field_values": [
      {
        "boolean_value": true,
        "custom_field_id": "string",
        "file_url_value": "string",
        "list_value": [
          "string"
        ],
        "numeric_value": 0.1,
        "string_value": "string",
        "table_value": [
          {}
        ]
      }
    ],
    "date": "2019-08-24T14:15:22Z",
    "dimensions": {
      "depth": 0.1,
      "height": 0.1,
      "width": 0.1
    },
    "id": "string",
    "line_items": [
      {
        "order_line_item_id": "string",
        "product_id": "string",
        "product_type": "string",
        "quantity": 0
      }
    ],
    "notes": "string",
    "number": 0.1,
    "number_of_pieces": 0.1,
    "order_id": "string",
    "packing_slip_notes": "string",
    "send_email_confirmation_to_customer": true,
    "shipping_address": {
      "city": "string",
      "country": "string",
      "country_name": "string",
      "county": "string",
      "latitude": 0.1,
      "line1": "string",
      "line2": "string",
      "line3": "string",
      "longitude": 0.1,
      "postal_code": "string",
      "state": "string",
      "time_zone_id": "string"
    },
    "shipping_label_uri": "string",
    "shipping_method_description": "string",
    "shipping_method_id": "string",
    "sys_bulk_load_at": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_pk": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_calculated_field_error": "string",
    "sys_calculated_field_errors": [
      {
        "error": "string",
        "field": "string"
      }
    ],
    "sys_configuration_snapshot_id": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_deleted_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_has_files_in_s3": true,
    "sys_last_bulk_data_operation_id": "string",
    "sys_last_bulk_data_operation_sys_version": "string",
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_last_security_context": {},
    "sys_locked": true,
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1,
    "tracking_number": "string",
    "ups_integration": {
      "packaging_code": "string",
      "service_code": "string"
    },
    "weight": {
      "ounces": 0.1,
      "pounds": 0.1
    }
  }'

Responses

The shipment was updated successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

carrier_integrationstring(Carrier Integration)

Enum"none""ups"

custom_field_valuesArray of objects(Custom Field Values)

datestring(date-time)(Date)

The date of the shipment

dimensionsobject(Dimensions)required

dimensions.depthnumber(float)(Depth)required

Depth in inches

dimensions.heightnumber(float)(Height)required

Height in inches

dimensions.widthnumber(float)(Width)required

Width in inches

idstring(ID)^[\w|-]+$required

The unique, string identifier of this shipment

line_itemsArray of objectsnon-emptyrequired

line_items[].order_line_item_idstring(Order Line Item)required

The order line item ID being fulfilled

line_items[].product_idstring(Product)required

The id of the product

line_items[].product_typestring(Product Type)required

The type of product

line_items[].quantityinteger(Quantity)required

The quantity of the order item

notesstring(Notes)

General notes

numbernumber(float)(Number)required

The unique, string identifier of this shipment

number_of_piecesnumber(float)(Number Of Pieces)

The number of pieces

order_idstring(Order)required

The order being fulfilled

packing_slip_notesstring(Packing Slip Notes)

Notes for the packing slip

send_email_confirmation_to_customerboolean(Send Email Confirmation To Customer)required

Whether or not the customer should be notified by email

shipping_addressobject(Address)required

A complete address

shipping_address.citystring(City)

The city of the address

shipping_address.countrystring(Country)

The country ISO code

shipping_address.country_namestring(Country Name)

The full name of hte country

shipping_address.countystring(County)

The county

shipping_address.latitudenumber(double)(Latitude)

shipping_address.line1string(Line 1)

The first line of the address

shipping_address.line2string(Line 2)

The second line of the address

shipping_address.line3string(Line 3)

The third line of the address

shipping_address.longitudenumber(double)(Longitude)

shipping_address.postal_codestring(Postal Code)

The zip/postal code

shipping_address.statestring(State)

The state/province of the address

shipping_address.time_zone_idstring(Time Zone)

shipping_label_uristring(Shipping Label Uri)

The shipping label, if applicable

shipping_method_descriptionstring(Shipping Method Description)required

User-friendly description for how the shipment was shipped

shipping_method_idstring(Shipping Method)

The shipping method ID from the order

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(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_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

sys_created_atstring(date-time)(Sys Created At)required

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(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_last_bulk_data_operation_idstring(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_versionstring(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_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(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_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

tracking_numberstring(Tracking Number)

The tracking number

ups_integrationobject(Ups Integration)required

ups_integration.packaging_codestring(Packaging Code)required

The UPS packaging code

ups_integration.service_codestring(Service Code)required

The UPS service code

weightobject(Weight)required

weight.ouncesnumber(float)(Ounces)required

Number of ounces

weight.poundsnumber(float)(Pounds)required

Number of pounds

Response

application/json

{
  "carrier_integration": "none",
  "custom_field_values": [
    { … }
  ],
  "date": "2019-08-24T14:15:22Z",
  "dimensions": {
    "depth": 0.1,
    "height": 0.1,
    "width": 0.1
  },
  "id": "string",
  "line_items": [
    { … }
  ],
  "notes": "string",
  "number": 0.1,
  "number_of_pieces": 0.1,
  "order_id": "string",
  "packing_slip_notes": "string",
  "send_email_confirmation_to_customer": true,
  "shipping_address": {
    "city": "string",
    "country": "string",
    "country_name": "string",
    "county": "string",
    "latitude": 0.1,
    "line1": "string",
    "line2": "string",
    "line3": "string",
    "longitude": 0.1,
    "postal_code": "string",
    "state": "string",
    "time_zone_id": "string"
  },
  "shipping_label_uri": "string",
  "shipping_method_description": "string",
  "shipping_method_id": "string",
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "tracking_number": "string",
  "ups_integration": {
    "packaging_code": "string",
    "service_code": "string"
  },
  "weight": {
    "ounces": 0.1,
    "pounds": 0.1
  }
}

Shipping Configurations

Operations

Shipping Products

Operations

Statistics

Operations

Stores

Operations

Tax Classes

Operations

Tax Configurations

Operations

Tax Products

Operations

Warehouse Bins

Operations

Warehouses

Operations

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

Cancellation Fees

Cancellations

Carts

Coupon Code Gen Processes

Coupon Codes

Coupons

Discount Products

Entitlement Types

Entitlements

Inventory Transactions

Merchandise

Orders

Product Categories

Product Confirmation Emails

Product Inventories

Query Definitions

Returns

Settings

Shared Modifier Options

Shared Variant Options

Shipments

Initiates workflow to warm up inventory transactions

Request

Responses

Was this helpful?

Processes a shipment

RequestExpand all

Responses

Was this helpful?

Execute Batch Operations

RequestExpand all

Responses

Was this helpful?

Returns a list of records with the specified order_id

Request

Responses

Was this helpful?

Sends out a preview of the CRC notification email

RequestExpand all

Responses

Was this helpful?

Gets all of the shipments in the system.

Request

Responses

Was this helpful?

Processes a shipment

RequestExpand all

Responses

Was this helpful?

Returns a shipment from the system by its ID.

Request

Responses

Was this helpful?

Returns a shipment from the system by its ID.

Request

Responses

Was this helpful?

Partially updates a shipment with the specified ID.

Request

Responses

Was this helpful?

Updates a shipment with the specified ID.

RequestExpand all

Responses

Was this helpful?

Shipping Configurations

Shipping Products

Statistics

Stores

Tax Classes

Tax Configurations

Tax Products

Warehouse Bins

Warehouses

Request

Request

Request

Request

Request