Fulfillments

Models

# Article Model

An article model is an item or asset inside of a manifest, fulfillment, or parcel.

object "article"
The enum for this object

id string
The unique ID of this article, prefixed with art_

item_id string
The ID of the item associated with this article

attributes Array.<"alcohol", "marijuana", "pharma", "dry_ice", "lithium">
Indicates certain aspects of the item that will impact shipping and handling

comment string
A free text field to add any comments about this item

damaged_qty integer (deprecated)
The count of defective items. Deprecated: use defective_qty instead.

defective_qty integer
The count of items identified as defective.

verified_qty integer (deprecated)
The count of verified items. Deprecated: use received_qty instead.

received_qty integer
The count of items that have been received.

manifested_qty integer
This value can be updated by the end user for staging inventory, like in a common two-step pick & pack process for a fulfillment. For a manifest, this value is prefilled indicating how many items are expected in the manifest.

requested_qty integer
The count of items being requested in a fulfillment or parcel. When used for a manifest, it counts how many items were requested.

picked_qty integer
The picked quantity of the item or asset.

packed_qty integer
The packed quantity of the item or asset.

gtin string
The Global Trade Item Number, typically found on barcodes

sku string
The unique identifier that is added by you for this item

harmonized_code string
The harmonized system code for the item. This is required if you will be shipping this item internationally

image_url string
A thumbnail image for the inventory

image_urls Array.<string>
Other images for the inventory

name string
The name of the item

origin_country string
The two character country code. ISO 3166-1 alpha-2

vendor string
The company that created the inventory

value integer
The value of the inventory

value_added_services object[]
Value-added services requested for the inventory item. See Value Added Services

packaged_length float
The length in inches of the product packaging

packaged_width float
The width in inches of the product packaging

packaged_height float
The height in inches of the product packaging

packaged_weight float
The weight in pounds (lbs) of the product packaging

order_line_number string
The order line number for the item in the article

ship_ready boolean
Indicates whether the item associated to the article is ready to ship.

metadata object
These are your metadata key value pairs added to the article

description string
The description of the item associated to this article.

tariff_codes array
The tariff codes of the item associated to this article

manufacturer_numbers Array.<string>
The manufacturer or serial numbers of the individual assets in this article.

is_asset boolean
Indicates whether this article represents an asset item.

asset_id string
The ID of the asset associated with this article, if applicable.

layout object
Layout information associated with this article.

article_levels object
Represents the layouts from which the article quantity is picked or packed. The object contains two keys; recommended and others. recommended contains an array of layouts from which the user has picked the items from, or the layouts that the user should pick the items from, based on org settings. others is an array of layouts on which additional quantity for the article item is available. Each entry in these arrays contains the layout and location information, as well the quantity of the item available, picked and packed from the said layout when fulfilling an order.

reason_code ReasonCode
Reason code associated with this article

# Fulfillment Model

The fulfillment model represents a unique fulfillment containing the articles that was sent to the recipient.

object "fulfillment"
The description of the model.

cancel_reason string
If the fulfillment gets canceled, a reason can be optionally provided here.

created_at integer
Time in epoch seconds when this resource was created

complete_at integer
Time in epoch seconds by which this fulfillment should be completed

id string
The unique ID given to this fulfillment prefixed with ful_

external_id string
An external identifier for this fulfillment, useful for linking with third-party systems.

alternate_external_id string
An alternate external identifier for this fulfillment.

articles Array.<Article>
The articles that needs to be shipped in this fulfillment

inventory Array.<Article>
Alias for articles. Returns the same array of article objects.

shipment_label_url string
The URL of the shipping label that gets generated when the fulfillment is completed

location_id string
The ID of the location from which this fulfillment is being shipped

metadata object
These are your metadata key value pairs added to the fulfillment

order_number string
The order number that either you provided to the fulfillment or that PackageX added automatically

sales_order_number string
The sales order number associated with this fulfillment. This is separate from the order_number and can be used to reference the original sales order.

partial_fulfillment boolean
Indicates whether this is a partial fulfillment, meaning only some of the items from the original order are being fulfilled. Defaults to false.

additional_notes string
Additional notes or comments about this fulfillment.

tracking_number string
The tracking number for the shipment associated with this fulfillment. Derived from the linked shipment.

organization_id string
The ID of the organization that owns this fulfillment. In almost all cases, this will be your organization ID.

packaging_recommendations Array
A list of the recommended way(s) to package to product into parcels if any shipping boxes are predefined in the settings. This is currently an empty array for all users.

packing_slip_url string
The URL to the PDF of the packing slip for all items added to inventory. Only available when the fulfillment status is packed, shipping, or completed.

parcels Array.<Parcel>
All parcels in the fulfillment and the inventory packed within them. See the Parcel Model for full details.

rates_generated_at integer
Time in epoch seconds when shipping rates were generated for this fulfillment. Shipping rates are only valid for 15 minutes after which new rates must be fetched.

active_steps string
Fulfillment steps active for the fulfillment. These are either set from the org settings, or are declared at the time of fulfillment creation. The active steps can be any of the following: pick, pack, pick_ship, pack_ship, and pick_pack_ship.

type string
Fulfillment type, can be domestic or international

reason_code object
The reason code associated to the fulfillment. The reason code model follows the same structure as the article reason codes.

recipient object
Details about the contact receiving this shipment

sender object
Details about the contact sending this shipment

shipment_id string
The ID of the shipment associated with this fulfillment, prefixed with ship_

shipment_rate_type string
The type of rate that was purchased for the shipment linked to the fulfillment without needing to query the shipment. Options include:

shipment_provider string
The shipping carrier or provider used for the shipment linked to this fulfillment (e.g., ups, fedex, usps).

shipment_purchased_rate object
The rate that was purchased for the shipment associated with this fulfillment.

status string
The status of the fulfillment

updated_at integer
Time in epoch seconds when this resource was last updated

finished_at integer
Time in epoch seconds when this fulfillment was completed

updated_by string
The ID of the user or API key that last updated this fulfillment

updated_by_details object
Details about the user who last updated this fulfillment.

user_id string
The ID of the user associated with this fulfillment

checksum string
A checksum of the fulfillment object, useful for detecting changes

shipment_options object
The shipment options for the fulfillment

options object
Fulfillment-specific options that control inventory and packing behavior.

location object
A summary of the location from which this fulfillment is being shipped.