Get Order Metadata

 

This method returns the metadata for a specified order based on a provided primary key (see Get Order PriKey).

 

HTTP Verb/Method:

GET 

URL Format:

http://server/api/orders/{ID}

Returns:

The metadata for a specific order returns upon successful completion of this request (see the Request Return section below).

 

An error is returned if the order metadata cannot be found.

 

The following table lists the parameter available for this method request.

 

Parameter

Description

ID

Enter the primary key (Orders.PriKey) or the Order Number (Orders.OrderNo) of the requested MoversSuite order.

 

Use the Get Order PriKey request to retrieve primary key based on a provided Order Number.

 

 

Request Return

 

SUCCESS:

Upon a successful request, metadata returns in JSON format as follows:

 

{

    "Agents": [{

        "AgentID": "U0244",

        "AgentType": "Booking"

    }, {

        "AgentID": "U0491",

        "AgentType": "Destination"

    }],

    "FirstName": "John",

    "LastName": "Miller",

    "Military": {

        "GBLNumber": "AB321789"

    },

    "OrderID": 35124,

    "OrderNumber": "U244-18319-2- - - ",

    "OrderSeg": "244-18319-2",

    "PONumber": "04982"

}

 

The following table describes the metadata returned by this method.

 

Property

Description

Agents

The agent ID and type will display for each affiliated agent (either “Booking” or “Destination”).

 

The agent of the order is managed through the Agents tab.

FirstName

The First Name/MI on the order (from Name, Address, Phone tab) is returned.

LastName

The Last Name/Company Name on the order (from Name, Address, Phone tab) returns.

Military

The GBL Number assigned to the order (from Military/Government tab) returns through this property.

OrderID

This is the primary key of the order record (Orders.PriKey).

OrderNumber

This property contains the full Order Number for this order.

OrderSeq

Returned in this property is the sequence number portion of the Order Number.

PONumber

The Purchase Order Number associated to the order (from Billing Information tab) is returned.

 

 

FAILURE:

An error message indicating that the order was not found returns.