GET drop-shipments/{dropShipmentID}

Returns information about the Drop Shipment with the given Drop Shipment ID

Request Information

URI Parameters

NameDescriptionTypeAdditional information
dropShipmentID integer Required

Body Parameters

None.

Response Information

Resource Description

Returns information about the Drop Shipment with the given Drop Shipment ID

DropShipmentModel
NameDescriptionTypeAdditional information
DropShipmentID ID of the Drop Shipment integer None.
DropShipmentGuid Unique GUID of the Drop Shipment globally unique identifier None.
DropShipmentReference StoreFeeder user facing reference number for the Drop Shipment string None.
DropShipmentStatus Status of the Drop Shipment DropShipmentStatuses None.
RaisedByUser User who raised the Drop Shipment UserBaseModel None.
Supplier Supplier that the Drop Shipment is for DropShipmentSupplierModel None.
DateRaised Date the Drop Shipment was originally raised date None.
DateSent The Date the Drop Shipment was sent to the Supplier date None.
DeliveryCost Delivery charge for the Drop Shipment decimal number None.
Currency Currency that the Drop Shipment is created in CurrencyBaseModel None.
ShippingAddress This is the Shipping Address for the Drop Shipment AddressModel None.
SupplierAddress This is the Supplier Address for the Drop Shipment AddressModel None.
Order Basic information about the Order OrderBaseModel None.
DropShipmentOrderLines List of Order Lines contained in the Drop Shipment. Collection of DropShipmentLineModel None.

Response Formats

application/json, text/json

Sample: 
{
  "DropShipmentID": 123,
  "DropShipmentGuid": "8dd1dd07-438e-41b6-9621-9ad36159d08c",
  "DropShipmentReference": "123_abc",
  "DropShipmentStatus": "SentToSupplier",
  "RaisedByUser": {
    "UserID": 1,
    "UserName": "Example User"
  },
  "Supplier": {
    "SupplierCode": "Sup1",
    "SupplierID": 1,
    "Name": "Supplier 1"
  },
  "DateRaised": "2024-11-21T08:01:49.2524901Z",
  "DateSent": "2024-11-21T08:21:49.2524901Z",
  "DeliveryCost": 5.99,
  "Currency": {
    "CurrencyID": 4,
    "CurrencyCode": "GBP",
    "CurrencyName": "British Pound",
    "Symbol": "£"
  },
  "ShippingAddress": {
    "FirstName": "John",
    "LastName": "Smith",
    "Company": "Company name",
    "Address1": "the cottage",
    "Address2": "1 street name",
    "City": "City",
    "State": "State",
    "Postcode": "NG7 2RR",
    "Country": "United Kingdom"
  },
  "SupplierAddress": {
    "Company": "Company name",
    "Address1": "the cottage",
    "Address2": "1 street name",
    "City": "City",
    "State": "State",
    "Postcode": "NG7 2RR",
    "Country": "United Kingdom"
  },
  "Order": {
    "OrderNumber": 123456,
    "OrderGuid": "d30b052d-9e40-49b6-8183-18ee764a8b56",
    "OrderStatus": "Draft",
    "OrderTotals": {
      "Subtotal": 8.33,
      "Tax": 1.66,
      "ShippingCost": 1.99,
      "Discount": 0.0,
      "Total": 11.98,
      "ShippingNet": 0.0,
      "ShippingTax": 0.0
    },
    "Currency": "GBP"
  },
  "DropShipmentOrderLines": [
    {
      "DropShipmentLineID": 456,
      "ProductSKU": "ABC",
      "SupplierCode": "SUP-ABC",
      "Quantity": 10,
      "Notes": "A note",
      "DeliveryStatus": "Received",
      "Cost": 2.5,
      "Currency": {
        "CurrencyID": 4,
        "CurrencyCode": "GBP",
        "CurrencyName": "British Pound",
        "Symbol": "£"
      }
    }
  ]
}