Item Fulfillments
The
ItemFulfillment object represents the recorded shipment or delivery of some or all items on an associated sales order.Properties
idUUIDremote_idStringThe 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_orderUUIDThe ID of the sales order that the item fulfillment originated from.
fulfillment_dateDateTime (ISO 8601)The date the fulfillment was created.
customerUUIDThe customer associated with the item fulfillment.
companyUUIDThe subsidiary associated with the fulfillment.
statusEnumThe 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.memoStringComment 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
idUUIDremote_idStringThe 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.
itemUUIDquantityStringThe amount of item being delivered.
tracking_categoriesArrayThe 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_deletedBooleanIndicates 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_deletedBooleanIndicates 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_mappingsObjectremote_dataRemoteData[]The RemoteData object
The
RemoteData object is used to represent the full data pulled from the third-party API for an object.Properties
pathStringThe third-party API path that is being called.
dataAnyThe data returned from the third-party for this object in its original, unnormalized format.
remote_fieldsRemoteField[]GET
/item-fulfillments/lines/remote-field-classes
Betahttps://api.merge.dev/api/accounting/v1/item-fulfillments/lines/remote-field-classes
US
EU
APAC
Returns a list of RemoteFieldClass objects.
Query & path parameters
cursorStringOptional
The pagination cursor value.
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_shell_dataBooleanOptional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
is_common_model_fieldBooleanOptional
If provided, will only return remote field classes with this is_common_model_field value
is_customBooleanOptional
If provided, will only return remote fields classes with this is_custom value
page_sizeIntegerOptional
Number of results to return per page. The maximum limit is 100.
GET
/item-fulfillments/remote-field-classes
Betahttps://api.merge.dev/api/accounting/v1/item-fulfillments/remote-field-classes
US
EU
APAC
Returns a list of RemoteFieldClass objects.
Query & path parameters
cursorStringOptional
The pagination cursor value.
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_shell_dataBooleanOptional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
is_common_model_fieldBooleanOptional
If provided, will only return remote field classes with this is_common_model_field value
is_customBooleanOptional
If provided, will only return remote fields classes with this is_custom value
page_sizeIntegerOptional
Number of results to return per page. The maximum limit is 100.