> ## Documentation Index
> Fetch the complete documentation index at: https://exsited.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# List an item's packages

> Returns the packages defined on an item.

Returns `{id, name, package_details}` under `item`. Each package has a `uuid`, which the single package endpoints take.

> [!NOTE]
>
> The SDK samples get their client from credentials your app registers once when it starts, as shown in [Authentication](https://exsited.mintlify.site/authentication.md#set-up-a-client). To try the call here, click **Try it**, set `host` to your Exsited API host name and paste an access token from [Get an access token](https://exsited.mintlify.site/api-reference/authentication/get-an-access-token.md).


## OpenAPI

````yaml GET /items/{item_id}/package_details
openapi: 3.1.0
info:
  title: Exsited API
  version: v4
servers:
  - url: https://{host}/api/v4
    variables:
      host:
        default: your-api-host.example.com
        description: Your Exsited API host name, without https://.
security:
  - bearerAuth: []
tags:
  - name: Authentication
  - name: Accounts
  - name: Account emails
  - name: Account groups
  - name: Communications
  - name: Communication profiles
  - name: Orders
  - name: Quote orders
  - name: Express
  - name: Usages
  - name: Sales reps
  - name: Gift certificates
  - name: Invoices
  - name: Pro-forma invoices
  - name: Payments
  - name: Refunds
  - name: Credit notes
  - name: Credit note applications
  - name: Reconciliations
  - name: Items
  - name: Inventory adjustments
  - name: Units of measurement
  - name: Zones
  - name: Shipping packages
  - name: Shipping rules
  - name: Fulfillment profiles
  - name: Fulfillment terms
  - name: Item fulfillments
  - name: Item receipts
  - name: Bookings
  - name: Rental assets
  - name: Return merchandise authorisations
  - name: Purchase orders
  - name: Purchase invoices
  - name: Purchase payments
  - name: Purchase refunds
  - name: Purchase credit notes
  - name: Purchase credit note applications
  - name: Purchase express
  - name: Return vendor authorizations
  - name: ABA files
  - name: Receive terms
  - name: Labours
  - name: Tasks
  - name: Timesheets
  - name: Milestones
  - name: Employees
  - name: Departments
  - name: Designations
  - name: Teams
  - name: Time periods
  - name: Workflows
  - name: Workflow settings
  - name: Events
  - name: Custom events
  - name: System events
  - name: Approvals
  - name: Approval profiles
  - name: Approval user groups
  - name: Alerts
  - name: Alert responsibility settings
  - name: Alert responsibilities
  - name: Action scripts
  - name: Note groups
  - name: Note attachments
  - name: Instance settings
  - name: Accounting codes
  - name: Additional codes
  - name: Billing periods
  - name: Charging periods
  - name: Pricing periods
  - name: Invoice terms
  - name: Days of the month
  - name: Countries
  - name: Salutations
  - name: Document templates
  - name: Email templates
  - name: Roles
  - name: Operators
  - name: Operator groups
  - name: User settings
  - name: Custom attributes
  - name: Custom components
  - name: Custom features
  - name: Custom fields
  - name: Custom forms
  - name: Attribute attachments
  - name: Portal
  - name: Integration connections
  - name: External databases
  - name: Reports
  - name: Applications
  - name: Organisation
  - name: Child organisations
  - name: Webhooks
paths:
  /items/{item_id}/package_details:
    get:
      tags:
        - Items
      summary: List an item's packages
      description: >-
        Returns `{id, name, package_details}` under `item`. Each package has a
        `uuid`, which the single package endpoints take.
      operationId: items_get_item_package_details
      parameters:
        - name: item_id
          in: path
          required: true
          description: The item's `id`, such as `ITEM-0001`. Not its `uuid`.
          schema:
            type: string
      responses:
        '200':
          description: The item with its packages, under `item`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ItemResponse'
      x-codeSamples:
        - lang: bash
          label: cURL
          source: >-
            curl -X GET
            "$EXSITED_BASE_URL/api/v4/items/ITEM-0001/package_details" \
              -H "Authorization: Bearer $ACCESS_TOKEN"
        - lang: python
          label: Python
          source: |
            from exsited import build_client

            client = build_client()

            response = client.items.get_item_package_details("ITEM-0001")
            print(response.data)
        - lang: javascript
          label: JavaScript
          source: >
            import {buildClient} from 'exsited';


            const client = await buildClient();


            const response = await
            client.items.getItemPackageDetails('ITEM-0001');

            console.log(response.data);
        - lang: php
          label: PHP
          source: |
            use Exsited\Client\ClientRegistry;

            $client = ClientRegistry::buildClient();

            $response = $client->items->getItemPackageDetails('ITEM-0001');
            print_r($response->data);
        - lang: java
          label: Java
          source: >
            import com.exsited.client.ApiResponse;

            import com.exsited.client.ClientRegistry;

            import com.exsited.client.ExsitedClient;

            import com.exsited.resources.items.items_dto.ItemsDto.Item;


            ExsitedClient client = ClientRegistry.buildClient();


            ApiResponse<Item> response =
            client.items().getItemPackageDetails("ITEM-0001");

            System.out.println(response.getMap());
        - lang: csharp
          label: .NET
          source: >
            using Exsited.Client;


            await using var client = ExsitedClient.BuildClient();


            var response = await
            client.Items.GetItemPackageDetailsAsync("ITEM-0001");


            Console.WriteLine(response.Json);
        - lang: dart
          label: Dart
          source: >
            import 'package:exsited/exsited.dart';


            final client = buildClient();


            final response = await
            client.items.getItemPackageDetails('ITEM-0001');

            print(response.map);
        - lang: go
          label: Go
          source: "import (\n\t\"context\"\n\t\"fmt\"\n\t\"log\"\n\n\texsited \"github.com/exsited/exsited-sdk-go/v4\"\n)\n\nclient, err := exsited.BuildClient(nil)\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer client.Close()\n\nresponse, err := client.Items().GetItemPackageDetails(context.Background(), \"ITEM-0001\", nil)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Println(response.Map)\n"
components:
  schemas:
    ItemResponse:
      type: object
      properties:
        item:
          $ref: '#/components/schemas/Item'
    Item:
      type: object
      properties:
        object:
          type: string
        id:
          type: string
          description: The item's `id`, such as `ITEM-0001`. Use it in every item path.
        name:
          type: string
        display_name:
          type: string
        description:
          type: string
        type:
          type: string
          description: >-
            The item type in lower case, such as `standard`, `bundle`, `family`
            or `variation_based`.
        status:
          type: string
        origin:
          type: string
        invoice_note:
          type: string
        version:
          type: integer
        href:
          type: string
        sale_enabled:
          type: boolean
        purchase_enabled:
          type: boolean
        inventory_enabled:
          type: boolean
        variations_enabled:
          type: boolean
        parent:
          type: boolean
          description: Whether the item is a variation parent.
        child:
          type: boolean
          description: Whether the item is a variation child.
        parent_item_id:
          type: string
        custom_form:
          $ref: '#/components/schemas/ItemCustomForm'
        manager:
          $ref: '#/components/schemas/ItemReference'
        group:
          $ref: '#/components/schemas/ItemReference'
        created_on:
          type: string
        created_by:
          $ref: '#/components/schemas/ItemUser'
        last_updated_on:
          type: string
        last_updated_by:
          $ref: '#/components/schemas/ItemUser'
        codes:
          type: array
          items:
            $ref: '#/components/schemas/ItemCode'
        currencies:
          type: array
          items:
            $ref: '#/components/schemas/ItemCurrency'
        sale:
          $ref: '#/components/schemas/ItemSale'
          description: The sale section.
        purchase:
          $ref: '#/components/schemas/ItemPurchase'
          description: The purchase section.
        inventories:
          $ref: '#/components/schemas/ItemInventories'
          description: The inventory section.
        bundle_details:
          type: array
          items:
            $ref: '#/components/schemas/ItemBundleDetail'
        family_details:
          type: array
          items:
            $ref: '#/components/schemas/ItemFamilyDetail'
        package_details:
          type: array
          items:
            $ref: '#/components/schemas/ItemPackageDetail'
        configure_variations:
          type: array
          items:
            $ref: '#/components/schemas/ItemVariationOption'
        use_variations:
          type: array
          items:
            $ref: '#/components/schemas/ItemVariationOption'
        custom_objects:
          type: array
        uoms:
          type: array
        custom_attributes:
          type: array
          items:
            $ref: '#/components/schemas/ItemCustomAttribute'
        activity_logs:
          type: array
        base_uom: {}
        image_url: {}
    ItemCustomForm:
      type: object
      properties:
        object:
          type: string
        id:
          type: string
        name:
          type: string
        href:
          type: string
    ItemReference:
      type: object
      properties:
        object:
          type: string
        id:
          type: string
        name:
          type: string
        href:
          type: string
    ItemUser:
      type: object
      properties:
        object:
          type: string
        name:
          type: string
        id:
          type: string
        email:
          type: string
        href:
          type: string
    ItemCode:
      type: object
      properties:
        name:
          type: string
        value:
          type: string
    ItemCurrency:
      type: object
      properties:
        name:
          type: string
        used_for_sale:
          type: boolean
        default_for_sale:
          type: boolean
        used_for_purchase:
          type: boolean
        default_for_purchase:
          type: boolean
        suppliers:
          type: array
    ItemSale:
      type: object
      properties:
        enabled:
          type: boolean
        enable_back_order:
          type: boolean
        invoice_note:
          type: string
        default_sale_price:
          type: number
        pricing_method:
          type: string
        sale_price_variant:
          type: string
        use_on_sale_price:
          type: boolean
        tax_exempt_when_sold:
          type: boolean
        tax_configuration:
          $ref: '#/components/schemas/ItemTaxConfiguration'
        charge:
          $ref: '#/components/schemas/ItemSaleCharge'
        pricing:
          $ref: '#/components/schemas/ItemPricing'
        pricing_levels:
          type: array
          items:
            $ref: '#/components/schemas/ItemSalePricingLevel'
        pricing_schedules:
          type: array
        payment_properties:
          type: array
          items:
            $ref: '#/components/schemas/ItemSalePaymentProperty'
        accounting_code: {}
        discount_profile: {}
        pricing_profile: {}
        shipping_profile: {}
        sale_price: {}
        start_date: {}
        end_date: {}
        height:
          $ref: '#/components/schemas/ItemSaleHeight'
        length:
          $ref: '#/components/schemas/ItemSaleLength'
        weight:
          $ref: '#/components/schemas/ItemSaleWeight'
        width:
          $ref: '#/components/schemas/ItemSaleWidth'
    ItemPurchase:
      type: object
      properties:
        enabled:
          type: boolean
        supplier_management_enabled:
          type: boolean
        purchase_order_note:
          type: string
        default_purchase_price:
          type: number
        tax_exempt_when_purchase:
          type: boolean
        tax_configuration:
          $ref: '#/components/schemas/ItemTaxConfiguration'
        pricing:
          $ref: '#/components/schemas/ItemPricing'
        purchase_properties:
          type: array
          items:
            $ref: '#/components/schemas/ItemPurchasePurchaseProperty'
        accounting_code: {}
        pricing_profile: {}
        suppliers:
          type: array
          items:
            $ref: '#/components/schemas/ItemPurchaseSupplier'
    ItemInventories:
      type: object
      properties:
        enabled:
          type: boolean
        enable_warehouse_management:
          type: boolean
        default_warehouse:
          type: string
        inventory_properties:
          $ref: '#/components/schemas/ItemInventoryProperties'
        warehouses:
          type: array
          items:
            $ref: '#/components/schemas/ItemWarehouseInventory'
    ItemBundleDetail:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        quantity:
          type: number
        uom:
          type: string
    ItemFamilyDetail:
      type: object
      properties:
        item_id:
          type: string
        item_name:
          type: string
    ItemPackageDetail:
      type: object
      properties:
        object:
          type: string
        id:
          type: string
        uuid:
          type: string
          description: Identifies the package in the package paths.
        name:
          type: string
        display_name:
          type: string
        status:
          type: string
        rank:
          type: integer
        items:
          type: array
          items:
            $ref: '#/components/schemas/ItemPackageDetailItem'
        billing_periods:
          type: array
          items:
            $ref: '#/components/schemas/ItemPackageDetailBillingPeriod'
        custom_attributes:
          type: array
        created_on:
          type: string
        created_by:
          $ref: '#/components/schemas/ItemUser'
        last_updated_on: {}
        last_updated_by: {}
    ItemVariationOption:
      type: object
      properties:
        object:
          type: string
        id:
          type: string
        name:
          type: string
        href:
          type: string
        values:
          type: array
          items:
            $ref: '#/components/schemas/ItemVariationOptionValue'
    ItemCustomAttribute:
      type: object
      properties:
        href:
          type: string
        id:
          type: string
        name:
          type: string
        object:
          type: string
        type:
          type: string
        value:
          type: string
    ItemTaxConfiguration:
      type: object
      properties:
        sale_price_entered_inclusive_of_tax:
          type: boolean
        purchase_price_entered_inclusive_of_tax:
          type: boolean
        sale_price_based_on:
          type: string
        tax_code:
          $ref: '#/components/schemas/ItemReference'
    ItemSaleCharge:
      type: object
      properties:
        type:
          type: string
        price_period:
          type: string
        properties:
          type: array
          items:
            $ref: '#/components/schemas/ItemSaleChargeProperty'
    ItemPricing:
      type: object
      properties:
        type:
          type: string
        version:
          type: integer
        latest_used_pricing_version:
          type: integer
        pricing_module:
          type: array
          items:
            $ref: '#/components/schemas/ItemPricingPricingModule'
    ItemSalePricingLevel:
      type: object
      properties:
        name:
          type: string
        uuid:
          type: string
    ItemSalePaymentProperty:
      type: object
      properties:
        name:
          type: string
        value:
          type: string
    ItemSaleHeight:
      type: object
      properties:
        uom:
          type: string
        value:
          type: number
    ItemSaleLength:
      type: object
      properties:
        uom:
          type: string
        value:
          type: number
    ItemSaleWeight:
      type: object
      properties:
        uom:
          type: string
        value:
          type: number
    ItemSaleWidth:
      type: object
      properties:
        uom:
          type: string
        value:
          type: number
    ItemPurchasePurchaseProperty:
      type: object
      properties:
        name:
          type: string
        value:
          type: string
    ItemPurchaseSupplier:
      type: object
      properties:
        accounting_code: {}
        default_purchase_price:
          type: number
        id: {}
        name:
          type: string
        pricing:
          $ref: '#/components/schemas/ItemPricing'
        purchase_order_note: {}
        tax_configuration:
          $ref: '#/components/schemas/ItemPurchaseSupplierTaxConfiguration'
        tax_exempt_when_purchase:
          type: boolean
    ItemInventoryProperties:
      type: object
      properties:
        enabled:
          type: boolean
        enable_batch_tracking:
          type: boolean
        enable_serialization:
          type: boolean
        enable_inventory_costing:
          type: boolean
        enable_low_stock_notification:
          type: boolean
        enable_preorder:
          type: boolean
        enable_reordering:
          type: boolean
        low_stock_threshold_based_on:
          type: string
        reordering_threshold_based_on:
          type: string
        quantity_available_for_sale:
          type: string
        quantity_available_for_sale_determination:
          type: array
        use_atp_value_as_quantity_available_for_webhook:
          type: boolean
        default_cost_per_unit: {}
        preorder_configuration:
          type: array
          items:
            $ref: '#/components/schemas/ItemInventoryPropertiesPreorderConfiguration'
        preorder_period:
          type: string
    ItemWarehouseInventory:
      type: object
      properties:
        quantity_on_hand:
          type: integer
          description: The stock held in the warehouse, as an integer.
        quantity_on_hand_value:
          type: string
        quantity_available:
          type: number
        quantity_available_value:
          type: string
        quantity_on_order:
          type: integer
        quantity_promised:
          type: number
        quantity_on_return:
          type: integer
        quantity_on_purchase_return:
          type: integer
        warehouse:
          $ref: '#/components/schemas/ItemReference'
        uom:
          type: string
    ItemPackageDetailItem:
      type: object
      properties:
        item_id:
          type: string
        item_name:
          type: string
        quantity:
          type: number
        uom: {}
    ItemPackageDetailBillingPeriod:
      type: object
      properties:
        name:
          type: string
        rank:
          type: integer
    ItemVariationOptionValue:
      type: object
      properties:
        name:
          type: string
        uuid:
          type: string
    ItemSaleChargeProperty:
      type: object
      properties:
        name:
          type: string
        value:
          type: string
    ItemPricingPricingModule:
      type: object
      properties:
        average_purchase_price: {}
        currency:
          type: string
        last_purchase_price: {}
        price:
          type: number
        price_type:
          type: string
        pricing_level:
          type: string
        unit:
          type: string
    ItemPurchaseSupplierTaxConfiguration:
      type: object
      properties:
        purchase_price_entered_inclusive_of_tax:
          type: boolean
        tax_code:
          $ref: '#/components/schemas/ItemReference'
    ItemInventoryPropertiesPreorderConfiguration:
      type: object
      properties:
        end_date:
          type: string
        name:
          type: string
        start_date:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        An access token from `POST /api/v4/oauth2/token`. The SDKs get and renew
        it for you.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.