/item-fulfillments/{id}

Returns an ItemFulfillment object with the given id.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

Query parameters

expandenumOptional

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

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

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

idstring or nullRead-onlyformat: "uuid"

remote_idstring or null

The third-party API ID of the matching object.

created_atdatetime or nullRead-only

The datetime that this object was created by Merge.

modified_atdatetime or nullRead-only

The datetime that this object was modified by Merge.

sales_orderstring or nullformat: "uuid"

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

fulfillment_datedatetime or null

The date the fulfillment was created.

customerstring or nullformat: "uuid"

The customer associated with the item fulfillment.

companystring or nullformat: "uuid"

The subsidiary associated with the fulfillment.

statusenum or null

The status of the item fulfillment.

DRAFT - DRAFT
IN_PROGRESS - IN_PROGRESS
SHIPPED - SHIPPED
CANCELLED - CANCELLED

The status of the item fulfillment. * `DRAFT` - DRAFT * `IN_PROGRESS` - IN_PROGRESS * `SHIPPED` - SHIPPED * `CANCELLED` - CANCELLED

Allowed values:

memostring or null

Comment attached to the fulfillment.

lineslist of objects or nullRead-only

remote_created_atdatetime or null

When the third party's item fulfillment was created.

remote_updated_atdatetime or null

When the third party's item fulfillment was updated.

remote_was_deletedboolean or nullRead-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 nullRead-only

remote_datalist of objects or nullRead-only

remote_fieldslist of objects or nullRead-only

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

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

1	import requests
2
3	url = "https://api.merge.dev/api/accounting/v1/item-fulfillments/id"
4
5	querystring = {"expand":"lines,sales_order,customer,company","remote_fields":"status","show_enum_origins":"status"}
6
7	headers = {
8	"X-Account-Token": "X-Account-Token",
9	"Authorization": "Bearer <token>"
10	}
11
12	response = requests.get(url, headers=headers, params=querystring)
13
14	print(response.json())

1	{
2	"id": "0048ea5b-911e-4dff-9364-92070dea62ff",
3	"remote_id": "IF-12345",
4	"created_at": "2021-09-15T00:00:00Z",
5	"modified_at": "2021-10-16T00:00:00Z",
6	"sales_order": "b26fd49a-cbae-470a-a8f8-bcbc119e0390",
7	"fulfillment_date": "2022-04-10T00:00:00Z",
8	"customer": "2f9edc34-c92a-48c0-b2c6-e9e0e3bc407b",
9	"company": "595c8f97-2ac4-45b7-b000-41bdf43240b5",
10	"status": "SHIPPED",
11	"memo": "Shipped via FedEx",
12	"lines": [
13	{
14	"remote_id": "121222",
15	"item": "0958cbc6-6040-430a-848e-aafacbadf4ae",
16	"quantity": "10",
17	"tracking_categories": [
18	"f1214c24-2702-4617-b74b-3ddecfc0d384"
19	]
20	},
21	{
22	"remote_id": "121223",
23	"item": "249c9faa-3045-4a31-953b-8f22d3613301",
24	"quantity": "5",
25	"tracking_categories": [
26	"f1214c24-2702-4617-b74b-3ddecfc0d384"
27	]
28	}
29	],
30	"remote_created_at": "2020-03-31T00:00:00Z",
31	"remote_updated_at": "2020-03-31T00:00:00Z",
32	"remote_was_deleted": true,
33	"field_mappings": {
34	"organization_defined_targets": {
35	"custom_key": "custom_value"
36	},
37	"linked_account_defined_targets": {
38	"custom_key": "custom_value"
39	}
40	},
41	"remote_data": [
42	{
43	"path": "/actions"
44	}
45	],
46	"remote_fields": [
47	{
48	"remote_field_class": {
49	"id": "string",
50	"display_name": "string",
51	"remote_key_name": "string",
52	"description": "string",
53	"is_custom": true,
54	"is_common_model_field": true,
55	"is_required": true,
56	"field_type": "string",
57	"field_format": "string",
58	"field_choices": [
59	"string"
60	],
61	"item_schema": {
62	"item_type": "string",
63	"item_format": "string",
64	"item_choices": [
65	"string"
66	]
67	}
68	},
69	"value": "string"
70	}
71	]
72	}

/item-fulfillments/{id}

Authentication

Path parameters

Headers

Query parameters

Response

Field support by integration

Field support by integration