Orders API

 

The MoversSuite Orders API service is available through the MoversSuite API Service and can be used in conjunction with other local requests, such as those available through Document API to retrieve data in JSON format. This section describes the methods available to users through this service.

 

Method

Description

Get Order PriKey

Use this method to retrieve the primary key of the Orders record you wish to view. This method returns the Orders.PriKey that can an input parameter for other requests, such as a Get Order Metadata request.

Get Order Metadata

Use this method to retrieve an Orders record metadata for the provided Orders.PriKey. The method returns basic information on the order including shipper name, GBO, and agent assignments.

 

NOTE: Refer to the Find Order Request topic for a more detailed version of the Orders API.

 

RELATED TOPICS:

Agent API

Basic Order Information Request

Document API

Find Order Request

Invoices API

MoversSuite API Service Requests

MSSApiService

MSSApiService Logging