GET drop-shipments?SupplierID={SupplierID}&OrderNumber={OrderNumber}&RaisedDateFrom={RaisedDateFrom}&RaisedDateTo={RaisedDateTo}&SentDateFrom={SentDateFrom}&SentDateTo={SentDateTo}&DropShipmentReference={DropShipmentReference}&DropShipmentStatus={DropShipmentStatus}&PageSize={PageSize}&Page={Page}

Returns information about multiple Drop Shipments matching the filter information provided

Request Information

URI Parameters

NameDescriptionTypeAdditional information
SupplierID This is an optional parameter. Specifying a Supplier ID will only return Purchase Orders for that Supplier. integer Matching regular expression pattern: ^[1-9]\d*$
OrderNumber This is an optional parameter. Specifying an Order Number will only return Drop Shipments for that Order. integer Matching regular expression pattern: ^[1-9]\d*$
RaisedDateFrom This is an optional parameter. This inidicates the earliest Raised Date which will be returned. date None.
RaisedDateTo This is an optional parameter. This indicates the most recent Raised Date which will be returned. date None.
SentDateFrom This is an optional parameter. This indicates the earliest Sent Date which will be returned date None.
SentDateTo This is an optional parameter. This indicates the most recent Sent Date which will be returned date None.
DropShipmentReference This is an optional parameter. Specifying a Reference will only return Drop Shipments with that matching reference. string None.
DropShipmentStatus This is an optional parameter. Specifying a Status will only return Drop Shipments with that matching status. DropShipmentStatuses None.
PageSize This is an optional parameter. This will default to 100. The max page size is 100. integer Range: inclusive between 1 and 100
Page This is an optional parameter. It will default to page 1. integer Matching regular expression pattern: ^[1-9]\d*$

Body Parameters

None.

Response Information

Resource Description

Returns information about multiple Drop Shipments matching the filter information provided

PagedResponseModelOfDropShipmentModel
NameDescriptionTypeAdditional information
TotalItems integer None.
PagingInfo PagingFilter None.
TotalPages integer None.
Data Collection of DropShipmentModel None.

Response Formats

application/json, text/json

Sample: 
{
  "TotalItems": 1,
  "PagingInfo": {
    "PageSize": 1,
    "Page": 1
  },
  "TotalPages": 1,
  "Data": [
    {
      "DropShipmentID": 123,
      "DropShipmentGuid": "5eaeac00-e51f-4ee1-a0ac-0e1ada7441ea",
      "DropShipmentReference": "123_abc",
      "DropShipmentStatus": "SentToSupplier",
      "RaisedByUser": {
        "UserID": 1,
        "UserName": "Example User"
      },
      "Supplier": {
        "SupplierCode": "Sup1",
        "SupplierID": 1,
        "Name": "Supplier 1"
      },
      "DateRaised": "2024-04-19T06:01:50.6640256Z",
      "DateSent": "2024-04-19T06:21:50.6640256Z",
      "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": "66223286-e53f-4c71-b6ce-4f85ccc5544c",
        "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": "£"
          }
        }
      ]
    }
  ]
}