Shipments

Processes a shipment

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.

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The id of the tenant being accessed.

Request Body schema: application/json

The shipment that you would like to be saved.

id required	string (ID) /^[\w\|-]+$/ The unique, string identifier of this shipment
number required	number <float> (Number) The unique, string identifier of this shipment
date	string <date-time> (Date) The date of the shipment
order_id required	string (Order) The order being fulfilled
required	Array of objects non-empty
number_of_pieces	number <float> (Number Of Pieces) The number of pieces
required	object (Address) A complete address
packing_slip_notes	string (Packing Slip Notes) Notes for the packing slip
carrier_integration	string (Carrier Integration) Enum: "none" "ups"
required	object (Weight)
required	object (Dimensions)
required	object (Ups Integration)
shipping_label_uri	string (Shipping Label Uri) The shipping label, if applicable
shipping_method_id	string (Shipping Method) The shipping method ID from the order
notes	string (Notes) General notes
send_email_confirmation_to_customer required	boolean (Send Email Confirmation To Customer) Whether or not the customer should be notified by email
tracking_number	string (Tracking Number) The tracking number
shipping_method_description required	string (Shipping Method Description) User-friendly description for how the shipment was shipped
	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 shipment was saved successfully.

400The shipment you supplied was invalid.

401Unauthorized.

403Forbidden.

404The resource could not be found

409The shipment could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to add shipment based on tenant limits.

500General server error.

post/shipments/{tenantId}

Request samples

application/json

{"id": "string",
"number": 0,
"date": "2019-08-24T14:15:22Z",
"order_id": "string",
"line_items": [{"order_line_item_id": "string",
"product_type": "string",
"product_id": "string",
"quantity": 0
}
],
"number_of_pieces": 0,
"shipping_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"packing_slip_notes": "string",
"carrier_integration": "none",
"weight": {"pounds": 0,
"ounces": 0
},
"dimensions": {"width": 0,
"height": 0,
"depth": 0
},
"ups_integration": {"service_code": "string",
"packaging_code": "string"
},
"shipping_label_uri": "string",
"shipping_method_id": "string",
"notes": "string",
"send_email_confirmation_to_customer": true,
"tracking_number": "string",
"shipping_method_description": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"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": [{"field": "string",
"error": "string"
}
]
}

Response samples

application/json

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

Gets all of the shipments in the system.

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

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The id of the tenant being accessed.

query Parameters

fields	string The fields that you want to retrieve; if omitted, the entire object is returned.
exclusiveStartKey	string The start key, if you're making a subsequent request

Responses

200The shipmentswere retrieved successfully.

400The request was invalid.

401Unauthorized.

403Forbidden.

404The resource could not be found

429Limit exceeded... unable to add contact role based on tenant limits.

500General server error.

get/shipments/{tenantId}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://commerce.api.756794052567.rhythmsoftware.com/shipments/:tenantId?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

[{"id": "string",
"number": 0,
"date": "2019-08-24T14:15:22Z",
"order_id": "string",
"line_items": [{"order_line_item_id": "string",
"product_type": "string",
"product_id": "string",
"quantity": 0
}
],
"number_of_pieces": 0,
"shipping_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"packing_slip_notes": "string",
"carrier_integration": "none",
"weight": {"pounds": 0,
"ounces": 0
},
"dimensions": {"width": 0,
"height": 0,
"depth": 0
},
"ups_integration": {"service_code": "string",
"packaging_code": "string"
},
"shipping_label_uri": "string",
"shipping_method_id": "string",
"notes": "string",
"send_email_confirmation_to_customer": true,
"tracking_number": "string",
"shipping_method_description": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"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": [{"field": "string",
"error": "string"
}
]
}
]

Returns a shipment from the system by its ID.

This method will look up a shipment 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 shipment 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 shipment was retrieved successfully.

400The request was not valid.

401Unauthorized.

403Forbidden.

404The shipment could not be found.

429Limit exceeded... unable to retrieve shipment based on tenant limits.

