Item Fulfillments
The ItemFulfillment object represents the recorded shipment or delivery of some or all items on an associated sales order.
Properties
idUUID
remote_idString
The third-party API ID of the matching object.
created_atDateTime (ISO 8601)
The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)
The datetime that this object was modified by Merge.
sales_orderUUID
The ID of the sales order that the item fulfillment originated from.
fulfillment_dateDateTime (ISO 8601)
The date the fulfillment was created.
customerUUID
The customer associated with the item fulfillment.
companyUUID
The subsidiary associated with the fulfillment.
statusEnum
The status of the item fulfillment. Possible values include: DRAFT, IN_PROGRESS, SHIPPED, CANCELLED. In cases where there is no clear mapping, the original value passed through will be returned. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.
memoString
Comment attached to the fulfillment.
linesItemFulfillmentLine[]
The ItemFulfillmentLine object
The ItemFulfillmentLine object represents the specific quantity of a particular product or service that has actually been shipped or delivered against its corresponding order line.
Properties
idUUID
remote_idString
The third-party API ID of the matching object.
created_atDateTime (ISO 8601)
The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)
The datetime that this object was modified by Merge.
itemUUID
sales_order_lineUUID
quantityString
The amount of item being delivered.
tracking_categoriesArray
The dimensions or classification tags.
remote_created_atDateTime (ISO 8601)
When the third party's item fulfillment line item was created.
remote_updated_atDateTime (ISO 8601)
When the third party's item fulfillment line item was updated.
remote_was_deletedBoolean
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.
remote_fieldsRemoteField[]
remote_created_atDateTime (ISO 8601)
When the third party's item fulfillment was created.
remote_updated_atDateTime (ISO 8601)
When the third party's item fulfillment was updated.
remote_was_deletedBoolean
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
remote_dataRemoteData[]
The RemoteData object
The RemoteData object is used to represent the full data pulled from the third-party API for an object.
Properties
pathString
The third-party API path that is being called.
dataAny
The data returned from the third-party for this object in its original, unnormalized format.
remote_fieldsRemoteField[]
GET
/item-fulfillments
Beta

https://api.merge.dev/api/accounting/v1/item-fulfillments

US
EU
APAC

Returns a list of ItemFulfillment objects.


Query & path parameters
cursorString
Optional
The pagination cursor value.
expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_dataBoolean
Optional
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_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_remote_fieldsBoolean
Optional
Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
include_shell_dataBoolean
Optional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
page_sizeInteger
Optional
Number of results to return per page. The maximum limit is 100.
remote_fieldsString
Optional
Deprecated. Use show_enum_origins.
show_enum_originsString
Optional
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
Field support by integration
Use the /linked-accounts endpoint to pull platform support information
NetSuite
NetSuite
Not seeing an integration that you're looking for?
POST
/item-fulfillments
Beta

https://api.merge.dev/api/accounting/v1/item-fulfillments

US
EU
APAC

Creates an ItemFulfillment object with the given values. To run asynchronously, see our guide.


Query & path parameters
is_debug_modeBoolean
Optional
Whether to include debug fields (such as log file links) in the response.
run_asyncBoolean
Optional
Whether or not third-party updates should be run asynchronously.
Body parameters
modelObject
Required
Find available fields below under “Model Parameters”.
Model parameters
View app-specific writable fields under “Field support by platform” in this section.
sales_orderUUID
The ID of the sales order that the item fulfillment originated from. Must pass in a valid Merge ID, which can be obtained from the id field in the SalesOrder object.
fulfillment_dateDateTime (ISO 8601)
The date the fulfillment was created.
customerUUID
The customer associated with the item fulfillment. Must pass in a valid Merge ID, which can be obtained from the id field in the Contact object.
companyUUID
The subsidiary associated with the fulfillment. Must pass in a valid Merge ID, which can be obtained from the id field in the CompanyInfo object.
statusEnum
The status of the item fulfillment. Must pass in one of the following choices: DRAFT, IN_PROGRESS, SHIPPED, CANCELLED.
memoString
Comment attached to the fulfillment.
integration_paramsObject
linked_account_paramsObject
remote_fieldsArray
Field support by integration
Use the /linked-accounts endpoint to pull platform support information
NetSuite
NetSuite
Not seeing an integration that you're looking for?
To include the correct model fields when making POST requests, use the GET /item-fulfillments/meta/post endpoint. Learn more in our /meta guide.
GET
/item-fulfillments/{id}
Beta

https://api.merge.dev/api/accounting/v1/item-fulfillments/{id}

US
EU
APAC

Returns an ItemFulfillment object with the given id.


Query & path parameters
expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
idUUID
Required
include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_remote_fieldsBoolean
Optional
Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
include_shell_dataBoolean
Optional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
remote_fieldsString
Optional
Deprecated. Use show_enum_origins.
show_enum_originsString
Optional
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
Field support by integration
Use the /linked-accounts endpoint to pull platform support information
NetSuite
NetSuite
Not seeing an integration that you're looking for?
GET
/item-fulfillments/batch/{batch_id}/objects
Beta

https://api.merge.dev/api/accounting/v1/item-fulfillments/batch/{batch_id}/objects

US
EU
APAC

Returns a list of ItemFulfillment objects.


Query & path parameters
batch_idUUID
Required
cursorString
Optional
The pagination cursor value.
expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_dataBoolean
Optional
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_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_remote_fieldsBoolean
Optional
Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
include_shell_dataBoolean
Optional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
page_sizeInteger
Optional
Number of results to return per page. The maximum limit is 100.
remote_fieldsString
Optional
Deprecated. Use show_enum_origins.
show_enum_originsString
Optional
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
Field support by integration
Use the /linked-accounts endpoint to pull platform support information
NetSuite
NetSuite
Not seeing an integration that you're looking for?
GET
/item-fulfillments/lines/remote-field-classes
Beta

https://api.merge.dev/api/accounting/v1/item-fulfillments/lines/remote-field-classes

US
EU
APAC

Returns a list of RemoteFieldClass objects.


Query & path parameters
cursorString
Optional
The pagination cursor value.
include_deleted_dataBoolean
Optional
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_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_dataBoolean
Optional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
is_common_model_fieldBoolean
Optional
If provided, will only return remote field classes with this is_common_model_field value
is_customBoolean
Optional
If provided, will only return remote fields classes with this is_custom value
page_sizeInteger
Optional
Number of results to return per page. The maximum limit is 100.
GET
/item-fulfillments/meta/post
Beta

https://api.merge.dev/api/accounting/v1/item-fulfillments/meta/post

US
EU
APAC

Returns metadata for ItemFulfillment POSTs.


Field support by integration
Use the /linked-accounts endpoint to pull platform support information
NetSuite
NetSuite
Not seeing an integration that you're looking for?
GET
/item-fulfillments/remote-field-classes
Beta

https://api.merge.dev/api/accounting/v1/item-fulfillments/remote-field-classes

US
EU
APAC

Returns a list of RemoteFieldClass objects.


Query & path parameters
cursorString
Optional
The pagination cursor value.
include_deleted_dataBoolean
Optional
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_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_dataBoolean
Optional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
is_common_model_fieldBoolean
Optional
If provided, will only return remote field classes with this is_common_model_field value
is_customBoolean
Optional
If provided, will only return remote fields classes with this is_custom value
page_sizeInteger
Optional
Number of results to return per page. The maximum limit is 100.
Previous
Invoices
Next Up
Items