1. Fulfillments
  2. Models

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

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
The count of damaged items being shipped in a fulfillment or parcel. When used for a manifest, it counts how many items were damaged.

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

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

id string
The ID of the item to reference

serial_number string
The serial number of the Item, only applicable for asset items

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 Array.<"gift_wrapping", "personalized_note", "engraving", "embossing", "embroidery", "monogramming", "assembly", "installation", "protection">
Indicates any value added services requested for the inventory item

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

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

Show Details
Object.reason_code string
The enum for this object
Object.code string
The reason code
Object.type string
The type of reason code. Can be positive or negative
Object.description string
The description of the reason code
Object.active boolean
Indicates whether the reason code is active

Inventory Model

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

object "inventory"
The enum for this object

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
The count of damaged items being shipped in a fulfillment or parcel. When used for a manifest, it counts how many items were damaged.

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

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.

harmonized_code string
The Harmonized System Code. See more.

id string
The ID of the item to reference

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

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

serial_number string
A unique number given to an asset

image_url string
A thumbnail image for the inventory

name string
The name of the inventory 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 each individual item in USD cents

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



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

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

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 Array
The URL to the PDF of the packing slip for all items added to inventory

parcels Array.<Parcel>
All parcels in the fulfillment and the inventory packed within them

Show Details
Parcel.object "parcel"
The enum for this object
Parcel.id string
The unique ID assigned to the parcel beginning with prcl_
Parcel.length float
The length of the parcel in inches
Parcel.width float
The width of the parcel in inches
Parcel.height float
The height of the parcel in inches
Parcel.weight float
The weight of the parcel in pounds (lbs)
Parcel.type enum
The type of package if selecting from carrier specific packaging. See Predefined Packages
Parcel.special_handling string
Special handling instructions for the parcel.
Parcel.tracking_number string
The tracking number for this parcel if a shipment was purchased
Parcel.label_url string
The shipping label PDF for this parcel if a shipment was purchased
Parcel.inventory Inventory
The inventory packed inside of the parcel
Parcel.contents Inventory
The inventory packed inside of the parcel

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

Show Details
recipient.address Address
The parsed address for this recipient See Address
recipient.email string
Email for the recipient. Recipient will receive tracking notifications here
recipient.phone string
Phone number of the recipient. On demand couriers may contact this number for issues
recipient.name string
Name of the recipient, printed on the shipping label
recipient.contact_id string
The ID of the contact if one was used to create this recipient.
recipient.location_id string
The location ID if the recipient is an internal location
recipient.federal_tax_id string
Federal tax ID for the recipient, used for international customs declarations. Masked in responses
recipient.state_tax_id string
State tax ID for the recipient. Masked in responses
recipient.tax_identifiers TaxIdentifier[]
Array of tax identifiers for the recipient. Tax ID values are masked in responses

sender object
Details about the contact sending this shipment

Show Details
sender.address object
Parsed address for the sender. See Address
sender.email string
Email for the sender
sender.phone string
Phone number of the sender. On demand couriers may contact this number for issues.
sender.name string
Name of the sender, printed on the shipping label
sender.contact_id string
The ID of the contact if one was used to create this sender.
sender.federal_tax_id string
Federal tax ID for the sender, used for international customs declarations. Masked in responses
sender.state_tax_id string
State tax ID for the sender. Masked in responses
sender.tax_identifiers TaxIdentifier[]
Array of tax identifiers for the sender. Tax ID values are masked in responses

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:

Show Rate Types
in_person_pickup
The recipient will pick up at your location
curbside_pickup
The recipient will indicate when they are curbside
locker_pickup
The recipient will pick up from a locker
provider_delivery
A shipping provider will deliver the shipment
offline_delivery
The shipment will be negotiated outside of the PackageX platform

status string
The status of the fulfillment

Show Details
created
The fulfillment was created either by you or a third party.
processing
Some activity occurred on the fulfillment, like a parcel being created.
picked
All items have been picked from inventory. This step is optional.
packed
The fulfillment has been packed.
shipping
A shipping label has been purchased and the fulfillment is in transit.
completed
The fulfillment is packaged and transport has been organized.
canceled
The fulfillment was canceled.

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

shipment_options object
The shipment options for the fulfillment

Show Details | | | :------------------------------------------------------------------------------------------ | | **provider_timeout** `integer`
The timeout value for shipping provider | | **verify_addresses** `boolean`
Whether to validate sender and recipient addresses | | **checkout_total** `integer`
The shipment checkout total | | **lead_time_mins** `integer`
The shipment lead time in minutes | | **provider_instructions** `string`
The shipment provider instructions | | **same_day_tip_amount** `integer`
The tip amount for same day service level | | **request_provider_pickup** `boolean`
Whether to request provider pickup | | **providers** `array`
List of shipment providers | | **service_levels** `array`
List of service levels enabled for this fulfillment | | **max_delivery_days** `array`
Maximum number of delivery days | | **rate_types** `array`
The types of rates to get for the shipment associated with this fulfillment. Can be `delivery`, `pickup`, `received` | | **return_other_rates** `boolean`
Whether to return rates other than the ones specified in rate_types | | **tracker_chained_status** `string`
The tracker chained status. Defaults to `package_at_waypoint` | | **tracker_auto_close_shipments_option** `string`
Tracker auto close shipments option. Defaults to `on_provider_updates` | | **tracker_auto_close_shipments_status** `string`
Tracker auto close shipments status. Defaults to `delivered` | | **incoterm** `string`
International fulfillments only. Can be `DDP` or `DAP` | | **content_type** `string`
International fulfillments only. Specifies the content type for customs. Can be `documents`, `gift`, `merchandise`, `returned_goods`, `sample`, `dangerous_goods`, `humanitarian_donation`, or `other` | | **non_delivery_option** `string`
International fulfillments only. Can be `return` or `abandon` | | **restriction_type** `string`
International fulfillments only. Can be `none`, `other`, `quarantine` or `sanitary_phytosanitary_inspection` | | **itn_number** `string`
International fulfillments only. The Internal Transaction Number (for U.S. Exports) | | **signer** `string`
International fulfillments only. Name of the signer | | **contents_explanation** `string`
International fulfillments only. Description of contents if the `content_type` is "other" | | **restriction_comments** `string`
International fulfillments only. Description of restriction if the `restriction_type` is not `none`| | **customs_certify** `boolean`
International fulfillments only. Whether the customs declaration has been certified |

Previous <- Fulfillments Overview
Next Fulfillment Events ->