For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Logo
Resources
Log inGet a demo
Get startedAPI referenceImplementation
Get startedAPI referenceImplementation
    • Overview
          • The ItemFulfillment object
          • GET/item-fulfillments
          • POST/item-fulfillments
          • GET/item-fulfillments/{id}
          • GET/item-fulfillments/lines/remote-field-classes
          • GET/item-fulfillments/remote-field-classes
          • POST/item-fulfillments/bulk
          • GET/item-fulfillments/bulk/{batch_id}
UnifiedAgent HandlerGateway
UnifiedAgent HandlerGateway
Resources
Log inGet a demo
Common ModelsItem Fulfillments

The ItemFulfillment object

Beta
The ItemFulfillment Object
1{
2  "id": "string",
3  "remote_id": "string",
4  "created_at": "2023-01-01T00:00:00Z",
5  "modified_at": "2023-01-01T00:00:00Z",
6  "sales_order": "string",
7  "fulfillment_date": "2023-01-01T00:00:00Z",
8  "customer": "string",
9  "company": "string",
10  "status": "DRAFT",
11  "memo": "string",
12  "lines": [
13    {
14      "id": "string",
15      "remote_id": "string",
16      "created_at": "2023-01-01T00:00:00Z",
17      "modified_at": "2023-01-01T00:00:00Z",
18      "item": "string",
19      "sales_order_line": "string",
20      "quantity": "string",
21      "tracking_categories": [
22        "string"
23      ],
24      "remote_created_at": "2023-01-01T00:00:00Z",
25      "remote_updated_at": "2023-01-01T00:00:00Z",
26      "remote_was_deleted": true,
27      "remote_fields": [
28        {
29          "remote_field_class": {
30            "id": "string",
31            "display_name": "string",
32            "remote_key_name": "string",
33            "description": "string",
34            "is_custom": true,
35            "is_common_model_field": true,
36            "is_required": true,
37            "field_type": "string",
38            "field_format": "string",
39            "field_choices": [
40              "string"
41            ],
42            "item_schema": {
43              "item_type": "string",
44              "item_format": "string",
45              "item_choices": [
46                "string"
47              ]
48            }
49          },
50          "value": {
51            "string": {}
52          }
53        }
54      ]
55    }
56  ],
57  "remote_created_at": "2023-01-01T00:00:00Z",
58  "remote_updated_at": "2023-01-01T00:00:00Z",
59  "remote_was_deleted": true,
60  "field_mappings": {},
61  "remote_data": [
62    {
63      "path": "string",
64      "data": {}
65    }
66  ],
67  "remote_fields": [
68    {
69      "remote_field_class": {
70        "id": "string",
71        "display_name": "string",
72        "remote_key_name": "string",
73        "description": "string",
74        "is_custom": true,
75        "is_common_model_field": true,
76        "is_required": true,
77        "field_type": "string",
78        "field_format": "string",
79        "field_choices": [
80          "string"
81        ],
82        "item_schema": {
83          "item_type": "string",
84          "item_format": "string",
85          "item_choices": [
86            "string"
87          ]
88        }
89      },
90      "value": {
91        "string": {}
92      }
93    }
94  ]
95}
Was this page helpful?
Previous

/invoices/bulk/{batch_id}

Next

/item-fulfillments

Built with

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

idstringOptionalRead-onlyformat: "uuid"
remote_idstring or nullOptional

The third-party API ID of the matching object.

created_atdatetimeOptionalRead-only
The datetime that this object was created by Merge.
modified_atdatetimeOptionalRead-only
The datetime that this object was modified by Merge.
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.
statusenum or nullOptional

The status of the item fulfillment.

  • DRAFT - DRAFT
  • IN_PROGRESS - IN_PROGRESS
  • SHIPPED - SHIPPED
  • CANCELLED - CANCELLED
Allowed values:
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_was_deletedbooleanOptionalRead-only

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.

field_mappingsobject or nullOptionalRead-only
remote_datalist of objects or nullOptionalRead-only
remote_fieldslist of objectsOptionalRead-only