Learn More

These topics boost your REST expertise and understanding of concepts and tasks introduced in the Quick Start. Take your REST skills to the next level.

Topic	Learn how to...
Work with your REST API Client	Send HTTP requests using cURL and third-party browser extensions or using add-on REST clients.
Custom Actions	Perform actions on resources to trigger processes which extend the basic create, read, update, and delete functions.
Manage Collections	Manage the display of data returned from a collection by querying, paginating, and filtering operations.
Configure for CORS	Configure your REST API client for cross-origin resource sharing (CORS) and cross-domain communication from a browser.
JSON PATCH	Make a sequence of modifications to a resource using a standard JSON PATCH (RFC 6902) format message.
Asynchronous Processing	Send messages to be processed asynchronously.
Batch Processing	The transmissions resource is available for submitting multiple resource messages for a mix of resources and operations. This resource will only be supported for Asynchronous processing.
Document Content Upload and Download	Document resources can be accessed directly as a root resource but can also be associated with many other resource types, e.g. shipments, order releases etc. These other resource types provide access to these associated document resources via their own corresponding "documents" child resource.
Rate Inquiry	Rate inquiry actions are exposed via REST Web services for rate route and network rate and route calls.
Outbound REST	The capability exists to send out messages containing the resource content for all supported resources.
Resource Metadata	Describes how the individual schema file for each resource can be accessed at runtime by accessing a "metadata-catalog" URL.
Available Custom Shapes	As and when new features are added to this REST API, backward compatibility of existing interfaces is a key consideration. It is usual practice that adding new optional content isn't a breaking change. However, when content is relocated or removed entirely, this is likely to be a breaking change. To avoid this breakage, changes to existing resource structures will be implemented as "custom shapes". That is, multiple structures can exist for the same underlying resource type, although each will use a different root resource name.