Sales Shipments
The SalesShipments resource allows shipments on a Sales Order to be listed and viewed. An individual shipment details can be viewed by appending its identifier (a GUID formatted as XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
) to the URI.
The full range of URIs and HTTP Verbs supported are:
Operation
HTTP Action
List of paginated SalesShipments
GET /SalesShipments/Page/{pageNumber}
View any sales shipment
GET /SalesShipments/{id}
Create a sales shipment
POST /SalesShipments
Update a sales shipment
PUT /SalesShipments/{id}
Delete a sales shipment
DELETE /SalesShipments/{id}
, DELETE /SalesShipments/Lines/{id}
GET SalesShipments
These filters can be used with the GET SalesShipments endpoint:
Filter
Description
endDate
Returns shipments created before a specified date.
modifiedSince
Returns shipments created or edited after a specified date.
orderBy
Permitted value: ShipmentNumber. Defaults to LastModifiedOn if not supplied.
orderNumber
Returns all shipments for the specified order number. If specified, it overrides all other filters.
pageSize
Specifies the page size for pagination. Default page size is 200 shipments.Note: Requesting large numbers of shipments can be susceptible to poor network performance. Please reduce the page size if you experience delayed requests.
serialBatch
False by default. If set to true then the attributes SerialNumbers and BatchNumbers are displayed.
shipmentStatus
Returns shipments for the specified status.
sort
Works in conjunction with orderBy to sort the list in ascending or descending order. Permitted values are asc (default) or desc.
startDate
Returns shipments created after a specified date.
warehouseCode
Returns sales shipments with the specified warehouse code.
Filters are used by adding the filter and value to the URI: /SalesShipments?orderStatus=Dispatched&startDate=2012-01-01&orderBy=ShipmentNumber&sort=desc
Note: Default ordering is done by LastModifiedOn descending.
Available Fields for GET SalesShipment:
Property
Type
Length
Notes
Comments
Nullable String
500
Can be edited after the sales shipment is dispatched.
CreatedBy
String
50
CreatedOn
DateTime
Customer
Customer
CustomerRef
String
500
DeliveryCity
String
500
DeliveryContact
DeliveryContact
DeliveryCountry
String
500
DeliveryInstruction
String
500
DeliveryName
String
500
DeliveryPostCode
String
50
DeliveryRegion
String
500
DeliveryStreetAddress
String
500
DeliveryStreetAddress2
String
500
DeliverySuburb
String
500
DispatchDate
Nullable DateTime
Guid
Guid
Unique identifier. Can only be set when adding a record.
Incoterm
Nullable String
3
LastModifiedBy
String
50
LastModifiedOn
Nullable DateTime
NatureOfTransactionCode
Nullable String
2
NumberOfPackages
Nullable Integer
OrderNumber
String
20
OrderGuid
Guid
ReceiverEORI
Nullable String
20
SalesShipmentLines
SalesShipmentLine
ShipmentNumber
String
25
ShipmentStatus
String
20
ShipmentWeight
Nullable Integer
ShippingCompany
Nullable ShippingCompany
Can be edited after the sales shipment is dispatched.
SupplierEORI
Nullable String
20
TotalCommercialValue
Nullable Decimal
TrackingNumber
Nullable String
50
Can be edited after the sales shipment is dispatched.
Warehouse
Warehouse
Note: Default ordering is done by SalesOrderLineNumber ascending.
Available Fields for SalesShipmentLine:
Property
Type
Length
Notes
CreatedBy
String
50
CreatedOn
DateTime
Guid
Guid
Unique identifier. Can only be set when adding a record.
LastModifiedBy
String
50
LastModifiedOn
Nullable DateTime
SalesOrderLineNumber
Integer
SalesOrderLineId
Integer
LineNumber
Integer
Line number maps to SalesOrderLineNumber
Product
Product
ShipmentQty
Decimal
UnitCost
Decimal
UnitCostAtTimeOfDispatch
Decimal
SerialNumbers
SerialNumber
BatchNumbers
BatchNumber
CommercialMonetaryValue
Nullable Decimal
Available Fields for Product:
Property
Type
Length
Notes
Guid
Guid
Unique identifier. Can only be set when adding a record.
ProductCode
String
100
ProductDescription
String
500
Examples for Response GET /SalesShipments
show xml example
<?xml version="1.0"?>
<SalesShipments xmlns:xsd= "http://www.w3.org/2001/XMLSchema" xmlns:xsi= "http://www.w3.org/2001/XMLSchema-instance" xmlns= "http://api.unleashedsoftware.com/version/1" >
<Pagination>
<NumberOfItems> 3</NumberOfItems>
<PageSize> 200</PageSize>
<PageNumber> 1</PageNumber>
<NumberOfPages> 1</NumberOfPages>
</Pagination>
<SalesShipments>
<Guid> a4ad6e8f-3f4f-472b-a8a8-cf9a4750114c</Guid>
<LastModifiedOn> 2016-10-05T03:04:02.2015467</LastModifiedOn>
<OrderNumber> SO-00000132</OrderNumber>
<OrderGuid> cae7ded2-ce11-43c4-98b8-0b8c6190061f</OrderGuid>
<ShipmentNumber> SS-00000132</ShipmentNumber>
<ShipmentStatus> Dispatched</ShipmentStatus>
<DispatchDate> 2016-10-05T00:00:00</DispatchDate>
<TrackingNumber xsi:nil= "true" />
<ShippingCompany xsi:nil= "true" />
<Comments xsi:nil= "true" />
<CreatedOn> 2016-10-05T03:04:01.9828041</CreatedOn>
<CreatedBy> support@unleashedsoftware.com</CreatedBy>
<LastModifiedBy> support@unleashedsoftware.com</LastModifiedBy>
<SalesShipmentLines>
<SalesShipmentLine>
<Guid> f3a22762-3944-4607-bba7-3b63f068fee1</Guid>
<LastModifiedOn> 2016-10-05T03:04:02.0609459</LastModifiedOn>
<LineNumber> 1</LineNumber>
<Product>
<Guid> 0ee9a600-9826-470d-aebb-1df791f0031f</Guid>
<ProductCode> COUCH2</ProductCode>
<ProductDescription> 2-Seater Couch</ProductDescription>
</Product>
<ShipmentQty> 1.0000</ShipmentQty>
<UnitCost> 8.50000000000000</UnitCost>
<UnitCostAtTimeOfDispatch> 7.50000000000000</UnitCostAtTimeOfDispatch>
<CreatedOn> 2016-10-05T03:04:02.0609459</CreatedOn>
<CreatedBy> support@unleashedsoftware.com</CreatedBy>
<LastModifiedBy> support@unleashedsoftware.com</LastModifiedBy>
<SalesOrderLineNumber> 1</SalesOrderLineNumber>
<SalesOrderLineId> 177</SalesOrderLineId>
<CommercialMonetaryValue> 1622.500</CommercialMonetaryValue>
</SalesShipmentLine>
</SalesShipmentLines>
<ReceiverEORI> 1111111</ReceiverEORI>
<ShipperEORI> 7777777</ShipperEORI>
<Incoterm> FAS</Incoterm>
<NatureOfTransactionCode> 90</NatureOfTransactionCode>
<TotalCommercialValue> 1622.50</TotalCommercialValue>
<NumberOfPackages> 20</NumberOfPackages>
<ShipmentWeight> 100</ShipmentWeight>
<DeliveryInstruction> Leave in mailbox</DeliveryInstruction>
<DeliveryName> House</DeliveryName>
<DeliveryStreetAddress> 8 Straight Lane</DeliveryStreetAddress>
<DeliveryStreetAddress2> Flat 2</DeliveryStreetAddress2>
<DeliverySuburb> Manurewa</DeliverySuburb>
<DeliveryCity> Auckland</DeliveryCity>
<DeliveryRegion> Auckland</DeliveryRegion>
<DeliveryCountry> New Zealand</DeliveryCountry>
<DeliveryPostCode> 3843</DeliveryPostCode>
<CustomerRef> Customer Ref</CustomerRef>
</SalesShipments>
<SalesShipments>
<Guid> 62e51350-5c2d-4c41-aeca-168830c2f5f3</Guid>
<LastModifiedOn> 2016-10-05T02:41:49.8993978</LastModifiedOn>
<OrderNumber> SO-00000127</OrderNumber>
<OrderGuid> c2e8b548-2465-44fa-8866-9cb0b1bf294d</OrderGuid>
<ShipmentNumber> SS-00000127</ShipmentNumber>
<ShipmentStatus> Dispatched</ShipmentStatus>
<DispatchDate> 2016-10-05T00:00:00</DispatchDate>
<TrackingNumber xsi:nil= "true" />
<ShippingCompany xsi:nil= "true" />
<Comments xsi:nil= "true" />
<CreatedOn> 2016-10-05T02:41:49.5400232</CreatedOn>
<CreatedBy> support@unleashedsoftware.com</CreatedBy>
<LastModifiedBy> support@unleashedsoftware.com</LastModifiedBy>
<SalesShipmentLines>
<SalesShipmentLine>
<Guid> 1ae9d2bf-993f-4795-99b9-1e9bf2bbcf5c</Guid>
<LastModifiedOn> 2016-10-05T02:41:49.6806286</LastModifiedOn>
<LineNumber> 1</LineNumber>
<Product>
<Guid> 06e6484a-8a5a-4a53-ae0a-c9b59c9e5efb</Guid>
<ProductCode> GLUE</ProductCode>
<ProductDescription> Furniture Assembly Glue</ProductDescription>
</Product>
<ShipmentQty> 4.0000</ShipmentQty>
<UnitCost> 9.99000000000000</UnitCost>
<UnitCostAtTimeOfDispatch> 8.99000000000000</UnitCostAtTimeOfDispatch>
<CreatedOn> 2016-10-05T02:41:49.6806286</CreatedOn>
<CreatedBy> support@unleashedsoftware.com</CreatedBy>
<LastModifiedBy> support@unleashedsoftware.com</LastModifiedBy>
<SalesOrderLineNumber> 1</SalesOrderLineNumber>
<SalesOrderLineId> 171</SalesOrderLineId>
<CommercialMonetaryValue> 1622.500</CommercialMonetaryValue>
</SalesShipmentLine>
<SalesShipmentLine>
<Guid> 829177d1-6a96-4de3-9f68-d567499ea34e</Guid>
<LastModifiedOn> 2016-10-05T02:41:49.6806286</LastModifiedOn>
<LineNumber> 2</LineNumber>
<Product>
<Guid> 43838c91-1991-4359-a79c-853ecc619903</Guid>
<ProductCode> DINING</ProductCode>
<ProductDescription> Dining Table</ProductDescription>
</Product>
<ShipmentQty> 4.0000</ShipmentQty>
<UnitCost> 40.42938410596026</UnitCost>
<UnitCostAtTimeOfDispatch> 35.42938410596026</UnitCostAtTimeOfDispatch>
<CreatedOn> 2016-10-05T02:41:49.6806286</CreatedOn>
<CreatedBy> support@unleashedsoftware.com</CreatedBy>
<LastModifiedBy> support@unleashedsoftware.com</LastModifiedBy>
<SalesOrderLineNumber> 2</SalesOrderLineNumber>
<SalesOrderLineId> 172</SalesOrderLineId>
<CommercialMonetaryValue> 1622.500</CommercialMonetaryValue>
</SalesShipmentLine>
</SalesShipmentLines>
<ReceiverEORI> 1111111</ReceiverEORI>
<ShipperEORI> 7777777</ShipperEORI>
<Incoterm> FAS</Incoterm>
<NatureOfTransactionCode> 90</NatureOfTransactionCode>
<TotalCommercialValue> 1622.50</TotalCommercialValue>
<NumberOfPackages> 20</NumberOfPackages>
<ShipmentWeight> 100</ShipmentWeight>
</SalesShipments>
<SalesShipments>
<Guid> abc99d38-ac78-4fb6-846c-ea928bfa43d7</Guid>
<LastModifiedOn> 2016-10-05T01:59:54.3529136</LastModifiedOn>
<OrderNumber> 4</OrderNumber>
<OrderGuid> 1ae9d2bf-993f-4795-99b9-1e9bf2bbcf5c</OrderGuid>
<ShipmentNumber> SS-4</ShipmentNumber>
<ShipmentStatus> Dispatched</ShipmentStatus>
<DispatchDate> 2016-10-05T00:00:00</DispatchDate>
<TrackingNumber xsi:nil= "true" />
<ShippingCompany xsi:nil= "true" />
<Comments xsi:nil= "true" />
<CreatedOn> 2016-10-05T01:59:54.1654329</CreatedOn>
<CreatedBy> support@unleashedsoftware.com</CreatedBy>
<LastModifiedBy> support@unleashedsoftware.com</LastModifiedBy>
<SalesShipmentLines>
<SalesShipmentLine>
<Guid> 59c3da4a-dcc0-49e6-8b02-d8bf61e9b7e7</Guid>
<LastModifiedOn> 2016-10-05T01:59:54.2435449</LastModifiedOn>
<LineNumber> 1</LineNumber>
<Product>
<Guid> 85e7a3be-cc79-4227-973f-67cd513ab087</Guid>
<ProductCode> SIDE</ProductCode>
<ProductDescription> Bookshelf Side</ProductDescription>
</Product>
<ShipmentQty> 1.0000</ShipmentQty>
<UnitCost> 804.39020512820513</UnitCost>
<UnitCostAtTimeOfDispatch> 802.49020512820513</UnitCostAtTimeOfDispatch>
<CreatedOn> 2016-10-05T01:59:54.2435449</CreatedOn>
<CreatedBy> support@unleashedsoftware.com</CreatedBy>
<LastModifiedBy> support@unleashedsoftware.com</LastModifiedBy>
<SalesOrderLineNumber> 1</SalesOrderLineNumber>
<SalesOrderLineId> 168</SalesOrderLineId>
<CommercialMonetaryValue> 1622.500</CommercialMonetaryValue>
</SalesShipmentLine>
</SalesShipmentLines>
<ReceiverEORI> 1111111</ReceiverEORI>
<ShipperEORI> 7777777</ShipperEORI>
<Incoterm> FAS</Incoterm>
<NatureOfTransactionCode> 90</NatureOfTransactionCode>
<TotalCommercialValue> 1622.50</TotalCommercialValue>
<NumberOfPackages> 20</NumberOfPackages>
<ShipmentWeight> 100</ShipmentWeight>
</SalesShipments>
</SalesShipments>
show json example
{
"Pagination" : {
"NumberOfItems" : 3 ,
"PageSize" : 200 ,
"PageNumber" : 1 ,
"NumberOfPages" : 1
},
"Items" : [
{
"OrderNumber" : "SO-00000132" ,
"OrderGuid" : "cae7ded2-ce11-43c4-98b8-0b8c6190061f" ,
"ShipmentNumber" : "SS-00000132" ,
"ShipmentStatus" : "Dispatched" ,
"DispatchDate" : "/Date(1475625600000)/" ,
"TrackingNumber" : null ,
"ShippingCompany" : null ,
"Comments" : null ,
"CreatedOn" : "/Date(1475636641982)/" ,
"CreatedBy" : "support@unleashedsoftware.com" ,
"LastModifiedBy" : "support@unleashedsoftware.com" ,
"SalesShipmentLines" : [
{
"LineNumber" : 1 ,
"Product" : {
"Guid" : "0ee9a600-9826-470d-aebb-1df791f0031f" ,
"ProductCode" : "COUCH2" ,
"ProductDescription" : "2-Seater Couch"
},
"ShipmentQty" : 1 ,
"UnitCost" : 8.5 ,
"UnitCostAtTimeOfDispatch" : 7.5 ,
"CreatedOn" : "/Date(1475636642060)/" ,
"CreatedBy" : "support@unleashedsoftware.com" ,
"LastModifiedBy" : "support@unleashedsoftware.com" ,
"SalesOrderLineNumber" : 1 ,
"SalesOrderLineId" : 177 ,
"SerialNumbers" : null ,
"BatchNumbers" : null ,
"CommercialMonetaryValue" : 1622.500 ,
"Guid" : "f3a22762-3944-4607-bba7-3b63f068fee1" ,
"LastModifiedOn" : "/Date(1475636642060)/"
}
],
"ReceiverEORI" : "1111111" ,
"ShipperEORI" : "7777777" ,
"Incoterm" : "FAS" ,
"NatureOfTransactionCode" : "90" ,
"TotalCommercialValue" : 1622.50 ,
"NumberOfPackages" : 20 ,
"ShipmentWeight" : "100" ,
"DeliveryInstruction" : "Leave in mailbox" ,
"DeliveryName" : "House" ,
"DeliveryStreetAddress" : "9 Straight Lane" ,
"DeliveryStreetAddress2" : "Flat 2" ,
"DeliverySuburb" : "Manurewa" ,
"DeliveryCity" : "Auckland" ,
"DeliveryRegion" : "Auckland" ,
"DeliveryCountry" : "New Zealand" ,
"DeliveryPostCode" : "3290" ,
"CustomerRef" : "Customer Ref" ,
"Guid" : "a4ad6e8f-3f4f-472b-a8a8-cf9a4750114c" ,
"LastModifiedOn" : "/Date(1475636642201)/"
},
{
"OrderNumber" : "SO-00000127" ,
"OrderGuid" : "c2e8b548-2465-44fa-8866-9cb0b1bf294d" ,
"ShipmentNumber" : "SS-00000127" ,
"ShipmentStatus" : "Dispatched" ,
"DispatchDate" : "/Date(1475625600000)/" ,
"TrackingNumber" : null ,
"ShippingCompany" : null ,
"Comments" : null ,
"CreatedOn" : "/Date(1475635309540)/" ,
"CreatedBy" : "support@unleashedsoftware.com" ,
"LastModifiedBy" : "support@unleashedsoftware.com" ,
"SalesShipmentLines" : [
{
"LineNumber" : 1 ,
"Product" : {
"Guid" : "06e6484a-8a5a-4a53-ae0a-c9b59c9e5efb" ,
"ProductCode" : "GLUE" ,
"ProductDescription" : "Furniture Assembly Glue"
},
"ShipmentQty" : 4 ,
"UnitCost" : 9.99 ,
"UnitCostAtTimeOfDispatch" : 8.99 ,
"CreatedOn" : "/Date(1475635309680)/" ,
"CreatedBy" : "support@unleashedsoftware.com" ,
"LastModifiedBy" : "support@unleashedsoftware.com" ,
"SalesOrderLineNumber" : 1 ,
"SalesOrderLineId" : 171 ,
"SerialNumbers" : null ,
"BatchNumbers" : null ,
"CommercialMonetaryValue" : 1622.500 ,
"Guid" : "1ae9d2bf-993f-4795-99b9-1e9bf2bbcf5c" ,
"LastModifiedOn" : "/Date(1475635309680)/"
},
{
"LineNumber" : 2 ,
"Product" : {
"Guid" : "43838c91-1991-4359-a79c-853ecc619903" ,
"ProductCode" : "DINING" ,
"ProductDescription" : " Dining Table"
},
"ShipmentQty" : 4 ,
"UnitCost" : 40.42938410596026 ,
"UnitCostAtTimeOfDispatch" : 35.42938410596026 ,
"CreatedOn" : "/Date(1475635309680)/" ,
"CreatedBy" : "support@unleashedsoftware.com" ,
"LastModifiedBy" : "support@unleashedsoftware.com" ,
"SalesOrderLineNumber" : 2 ,
"SalesOrderLineId" : 172 ,
"SerialNumbers" : null ,
"BatchNumbers" : null ,
"CommercialMonetaryValue" : 1622.500 ,
"Guid" : "829177d1-6a96-4de3-9f68-d567499ea34e" ,
"LastModifiedOn" : "/Date(1475635309680)/"
}
],
"ReceiverEORI" : "1111111" ,
"ShipperEORI" : "7777777" ,
"Incoterm" : "FAS" ,
"NatureOfTransactionCode" : "90" ,
"TotalCommercialValue" : 1622.50 ,
"NumberOfPackages" : 20 ,
"ShipmentWeight" : "100" ,
"Guid" : "62e51350-5c2d-4c41-aeca-168830c2f5f3" ,
"LastModifiedOn" : "/Date(1475635309899)/"
},
{
"OrderNumber" : "4" ,
"OrderGuid" : "1ae9d2bf-993f-4795-99b9-1e9bf2bbcf5c" ,
"ShipmentNumber" : "SS-4" ,
"ShipmentStatus" : "Dispatched" ,
"DispatchDate" : "/Date(1475625600000)/" ,
"TrackingNumber" : null ,
"ShippingCompany" : null ,
"Comments" : null ,
"CreatedOn" : "/Date(1475632794165)/" ,
"CreatedBy" : "support@unleashedsoftware.com" ,
"LastModifiedBy" : "support@unleashedsoftware.com" ,
"SalesShipmentLines" : [
{
"LineNumber" : 1 ,
"Product" : {
"Guid" : "85e7a3be-cc79-4227-973f-67cd513ab087" ,
"ProductCode" : "SIDE" ,
"ProductDescription" : "Bookshelf Side"
},
"ShipmentQty" : 1 ,
"UnitCost" : 804.39020512820513 ,
"UnitCostAtTimeOfDispatch" : 803.49020512820513 ,
"CreatedOn" : "/Date(1475632794243)/" ,
"CreatedBy" : "support@unleashedsoftware.com" ,
"LastModifiedBy" : "support@unleashedsoftware.com" ,
"SalesOrderLineNumber" : 1 ,
"SalesOrderLineId" : 168 ,
"SerialNumbers" : null ,
"BatchNumbers" : null ,
"CommercialMonetaryValue" : 1622.500 ,
"Guid" : "59c3da4a-dcc0-49e6-8b02-d8bf61e9b7e7" ,
"LastModifiedOn" : "/Date(1475632794243)/"
}
],
"ReceiverEORI" : "1111111" ,
"ShipperEORI" : "7777777" ,
"Incoterm" : "FAS" ,
"NatureOfTransactionCode" : "90" ,
"TotalCommercialValue" : 1622.50 ,
"NumberOfPackages" : 20 ,
"ShipmentWeight" : "100" ,
"Guid" : "abc99d38-ac78-4fb6-846c-ea928bfa43d7" ,
"LastModifiedOn" : "/Date(1475632794352)/"
}
]
}
POST / PUT SalesShipments
These filters can be used with the POST / PUT SalesShipments endpoint:
Filter
Description
serialBatch
If set to true: For a POST request, the serial and batch numbers are assigned provided they are already assigned to the Sales Order. For a PUT request, the serial and batch numbers are assigned regardless of whether they are assigned on the Sales Order.
Available Fields for POST SalesShipments:
Property
Type
Length
Required
Notes
Guid
Guid
Yes
Unique identifier. Can only be set when adding a record.
OrderNumber
String
20
Yes
ShipmentStatus
String
20
Yes
DispatchDate
Nullable DateTime
yyyy-mm-dd
No
ShippingCompany
Nullable ShippingCompany
No
TrackingNumber
Nullable String
50
No
Comments
Nullable String
500
No
SalesShipmentLines
SalesShipmentLine
Yes
At least one shipment line is required.
Available Fields for ShippingCompany:
Property
Type
Length
Required
Notes
Guid
Guid
Required when Name is not provided
Name
String
Required when Guid is not provided
Available Fields for POST/PUT SalesShipmentLine:
Property
Type
Length
Required
Notes
Product
Product
Yes
SerialNumbers
SerialNumber
If the serialBatch filter value is set to true: For POST, the serial numbers must match those assigned to the Sales Order. For PUT, the serial numbers provided must be valid and will be assigned to the shipment regardless of any serial numbers assigned to the Sales Order.
BatchNumbers
BatchNumber
If the serialBatch filter value is set to true: For POST, the batch numbers must match those assigned to the Sales Order. For PUT, the batch numbers provided must be valid and will be assigned to the shipment regardless of any batch numbers assigned to the Sales Order.
ShipmentQty
Decimal
Yes
Guid
Guid
No
On Creation, the value will be ignored. On Update, If the Guid is set, it will try to update the existing lines instead of recreating them.
SalesOrderLineNumber
Integer
No
Sales Order line mapping. If the sales order line is specified, it will validate if the product for shipment line is the same as the product of the sales order line.
Available Fields for Product:
Property
Type
Length
Required
Notes
Guid
Guid
No
Unique identifier. Can only be set when adding a record.
ProductCode
String
100
Yes
Available fields for PUT SalesShipments:
Property
Type
Length
Required
Notes
Guid
Guid
Yes
Must be supplied for PUT to identify the Sales Shipment to update.
ShipmentStatus
String
20
Required when order management is enabled.
DispatchDate
Nullable DateTime
yyyy-mm-dd
No
ShippingCompany
Nullable ShippingCompany
No
TrackingNumber
Nullable String
50
No
Comments
Nullable String
500
No
SalesShipmentLines
SalesShipmentLine
Yes
Available fields for ShippingCompany:
Property
Type
Length
Required
Notes
Guid
Guid
Required when Name is not specified.
Name
String
Required when Guid is not specified.
Examples for Request POST / PUT /SalesShipments
show xml example
<?xml version="1.0"?>
<SalesOrderShipment xmlns:xsd= "http://www.w3.org/2001/XMLSchema" xmlns:xsi= "http://www.w3.org/2001/XMLSchema-instance" xmlns= "http://api.unleashedsoftware.com/version/1" >
<Guid> 62e51350-5c2d-4c41-aeca-168830c2f5f3</Guid>
<OrderNumber> SO-00000127</OrderNumber>
<OrderGuid> c2e8b548-2465-44fa-8866-9cb0b1bf294d</OrderGuid>
<ShipmentNumber> SS-00000127</ShipmentNumber>
<ShipmentStatus> Dispatched</ShipmentStatus>
<TrackingNumber xsi:nil= "true" />
<ShippingCompany xsi:nil= "true" />
<Comments xsi:nil= "true" />
<SalesShipmentLines>
<SalesShipmentLine>
<Guid> 1ae9d2bf-993f-4795-99b9-1e9bf2bbcf5c</Guid>
<Product>
<Guid> 06e6484a-8a5a-4a53-ae0a-c9b59c9e5efb</Guid>
<ProductCode> GLUE</ProductCode>
<ProductDescription> Furniture Assembly Glue</ProductDescription>
</Product>
<ShipmentQty> 4.0000</ShipmentQty>
<SalesOrderLineNumber> 1</SalesOrderLineNumber>
<BatchNumbers>
<Batch>
<Guid> 6a323b83-88ed-4132-8cc0-8dbe6579f5a0</Guid>
<BatchNumber> mgp513</BatchNumber>
<Quantity> 4.0000</Quantity>
</Batch>
</BatchNumbers>
</SalesShipmentLine>
<SalesShipmentLine>
<Guid> 829177d1-6a96-4de3-9f68-d567499ea34e</Guid>
<Product>
<Guid> 43838c91-1991-4359-a79c-853ecc619903</Guid>
<ProductCode> DINING</ProductCode>
<ProductDescription> Dining Table</ProductDescription>
</Product>
<ShipmentQty> 4.0000</ShipmentQty>
<UnitCost> 40.42938410596026</UnitCost>
<SalesOrderLineNumber> 2</SalesOrderLineNumber>
<SerialNumbers>
<Serial>
<Guid> 72ade275-4d16-4aa1-8fca-71bfef7772c2</Guid>
<SerialNumber> AA0016650</SerialNumber>
</Serial>
<Serial>
<Guid> 4dde9082-5415-4c0b-9c80-678625fa9135</Guid>
<SerialNumber> AA0016651</SerialNumber>
</Serial>
<Serial>
<Guid> 77551442-0b23-4024-8168-0b0da00e1ca7</Guid>
<SerialNumber> AA0016652</SerialNumber>
</Serial>
<Serial>
<Guid> 51df07be-9df3-452c-8903-147cc045ef27</Guid>
<SerialNumber> AA0016653</SerialNumber>
</Serial>
</SerialNumbers>
</SalesShipmentLine>
</SalesShipmentLines>
</SalesOrderShipment>
show json example
{
"OrderNumber" : "SO-00000127" ,
"OrderGuid" : "c2e8b548-2465-44fa-8866-9cb0b1bf294d" ,
"ShipmentNumber" : "SS-00000127" ,
"ShipmentStatus" : "Dispatched" ,
"TrackingNumber" : null ,
"ShippingCompany" : null ,
"Comments" : null ,
"SalesShipmentLines" : [
{
"Product" : {
"Guid" : "06e6484a-8a5a-4a53-ae0a-c9b59c9e5efb" ,
"ProductCode" : "GLUE" ,
"ProductDescription" : "Furniture Assembly Glue"
},
"ShipmentQty" : 4 ,
"SalesOrderLineNumber" : 1 ,
"SerialNumbers" : null ,
"BatchNumbers" : [
{
"Number" : "mgp513" ,
"Quantity" : 4 ,
"Guid" : "6a323b83-88ed-4132-8cc0-8dbe6579f5a0" ,
}
],
"Guid" : "1ae9d2bf-993f-4795-99b9-1e9bf2bbcf5c" ,
},
{
"Product" : {
"Guid" : "43838c91-1991-4359-a79c-853ecc619903" ,
"ProductCode" : "DINING" ,
"ProductDescription" : " Dining Table"
},
"ShipmentQty" : 4 ,
"SalesOrderLineNumber" : 2 ,
"SerialNumbers" : [
{
"Identifier" : "AA0016650" ,
"Guid" : "72ade275-4d16-4aa1-8fca-71bfef7772c2" ,
},
{
"Identifier" : "AA0016651" ,
"Guid" : "4dde9082-5415-4c0b-9c80-678625fa9135" ,
},
{
"Identifier" : "AA0016652" ,
"Guid" : "77551442-0b23-4024-8168-0b0da00e1ca7" ,
},
{
"Identifier" : "AA0016653" ,
"Guid" : "51df07be-9df3-452c-8903-147cc045ef27" ,
}
],
"BatchNumbers" : null ,
"Guid" : "829177d1-6a96-4de3-9f68-d567499ea34e" ,
}
],
"Guid" : "62e51350-5c2d-4c41-aeca-168830c2f5f3" ,
}
Examples for Response POST / PUT /SalesShipments
show xml example
<?xml version="1.0"?>
<SalesOrderShipment xmlns:xsd= "http://www.w3.org/2001/XMLSchema" xmlns:xsi= "http://www.w3.org/2001/XMLSchema-instance" xmlns= "http://api.unleashedsoftware.com/version/1" >
<Guid> 62e51350-5c2d-4c41-aeca-168830c2f5f3</Guid>
<LastModifiedOn> 2016-10-05T02:41:49.8993978</LastModifiedOn>
<OrderNumber> SO-00000127</OrderNumber>
<OrderGuid> c2e8b548-2465-44fa-8866-9cb0b1bf294d</OrderGuid>
<ShipmentNumber> SS-00000127</ShipmentNumber>
<ShipmentStatus> Dispatched</ShipmentStatus>
<DispatchDate> 2016-10-05T00:00:00</DispatchDate>
<TrackingNumber xsi:nil= "true" />
<ShippingCompany xsi:nil= "true" />
<Comments xsi:nil= "true" />
<CreatedOn> 2016-10-05T02:41:49.5400232</CreatedOn>
<CreatedBy> support@unleashedsoftware.com</CreatedBy>
<LastModifiedBy> support@unleashedsoftware.com</LastModifiedBy>
<SalesShipmentLines>
<SalesShipmentLine>
<Guid> 1ae9d2bf-993f-4795-99b9-1e9bf2bbcf5c</Guid>
<LastModifiedOn> 2016-10-05T02:41:49.6806286</LastModifiedOn>
<LineNumber> 1</LineNumber>
<Product>
<Guid> 06e6484a-8a5a-4a53-ae0a-c9b59c9e5efb</Guid>
<ProductCode> GLUE</ProductCode>
<ProductDescription> Furniture Assembly Glue</ProductDescription>
</Product>
<ShipmentQty> 4.0000</ShipmentQty>
<UnitCost> 9.99000000000000</UnitCost>
<CreatedOn> 2016-10-05T02:41:49.6806286</CreatedOn>
<CreatedBy> support@unleashedsoftware.com</CreatedBy>
<LastModifiedBy> support@unleashedsoftware.com</LastModifiedBy>
<SalesOrderLineNumber> 1</SalesOrderLineNumber>
<SalesOrderLineId> 171</SalesOrderLineId>
<CommercialMonetaryValue> 1622.500</CommercialMonetaryValue>
<BatchNumbers>
<Batch>
<Guid> 6a323b83-88ed-4132-8cc0-8dbe6579f5a0</Guid>
<LastModifiedOn> 2016-10-05T02:41:49.8993978</LastModifiedOn>
<BatchNumber> mgp513</BatchNumber>
<Quantity> 4.0000</Quantity>
<ExpiryDate xsi:nil= "true" />
</Batch>
</BatchNumbers>
</SalesShipmentLine>
<SalesShipmentLine>
<Guid> 829177d1-6a96-4de3-9f68-d567499ea34e</Guid>
<LastModifiedOn> 2016-10-05T02:41:49.6806286</LastModifiedOn>
<LineNumber> 2</LineNumber>
<Product>
<Guid> 43838c91-1991-4359-a79c-853ecc619903</Guid>
<ProductCode> DINING</ProductCode>
<ProductDescription> Dining Table</ProductDescription>
</Product>
<ShipmentQty> 4.0000</ShipmentQty>
<UnitCost> 40.42938410596026</UnitCost>
<CreatedOn> 2016-10-05T02:41:49.6806286</CreatedOn>
<CreatedBy> support@unleashedsoftware.com</CreatedBy>
<LastModifiedBy> support@unleashedsoftware.com</LastModifiedBy>
<SalesOrderLineNumber> 2</SalesOrderLineNumber>
<SalesOrderLineId> 172</SalesOrderLineId>
<CommercialMonetaryValue> 1622.500</CommercialMonetaryValue>
<SerialNumbers>
<Serial>
<Guid> 72ade275-4d16-4aa1-8fca-71bfef7772c2</Guid>
<LastModifiedOn> 2016-10-05T02:41:49.821276</LastModifiedOn>
<SerialNumber> AA0016650</SerialNumber>
</Serial>
<Serial>
<Guid> 4dde9082-5415-4c0b-9c80-678625fa9135</Guid>
<LastModifiedOn> 2016-10-05T02:41:49.821276</LastModifiedOn>
<SerialNumber> AA0016651</SerialNumber>
</Serial>
<Serial>
<Guid> 77551442-0b23-4024-8168-0b0da00e1ca7</Guid>
<LastModifiedOn> 2016-10-05T02:41:49.8368903</LastModifiedOn>
<SerialNumber> AA0016652</SerialNumber>
</Serial>
<Serial>
<Guid> 51df07be-9df3-452c-8903-147cc045ef27</Guid>
<LastModifiedOn> 2016-10-05T02:41:49.8368903</LastModifiedOn>
<SerialNumber> AA0016653</SerialNumber>
</Serial>
</SerialNumbers>
</SalesShipmentLine>
</SalesShipmentLines>
<ReceiverEORI> 1111111</ReceiverEORI>
<ShipperEORI> 7777777</ShipperEORI>
<Incoterm> FAS</Incoterm>
<NatureOfTransactionCode> 90</NatureOfTransactionCode>
<TotalCommercialValue> 1622.50</TotalCommercialValue>
<NumberOfPackages> 20</NumberOfPackages>
<ShipmentWeight> 100</ShipmentWeight>
</SalesOrderShipment>
show json example
{
"OrderNumber" : "SO-00000127" ,
"OrderGuid" : "c2e8b548-2465-44fa-8866-9cb0b1bf294d" ,
"ShipmentNumber" : "SS-00000127" ,
"ShipmentStatus" : "Dispatched" ,
"DispatchDate" : "/Date(1475625600000)/" ,
"TrackingNumber" : null ,
"ShippingCompany" : null ,
"Comments" : null ,
"CreatedOn" : "/Date(1475635309540)/" ,
"CreatedBy" : "support@unleashedsoftware.com" ,
"LastModifiedBy" : "support@unleashedsoftware.com" ,
"SalesShipmentLines" : [
{
"LineNumber" : 1 ,
"Product" : {
"Guid" : "06e6484a-8a5a-4a53-ae0a-c9b59c9e5efb" ,
"ProductCode" : "GLUE" ,
"ProductDescription" : "Furniture Assembly Glue"
},
"ShipmentQty" : 4 ,
"UnitCost" : 9.99 ,
"CreatedOn" : "/Date(1475635309680)/" ,
"CreatedBy" : "support@unleashedsoftware.com" ,
"LastModifiedBy" : "support@unleashedsoftware.com" ,
"SalesOrderLineNumber" : 1 ,
"SalesOrderLineId" : 171 ,
"SerialNumbers" : null ,
"BatchNumbers" : [
{
"Number" : "mgp513" ,
"Quantity" : 4 ,
"ExpiryDate" : null ,
"Guid" : "6a323b83-88ed-4132-8cc0-8dbe6579f5a0" ,
"LastModifiedOn" : "/Date(1475635309899)/"
}
],
"CommercialMonetaryValue" : 1622.500 ,
"Guid" : "1ae9d2bf-993f-4795-99b9-1e9bf2bbcf5c" ,
"LastModifiedOn" : "/Date(1475635309680)/"
},
{
"LineNumber" : 2 ,
"Product" : {
"Guid" : "43838c91-1991-4359-a79c-853ecc619903" ,
"ProductCode" : "DINING" ,
"ProductDescription" : " Dining Table"
},
"ShipmentQty" : 4 ,
"UnitCost" : 40.42938410596026 ,
"CreatedOn" : "/Date(1475635309680)/" ,
"CreatedBy" : "support@unleashedsoftware.com" ,
"LastModifiedBy" : "support@unleashedsoftware.com" ,
"SalesOrderLineNumber" : 2 ,
"SalesOrderLineId" : 172 ,
"SerialNumbers" : [
{
"Identifier" : "AA0016650" ,
"Guid" : "72ade275-4d16-4aa1-8fca-71bfef7772c2" ,
"LastModifiedOn" : "/Date(1475635309821)/"
},
{
"Identifier" : "AA0016651" ,
"Guid" : "4dde9082-5415-4c0b-9c80-678625fa9135" ,
"LastModifiedOn" : "/Date(1475635309821)/"
},
{
"Identifier" : "AA0016652" ,
"Guid" : "77551442-0b23-4024-8168-0b0da00e1ca7" ,
"LastModifiedOn" : "/Date(1475635309836)/"
},
{
"Identifier" : "AA0016653" ,
"Guid" : "51df07be-9df3-452c-8903-147cc045ef27" ,
"LastModifiedOn" : "/Date(1475635309836)/"
}
],
"BatchNumbers" : null ,
"CommercialMonetaryValue" : 1622.500 ,
"Guid" : "829177d1-6a96-4de3-9f68-d567499ea34e" ,
"LastModifiedOn" : "/Date(1475635309680)/"
}
],
"ReceiverEORI" : "1111111" ,
"ShipperEORI" : "7777777" ,
"Incoterm" : "FAS" ,
"NatureOfTransactionCode" : "90" ,
"TotalCommercialValue" : 1622.50 ,
"NumberOfPackages" : 20 ,
"ShipmentWeight" : "100" ,
"Guid" : "62e51350-5c2d-4c41-aeca-168830c2f5f3" ,
"LastModifiedOn" : "/Date(1475635309899)/"
}
DELETE SalesShipments
Examples for Response DELETE /SalesShipments/{id}
show xml example
<SalesOrderShipment xmlns= "http://api.unleashedsoftware.com/version/1" >
<Guid> ec583db9-25e5-4616-8d17-2d88ecaef605</Guid>
<LastModifiedOn> 2015-12-08T21:47:28.032953</LastModifiedOn>
<OrderNumber> 100000014</OrderNumber>
<OrderGuid> 62e51350-5c2d-4c41-aeca-168830c2f5f3</OrderGuid>
<ShipmentNumber> SS-100000014</ShipmentNumber>
<ShipmentStatus> Deleted</ShipmentStatus>
<DispatchDate> 2015-12-09T00:00:00</DispatchDate>
<TrackingNumber> NZ123456789</TrackingNumber>
<ShippingCompany> NZCourier</ShippingCompany>
<Comments></Comments>
<CreatedOn> 8/12/2015 9:47:25 p.m.</CreatedOn>
<CreatedBy> support@unleashedsoftware.com</CreatedBy>
<LastModifiedBy> support@unleashedsoftware.com</LastModifiedBy>
<SalesShipmentLines>
<SalesShipmentLine>
<Guid> 43c071a4-40b8-462d-a8c7-36883c000644</Guid>
<LastModifiedOn> 0001-01-01T00:00:00</LastModifiedOn>
<LineNumber> 1</LineNumber>
<Product>
<Guid> 5d6446af-a4c1-472b-8ff3-7e869bbe785c</Guid>
<ProductCode> ANIMAL</ProductCode>
</Product>
<ShipmentQty> 1.0000</ShipmentQty>
<UnitCost> 7.897</UnitCost>
<CreatedOn> 1/01/0001 12:00:00 a.m.</CreatedOn>
</SalesShipmentLine>
<SalesShipmentLine>
<Guid> 13c071a4-40b8-462d-a8c7-36883c000644</Guid>
<LastModifiedOn> 0001-01-01T00:00:00</LastModifiedOn>
<LineNumber> 2</LineNumber>
<Product>
<Guid> 5d6446af-a4c1-472b-8ff3-7e869bbe785c</Guid>
<ProductCode> ANIMAL</ProductCode>
</Product>
<ShipmentQty> 2.0000</ShipmentQty>
<UnitCost> 7.897</UnitCost>
<CreatedOn> 1/01/0001 12:00:00 a.m.</CreatedOn>
</SalesShipmentLine>
</SalesShipmentLines>
</SalesOrderShipment>
show json example
{
"Guid" : "ec583db9-25e5-4616-8d17-2d88ecaef605" ,
"LastModifiedOn" : "/Date(1449611248032)/" ,
"OrderNumber" : "100000014" ,
"OrderGuid" : "62e51350-5c2d-4c41-aeca-168830c2f5f3" ,
"ShipmentNumber" : "SS-100000014" ,
"ShipmentStatus" : "Deleted" ,
"DispatchDate" : "/Date(1449619200000)/" ,
"TrackingNumber" : null ,
"ShippingCompany" : "NZCourier" ,
"Comments" : null ,
"CreatedOn" : "8/12/2015 9:47:25 p.m." ,
"CreatedBy" : "support@unleashedsoftware.com" ,
"LastModifiedBy" : "support@unleashedsoftware.com" ,
"SalesShipmentLines" : [
{
"LineNumber" : 1 ,
"Product" : {
"Guid" : "5d6446af-a4c1-472b-8ff3-7e869bbe785c" ,
"ProductCode" : "aaaa"
},
"ShipmentQty" : 1 ,
"UnitCost" : 7.897 ,
"CreatedOn" : "1/01/0001 12:00:00 a.m." ,
"CreatedBy" : null ,
"LastModifiedBy" : null ,
"Guid" : "43c071a4-40b8-462d-a8c7-36883c000644" ,
"LastModifiedOn" : "/Date(-62135596800000)/"
},
{
"LineNumber" : 2 ,
"Product" : {
"Guid" : "5d6446af-a4c1-472b-8ff3-7e869bbe785c" ,
"ProductCode" : "aaaa"
},
"ShipmentQty" : 2 ,
"UnitCost" : 7.897 ,
"CreatedOn" : "1/01/0001 12:00:00 a.m." ,
"CreatedBy" : null ,
"LastModifiedBy" : null ,
"Guid" : "13c071a4-40b8-462d-a8c7-36883c000644" ,
"LastModifiedOn" : "/Date(-62135596800000)/"
}
]
}