Query parameters

• page integer

  Page number (default 1)

• per_page integer

  Results per page (default 20)

• search string

  Substring match on IR number, brand/vendor name, warehouse name, user emails, and item master ID / name / MPN

• sort string

  Sort as " ". Defaults to created_at desc.

  Values are status desc, status asc, notes desc, notes asc, total_units desc, total_units asc, fill_rate desc, fill_rate asc, created_at desc, created_at asc, placed_at desc, placed_at asc, updated_at desc, updated_at asc, total_units_received desc, total_units_received asc, ir_number desc, ir_number asc, warehouse_name asc, warehouse_name desc, items_received asc, items_received desc, vendor_name asc, vendor_name desc, est_ship_date desc, or est_ship_date asc.

• note string

  Case-insensitive substring match on inventory request notes

• created_start_date string

  Inclusive start of created_at (YYYY-MM-DD). Ignored when placed_start_date is present. Applied independently of created_end_date.

• created_end_date string

  Inclusive end of created_at (YYYY-MM-DD). Ignored when placed_end_date is present. Applied independently of created_start_date.

• placed_start_date string

  Start of placed_at (YYYY-MM-DD). Nulls created_start_date. Applied independently of placed_end_date.

• placed_end_date string

  Inclusive end of placed_at (YYYY-MM-DD). Nulls created_end_date. Applied independently of placed_start_date.

• ship_start_date string

  Inclusive start of requested ship date (YYYY-MM-DD). Silently dropped unless ship_end_date is also provided.

• ship_end_date string

  Inclusive end of requested ship date (YYYY-MM-DD). Silently dropped unless ship_start_date is also provided.

• delivery_start_date string

  Inclusive start of requested delivery date (YYYY-MM-DD). Silently dropped unless delivery_end_date is also provided.

• delivery_end_date string

  Inclusive end of requested delivery date (YYYY-MM-DD). Silently dropped unless delivery_start_date is also provided.

• updated_start_date string

  Inclusive start of updated_at (YYYY-MM-DD). Silently dropped unless updated_end_date is also provided.

• updated_end_date string

  Inclusive end of updated_at (YYYY-MM-DD). Silently dropped unless updated_start_date is also provided.

• est_ship_start_date string

  Inclusive start of estimated ship date (YYYY-MM-DD). Silently dropped unless est_ship_end_date is also provided.

• est_ship_end_date string

  Inclusive end of estimated ship date (YYYY-MM-DD). Silently dropped unless est_ship_start_date is also provided.

• state[] array[string]

  Inventory request states to include. Drafted is always excluded, even if requested. Repeat the parameter for multiple values.

  Values are placed, arrived, receiving, ready_to_reconcile, reconciled, cancelled, deleted, or ready_to_ship.

• brand_ids[] array[integer]

  Pattern vendor IDs. Intersected with the caller's authorized vendors; IDs outside that scope are ignored. Omit to include all authorized vendors. An empty intersection returns no results.

• vendor_ids[] array[integer]

  NetSuite vendor IDs (netsuite_vendors.id), not Pattern vendor IDs. Use brand_ids[] to filter by Pattern vendor.

• warehouse_ids[] array[integer]

  Pattern warehouse IDs

• created_by_ids[] array[integer]

  Filter by created-by user IDs

• placed_by_ids[] array[integer]

  Filter by placed-by user IDs

• updated_by_ids[] array[integer]

  Filter by last-updated-by user IDs

• order_tags[] array[string]

  Boolean order tags that must all be true. Repeat the parameter for multiple values.

  Values are initial_order or holiday_order.

Responses

• 200 application/json

  Returns list of inventory requests

  Hide headers attributes Show headers attributes

  • Current-Page integer

    Current page number

  • Page-Items integer

    Number of items returned on this page

  • Total-Count integer

    Total number of matching inventory requests

  • Total-Pages integer

    Total number of pages

  Hide response attributes Show response attributes object

  • shipment_id string

    The IR number

  • status string
  • items_received integer
  • items_total integer
  • estimated_ship_date string(date) | null
  • shipment_method string | null
  • warehouse string
  • created string(date-time)
  • packslip_decision_date string(date-time) | null
  • created_by string | null
  • brand string
  • appointment_scheduled boolean
  • fba_shipments array[object]

    Array of FBA shipments for this inventory request with item, quantity and shipment details

    Hide fba_shipments attributes Show fba_shipments attributes object

    • item_id integer | null

      Item ID

    • quantity integer

      Quantity shipped to this FBA shipment

    • destination_shipment_id string

      FBA Shipment ID

    • destination_fulfillment_center_id string

      Destination FBA fulfillment center ID

• 401

  Unauthorized - missing org_id