Note that an export pulls data from MoversSuite and an import pushes data into MoversSuite.

JSON Property

Description and Mappings

Order

Object title, which must match “Order”.  An Order object must be included in the JSON.

OrderNumber

This property contains several sub properties with the OrderSeg and ExternalID being required.

OrderSeg

Sub property that must be set to an order that exists within MoversSuite. PSeg, OSeg, SSeg, and VanLineID are not required. However, on some systems, the factor into what comprise the Order Number in MoversSuite.

VanLineID

If specified, it must match a Van Line Code for a record defined within Van Line Setup.

ExternalID

This is the identifier for a previously retrieved order through a request. If you update an existing order, then this property is required to match the order in MoversSuite.

NOTE: Optionally, other order data goes here, such as the address and order information for the Office & Industrial shipment (as shown in the example JSON – see MSO&ISales Integration Sample JSON).

SalesQuote

Object title, which must match “SalesQuote”.

QuoteStatus

If specified, this must match what is defined within Quote Status Setup. If not specified, then the quote defaults to “Accepted” within MoversSuite.

QuoteGroups

There are two levels: An array of Quote Groups and there CAN BE zero or more Quote Details under a single Quote Group. The sum of the Quote Details (when specified) Charge amounts must equal the Quote Group's Charge amount. Quote Details are identical in JSON to a Quote Group as far as property names go BUT a Quote Detail DOES NOT have Details. Having a discussion between thw developer and the mover about what fields need to be completed on a SalesQuote is desirable.  In reality, the only required fields are ItemCodeMapping, the Charge and the SourceChargeId.  Everything else is optional.

Details

Details of the quote or the quote group are specified as follows.

IsTransportationCharge, ItemCode and ItemCodeMapping

IsTransportationCharge and ItemCode are only EXPORTED.  On IMPORTS, ItemCodeMapping points to a "Mapped Code" that must be configured for each item code.  See the XML Item Code Setup. ItemCodeMapping is a varchar(50) size. While an ItemCodeMapping is not necessarily required, the lack of this will not allow the item to be subsequently imported into MoversSuite as revenue.

Description

The charge description (varchar (128). If not specified, then the mapped ItemCode's Description is used. And if neither are specified, the description will be blank.

Qty, Rates and Charge

Quantity, Quantity2, Rate and RateType are optional. RateType is a "Mapped Code" that must be configured for each item code.  See the Rate Type Setup administration screen.  Rate Types define a divisior, and if a Quantity2 is used. When used, they should end up with the same calculation as MoversSuite would do to get the Charge (Quanity * Quantity2 (if needed) * Rate divided by the RateType divisor = Charge). Charge, on the other hand, is a required field.  Four decimal places on the two quantity fields and Rate and Charge are money fields.

ServiceProviderType

When specified, one of the following case insensitive values must be:

Origin Agent

Origin Linehaul Carrier

Carrier

Consolidator

Customs Agent

Destination Linehaul Carrier

Destination Agent

Booking Agent

Hauling Agent

Delivery Agent Warehouse

Pickup Agent Warehouse

Linehaul Agent

Linehaul Carrier

Destination Consignee Agent

ServiceProviderCode, ServiceProviderName

An appropriate code and name for the ServiceProvider.  An intense discussion on what to send here would be needed, if these are fields to be sent in at all.

ServiceProviderBillToType

When specified, one of the following case insensitive values must be:

Agent

National Account

Shipper

SourceChargeId (Required)

An external charge identifier. Use a Guid with no dashes. This is a varchar(32) size field.  If you send an update, then this value is used to locate the quote item to be updated.  Note that moving details to a different group and using the same SourceChargeId may not be supported.  Pushing in updates with details may not work.

PoNumber

Purchase Order Number (varchar(20) (optional)

InvoiceNumber

Purchase Invoice Number (varchar(20) (optional)

Service Date

Date of the service in (yyyy-mm-dd format) (optional)

NoteText

An accounting note (varchar(1024)) (optional)