GET api/BasketHeaders

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of BasketHeader
NameDescriptionTypeAdditional information
BasketHeaderId

integer

None.

DealerId

integer

None.

CreateDate

date

None.

CreatedByUserId

integer

None.

AddressId

integer

None.

OrderTypeId

integer

None.

CustomerReference

string

String length: inclusive between 0 and 20

AlternativeAddressId

integer

None.

OrderType

OrderType

None.

BasketLines

Collection of BasketLine

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "$id": "2",
    "basketHeaderId": 1,
    "dealerId": 2,
    "createDate": "2025-09-01T00:39:38.5591973+00:00",
    "createdByUserId": 3,
    "addressId": 1,
    "orderTypeId": 4,
    "customerReference": "sample string 5",
    "alternativeAddressId": 1,
    "orderType": {
      "$id": "3",
      "id": 1,
      "code": "sample string 2",
      "description": "sample string 3",
      "dropdowngroup": true,
      "basketHeaders": {
        "$id": "4",
        "$values": [
          {
            "$ref": "2"
          },
          {
            "$ref": "2"
          }
        ]
      }
    },
    "basketLines": {
      "$id": "5",
      "$values": [
        {
          "$id": "6",
          "basketLineId": 1,
          "basketHeaderId": 2,
          "partId": 3,
          "quantity": 4,
          "statusId": 1,
          "createdDate": "2025-09-01T00:39:38.5591973+00:00",
          "lineCost": 1.0,
          "exceptionId": 1,
          "dropShip": "sample string 6",
          "discount": 1.0,
          "surcharge": 1.0,
          "basketHeader": {
            "$ref": "2"
          },
          "part": {
            "$id": "7",
            "partId": 1,
            "partNumber": "sample string 2",
            "partDescription": "sample string 3",
            "series": "sample string 4",
            "element": 1,
            "unit": "sample string 5",
            "unitQty": 1.1,
            "special": true,
            "vor": true,
            "superceeded": true,
            "restricted": true,
            "vatCode": 1,
            "coOrigin": "sample string 6",
            "partOrderTypeId": 1,
            "emissionsCritical": true,
            "exchangePart": true,
            "surchargeValue": 1.1,
            "requiredFieldsCode": 1,
            "uoi": 1,
            "stock_Discount": 1.1,
            "voR_Discount": 1.1,
            "unitOfSale": 1,
            "maxQty": 1,
            "template": "sample string 7"
          }
        },
        {
          "$ref": "6"
        }
      ]
    }
  },
  {
    "$ref": "2"
  }
]