product

Fetch product records matching the supplied arguments.

Arguments

Argument	Type	Required	Description
`id`	`String`	No	Filter by ID; pass the public API ID unless the field name says legacy ID.
`sku`	`String`	No	Filter by SKU. SKU matching is case-insensitive and ignores surrounding whitespace.
`barcode`	`String`	No	Filter by barcode.
`customer_account_id`	`String`	No	If you are a 3PL you can specify one of your customer's account.
`analyze`	`Boolean`	No	If true, the query will only be analyzed (cost estimated) without executing it.

Return Type

ProductQueryResult

Query

query product(
  $id: String,
  $sku: String,
  $barcode: String,
  $customer_account_id: String,
  $analyze: Boolean
) {
  product(
    id: $id,
    sku: $sku,
    barcode: $barcode,
    customer_account_id: $customer_account_id,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...ProductFragment
    
      id
      legacy_id
      account_id
      name
      sku
      price
      value
      value_currency
      barcode
      country_of_manufacture
      dimensions {
        ...DimensionsFragment
      
        weight
        height
        width
        length
      }
      tariff_code
      kit
      kit_build
      no_air
      final_sale
      customs_value
      customs_description
      not_owned
      dropship
      needs_serial_number
      thumbnail
      large_thumbnail
      created_at
      updated_at
      product_note
      virtual
      ignore_on_invoice
      ignore_on_customs
      active
      needs_lot_tracking
      is_assembly
      packer_note
      size
      style
      vendor_part_number
      consumer_package_code
      buyer_part_number
      buyer_style_number
      auto_pack
      warehouse_products {
        ...WarehouseProductFragment
      
        id
        legacy_id
        account_id
        sku
        warehouse_id
        warehouse_identifier
        price
        value
        value_currency
        on_hand
        inventory_bin
        inventory_overstock_bin
        reserve_inventory
        replenishment_level
        replenishment_max_level
        replenishment_increment
        reorder_amount
        reorder_level
        backorder
        allocated
        available
        non_sellable_quantity
        in_tote
        custom
        customs_value
        created_at
        updated_at
        sell_ahead
        active
        warehouse {
          ...WarehouseFragment
        
          id
          legacy_id
          account_id
          identifier
          dynamic_slotting
          invoice_email
          phone_number
          profile
          address {
            ...AddressFragment
          
            name
            address1
            address2
            city
            state
            country
            zip
            phone
          }
          return_address {
            ...AddressFragment
          
            name
            address1
            address2
            city
            state
            country
            zip
            phone
          }
          company_name
          company_alias
          active
          products {
            ...ProductConnectionFragment
          
            pageInfo {
              ...PageInfoFragment
            
              hasNextPage
              hasPreviousPage
              startCursor
              endCursor
            }
            edges {
              ...ProductEdgeFragment
            
              node {
                ...ProductFragment
              }
              cursor
            }
          }
        }
        product {
          ...ProductFragment
        }
        inbounds {
          ...WarehouseProductInboundConnectionFragment
        
          pageInfo {
            ...PageInfoFragment
          
            hasNextPage
            hasPreviousPage
            startCursor
            endCursor
          }
          edges {
            ...WarehouseProductInboundEdgeFragment
          
            node {
              ...WarehouseProductInboundFragment
            
              id
              legacy_id
              sku
              warehouse_id
              po_id
              purchase_order_line_item_id
              po_date
              quantity
              quantity_received
              quantity_rejected
              sell_ahead
              status
            }
            cursor
          }
        }
        locations {
          ...ItemLocationConnectionFragment
        
          pageInfo {
            ...PageInfoFragment
          
            hasNextPage
            hasPreviousPage
            startCursor
            endCursor
          }
          edges {
            ...ItemLocationEdgeFragment
          
            node {
              ...ItemLocationFragment
            
              id
              legacy_id
              account_id
              warehouse_id
              location_id
              sku
              quantity
              loose_quantity
              allocated_quantity
              created_at
              updated_at
              location {
                ...LocationFragment
              
                id
                legacy_id
                account_id
                warehouse_id
                type {
                  ...LocationTypeFragment
                
                  id
                  legacy_id
                  account_id
                  name
                  daily_storage_cost
                  category
                  is_lpn_allowed
                }
                name
                zone
                pickable
                sellable
                staging
                is_cart
                pick_priority
                dimensions {
                  ...DimensionsFragment
                
                  weight
                  height
                  width
                  length
                }
                length
                width
                height
                max_weight
                temperature
                products {
                  ...ProductConnectionFragment
                
                  pageInfo {
                    ...PageInfoFragment
                  
                    hasNextPage
                    hasPreviousPage
                    startCursor
                    endCursor
                  }
                  edges {
                    ...ProductEdgeFragment
                  
                    node {
                      ...ProductFragment
                    }
                    cursor
                  }
                }
                last_counted
                created_at
                expiration_lots {
                  ...LotConnectionFragment
                
                  pageInfo {
                    ...PageInfoFragment
                  
                    hasNextPage
                    hasPreviousPage
                    startCursor
                    endCursor
                  }
                  edges {
                    ...LotEdgeFragment
                  
                    node {
                      ...LotFragment
                    }
                    cursor
                  }
                }
              }
              location_type {
                ...LocationTypeFragment
              
                id
                legacy_id
                account_id
                name
                daily_storage_cost
                category
                is_lpn_allowed
              }
              expiration_lot {
                ...LotFragment
              
                id
                legacy_id
                account_id
                po_id
                name
                sku
                created_at
                updated_at
                expires_at
                received_at
                is_active
                locations {
                  ...LocationConnectionFragment
                
                  pageInfo {
                    ...PageInfoFragment
                  
                    hasNextPage
                    hasPreviousPage
                    startCursor
                    endCursor
                  }
                  edges {
                    ...LocationEdgeFragment
                  
                    node {
                      ...LocationFragment
                    }
                    cursor
                  }
                }
                purchase_orders {
                  ...PurchaseOrderConnectionFragment
                
                  pageInfo {
                    ...PageInfoFragment
                  
                    hasNextPage
                    hasPreviousPage
                    startCursor
                    endCursor
                  }
                  edges {
                    ...PurchaseOrderEdgeFragment
                  
                    node {
                      ...PurchaseOrderFragment
                    }
                    cursor
                  }
                }
              }
              lpns {
                ...LicensePlateNumberConnectionFragment
              
                pageInfo {
                  ...PageInfoFragment
                
                  hasNextPage
                  hasPreviousPage
                  startCursor
                  endCursor
                }
                edges {
                  ...LicensePlateNumberEdgeFragment
                
                  node {
                    ...LicensePlateNumberFragment
                  
                    container_type
                    status
                    lpn_id
                    sku
                    units
                    order {
                      ...OrderFragment
                    }
                  }
                  cursor
                }
              }
              product {
                ...ProductFragment
              }
              warehouse_product {
                ...WarehouseProductFragment
              }
            }
            cursor
          }
        }
      }
      fba_inventory {
        ...FbaInventoryFragment
      
        id
        legacy_id
        quantity
        marketplace_id
        merchant_id
      }
      images {
        ...ProductImageFragment
      
        src
        position
      }
      tags
      vendors {
        ...ProductVendorFragment
      
        vendor_id
        vendor_sku
        price
      }
      components {
        ...ProductFragment
      }
      kit_components {
        ...KitComponentFragment
      
        id
        legacy_id
        account_id
        sku
        quantity
      }
      assembly_components {
        ...AssemblyComponentFragment
      
        id
        legacy_id
        account_id
        sku
        quantity
      }
      cases {
        ...CaseFragment
      
        id
        legacy_id
        case_barcode
        case_quantity
      }
    }
  }
}

Variables

{
  "id": "UmVjb3JkOjEyMzQ=",
  "sku": "BLUE-TEE-M",
  "barcode": "012345678905",
  "customer_account_id": "QWNjb3VudDoxMjM0",
  "analyze": true
}

Response

{
  "data": {
    "product": {
      "request_id": "UmVjb3JkOjEyMzQ=",
      "complexity": 100,
      "data": {sku: "BLUE-TEE-M", name: "Blue Tee"}
    }
  }
}