GET v1/inboundOrder/listByCarrierDay/{carrierID}

Retrieve list of Inound Orders for the current PIN location

Request Information

URI Parameters

NameDescriptionTypeAdditional information
carrierID

integer

Required

Body Parameters

None.

Response Information

Resource Description

InboundOrderModel
NameDescriptionTypeAdditional information
InboundOrderID

Unique identifier of a Inbound Order

integer

None.

InboundOrderNumber

string

None.

InboundOrderStatus

InboundOrderStatusModel

None.

FromLocation

Location

LocationModel

None.

ToLocation

Location

LocationModel

None.

ExpectedDueDate

The Inbound Order due date

date

None.

Reference

string

None.

Carrier

LocationModel

None.

CancellationDate

date

None.

DispatchDate

date

None.

ChangeOfCollectionDate

date

None.

OriginRequestedCollectionDate

date

None.

Days

number of working days between either Cancellation Date’ or ‘Change of Collection Date’ and the field ‘Original Requested Collection Date

integer

None.

Notes

string

None.

Quantity

integer

None.

ReceivedQuantity

integer

None.

ReturnQuantity

integer

None.

ReceiveDate

date

None.

BOLNumber

string

None.

Trailer

string

None.

CreationDate

date

None.

CreatedBy

string

None.

Response Formats

application/json, text/json

