POST api/v1/Tracking/{trackingNumber}?memberNumber={memberNumber}&itemCode={itemCode}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
memberNumber

string

Required

itemCode

string

Required

trackingNumber

string

Body Parameters

Response Information

Resource Description

Order
NameDescriptionTypeAdditional information
Id

integer

ShortOrderNumber

Short order number for the order. System generated

string

ClientId

Client ID for the order

integer

MemberId

Member ID for the order

integer

OrderTypeId

Order Type ID for the order

TOrderType

OrderStatusId

Order Status ID for the order

TOrderStatus

OrderDate

Order Date for the order

date

OrderTemplateId

Not required for all orders. If you supply it, please make it accurate

integer

ShipName

Shipping name for the order

string

ShipAddress1

Shipping address line 1 for the order

string

ShipAddress2

Shipping address line 2 for the order

string

ShipAddress3

Shipping address line 3 for the order

string

ShipCity

Shipping city for the order

string

ShipState

Shipping state for the order

string

ShipZip

Shipping zip code for the order

string

ShipPhone

Shipping phone number for the order

string

Email

Email address for the order

string

ShippingServiceLevel

Shipping service level for the order

string

PreferredShipMethod

Preferred shipping method for the order

string

PackslipMessage

Packslip message for the order

string

MustShipByDate

Must ship by date for the order

date

OrderItems

Collection of order items

Collection of OrderItem

OrderShipments

Collection of order shipments

Collection of OrderShipment

Client

Client associated with the order

Client

ModifiedDateTime

Modified datetime for the object. This will be added by the system.

date

ExecutionTime

How long the method took in milliseconds. System supplied value.

integer

TxID

Transaction ID of the call. Will be added for the response. Not needed in the request.

string

Response Formats

application/json, text/json

