products

Arguments

Argument	Type	Required	Description
`sku`	`String`	No
`created_from`	ISODateTime	No
`created_to`	ISODateTime	No
`updated_from`	ISODateTime	No
`updated_to`	ISODateTime	No
`customer_account_id`	`String`	No	If you are a 3PL you can specify one of your customer's account
`has_kits`	`Boolean`	No
`tag`	[`String`]	No	Filters products that have ANY of the specified tags (OR)
`tag_not_in`	[`String`]	No	Excludes products that have ANY of the specified tags; untagged products are included
`analyze`	`Boolean`	No	If true, the query will only be analyzed (cost estimated) without executing it.

Return Type

ProductsQueryResult

Query

query products(
  $sku: String,
  $created_from: ISODateTime,
  $created_to: ISODateTime,
  $updated_from: ISODateTime,
  $updated_to: ISODateTime,
  $customer_account_id: String,
  $has_kits: Boolean,
  $tag: [String],
  $tag_not_in: [String],
  $analyze: Boolean
) {
  products(
    sku: $sku,
    created_from: $created_from,
    created_to: $created_to,
    updated_from: $updated_from,
    updated_to: $updated_to,
    customer_account_id: $customer_account_id,
    has_kits: $has_kits,
    tag: $tag,
    tag_not_in: $tag_not_in,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...ProductConnectionFragment
    
      pageInfo {
        ...PageInfoFragment
      
        hasNextPage
        hasPreviousPage
        startCursor
        endCursor
      }
      edges {
        ...ProductEdgeFragment
      
        node {
          ...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
          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
              }
            }
            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
                  created_at
                  location {
                    ...LocationFragment
                  
                    id
                    legacy_id
                    account_id
                    warehouse_id
                    type {
                      ...LocationTypeFragment
                    }
                    name
                    zone
                    pickable
                    sellable
                    staging
                    is_cart
                    pick_priority
                    dimensions {
                      ...DimensionsFragment
                    }
                    length
                    width
                    height
                    max_weight
                    temperature
                    products {
                      ...ProductConnectionFragment
                    }
                    last_counted
                    created_at
                    expiration_lots {
                      ...LotConnectionFragment
                    }
                  }
                  expiration_lot {
                    ...LotFragment
                  
                    id
                    legacy_id
                    account_id
                    po_id
                    name
                    sku
                    created_at
                    updated_at
                    expires_at
                    received_at
                    is_active
                    locations {
                      ...LocationConnectionFragment
                    }
                    purchase_orders {
                      ...PurchaseOrderConnectionFragment
                    }
                  }
                  lpns {
                    ...LicensePlateNumberConnectionFragment
                  
                    pageInfo {
                      ...PageInfoFragment
                    }
                    edges {
                      ...LicensePlateNumberEdgeFragment
                    }
                  }
                }
                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
          }
          cases {
            ...CaseFragment
          
            id
            legacy_id
            case_barcode
            case_quantity
          }
        }
        cursor
      }
    }
  }
}

Variables

{
  "sku": "abc123",
  "created_from": ISODateTime,
  "created_to": ISODateTime,
  "updated_from": ISODateTime,
  "updated_to": ISODateTime,
  "customer_account_id": "abc123",
  "has_kits": true,
  "tag": ["abc123"],
  "tag_not_in": ["abc123"],
  "analyze": true
}

Response

{
  "data": {
    "products": {
      "request_id": "abc123",
      "complexity": 987,
      "data": ProductConnection
    }
  }
}