Filtering
Last updated
Last updated
Below is a list of attributes and operators available for filtering inward consignment.
Attribute
Description
Type
Operator
Example
from
your party id from where your items will be shipped
string
=
from=2
to
Eshopbox
warehouse id
string
=
to=7
consignment_type
Consignment type
string
=
consignment_type=INWARD
status
Consignment status
string
=
status =COMPLETE
created_from
Consignment created date
string
=
created_from=2020-01-20
created_to
Consignment created date
string
=
created_to=2020-01-30
qty_from
Consignment quantity
string
=
qty_from=100
qty_to
Consignment quantity
string
=
qty_to=300
consignment_number
Identifier for this inward consignment
string
=
consignment_number=CON/19-20/123456
document_number
Consignment document number
string
=
document_number=0092001405
document_type
Consignment document type
string
=
document_type=stc
receivedOnFrom
Consignment delivered date
string
=
receivedOnFrom=2020-02-20
receivedOnTo
Consignment delivered date
string
=
receivedOnTo=2020-02-25
completedOnFrom
Consignment completed date
string
=
completedOnFrom=2020-01-20
completedOnTo
Consignment completed date
string
=
completedOnTo=2020-02-02
consignmentDetails
If you want consignment received details with consignment
boolean
=
consignmentDetails=true