fulfillment_invoice

Fetch fulfillment invoice records matching the supplied arguments.

Arguments

Argument	Type	Required	Default	Description
`id`	`String`	No		Filter by ID; pass the public API ID unless the field name says legacy ID.
`analyze`	`Boolean`	No		If true, the query will only be analyzed (cost estimated) without executing it.

Return Type

FulfillmentInvoiceQueryResult

Query

query fulfillment_invoice(
  $id: String,
  $analyze: Boolean
) {
  fulfillment_invoice(
    id: $id,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...FulfillmentInvoiceFragment
    
      id
      legacy_id
      stripe_charge_id
      stripe_invoice_id
      stripe_invoice_number
      stripe_invoice_status
      stripe_invoice_url
      stripe_next_payment_attempt
      account_id
      cc_info
      amount
      created_at
      shipping_items {
        ...FulfillmentInvoiceShippingItemConnectionFragment
      
        pageInfo {
          ...PageInfoFragment
        
          hasNextPage
          hasPreviousPage
          startCursor
          endCursor
        }
        edges {
          ...FulfillmentInvoiceShippingItemEdgeFragment
        
          node {
            ...FulfillmentInvoiceShippingItemFragment
          
            id
            legacy_id
            account_id
            invoice_id
            order_id
            shipment_id
            shipping_label_id
            amount
            shipping_rate
            processing_fee
            picking_fee
            overcharge_fee
            created_at
          }
          cursor
        }
      }
      inbound_shipping_items {
        ...FulfillmentInvoiceInboundShippingItemConnectionFragment
      
        pageInfo {
          ...PageInfoFragment
        
          hasNextPage
          hasPreviousPage
          startCursor
          endCursor
        }
        edges {
          ...FulfillmentInvoiceInboundShippingItemEdgeFragment
        
          node {
            ...FulfillmentInvoiceInboundShippingItemFragment
          
            id
            legacy_id
            account_id
            invoice_id
            purchase_order_id
            shipment_id
            shipping_label_id
            amount
            cost
            created_at
          }
          cursor
        }
      }
      returns_items {
        ...FulfillmentInvoiceReturnItemConnectionFragment
      
        pageInfo {
          ...PageInfoFragment
        
          hasNextPage
          hasPreviousPage
          startCursor
          endCursor
        }
        edges {
          ...FulfillmentInvoiceReturnItemEdgeFragment
        
          node {
            ...FulfillmentInvoiceReturnItemFragment
          
            id
            legacy_id
            account_id
            invoice_id
            order_id
            rma_id
            rma_label_id
            amount
            shipping_rate
            picking_fee
            inspection_fee
            restocking_fee
            created_at
          }
          cursor
        }
      }
      returns_fulfillment_items {
        ...FulfillmentInvoiceReturnFulfillmentItemConnectionFragment
      
        pageInfo {
          ...PageInfoFragment
        
          hasNextPage
          hasPreviousPage
          startCursor
          endCursor
        }
        edges {
          ...FulfillmentInvoiceReturnFulfillmentItemEdgeFragment
        
          node {
            ...FulfillmentInvoiceReturnFulfillmentItemFragment
          
            id
            legacy_id
            account_id
            invoice_id
            order_id
            rma_id
            rma_label_id
            amount
            sub_total_amount
            picking_fee
            inspection_fee
            restocking_fee
            fulfillment_taxes
            created_at
          }
          cursor
        }
      }
      storage_items {
        ...FulfillmentInvoiceStorageItemConnectionFragment
      
        pageInfo {
          ...PageInfoFragment
        
          hasNextPage
          hasPreviousPage
          startCursor
          endCursor
        }
        edges {
          ...FulfillmentInvoiceStorageItemEdgeFragment
        
          node {
            ...FulfillmentInvoiceStorageItemFragment
          
            id
            legacy_id
            account_id
            warehouse_id
            invoice_id
            amount
            created_at
          }
          cursor
        }
      }
    }
  }
}

Variables

{
  "id": "UmVjb3JkOjEyMzQ=",
  "analyze": true
}

Response

{
  "data": {
    "fulfillment_invoice": {
      "request_id": "UmVjb3JkOjEyMzQ=",
      "complexity": 100,
      "data": {id: "RnVsZmlsbG1lbnRJbnZvaWNlOjEyMzQ="}
    }
  }
}