2Service Services API

GetShipment

The following routes are available for this service:
GET	/dealers/shipment/{ShipmentId}	Retrieves shipment based on it's ID.

**GetShipment** Parameters:
Name	Parameter	Data Type	Required	Description
ShipmentId	path	int	Yes	Shipment ID to retrieve the status for.

**AuthenticatedRequest** Parameters:
Name	Parameter	Data Type	Required	Description
SessionToken	query	string	Yes	Session token received from successful authentication.

**OperationResult<T>** Parameters:
Name	Parameter	Data Type	Required	Description
Result	model	PartResults	No	Result value

**OperationResult** Parameters:
Name	Parameter	Data Type	Required	Description
IsSuccessful	model	bool	No	Specifies if the operation was successful.
ErrorMessage	model	string	No	States error message in case of unsuccessful operation.

**PartResults** Parameters:
Name	Parameter	Data Type	Required	Description
TotalNumberOfParts	form	int	No	Total number of parts available.
HasMoreRecords	form	bool	No	Indication if there are more parts to retrieve.
Parts	form	List<PartInfoResult>	No	Part records.

**PartInfoResult** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int	No	Unique ID for the part.
PartNumber	form	string	No	Part number.
Description	form	string	No	Description of the part.
Manufacturer	form	string	No	Part manufacturer.
CanBeOrdered	form	bool	No	Determines if the part can be ordered.
StatusText	form	string	No	Textual representation of the status of the part.
AvailableStockQuantity	form	int	No	Available stock to order.
AverageDeliveryInDays	form	int?	No	Average days needed for delivery.
UnitPrice	form	decimal?	No	Price of a single unit, excluding VAT.
EanNumber	form	string	No	EAN number.
Images	form	List<PartInfoResultImage>	No	Images
SecondaryArticleNumbers	form	List<string>	No	Secondary article numbers
ReplacementArticleNumbers	form	List<string>	No	Replacement article numbers
StockQuantities	form	List<PartStockQuantity>	No	Stock quantities

**PartInfoResultImage** Parameters:
Name	Parameter	Data Type	Required	Description
ImageNumber	form	int	No	Image number
ImageUrl	form	string	No	Image URL

**PartStockQuantity** Parameters:
Name	Parameter	Data Type	Required	Description
LocationId	form	int	No	Location ID
LocationCode	form	string	No	Location code
StockQuantity	form	int	No	Stock quantity in location

**ShipmentResult** Parameters:
Name	Parameter	Data Type	Required	Description
ShipmentId	form	int	No	ID of the shipment.
HasBeenDispatched	form	bool	No	Determines of the shipment has been dispatched.
DispatchDate	form	DateTime?	No	Date/time of dispatch.
Articles	form	List<ShipmentArticleResult>	No	List of articles in shipment.
Packages	form	List<ShipmentPackageResult>	No	List of packages for shipment.

**ShipmentArticleResult** Parameters:
Name	Parameter	Data Type	Required	Description
OrderNumber	form	string	No	Order number.
ArticleNumber	form	string	No	Article number.
Quantity	form	int	No	Quantity.
CustomReference	form	string	No	Custom reference.

**ShipmentPackageResult** Parameters:
Name	Parameter	Data Type	Required	Description
ShipmentMethod	form	string	No	Shipment method.
TrackingNumber	form	string	No	Tracking number.
TrackingUrl	form	string	No	Tracking URL.

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /dealers/shipment/{ShipmentId} HTTP/1.1 
Host: services.acct.2service.nl 
Accept: text/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Result":{"ShipmentId":0,"HasBeenDispatched":false,"DispatchDate":"0001-01-01T00:00:00.0000000","Articles":[{"OrderNumber":"String","ArticleNumber":"String","Quantity":0,"CustomReference":"String"}],"Packages":[{"ShipmentMethod":"String","TrackingNumber":"String","TrackingUrl":"String"}]},"IsSuccessful":false,"ErrorMessage":"String"}