---
title: "GET /bulkmodificationtool/order/search"
method: GET
path: "/bulkmodificationtool/order/search"
---

# GET /bulkmodificationtool/order/search

`GET /bulkmodificationtool/order/search`

## Query parameters

- `productId` integer, required
- `boxIds` integer[], required
- `startDate` string, date, required
- `endDate` string, date, required
- `includeDIY` boolean, required
- `substitutions` boolean, nullable
- `isMember` boolean, nullable
- `isEISHCustomer` boolean, nullable

## Response `200`

getOrderSearchResults 200 response

- OrderSearchResult[]
  - `addonId` integer, required
  - `order` OndOrder, required
    - `id` integer, required
    - `date` string, date, required
    - `created` string, date-time, required
    - `modified` string, date-time, required
    - `visitedAt` string, date-time, required
    - `user` UserBasic, required
      - `active` boolean
    - `deliveryAddress` StreetAddress, required
      - `type` 'USER' | 'GUEST' | 'STORE', required
      - `name` string, required
      - `line1` string, required
      - `line2` string, required
      - `city` string, required
      - `province` 'ALBERTA' | 'BRITISH_COLUMBIA' | 'MANITOBA' | 'NEW_BRUNSWICK' | 'NEWFOUNDLAND_AND_LABRADOR' | 'NORTHWEST_TERRITORIES' | 'NOVA_SCOTIA' | 'NUNAVUT' | 'ONTARIO' | 'PRINCE_EDWARD_ISLAND' | 'QUEBEC' | 'SASKATCHEWAN' | 'YUKON_TERRITORY', required
      - `postalCode` string, required
      - `telephone` PhoneNumberServiceNormalizedPhoneNumberNormalizedE164PhoneNumber, required
        - `value` string, required
      - `instructions` string, required
      - `buildingType` integer, required
      - `latitude` number, double, required
      - `longitude` number, double, required
      - `id` integer
    - `timeslot` OndOrderTimeslot, required
      - `name` string, required
      - `start` string, partial-time, required
      - `end` string, partial-time, required
    - `deliveryPreferences` OndDeliveryPreferences, required
      - `callAhead` boolean, required
      - `keyId` string, nullable, required
    - `totals` Totals, required
      - `amountBelowMinimumOrderValue` number, required
      - `subtotal` number, required
      - `totalDiscount` number, required
      - `credits` number, required
      - `totalSubscriptionDiscount` number, required
      - `potentialSubscriptionDiscount` number, required
      - `totalMembershipDiscount` number, required
      - `potentialMembershipDiscount` number, required
      - `totalFees` number, required
      - `totalTax` number, required
      - `grandTotal` number, required
      - `fees` FeeDiscountFeeDiscount[], required
      - `discounts` AppliedDiscount[], required
        - `isMembershipDiscount` boolean
        - `isSubscriptionDiscount` boolean
        - `isCouponDiscount` boolean
        - `amount` number, required
      - `warnings` TotalsTotalWarning[], required
        - `title` string, required
        - `details` string, required
    - `packagingType` 'SINGLE_USE' | 'REUSABLE', required
    - `isPrime` boolean, required
    - `isSubstitutionAllowed` boolean, required
    - `hasAlcohol` boolean, required
    - `estimatedBinsRequired` integer, required
    - `estimatedBinsReturned` integer, required
    - `routeInfo` DeliveryRouteInfo, required
      - `date` string, date, required
      - `code` string, required
      - `routeSequence` integer, required
      - `stopSequence` integer, required
      - `barcode` string, required
      - `provider` DeliveryProvider, required
        - `code` string, required
        - `name` string, required
      - `driver` DeliveryDriver, required
        - `externalId` string, required
        - `displayName` string, required
    - `ordinality` integer, required
    - `tier` 'A_LA_CARTE' | 'PRODUCT_SUBSCRIBER' | 'BAG_SUBSCRIBER' | 'MEMBER', required
  - `bag` Bag, required
    - `id` integer, required
    - `erpItemId` integer, required
    - `name` string, required
    - `shortName` string, required
    - `bagType` 'REGULAR' | 'VALUE', required
    - `description` string, required
    - `shortDescription` string, required
    - `contentsProfile` string, required
    - `contentsDescription` string, required
    - `portionText` string, required
    - `portionSize` integer, required
    - `uri` string, required
    - `imageUrl` string, required
    - `price` Price, required
      - `promo` boolean, required
      - `value` number, required
      - `originalValue` number, nullable, required
      - `availability` PriceAvailability
        - `startDate` string, date, required
        - `endDate` string, date, required
    - `customizationFee` number, required
    - `points` integer, nullable, required
    - `allowExtraItems` boolean, required
    - `extraBagPointPrice` number, required
    - `published` boolean, required
    - `immutable` boolean, required
    - `allowedIntervals` integer[], required
    - `allowedCategoryCodes` string[], required
    - `isDIY` boolean, required
    - `isFeatured` boolean, required
    - `isOrganic` boolean, required
  - `productPrice` number, required
  - `productQuantity` integer, required
  - `bagPoints` integer, nullable, required
  - `coupon` Coupon, required
  - `substitutions` boolean, required
  - `oneOff` boolean, required
  - `isMember` boolean, required
  - `isEISHCustomer` boolean, required

---

[API](https://skmtc.dev/mamaearth/apis/mama-earth-api.md) · [All operations](https://skmtc.dev/mamaearth/apis/mama-earth-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/mamaearth/mama-earth-api/revisions/42b90383d711/schema)