/item-fulfillments/batch/{batch_id}/objects

curl -G https://api.merge.dev/api/accounting/v1/item-fulfillments/batch/batch_id/objects \
     -H "X-Account-Token: X-Account-Token" \
     -H "Authorization: Bearer <token>" \
     -d cursor=cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw \
     --data-urlencode expand=lines,sales_order,customer,company \
     -d remote_fields=status \
     -d show_enum_origins=status

{
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
  "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
  "results": [
    {
      "id": "0048ea5b-911e-4dff-9364-92070dea62ff",
      "remote_id": "IF-12345",
      "created_at": "2021-09-15T00:00:00Z",
      "modified_at": "2021-10-16T00:00:00Z",
      "sales_order": "b26fd49a-cbae-470a-a8f8-bcbc119e0390",
      "fulfillment_date": "2022-04-10T00:00:00Z",
      "customer": "2f9edc34-c92a-48c0-b2c6-e9e0e3bc407b",
      "company": "595c8f97-2ac4-45b7-b000-41bdf43240b5",
      "status": "SHIPPED",
      "memo": "Shipped via FedEx",
      "lines": [
        {
          "remote_id": "121222",
          "item": "0958cbc6-6040-430a-848e-aafacbadf4ae",
          "quantity": "10",
          "tracking_categories": [
            "f1214c24-2702-4617-b74b-3ddecfc0d384"
          ]
        },
        {
          "remote_id": "121223",
          "item": "249c9faa-3045-4a31-953b-8f22d3613301",
          "quantity": "5",
          "tracking_categories": [
            "f1214c24-2702-4617-b74b-3ddecfc0d384"
          ]
        }
      ],
      "remote_created_at": "2020-03-31T00:00:00Z",
      "remote_updated_at": "2020-03-31T00:00:00Z",
      "remote_was_deleted": true,
      "field_mappings": {
        "organization_defined_targets": {
          "custom_key": "custom_value"
        },
        "linked_account_defined_targets": {
          "custom_key": "custom_value"
        }
      },
      "remote_data": [
        {
          "path": "/actions"
        }
      ],
      "remote_fields": [
        {
          "remote_field_class": {
            "id": "string",
            "display_name": "string",
            "remote_key_name": "string",
            "description": "string",
            "is_custom": true,
            "is_common_model_field": true,
            "is_required": true,
            "field_type": "string",
            "field_format": "string",
            "field_choices": [
              "string"
            ],
            "item_schema": {
              "item_type": "string",
              "item_format": "string",
              "item_choices": [
                "string"
              ]
            }
          },
          "value": "string"
        }
      ]
    }
  ]
}

Returns a list of ItemFulfillment objects.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

batch_idstringRequiredformat: "uuid"

Query parameters

cursorstringOptional

The pagination cursor value.

expandenumOptional

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

include_deleted_databooleanOptional

Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.

include_remote_databooleanOptional

Whether to include the original data Merge fetched from the third-party to produce these models.

include_remote_fieldsbooleanOptional

Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.

include_shell_databooleanOptional

Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

page_sizeintegerOptional

Number of results to return per page. The maximum limit is 100.

remote_fieldsenumOptional

Deprecated. Use show_enum_origins.

Allowed values:

show_enum_originsenumOptional

A comma separated list of enum field names for which you’d like the original values to be returned, instead of Merge’s normalized enum values. Learn more

A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)

Allowed values:

Response

nextstring or null

previousstring or null

resultslist of objects or null

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

sales_orderstring or nullOptionalformat: "uuid"

The ID of the sales order that the item fulfillment originated from.

fulfillment_datedatetime or nullOptional

The date the fulfillment was created.

customerstring or nullOptionalformat: "uuid"

The customer associated with the item fulfillment.

companystring or nullOptionalformat: "uuid"

The subsidiary associated with the fulfillment.

memostring or nullOptional

Comment attached to the fulfillment.

lineslist of objectsOptionalRead-only

remote_created_atdatetime or nullOptional

When the third party's item fulfillment was created.

remote_updated_atdatetime or nullOptional

When the third party's item fulfillment was updated.

remote_datalist of objects or nullOptionalRead-only