Page Comparison

Element

Type

Optional / Mandatory

Length

Comments

ValidSession

Session

M

Session object created using the Login method or by hard-coding the properties of a session object (See Request an API Key)

connoteReference

String

M

20

Use this string to query for consignments that match based on their references

consignmentDate

• DateTime

• dd/mm/yyyy
• yyyy/mm/dd
• yy/mm/dd
• dd/mm/

• yy
• dd-mm-yyyy
• yyyy-mm-dd
• yy-mm-dd
• dd-mm-yy

M

This value represents the date the consignment was created.

Element

Type

Optional / Mandatory

Length

Comments

ValidSession

Session

M

Session object created using the Login method or by hard-coding the properties of a session object (See Request an API Key)

connoteReference

String

M

20

Use this string to query for consignments that match based on their references

consignmentDate(

• DateTime
• dd/mm/

• yyyy
• yyyy/mm/dd
• yy/mm/dd
• dd/mm/yy
• dd-mm-yyyy
• yyyy-mm-dd
• yy-mm-dd
• dd-mm-yy

M

This value represents the date the consignment was created.

distributorId

Int

M

10

This value represents your assigned distributor and can be found as a property in your Session object.

accountId

Int

M

10

This value represents your assigned account id and can be found as a property in your Session object.