500General server error.

get/shipments/{tenantId}/{id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://commerce.api.756794052567.rhythmsoftware.com/shipments/:tenantId/:id?fields=string&consistentRead=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"id": "string",
"number": 0,
"date": "2019-08-24T14:15:22Z",
"order_id": "string",
"line_items": [{"order_line_item_id": "string",
"product_type": "string",
"product_id": "string",
"quantity": 0
}
],
"number_of_pieces": 0,
"shipping_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"packing_slip_notes": "string",
"carrier_integration": "none",
"weight": {"pounds": 0,
"ounces": 0
},
"dimensions": {"width": 0,
"height": 0,
"depth": 0
},
"ups_integration": {"service_code": "string",
"packaging_code": "string"
},
"shipping_label_uri": "string",
"shipping_method_id": "string",
"notes": "string",
"send_email_confirmation_to_customer": true,
"tracking_number": "string",
"shipping_method_description": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"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": [{"field": "string",
"error": "string"
}
]
}

Updates a shipment with the specified ID.

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

Request Body schema: application/json

The updated shipment that will be saved.

id required	string (ID) /^[\w\|-]+$/ The unique, string identifier of this shipment
number required	number <float> (Number) The unique, string identifier of this shipment
date	string <date-time> (Date) The date of the shipment
order_id required	string (Order) The order being fulfilled
required	Array of objects non-empty
number_of_pieces	number <float> (Number Of Pieces) The number of pieces
required	object (Address) A complete address
packing_slip_notes	string (Packing Slip Notes) Notes for the packing slip
carrier_integration	string (Carrier Integration) Enum: "none" "ups"
required	object (Weight)
required	object (Dimensions)
required	object (Ups Integration)
shipping_label_uri	string (Shipping Label Uri) The shipping label, if applicable
shipping_method_id	string (Shipping Method) The shipping method ID from the order
notes	string (Notes) General notes
send_email_confirmation_to_customer required	boolean (Send Email Confirmation To Customer) Whether or not the customer should be notified by email
tracking_number	string (Tracking Number) The tracking number
shipping_method_description required	string (Shipping Method Description) User-friendly description for how the shipment was shipped
	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 shipment was updated successfully.

400The shipment supplied was not valid.

401Unauthorized.

403Forbidden.

404The shipment could not be found.

409The shipment could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to retrieve shipment based on tenant limits.

500General server error.

put/shipments/{tenantId}/{id}

Request samples

application/json

{"id": "string",
"number": 0,
"date": "2019-08-24T14:15:22Z",
"order_id": "string",
"line_items": [{"order_line_item_id": "string",
"product_type": "string",
"product_id": "string",
"quantity": 0
}
],
"number_of_pieces": 0,
"shipping_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"packing_slip_notes": "string",
"carrier_integration": "none",
"weight": {"pounds": 0,
"ounces": 0
},
"dimensions": {"width": 0,
"height": 0,
"depth": 0
},
"ups_integration": {"service_code": "string",
"packaging_code": "string"
},
"shipping_label_uri": "string",
"shipping_method_id": "string",
"notes": "string",
"send_email_confirmation_to_customer": true,
"tracking_number": "string",
"shipping_method_description": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"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": [{"field": "string",
"error": "string"
}
]
}

Response samples

application/json

{"id": "string",
"number": 0,
"date": "2019-08-24T14:15:22Z",
"order_id": "string",
"line_items": [{"order_line_item_id": "string",
"product_type": "string",
"product_id": "string",
"quantity": 0
}
],
"number_of_pieces": 0,
"shipping_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"packing_slip_notes": "string",
"carrier_integration": "none",
"weight": {"pounds": 0,
"ounces": 0
},
"dimensions": {"width": 0,
"height": 0,
"depth": 0
},
"ups_integration": {"service_code": "string",
"packaging_code": "string"
},
"shipping_label_uri": "string",
"shipping_method_id": "string",
"notes": "string",
"send_email_confirmation_to_customer": true,
"tracking_number": "string",
"shipping_method_description": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"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": [{"field": "string",
"error": "string"
}
]
}