Sample:
{
  "inboundOrderID": 1,
  "inboundOrderNumber": "sample string 2",
  "inboundOrderStatus": {
    "inboundOrderStatusID": 1,
    "inboundOrderStatus": "sample string 2"
  },
  "fromLocation": {
    "locationID": 1,
    "company": {
      "companyID": 1,
      "companyName": "sample string 2",
      "companyCode": "sample string 3",
      "vatNumber": "sample string 4",
      "address1": "sample string 5",
      "address2": "sample string 6",
      "address3": "sample string 7",
      "address4": "sample string 8",
      "address5": "sample string 9",
      "email": "sample string 10",
      "currentRates": [
        {
          "companyRateID": 1,
          "rate": 2.0,
          "supportLevel": {
            "supportLevelID": 1,
            "supportLevel": "sample string 2"
          },
          "startDate": "2025-11-08T08:22:43.1349671+00:00"
        },
        {
          "companyRateID": 1,
          "rate": 2.0,
          "supportLevel": {
            "supportLevelID": 1,
            "supportLevel": "sample string 2"
          },
          "startDate": "2025-11-08T08:22:43.1349671+00:00"
        }
      ]
    },
    "isActive": true,
    "isKeyAccount": true,
    "locationCategory": {
      "locationCategoryID": 1,
      "locationCategory": "sample string 2",
      "isSystem": true
    },
    "locationName": "sample string 4",
    "address": "sample string 5",
    "address2": "sample string 6",
    "address3": "sample string 7",
    "city": "sample string 8",
    "state": {
      "stateID": 1,
      "stateShortName": "sample string 2",
      "stateLongName": "sample string 3"
    },
    "zipCode": "sample string 9",
    "country": {
      "countryID": 1,
      "countryShortName": "sample string 2",
      "countryLongName": "sample string 3"
    },
    "cityStateZipCountry": "sample string 10",
    "xCoordinate": "sample string 11",
    "yCoordinate": "sample string 12",
    "googlePlaceID": "sample string 13",
    "googleURL": "sample string 14",
    "term": {
      "termID": 1,
      "term": "sample string 2",
      "isActive": true
    },
    "bolTemplate": {
      "bolTemplateID": 1,
      "templateName": "sample string 2"
    },
    "isIntegrationControlled": true,
    "locationRules": {
      "locationRuleID": 1,
      "shipMethod": {
        "shipMethodID": 1,
        "shipMethod": "sample string 2"
      },
      "isLocked": true,
      "canSelfOrder": true,
      "additionalBillingDays": 4,
      "allowUDFAddress": true,
      "palletLabelQuantity": 6,
      "returnFlagType": {
        "flagTypeID": 1,
        "flagType": "sample string 2",
        "isActive": true,
        "isSystem": true,
        "isCleared": true,
        "isDefault": true,
        "isRepair": true,
        "isAdmin": true,
        "isRepairComponent": true
      },
      "returnFlagBarcodePrefix": "sample string 7"
    }
  },
  "toLocation": {
    "locationID": 1,
    "company": {
      "companyID": 1,
      "companyName": "sample string 2",
      "companyCode": "sample string 3",
      "vatNumber": "sample string 4",
      "address1": "sample string 5",
      "address2": "sample string 6",
      "address3": "sample string 7",
      "address4": "sample string 8",
      "address5": "sample string 9",
      "email": "sample string 10",
      "currentRates": [
        {
          "companyRateID": 1,
          "rate": 2.0,
          "supportLevel": {
            "supportLevelID": 1,
            "supportLevel": "sample string 2"
          },
          "startDate": "2025-11-08T08:22:43.1349671+00:00"
        },
        {
          "companyRateID": 1,
          "rate": 2.0,
          "supportLevel": {
            "supportLevelID": 1,
            "supportLevel": "sample string 2"
          },
          "startDate": "2025-11-08T08:22:43.1349671+00:00"
        }
      ]
    },
    "isActive": true,
    "isKeyAccount": true,
    "locationCategory": {
      "locationCategoryID": 1,
      "locationCategory": "sample string 2",
      "isSystem": true
    },
    "locationName": "sample string 4",
    "address": "sample string 5",
    "address2": "sample string 6",
    "address3": "sample string 7",
    "city": "sample string 8",
    "state": {
      "stateID": 1,
      "stateShortName": "sample string 2",
      "stateLongName": "sample string 3"
    },
    "zipCode": "sample string 9",
    "country": {
      "countryID": 1,
      "countryShortName": "sample string 2",
      "countryLongName": "sample string 3"
    },
    "cityStateZipCountry": "sample string 10",
    "xCoordinate": "sample string 11",
    "yCoordinate": "sample string 12",
    "googlePlaceID": "sample string 13",
    "googleURL": "sample string 14",
    "term": {
      "termID": 1,
      "term": "sample string 2",
      "isActive": true
    },
    "bolTemplate": {
      "bolTemplateID": 1,
      "templateName": "sample string 2"
    },
    "isIntegrationControlled": true,
    "locationRules": {
      "locationRuleID": 1,
      "shipMethod": {
        "shipMethodID": 1,
        "shipMethod": "sample string 2"
      },
      "isLocked": true,
      "canSelfOrder": true,
      "additionalBillingDays": 4,
      "allowUDFAddress": true,
      "palletLabelQuantity": 6,
      "returnFlagType": {
        "flagTypeID": 1,
        "flagType": "sample string 2",
        "isActive": true,
        "isSystem": true,
        "isCleared": true,
        "isDefault": true,
        "isRepair": true,
        "isAdmin": true,
        "isRepairComponent": true
      },
      "returnFlagBarcodePrefix": "sample string 7"
    }
  },
  "expectedDueDate": "2025-11-08T08:22:43.1349671+00:00",
  "reference": "sample string 4",
  "carrier": {
    "locationID": 1,
    "company": {
      "companyID": 1,
      "companyName": "sample string 2",
      "companyCode": "sample string 3",
      "vatNumber": "sample string 4",
      "address1": "sample string 5",
      "address2": "sample string 6",
      "address3": "sample string 7",
      "address4": "sample string 8",
      "address5": "sample string 9",
      "email": "sample string 10",
      "currentRates": [
        {
          "companyRateID": 1,
          "rate": 2.0,
          "supportLevel": {
            "supportLevelID": 1,
            "supportLevel": "sample string 2"
          },
          "startDate": "2025-11-08T08:22:43.1349671+00:00"
        },
        {
          "companyRateID": 1,
          "rate": 2.0,
          "supportLevel": {
            "supportLevelID": 1,
            "supportLevel": "sample string 2"
          },
          "startDate": "2025-11-08T08:22:43.1349671+00:00"
        }
      ]
    },
    "isActive": true,
    "isKeyAccount": true,
    "locationCategory": {
      "locationCategoryID": 1,
      "locationCategory": "sample string 2",
      "isSystem": true
    },
    "locationName": "sample string 4",
    "address": "sample string 5",
    "address2": "sample string 6",
    "address3": "sample string 7",
    "city": "sample string 8",
    "state": {
      "stateID": 1,
      "stateShortName": "sample string 2",
      "stateLongName": "sample string 3"
    },
    "zipCode": "sample string 9",
    "country": {
      "countryID": 1,
      "countryShortName": "sample string 2",
      "countryLongName": "sample string 3"
    },
    "cityStateZipCountry": "sample string 10",
    "xCoordinate": "sample string 11",
    "yCoordinate": "sample string 12",
    "googlePlaceID": "sample string 13",
    "googleURL": "sample string 14",
    "term": {
      "termID": 1,
      "term": "sample string 2",
      "isActive": true
    },
    "bolTemplate": {
      "bolTemplateID": 1,
      "templateName": "sample string 2"
    },
    "isIntegrationControlled": true,
    "locationRules": {
      "locationRuleID": 1,
      "shipMethod": {
        "shipMethodID": 1,
        "shipMethod": "sample string 2"
      },
      "isLocked": true,
      "canSelfOrder": true,
      "additionalBillingDays": 4,
      "allowUDFAddress": true,
      "palletLabelQuantity": 6,
      "returnFlagType": {
        "flagTypeID": 1,
        "flagType": "sample string 2",
        "isActive": true,
        "isSystem": true,
        "isCleared": true,
        "isDefault": true,
        "isRepair": true,
        "isAdmin": true,
        "isRepairComponent": true
      },
      "returnFlagBarcodePrefix": "sample string 7"
    }
  },
  "cancellationDate": "2025-11-08T08:22:43.1349671+00:00",
  "dispatchDate": "2025-11-08T08:22:43.1349671+00:00",
  "changeOfCollectionDate": "2025-11-08T08:22:43.1349671+00:00",
  "originRequestedCollectionDate": "2025-11-08T08:22:43.1349671+00:00",
  "days": 5,
  "notes": "sample string 6",
  "quantity": 7,
  "receivedQuantity": 8,
  "returnQuantity": 9,
  "receiveDate": "2025-11-08T08:22:43.1349671+00:00",
  "bolNumber": "sample string 10",
  "trailer": "sample string 11",
  "creationDate": "2025-11-08T08:22:43.1349671+00:00",
  "createdBy": "sample string 12"
}