Articles in this section

Available Ryder APIs

When you configure an export, import, or other type of flow step using the prebuilt Ryder connector, you can select any of the API operations listed below, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the Ryder API documentation. You can also create a composite endpoint for this application in HTTP mode.

Resource

API endpoint

Export

Import

Bundle items

Retrieve a bundle item

X

Update a bundle item's quantity

X

Destroy a bundle item

X

Consumer returns

List all consumer returns

X

Create a consumer return

X

Create consumer returns in bulk

X

Count consumer returns

X

Retrieve a consumer return

X

Update a consumer return

X

Destroy a consumer return

X

List meta fields

X

Set meta fields

X

Customers

List all customers

X

List actions you can perform

X

Count customers

X

Retrieve a customer

X

Update a customer

X

Documents

List all documents

X

Create a document

X

List actions you can perform

X

Retrieve a document

X

Destroy an document

X

Items

List all items

X

Create an item

X

List actions you can perform

X

Count items

X

Retrieve an item

X

Update an item

X

Archive an item

X

List all bundle items containing this item

X

Add an item to an bundle

X

Perform an action on an item

X

List all instances of this item in bundles

X

List locations associated with this item - by role

X

List meta fields

X

Set meta fields

X

List associated originators

X

Count originators

X

List all scancodes associated with this item

X

List associated ship notice items

X

Count associated ship notice items

X

List an item's history

X

Count the transactions in an item's history

X

Export an item's transaction history

X

Item stock by warehouse

X

Load SCACs

List all load SCACs

X

Count load SCACs

X

Notification events

List all notification events

X

Retrieve a notification event

X

Notification subscriptions

List all notification subscriptions

X

Create a notification subscription

X

Count notification subscriptions

X

Retrieve a notification subscription

X

Update a notification subscription

X

Delete a notification subscription

X

Test a notification subscription

X

Order documents

Delete an order document

X

Order items

List actions you can perform

X

Retrieve an order item

X

Update an order item

X

Destroy an order item

X

Perform an action on an order item

X

List meta fields

X

Set meta fields

X

Separate an order item

X

List all serial numbers associated with an order item

X

Retrieve the wholesale item object for an order item

X

Update a wholesale item object

X

Order totes

Count order items for an order tote

X

Count orders for a tote

X

Orders

List all orders

X

Create an order

X

List actions you can perform

X

Create orders in bulk

X

Count orders

X

Retrieve an order

X

Update an order

X

Perform an action on an order

X

Retrieve the customs info object for an order

X

Retrieve the history for an order

X

Count order's events

X

List meta fields

X

Set meta fields

X

List all order documents for an order

X

Create an order document for an order

X

Count all order documents for an order

X

List all order items for an order

X

Create an order item

X

Count order items

X

List all serial numbers associated with an order item

X

List shipping documents for a order

X

Retrieve the wholesale object for an order

X

Originators

List originators

X

Packages

List shipping documents for a package

X

Projects

List all project tasks

X

Scancodes

Create a scancode

X

Ship notice items

List actions you can perform

X

Count ship notice items

X

Retrieve a ship notice item

X

Update a ship notice item

X

Destroy a ship notice item

X

List meta fields

X

Set meta fields

X

Ship notices

List all ship notices

X

Create a ship notice

X

List actions you can perform

X

Create ship notices in bulk

X

Count ship notices

X

Retrieve a ship notice

X

Update a ship notice

X

Destroy a ship notice

X

List meta fields

X

Set meta fields

X

Count orders waiting for stock in a ship notice

X

List associated ship notice items

X

Create a ship notice item

X

Count associated ship notice items

X

Simulate

Create a consumer return with simulated data

X

Simulate processing for an consumer return

X

Create an order with simulated data

X

Simulate processing for an order

X

Create a ship notice with simulated data

X

Simulate processing for an ship notice

X

Templates

List all templates

X

Create a template

X

Retrieve a template

X

Update a template

X

Destroy a template

X

Wholesale items

List all wholesale item objects

X

Retrieve a wholesale item object

X

Update a wholesale item object

X

Delete a wholesale item object

X