/item-fulfillments

curl -X POST https://api.merge.dev/api/accounting/v1/item-fulfillments \
     -H "X-Account-Token: X-Account-Token" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "model": {}
}'

{
  "model": {
    "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"
      }
    ]
  },
  "warnings": [
    {
      "title": "Unrecognized Field",
      "detail": "An unrecognized field, age, was passed in with request data.",
      "problem_type": "UNRECOGNIZED_FIELD",
      "source": {
        "pointer": "/age"
      },
      "block_merge_link": true
    }
  ],
  "errors": [
    {
      "title": "Missing Required Field",
      "detail": "custom_fields is a required field on model.",
      "problem_type": "MISSING_REQUIRED_FIELD",
      "source": {
        "pointer": "/model/custom_fields"
      },
      "block_merge_link": true
    }
  ],
  "logs": [
    {
      "log_id": "99433219-8017-4acd-bb3c-ceb23d663832",
      "dashboard_view": "https://app.merge.dev/logs/99433219-8017-4acd-bb3c-ceb23d663832",
      "log_summary": {
        "url": "www.exampleintegration.com/api/v1/exampleapi",
        "method": "POST",
        "status_code": 200
      }
    }
  ]
}

Creates an ItemFulfillment object with the given values.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Query parameters

is_debug_modebooleanOptional

Whether to include debug fields (such as log file links) in the response.

run_asyncbooleanOptional

Whether or not third-party updates should be run asynchronously.

Request

This endpoint expects an object.

modelobjectRequired

Description

The ItemFulfillment object represents the recorded shipment or delivery of some or all items on an associated sales order.

Usage Example

Fetch from the LIST ItemFulfillments endpoint and view a company’s item fulfillments.

# The ItemFulfillment Object ### Description The `ItemFulfillment` object represents the recorded shipment or delivery of some or all items on an associated sales order. ### Usage Example Fetch from the `LIST ItemFulfillments` endpoint and view a company's item fulfillments.

Response

modelobject

Description

The ItemFulfillment object represents the recorded shipment or delivery of some or all items on an associated sales order.

Usage Example

Fetch from the LIST ItemFulfillments endpoint and view a company’s item fulfillments.

warningslist of objects

errorslist of objects

logslist of objects or null

Supported POST model parameters

sales_orderstring or nullRequiredformat: "uuid"

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

remote_idstring or nullOptional

The third-party API ID of the matching object.

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.

/item-fulfillments

Authentication

Headers

Query parameters

Request

Description

Usage Example

Response

Description

Usage Example

Field support by integration

Description

Usage Example

Description

Usage Example

Field support by integration