> ## Documentation Index
> Fetch the complete documentation index at: https://redo-44af351d-docs-v3-graphql-api-reference.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Supplier

> A vendor a merchant buys inventory from, with contacts and purchase orders.

**Required scopes:**
[`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)

<ResponseField name="contacts" type={<a href="/docs/api-reference/v3/reference/procurement/supplier-contact">[SupplierContact!]!</a>} required>
  The contact people at this supplier.

  <Expandable title="fields" lazyRender>
    <ResponseField name="createdAt" type={<a href="/docs/api-reference/v3/reference/common/date-time">DateTime!</a>} required>
      When the record was created.
    </ResponseField>

    <ResponseField name="email" type="String">
      The contact's email address.
    </ResponseField>

    <ResponseField name="id" type="ID!" required>
      The id of this contact.
    </ResponseField>

    <ResponseField name="name" type="String!" required>
      The contact's name.
    </ResponseField>

    <ResponseField name="phone" type="String">
      The contact's phone number.
    </ResponseField>

    <ResponseField name="updatedAt" type={<a href="/docs/api-reference/v3/reference/common/date-time">DateTime!</a>} required>
      When the record was last updated.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="createdAt" type={<a href="/docs/api-reference/v3/reference/common/date-time">DateTime!</a>} required>
  When the record was created.
</ResponseField>

<ResponseField name="currency" type="String">
  The ISO 4217 currency code the supplier transacts in.
</ResponseField>

<ResponseField name="id" type="ID!" required>
  The id of this supplier.
</ResponseField>

<ResponseField name="leadTimeDays" type="Int">
  The supplier's typical lead time, in days.
</ResponseField>

<ResponseField name="name" type="String!" required>
  The supplier's name.
</ResponseField>

<ResponseField name="phone" type="String">
  The supplier's phone number.
</ResponseField>

<ResponseField name="productVendors" type="[String!]!" required>
  Product vendor names associated with this supplier.
</ResponseField>

<ResponseField name="purchaseOrders" type={<a href="/docs/api-reference/v3/pagination">PurchaseOrderConnection!</a>} required>
  Purchase orders placed with this supplier.

  **Requires:**
  [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)

  <Expandable title="fields" lazyRender>
    **Arguments**

    <ResponseField name="after" type="String">
      Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
    </ResponseField>

    <ResponseField name="before" type="String">
      Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
    </ResponseField>

    <ResponseField name="first" type="Int">
      Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
    </ResponseField>

    <ResponseField name="last" type="Int">
      Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
    </ResponseField>

    **Fields**

    <ResponseField name="edges" type={<a href="/docs/api-reference/v3/pagination">[PurchaseOrderEdge!]!</a>} required>
      The list of edges (each a node plus its pagination `cursor`).

      <Expandable title="fields" lazyRender>
        <ResponseField name="cursor" type="String!" required>
          Opaque cursor for this item; pass to `after`/`before` to page from here.
        </ResponseField>

        <ResponseField name="node" type={<a href="/docs/api-reference/v3/reference/procurement/purchase-order">PurchaseOrder!</a>} required>
          The item at this edge.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="nodes" type={<a href="/docs/api-reference/v3/reference/procurement/purchase-order">[PurchaseOrder!]!</a>} required>
      The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.

      <Expandable title="fields" lazyRender>
        <ResponseField name="closedAt" type={<a href="/docs/api-reference/v3/reference/common/date-time">DateTime</a>}>
          When the purchase order was closed.
        </ResponseField>

        <ResponseField name="createdAt" type={<a href="/docs/api-reference/v3/reference/common/date-time">DateTime!</a>} required>
          When the record was created.
        </ResponseField>

        <ResponseField name="id" type="ID!" required>
          The id of this purchase order.
        </ResponseField>

        <ResponseField name="items" type={<a href="/docs/api-reference/v3/pagination">PurchaseOrderItemConnection!</a>} required>
          A paginated list of the order's line items.

          **Requires:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)

          <Expandable title="fields" lazyRender>
            **Arguments**

            <ResponseField name="after" type="String">
              Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
            </ResponseField>

            <ResponseField name="before" type="String">
              Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
            </ResponseField>

            <ResponseField name="first" type="Int">
              Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
            </ResponseField>

            <ResponseField name="last" type="Int">
              Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="location" type={<a href="/docs/api-reference/v3/reference/inventory/location">Location</a>}>
          The location the order's inventory is destined for.

          **Requires:** [`locations_read`](/docs/api-reference/v3/reference/scopes#scope-locations_read)
        </ResponseField>

        <ResponseField name="note" type="String">
          An internal note on the purchase order.
        </ResponseField>

        <ResponseField name="orderedAt" type={<a href="/docs/api-reference/v3/reference/common/date">Date</a>}>
          The date the order was placed with the supplier.
        </ResponseField>

        <ResponseField name="poNumber" type="String!" required>
          The merchant-facing purchase order number.
        </ResponseField>

        <ResponseField name="referenceNumber" type="String">
          An external reference for the purchase order.
        </ResponseField>

        <ResponseField name="shipments" type={<a href="/docs/api-reference/v3/pagination">InboundShipmentConnection!</a>} required>
          Inbound shipments fulfilling this purchase order.

          **Requires:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)

          <Expandable title="fields" lazyRender>
            **Arguments**

            <ResponseField name="after" type="String">
              Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
            </ResponseField>

            <ResponseField name="before" type="String">
              Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
            </ResponseField>

            <ResponseField name="first" type="Int">
              Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
            </ResponseField>

            <ResponseField name="last" type="Int">
              Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="status" type={<a href="/docs/api-reference/v3/reference/procurement/purchase-order-status">PurchaseOrderStatus!</a>} required>
          The current lifecycle status of the purchase order.
        </ResponseField>

        <ResponseField name="supplier" type={<a href="/docs/api-reference/v3/reference/procurement/supplier">Supplier</a>}>
          The supplier the order was placed with.

          **Requires:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)
        </ResponseField>

        <ResponseField name="supplierNote" type="String">
          A note shared with the supplier.
        </ResponseField>

        <ResponseField name="tags" type="[String!]!" required>
          Free-form tags applied to the purchase order.
        </ResponseField>

        <ResponseField name="updatedAt" type={<a href="/docs/api-reference/v3/reference/common/date-time">DateTime!</a>} required>
          When the record was last updated.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="pageInfo" type={<a href="/docs/api-reference/v3/pagination">PageInfo!</a>} required>
      Pagination metadata for the current page.

      <Expandable title="fields" lazyRender>
        <ResponseField name="endCursor" type="String">
          Cursor of the last edge in this page; pass to `after` to page forward.
        </ResponseField>

        <ResponseField name="hasNextPage" type="Boolean!" required>
          Whether more items exist after this page (drives forward pagination with `first`/`after`).
        </ResponseField>

        <ResponseField name="hasPreviousPage" type="Boolean!" required>
          Whether more items exist before this page (drives backward pagination with `last`/`before`).
        </ResponseField>

        <ResponseField name="startCursor" type="String">
          Cursor of the first edge in this page; pass to `before` to page backward.
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="updatedAt" type={<a href="/docs/api-reference/v3/reference/common/date-time">DateTime!</a>} required>
  When the record was last updated.
</ResponseField>

<ResponseField name="website" type="String">
  The supplier's website URL.
</ResponseField>
