wholesale_staging_location_candidates

Fetch wholesale staging location candidates matching the supplied arguments.

Arguments

ArgumentTypeRequiredDefaultDescription
warehouse_idString!Yes

Identifier from where the wholesale order will be shipped.

searchStringNo

Free-text search term used to match the most relevant records.

analyzeBooleanNo

If true, the query will only be analyzed (cost estimated) without executing it.

Return Type

WholesaleStagingLocationCandidatesQueryResult

Query

query wholesale_staging_location_candidates(
  $warehouse_id: String!,
  $search: String,
  $analyze: Boolean
) {
  wholesale_staging_location_candidates(
    warehouse_id: $warehouse_id,
    search: $search,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...LocationConnectionFragment
    }
  }
}

Variables

{
  "warehouse_id": "V2FyZWhvdXNlOjEyMzQ=",
  "search": "BLUE-TEE",
  "analyze": true
}

Response

{
  "data": {
    "wholesale_staging_location_candidates": {
      "request_id": "UmVjb3JkOjEyMzQ=",
      "complexity": 100,
      "data": ["priority", "vip"]
    }
  }
}