Manifests

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

Manifest Model

The manifest model represents a unique manifest containing the inventory that you would like to track.

object "manifest"
The description of the model.

created_at integer
Time in epoch seconds when this resource was created

estimated_delivery_at integer
Time in epoch seconds when the last package of the manifest is going to arrive. This date is derived from tracking numbers entered when creating the manifest.

id string
The unique ID given to this manifest prefixed with mfst_

inventory Array.<Inventory>
The inventory that is included in the manifest

articles Array.<Article>
The articles that are included in the manifest

location_id string
The ID of the location to which this manifest is being delivered

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

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

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

arrived_at integer
The timestamp at which the manifest arrived.

processing_at integer
The timestamp at which the manifest processing was started.

processed_at integer
The timestamp at which the manifest processing was completed.

rejected_at integer
The timestamp at which the manifest was rejected.

reason_code object
The reason code associated to the manifest. See the Reason Codes.

external_id string
The external id of the manifest.

alternate_external_id string
Alternate external id of the manifest.

invoice_number string
The invoice number of the manifest.

purchase_order_number string
The purchase order number of the manifest.

reference_number string
The reference number of the manifest.

customer_purchase_order_number string
The customer purchase order number of the manifest.

container_number string
Container number of the overall manifest.

load_number string
The load number of the manifest.

linked_fulfillment object
An object containing the id of associated fulfillment. This is populated when fulfilling goods from one location within the org to another.

parent_manifest object
If the org setting for manifest partial completion option is set to create_new, a new manifest is created from any remaining article quantities not received in the current manifest. parent_manifest is populated in the newly created manifest with the id of the current one.

options object
Additional options for the manifest

Show Details

| | | :------------------------------------------------------------------------------------------ | | **partial_completion** `boolean`
Whether to allow partial completion of the manifest | | **verify_addresses** `boolean`
Whether to validate sender and recipient addresses |

tracking_numbers Array.<string>
A list of all tracking numbers for this manifest. When added, trackers will be created for each tracking number which will then update the estimated_delivery_at property.

attachments Array.<ManifestAttachment>
An array of documents associated with this manifest.

Show Details


Object.document_type `string` Describes the type of the document like `warranty card`, `user_manual`, `invoice`, `transfer_order`, `POD`, `asset_request`, `other`
Object.url `string` The bucket URL for the document
Object.external_url `string` URL for documents attached from external sources
Object.document_name `string` The name of the document

recipient object
Details about the contact receiving this shipment

sender object
Details about the contact sending this shipment

shipment_info object
Details about the shipment being received

Show Details


Object.provider `string` The shipment provider
Object.tracker_type `string` The shipment tracker type
Object.tracking_number `string` The shipment tracking number for the manifest
Object.document_number `string` The document number for the manifest
Object.shipment_contact `object` The shipment contact associated to the manifest

parcels Array.<Parcel>
All parcels in the manifest 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](/apis/shipments/packages-and-labels#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`](#inventory-model)
The inventory packed inside of the parcel | | Parcel.**contents** [`Inventory`](#inventory-model)
The inventory packed inside of the parcel |

status string
The status of the manifest

Show Details


requested The manifest was created either by you or a third party.
accepted Someone in your organization approved the manifest. Any items in the `created_inventory` were created and inventory counts from this manifest were added to the `manifested_qty` on the item.
processing There was activity performed on an accepted manifest. This status will automatically update when inventory begins being verified.
completed All items have been scanned from the manifest and the manifest quantities are added to inventory.
void The manifest is canceled. Any quantities added to it will be removed from inventory.

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

Models

# Article Model

# Manifest Model

On this page

Article Model

Manifest Model