Sample:
{
  "id": 1,
  "shortOrderNumber": "sample string 3",
  "clientId": 4,
  "memberId": 5,
  "orderTypeId": "Unknown",
  "orderStatusId": "Unknown",
  "orderDate": "2025-08-14T01:26:00.8186741+00:00",
  "orderTemplateId": 1,
  "shipName": "sample string 7",
  "shipAddress1": "sample string 8",
  "shipAddress2": "sample string 9",
  "shipAddress3": "sample string 10",
  "shipCity": "sample string 11",
  "shipState": "sample string 12",
  "shipZip": "sample string 13",
  "shipPhone": "sample string 14",
  "email": "sample string 15",
  "shippingServiceLevel": "sample string 16",
  "preferredShipMethod": "sample string 17",
  "packslipMessage": "sample string 18",
  "mustShipByDate": "2025-08-14T01:26:00.8186741+00:00",
  "orderItems": [
    {
      "itemCode": "sample string 4",
      "quantity": 5,
      "item": {
        "id": 1,
        "itemCode": "sample string 2",
        "alternateItemCode": "sample string 3",
        "mfgItemCode": "sample string 4",
        "harmonizedCode": "sample string 5",
        "erpId": "sample string 6",
        "description": "sample string 7",
        "itemTypeId": "Unknown",
        "image": "QEA=",
        "itemStatusId": "Inactive",
        "itemUoM": "sample string 8",
        "upcCode": "sample string 9",
        "billingCode": "sample string 10",
        "weight": 12.0,
        "weightUoM": "sample string 13",
        "prop65": true,
        "dimLength": 15.0,
        "dimWidth": 16.0,
        "dimHeight": 17.0,
        "dimUoM": "sample string 18",
        "itemPrice": 19.0,
        "lotControlled": true,
        "volume": 1.0,
        "volumeUoM": "sample string 21",
        "cost": 22.0,
        "barCodeNumber": "sample string 23",
        "itemKits": [
          {
            "id": 1,
            "itemId": 2,
            "itemCode": "sample string 3",
            "componentItemId": 4,
            "componentItemCode": "sample string 5",
            "componentQuantity": 6.0,
            "modifiedDateTime": "2025-08-14T01:26:00.8186741+00:00",
            "executionTime": 9,
            "txID": "sample string 10"
          },
          {
            "id": 1,
            "itemId": 2,
            "itemCode": "sample string 3",
            "componentItemId": 4,
            "componentItemCode": "sample string 5",
            "componentQuantity": 6.0,
            "modifiedDateTime": "2025-08-14T01:26:00.8186741+00:00",
            "executionTime": 9,
            "txID": "sample string 10"
          }
        ],
        "vendor": {
          "name": "sample string 2"
        },
        "modifiedDateTime": "2025-08-14T01:26:00.8186741+00:00",
        "executionTime": 26,
        "txID": "sample string 27"
      },
      "modifiedDateTime": "2025-08-14T01:26:00.8186741+00:00",
      "executionTime": 8,
      "txID": "sample string 9"
    },
    {
      "itemCode": "sample string 4",
      "quantity": 5,
      "item": {
        "id": 1,
        "itemCode": "sample string 2",
        "alternateItemCode": "sample string 3",
        "mfgItemCode": "sample string 4",
        "harmonizedCode": "sample string 5",
        "erpId": "sample string 6",
        "description": "sample string 7",
        "itemTypeId": "Unknown",
        "image": "QEA=",
        "itemStatusId": "Inactive",
        "itemUoM": "sample string 8",
        "upcCode": "sample string 9",
        "billingCode": "sample string 10",
        "weight": 12.0,
        "weightUoM": "sample string 13",
        "prop65": true,
        "dimLength": 15.0,
        "dimWidth": 16.0,
        "dimHeight": 17.0,
        "dimUoM": "sample string 18",
        "itemPrice": 19.0,
        "lotControlled": true,
        "volume": 1.0,
        "volumeUoM": "sample string 21",
        "cost": 22.0,
        "barCodeNumber": "sample string 23",
        "itemKits": [
          {
            "id": 1,
            "itemId": 2,
            "itemCode": "sample string 3",
            "componentItemId": 4,
            "componentItemCode": "sample string 5",
            "componentQuantity": 6.0,
            "modifiedDateTime": "2025-08-14T01:26:00.8186741+00:00",
            "executionTime": 9,
            "txID": "sample string 10"
          },
          {
            "id": 1,
            "itemId": 2,
            "itemCode": "sample string 3",
            "componentItemId": 4,
            "componentItemCode": "sample string 5",
            "componentQuantity": 6.0,
            "modifiedDateTime": "2025-08-14T01:26:00.8186741+00:00",
            "executionTime": 9,
            "txID": "sample string 10"
          }
        ],
        "vendor": {
          "name": "sample string 2"
        },
        "modifiedDateTime": "2025-08-14T01:26:00.8186741+00:00",
        "executionTime": 26,
        "txID": "sample string 27"
      },
      "modifiedDateTime": "2025-08-14T01:26:00.8186741+00:00",
      "executionTime": 8,
      "txID": "sample string 9"
    }
  ],
  "orderShipments": [
    {
      "id": 1,
      "orderId": 2,
      "shortOrderNumber": "sample string 3",
      "orderShipmentDate": "2025-08-14T01:26:00.8186741+00:00",
      "orderShipmentPackageNumber": 5,
      "orderShipmentStatusId": "Unknown",
      "warehouseId": 6,
      "shipName": "sample string 7",
      "shipAddress1": "sample string 8",
      "shipAddress2": "sample string 9",
      "shipAddress3": "sample string 10",
      "shipCity": "sample string 11",
      "shipState": "sample string 12",
      "shipZip": "sample string 13",
      "shipPhone": "sample string 14",
      "weight": 15.0,
      "orderShipmentItems": [
        {
          "id": 1,
          "orderShipmentId": 2,
          "itemId": 3,
          "itemCode": "sample string 4",
          "quantity": 5,
          "locationName": "sample string 6",
          "pickedQuantity": 1,
          "pickedDateTime": "2025-08-14T01:26:00.8186741+00:00",
          "modifiedDateTime": "2025-08-14T01:26:00.8186741+00:00",
          "executionTime": 9,
          "txID": "sample string 10"
        },
        {
          "id": 1,
          "orderShipmentId": 2,
          "itemId": 3,
          "itemCode": "sample string 4",
          "quantity": 5,
          "locationName": "sample string 6",
          "pickedQuantity": 1,
          "pickedDateTime": "2025-08-14T01:26:00.8186741+00:00",
          "modifiedDateTime": "2025-08-14T01:26:00.8186741+00:00",
          "executionTime": 9,
          "txID": "sample string 10"
        }
      ],
      "orderShipmentPackages": [
        {
          "id": 1,
          "orderShipmentId": 2,
          "packageNumber": 3,
          "actualShipWeight": 1.0,
          "shipCarrier": "sample string 4",
          "trackingNumber1": "sample string 5",
          "trackingNumber2": "sample string 6",
          "deliveryStatus": "sample string 7",
          "carrierReceiveDate": "2025-08-14T01:26:00.8186741+00:00",
          "transitDays": 9.0,
          "deliveryDate": "2025-08-14T01:26:00.8186741+00:00",
          "modifiedDateTime": "2025-08-14T01:26:00.8186741+00:00",
          "executionTime": 13,
          "txID": "sample string 14"
        },
        {
          "id": 1,
          "orderShipmentId": 2,
          "packageNumber": 3,
          "actualShipWeight": 1.0,
          "shipCarrier": "sample string 4",
          "trackingNumber1": "sample string 5",
          "trackingNumber2": "sample string 6",
          "deliveryStatus": "sample string 7",
          "carrierReceiveDate": "2025-08-14T01:26:00.8186741+00:00",
          "transitDays": 9.0,
          "deliveryDate": "2025-08-14T01:26:00.8186741+00:00",
          "modifiedDateTime": "2025-08-14T01:26:00.8186741+00:00",
          "executionTime": 13,
          "txID": "sample string 14"
        }
      ],
      "modifiedDateTime": "2025-08-14T01:26:00.8186741+00:00",
      "executionTime": 18,
      "txID": "sample string 19"
    },
    {
      "id": 1,
      "orderId": 2,
      "shortOrderNumber": "sample string 3",
      "orderShipmentDate": "2025-08-14T01:26:00.8186741+00:00",
      "orderShipmentPackageNumber": 5,
      "orderShipmentStatusId": "Unknown",
      "warehouseId": 6,
      "shipName": "sample string 7",
      "shipAddress1": "sample string 8",
      "shipAddress2": "sample string 9",
      "shipAddress3": "sample string 10",
      "shipCity": "sample string 11",
      "shipState": "sample string 12",
      "shipZip": "sample string 13",
      "shipPhone": "sample string 14",
      "weight": 15.0,
      "orderShipmentItems": [
        {
          "id": 1,
          "orderShipmentId": 2,
          "itemId": 3,
          "itemCode": "sample string 4",
          "quantity": 5,
          "locationName": "sample string 6",
          "pickedQuantity": 1,
          "pickedDateTime": "2025-08-14T01:26:00.8186741+00:00",
          "modifiedDateTime": "2025-08-14T01:26:00.8186741+00:00",
          "executionTime": 9,
          "txID": "sample string 10"
        },
        {
          "id": 1,
          "orderShipmentId": 2,
          "itemId": 3,
          "itemCode": "sample string 4",
          "quantity": 5,
          "locationName": "sample string 6",
          "pickedQuantity": 1,
          "pickedDateTime": "2025-08-14T01:26:00.8186741+00:00",
          "modifiedDateTime": "2025-08-14T01:26:00.8186741+00:00",
          "executionTime": 9,
          "txID": "sample string 10"
        }
      ],
      "orderShipmentPackages": [
        {
          "id": 1,
          "orderShipmentId": 2,
          "packageNumber": 3,
          "actualShipWeight": 1.0,
          "shipCarrier": "sample string 4",
          "trackingNumber1": "sample string 5",
          "trackingNumber2": "sample string 6",
          "deliveryStatus": "sample string 7",
          "carrierReceiveDate": "2025-08-14T01:26:00.8186741+00:00",
          "transitDays": 9.0,
          "deliveryDate": "2025-08-14T01:26:00.8186741+00:00",
          "modifiedDateTime": "2025-08-14T01:26:00.8186741+00:00",
          "executionTime": 13,
          "txID": "sample string 14"
        },
        {
          "id": 1,
          "orderShipmentId": 2,
          "packageNumber": 3,
          "actualShipWeight": 1.0,
          "shipCarrier": "sample string 4",
          "trackingNumber1": "sample string 5",
          "trackingNumber2": "sample string 6",
          "deliveryStatus": "sample string 7",
          "carrierReceiveDate": "2025-08-14T01:26:00.8186741+00:00",
          "transitDays": 9.0,
          "deliveryDate": "2025-08-14T01:26:00.8186741+00:00",
          "modifiedDateTime": "2025-08-14T01:26:00.8186741+00:00",
          "executionTime": 13,
          "txID": "sample string 14"
        }
      ],
      "modifiedDateTime": "2025-08-14T01:26:00.8186741+00:00",
      "executionTime": 18,
      "txID": "sample string 19"
    }
  ],
  "client": {
    "id": 1,
    "name": "sample string 2",
    "shortName": "sample string 3",
    "code": "sample string 4",
    "active": true,
    "parentClient": "sample string 6",
    "description": "sample string 7",
    "erpId": "sample string 8",
    "erpNumber": "sample string 9",
    "address1": "sample string 10",
    "address2": "sample string 11",
    "city": "sample string 12",
    "state": "sample string 13",
    "zip": "sample string 14",
    "email": "sample string 15",
    "phone": "sample string 16",
    "clientContracts": [
      {
        "id": 1,
        "clientId": 2,
        "effectiveDateStart": "2025-08-14T01:26:00.8186741+00:00",
        "effectiveDateEnd": "2025-08-14T01:26:00.8186741+00:00",
        "planName": "sample string 5",
        "planBillingCode": "sample string 6",
        "itemId": 7,
        "price": 8.0,
        "discountAmount": 9.0,
        "clientContractDetails": [
          {
            "id": 1,
            "clientContractId": 2,
            "healthCoachInboundCalls": 3.0,
            "healthCoachInboundCallsMax": 4.0,
            "additionalHealthCoachCallPrice": 5.0,
            "additionalHealthCoachCallDiscountAmount": 6.0,
            "additionalHealthCoachCallItemId": 7,
            "clinicalCalls": 8.0,
            "clinicalCallsMax": 9.0,
            "additionalDieticianCallPrice": 10.0,
            "additionalDieticianCallDiscountAmount": 11.0,
            "additionalDieticianCallItemId": 12,
            "additionalNurseCallPrice": 13.0,
            "additionalNurseCallDiscountAmount": 14.0,
            "additionalNurseCallItemId": 15,
            "reportingType": "sample string 16",
            "collectBiometricData": true,
            "rewardsProgram": true,
            "nutritionPlans": true,
            "resupplyGoal": 20.0,
            "resupplyLimit": 21.0,
            "replacementWelcomeKitPrice": 22.0,
            "replacementWelcomeKitItemId": 23,
            "replacementGlucometerPrice": 24.0,
            "replacementGlucometerItemId": 25,
            "replacementDeviceBandPrice": 26.0,
            "replacementDeviceBandItemId": 27,
            "modifiedDateTime": "2025-08-14T01:26:00.8186741+00:00",
            "executionTime": 30,
            "txID": "sample string 31"
          },
          {
            "id": 1,
            "clientContractId": 2,
            "healthCoachInboundCalls": 3.0,
            "healthCoachInboundCallsMax": 4.0,
            "additionalHealthCoachCallPrice": 5.0,
            "additionalHealthCoachCallDiscountAmount": 6.0,
            "additionalHealthCoachCallItemId": 7,
            "clinicalCalls": 8.0,
            "clinicalCallsMax": 9.0,
            "additionalDieticianCallPrice": 10.0,
            "additionalDieticianCallDiscountAmount": 11.0,
            "additionalDieticianCallItemId": 12,
            "additionalNurseCallPrice": 13.0,
            "additionalNurseCallDiscountAmount": 14.0,
            "additionalNurseCallItemId": 15,
            "reportingType": "sample string 16",
            "collectBiometricData": true,
            "rewardsProgram": true,
            "nutritionPlans": true,
            "resupplyGoal": 20.0,
            "resupplyLimit": 21.0,
            "replacementWelcomeKitPrice": 22.0,
            "replacementWelcomeKitItemId": 23,
            "replacementGlucometerPrice": 24.0,
            "replacementGlucometerItemId": 25,
            "replacementDeviceBandPrice": 26.0,
            "replacementDeviceBandItemId": 27,
            "modifiedDateTime": "2025-08-14T01:26:00.8186741+00:00",
            "executionTime": 30,
            "txID": "sample string 31"
          }
        ],
        "modifiedDateTime": "2025-08-14T01:26:00.8186741+00:00",
        "executionTime": 12,
        "txID": "sample string 13"
      },
      {
        "id": 1,
        "clientId": 2,
        "effectiveDateStart": "2025-08-14T01:26:00.8186741+00:00",
        "effectiveDateEnd": "2025-08-14T01:26:00.8186741+00:00",
        "planName": "sample string 5",
        "planBillingCode": "sample string 6",
        "itemId": 7,
        "price": 8.0,
        "discountAmount": 9.0,
        "clientContractDetails": [
          {
            "id": 1,
            "clientContractId": 2,
            "healthCoachInboundCalls": 3.0,
            "healthCoachInboundCallsMax": 4.0,
            "additionalHealthCoachCallPrice": 5.0,
            "additionalHealthCoachCallDiscountAmount": 6.0,
            "additionalHealthCoachCallItemId": 7,
            "clinicalCalls": 8.0,
            "clinicalCallsMax": 9.0,
            "additionalDieticianCallPrice": 10.0,
            "additionalDieticianCallDiscountAmount": 11.0,
            "additionalDieticianCallItemId": 12,
            "additionalNurseCallPrice": 13.0,
            "additionalNurseCallDiscountAmount": 14.0,
            "additionalNurseCallItemId": 15,
            "reportingType": "sample string 16",
            "collectBiometricData": true,
            "rewardsProgram": true,
            "nutritionPlans": true,
            "resupplyGoal": 20.0,
            "resupplyLimit": 21.0,
            "replacementWelcomeKitPrice": 22.0,
            "replacementWelcomeKitItemId": 23,
            "replacementGlucometerPrice": 24.0,
            "replacementGlucometerItemId": 25,
            "replacementDeviceBandPrice": 26.0,
            "replacementDeviceBandItemId": 27,
            "modifiedDateTime": "2025-08-14T01:26:00.8186741+00:00",
            "executionTime": 30,
            "txID": "sample string 31"
          },
          {
            "id": 1,
            "clientContractId": 2,
            "healthCoachInboundCalls": 3.0,
            "healthCoachInboundCallsMax": 4.0,
            "additionalHealthCoachCallPrice": 5.0,
            "additionalHealthCoachCallDiscountAmount": 6.0,
            "additionalHealthCoachCallItemId": 7,
            "clinicalCalls": 8.0,
            "clinicalCallsMax": 9.0,
            "additionalDieticianCallPrice": 10.0,
            "additionalDieticianCallDiscountAmount": 11.0,
            "additionalDieticianCallItemId": 12,
            "additionalNurseCallPrice": 13.0,
            "additionalNurseCallDiscountAmount": 14.0,
            "additionalNurseCallItemId": 15,
            "reportingType": "sample string 16",
            "collectBiometricData": true,
            "rewardsProgram": true,
            "nutritionPlans": true,
            "resupplyGoal": 20.0,
            "resupplyLimit": 21.0,
            "replacementWelcomeKitPrice": 22.0,
            "replacementWelcomeKitItemId": 23,
            "replacementGlucometerPrice": 24.0,
            "replacementGlucometerItemId": 25,
            "replacementDeviceBandPrice": 26.0,
            "replacementDeviceBandItemId": 27,
            "modifiedDateTime": "2025-08-14T01:26:00.8186741+00:00",
            "executionTime": 30,
            "txID": "sample string 31"
          }
        ],
        "modifiedDateTime": "2025-08-14T01:26:00.8186741+00:00",
        "executionTime": 12,
        "txID": "sample string 13"
      }
    ],
    "modifiedDateTime": "2025-08-14T01:26:00.8186741+00:00",
    "executionTime": 19,
    "txID": "sample string 20"
  },
  "modifiedDateTime": "2025-08-14T01:26:00.8186741+00:00",
  "executionTime": 22,
  "txID": "sample string 23"
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.