getShipments

Method returns list of contractor's shipments.

Usage URL: https://magboss.pl/api/getShipments.json?key=YOURAPIKEY

Query params

(put those in your URL, e.g. ?id=123)

id
integer or integer[]
Internal identifier of shipment.
More than one value can be specified after comma (,) separator.
{"name":"id","propertyName":"id","type":{"format":null},"description":"Internal identifier of shipment.\nMore than one value can be specified after comma (,) separator.","example":null,"required":false,"children":[]}
created
datetime (YYYY-MM-DD HH:MM:SS)
Return all shipments created after the created date. That is highly recommended when you want to update your local database.
{"name":"created","propertyName":"created","type":{"format":"YYYY-MM-DD HH:MM:SS"},"description":"Return all shipments created after the created<\/strong> date. That is highly recommended<\/strong> when you want to update your local database.","example":null,"required":false,"children":[]}
modified
datetime (YYYY-MM-DD HH:MM:SS)
Return all shipments modified after the modified date. That is highly recommended when you want to update your local database.
{"name":"modified","propertyName":"modified","type":{"format":"YYYY-MM-DD HH:MM:SS"},"description":"Return all shipments modified after the modified<\/strong> date. That is highly recommended<\/strong> when you want to update your local database.","example":null,"required":false,"children":[]}
date
datetime (YYYY-MM-DD HH:MM:SS)
Return all shipments shipped after the date date. That is highly recommended when you want to update your local database.
{"name":"date","propertyName":"date","type":{"format":"YYYY-MM-DD HH:MM:SS"},"description":"Return all shipments shipped after the date<\/strong> date. That is highly recommended<\/strong> when you want to update your local database.","example":null,"required":false,"children":[]}
name
string
Tracking number of the shipment.
Example: '51234' will return all shipments that contain 51234 in the `name` field.
{"name":"name","propertyName":"name","type":{"format":null},"description":"Tracking number of the shipment.","example":"'51234' will return all shipments that contain 51234<\/strong> in the `name` field.","required":false,"children":[]}
saleid
integer or integer[]
Internal identifier of sale.
More than one value can be specified after comma (,) separator.
{"name":"saleid","propertyName":"saleId","type":{"format":null},"description":"Internal identifier of sale.\nMore than one value can be specified after comma (,) separator.","example":null,"required":false,"children":[]}
shipmenttypeid
integer or integer[]
Shipment type internal identifier.
More than one value can be specified after comma (,) separator.
{"name":"shipmenttypeid","propertyName":"shipmentTypeId","type":{"format":null},"description":"Shipment type internal identifier.\nMore than one value can be specified after comma (,) separator.","example":null,"required":false,"children":[]}
lang
string
Language of result. ISO 2 Letter Language Codes ie
Example: en, pl, cs
{"name":"lang","propertyName":"lang","type":{"format":null},"description":"Language of result. ISO 2 Letter Language Codes ie","example":"en, pl, cs","required":false,"children":[]}

id
integer
Internal identifier of shipment.
{"name":"id","propertyName":"id","type":{"format":null},"description":"Internal identifier of shipment.","example":null,"required":false,"children":[]}
created
datetime (YYYY-MM-DD HH:MM:SS)
When shipment was created.
{"name":"created","propertyName":"created","type":{"format":"YYYY-MM-DD HH:MM:SS"},"description":"When shipment was created.","example":null,"required":false,"children":[]}
modified
datetime (YYYY-MM-DD HH:MM:SS)
When shipment was last modified.
{"name":"modified","propertyName":"modified","type":{"format":"YYYY-MM-DD HH:MM:SS"},"description":"When shipment was last modified.","example":null,"required":false,"children":[]}
date
datetime (YYYY-MM-DD HH:MM:SS)
When shipment was shipped out.
{"name":"date","propertyName":"date","type":{"format":"YYYY-MM-DD HH:MM:SS"},"description":"When shipment was shipped out.","example":null,"required":false,"children":[]}
name
string
Name of shipment.
{"name":"name","propertyName":"name","type":{"format":null},"description":"Name of shipment.","example":null,"required":false,"children":[]}
state
integer
0 - created, 1 - awaiting for pickup, 2 - shipped, 3 - cancelled, 10 - delivered (only some delivery providers)
{"name":"state","propertyName":"state","type":{"format":null},"description":"0 - created, 1 - awaiting for pickup, 2 - shipped, 3 - cancelled, 10 - delivered (only some delivery providers)","example":null,"required":false,"children":[]}
weightgross
float
Declared weight of package
{"name":"weightgross","propertyName":"weightGross","type":{"format":null},"description":"Declared weight of package","example":null,"required":false,"children":[]}
orderdocumentnames
string
Name of invoices that were shipped in this package (comma separated)
{"name":"orderdocumentnames","propertyName":"orderDocumentNames","type":{"format":null},"description":"Name of invoices that were shipped in this package (comma separated)","example":null,"required":false,"children":[]}
ordernames
string
Document names of orders that were shipped in this package (comma separated)
{"name":"ordernames","propertyName":"orderNames","type":{"format":null},"description":"Document names of orders that were shipped in this package (comma separated)","example":null,"required":false,"children":[]}
orderids
string
Order names of sales that were shipped in this package (comma separated) - due to an issue on our side - this field was wrongly marked for a long time and we are not changing it's output. To get IDs of sales/orders - use salepointers instead
{"name":"orderids","propertyName":"orderIds","type":{"format":null},"description":"Order names of sales that were shipped in this package (comma separated) - due to an issue on our side - this field was wrongly marked for a long time and we are not changing it's output. To get IDs of sales\/orders - use salepointers instead","example":null,"required":false,"children":[]}
fkshipmenttype
integer
Shipment type internal identifier.
{"name":"fkshipmenttype","propertyName":"fkShipmentType","type":{"format":null},"description":"Shipment type internal identifier.","example":null,"required":false,"children":[]}
shipmenttypename
string
Shipment type name.
{"name":"shipmenttypename","propertyName":"shipmentTypeName","type":{"format":null},"description":"Shipment type name.","example":null,"required":false,"children":[]}
trackingurl
string
External URL where package can be tracked (from courier)
{"name":"trackingurl","propertyName":"trackingUrl","type":{"format":null},"description":"External URL where package can be tracked (from courier)","example":null,"required":false,"children":[]}

Example URL: https://magboss.pl/api/getShipments.json?key=YOURAPIKEY&lang=en&modified=2017-02-20

Example URL: https://magboss.pl/api/getShipments.xml?key=YOURAPIKEY&lang=en&modified=2017-02-20