> ## 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.

# Create an item fulfillment

> Records items sent against a sale invoice's lines and returns the fulfillment.

Send the fulfillment under `item_fulfillment`: the `invoice_id`, and `fulfillments` listing each invoice line by its id in `invoice_line` with the `fulfillment_quantity` sent. The new fulfillment comes back under `item_fulfillment` with `fulfillment_status` `shipped`.

> [!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). To send a raw JSON body instead of filling in fields, copy the cURL sample and edit its `-d` payload.


## OpenAPI

````yaml POST /item_fulfillments
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:
  /item_fulfillments:
    post:
      tags:
        - Item fulfillments
      summary: Create an item fulfillment
      description: >-
        Send the fulfillment under `item_fulfillment`: the `invoice_id`, and
        `fulfillments` listing each invoice line by its id in `invoice_line`
        with the `fulfillment_quantity` sent. The new fulfillment comes back
        under `item_fulfillment` with `fulfillment_status` `shipped`.
      operationId: item_fulfillments_create_item_fulfillment
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                item_fulfillment:
                  type: object
                  properties:
                    invoice_id:
                      type: string
                      description: The sale invoice's `id`.
                    fulfillments:
                      type: array
                      items:
                        type: object
                        properties:
                          invoice_line:
                            type: string
                            description: The invoice line's `id`.
                          fulfillment_quantity:
                            type: number
                        required:
                          - invoice_line
                          - fulfillment_quantity
                  required:
                    - invoice_id
                    - fulfillments
              required:
                - item_fulfillment
            example:
              item_fulfillment:
                invoice_id: INV-0001
                fulfillments:
                  - invoice_line: 8e7d6c5b-4a39-4281-9706-f5e4d3c2b1a0
                    fulfillment_quantity: 1
      responses:
        '201':
          description: The new fulfillment, under `item_fulfillment`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ItemFulfillments'
      x-codeSamples:
        - lang: bash
          label: cURL
          source: |-
            curl -X POST "$EXSITED_BASE_URL/api/v4/item_fulfillments" \
              -H "Authorization: Bearer $ACCESS_TOKEN" \
              -H "Content-Type: application/json" \
              -d '{
                "item_fulfillment": {
                  "invoice_id": "INV-0001",
                  "fulfillments": [
                    {
                      "invoice_line": "8e7d6c5b-4a39-4281-9706-f5e4d3c2b1a0",
                      "fulfillment_quantity": 1
                    }
                  ]
                }
              }'
        - lang: python
          label: Python
          source: |
            from exsited import build_client

            client = build_client()

            response = client.item_fulfillments.create_item_fulfillment(
                {
                    "item_fulfillment": {
                        "invoice_id": "INV-0001",
                        "fulfillments": [
                            {
                                "invoice_line": "8e7d6c5b-4a39-4281-9706-f5e4d3c2b1a0",
                                "fulfillment_quantity": 1,
                            }
                        ],
                    }
                }
            )
            print(response.data)
        - lang: javascript
          label: JavaScript
          source: >
            import {buildClient} from 'exsited';


            const client = await buildClient();


            const response = await
            client.itemFulfillments.createItemFulfillment({
                item_fulfillment: {
                    invoice_id: 'INV-0001',
                    fulfillments: [{invoice_line: '8e7d6c5b-4a39-4281-9706-f5e4d3c2b1a0', fulfillment_quantity: 1}],
                },
            });

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

            $client = ClientRegistry::buildClient();

            $response = $client->itemFulfillments->createItemFulfillment([
                'item_fulfillment' => [
                    'invoice_id' => 'INV-0001',
                    'fulfillments' => [
                        ['invoice_line' => '8e7d6c5b-4a39-4281-9706-f5e4d3c2b1a0', 'fulfillment_quantity' => 1],
                    ],
                ],
            ]);
            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.item_fulfillments.item_fulfillments_dto.ItemFulfillmentsDto;

            import java.util.List;

            import java.util.Map;


            ExsitedClient client = ClientRegistry.buildClient();


            ApiResponse<ItemFulfillmentsDto.ItemFulfillments> response =
            client.itemFulfillments().createItemFulfillment(
                    Map.of(
                            "item_fulfillment", Map.of(
                                    "invoice_id", "INV-0001",
                                    "fulfillments", List.of(
                                            Map.of(
                                                    "invoice_line", "8e7d6c5b-4a39-4281-9706-f5e4d3c2b1a0",
                                                    "fulfillment_quantity", 1)))));
            System.out.println(response.getMap());
        - lang: csharp
          label: .NET
          source: >
            using Exsited.Client;


            await using var client = ExsitedClient.BuildClient();


            var response = await
            client.ItemFulfillments.CreateItemFulfillmentAsync(new
            Dictionary<string, object?>

            {
                ["item_fulfillment"] = new Dictionary<string, object?>
                {
                    ["invoice_id"] = "INV-0001",
                    ["fulfillments"] = new List<object?>
                    {
                        new Dictionary<string, object?>
                        {
                            ["invoice_line"] = "8e7d6c5b-4a39-4281-9706-f5e4d3c2b1a0",
                            ["fulfillment_quantity"] = 1,
                        },
                    },
                },
            });


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


            final client = buildClient();


            final response = await
            client.itemFulfillments.createItemFulfillment({
              'item_fulfillment': {
                'invoice_id': 'INV-0001',
                'fulfillments': [
                  {
                    'invoice_line': '8e7d6c5b-4a39-4281-9706-f5e4d3c2b1a0',
                    'fulfillment_quantity': 1,
                  },
                ],
              },
            });

            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.ItemFulfillments().CreateItemFulfillment(context.Background(), map[string]any{\n\t\"item_fulfillment\": map[string]any{\n\t\t\"invoice_id\": \"INV-0001\",\n\t\t\"fulfillments\": []any{\n\t\t\tmap[string]any{\n\t\t\t\t\"invoice_line\":         \"8e7d6c5b-4a39-4281-9706-f5e4d3c2b1a0\",\n\t\t\t\t\"fulfillment_quantity\": 1,\n\t\t\t},\n\t\t},\n\t},\n}, nil)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Println(response.Map)\n"
components:
  schemas:
    ItemFulfillments:
      type: object
      properties:
        item_fulfillment:
          $ref: '#/components/schemas/ItemFulfillmentsItemFulfillment'
    ItemFulfillmentsItemFulfillment:
      type: object
      properties:
        activity_logs:
          type: array
        code:
          type: string
        fulfillment_date:
          type: string
        fulfillment_note:
          type: string
        fulfillment_status:
          type: string
          description: Such as `shipped`.
        href:
          type: string
        id:
          type: string
        object:
          type: string
        status:
          type: string
        version:
          type: integer
  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.