Partially updates a shipment with the specified ID.

This method will patch an existing shipment 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 shipment 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 shipment was patched successfully.

400The JSON patch directive you supplied was not valid.

401Unauthorized.

403Forbidden.

404The shipment could not be found.

409The shipment could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to retrieve shipment based on tenant limits.

500General server error.

patch/shipments/{tenantId}/{id}

Request samples

application/json

[{"op": "add",
"path": "string",
"value": "string"
}
]

Response samples

application/json

{"id": "string",
"number": 0,
"date": "2019-08-24T14:15:22Z",
"order_id": "string",
"line_items": [{"order_line_item_id": "string",
"product_type": "string",
"product_id": "string",
"quantity": 0
}
],
"number_of_pieces": 0,
"shipping_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"packing_slip_notes": "string",
"carrier_integration": "none",
"weight": {"pounds": 0,
"ounces": 0
},
"dimensions": {"width": 0,
"height": 0,
"depth": 0
},
"ups_integration": {"service_code": "string",
"packaging_code": "string"
},
"shipping_label_uri": "string",
"shipping_method_id": "string",
"notes": "string",
"send_email_confirmation_to_customer": true,
"tracking_number": "string",
"shipping_method_description": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"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": [{"field": "string",
"error": "string"
}
]
}

Returns a shipment from the system by its ID.

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

Responses

200The shipment was deleted successfully.

400The request was not valid.

401Unauthorized.

403Forbidden.

404The shipment could not be found.

409The shipment could not be deleted because other objects refers to/depends on this one.

429Limit exceeded... unable to delete shipment based on tenant limits.

500General server error.

delete/shipments/{tenantId}/{id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X DELETE \
  https://commerce.api.756794052567.rhythmsoftware.com/shipments/:tenantId/:id \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

"string"

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/shipments/{tenantId}/order/{order_id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://commerce.api.756794052567.rhythmsoftware.com/shipments/:tenantId/order/:order_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"Count": 0,
"Items": [{"id": "string",
"number": 0,
"date": "2019-08-24T14:15:22Z",
"order_id": "string",
"line_items": [{"order_line_item_id": "string",
"product_type": "string",
"product_id": "string",
"quantity": 0
}
],
"number_of_pieces": 0,
"shipping_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"packing_slip_notes": "string",
"carrier_integration": "none",
"weight": {"pounds": 0,
"ounces": 0
},
"dimensions": {"width": 0,
"height": 0,
"depth": 0
},
"ups_integration": {"service_code": "string",
"packaging_code": "string"
},
"shipping_label_uri": "string",
"shipping_method_id": "string",
"notes": "string",
"send_email_confirmation_to_customer": true,
"tracking_number": "string",
"shipping_method_description": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"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": [{"field": "string",
"error": "string"
}
]
}
],
"LastEvaluatedKey": "string"
}

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/shipments/{tenantId}/previewEmail

Request samples

application/json

{"cancellation_id": "string",
"email_template": {"from": "string",
"from_name": "string",
"reply_to": "string",
"subject": "string",
"cc": "string",
"bcc": "string",
"body": "string"
},
"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/shipments/warmUpStepFunctions

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X POST \
  https://commerce.api.756794052567.rhythmsoftware.com/shipments/warmUpStepFunctions \
  -H 'Authorization: YOUR_API_KEY_HERE'

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 shipment could not be found.

429Limit exceeded... unable to retrieve shipment based on tenant limits.

500General server error.

post/shipments/{tenantId}/batch

Request samples

application/json

{"operations": [{"operation": "create",
"id": "string",
"patch_directives": [{"op": "add",
"path": "string",
"value": "string"
}
],
"object": { }
}
]
}

Response samples

application/json

{"success_count": 0,
"error_count": 0,
"results": [{"operation": "create",
"id": "string",
"outcome": "success",
"error_message": "string",
"object": { }
}
]
}