class Falsify::Fulfillment

In Shopify, a fulfillment represents a shipment of one or more items in an order. You can use the Fulfillment resource to view, create, modify, or delete an order's fulfillments. See the [API documentation](help.shopify.com/en/api/reference/shipping-and-fulfillment/fulfillment).

Attributes

created_at[RW]

The date and time when the fulfillment was created. The API returns this value in [ISO 8601 format](en.wikipedia.org/wiki/ISO_8601). @return [String]

id[RW]

The ID for the fulfillment. @return [String]

line_items[RW]

A historical record of each item in the fulfillment. @return [Array<LineItem>]

location_id[RW]

The unique identifier of the location that the fulfillment should be processed for. To find the ID of the location, use the [Location resource](help.shopify.com/en/api/reference/inventory/location). @return [String]

name[RW]

The uniquely identifying fulfillment name, consisting of two parts separated by a `.`. The first part represents the order name and the second part represents the fulfillment number. The fulfillment number automatically increments depending on how many fulfillments are in an order (e.g. `#1001.1`, `#1001.2`). @return [String]

notify_customer[RW]

Whether the customer should be notified. If set to `true`, then an email will be sent when the fulfillment is created or updated. For orders that were initially created using the API, the default value is `false`. For all other orders, the default value is `true`. @return [Boolean]

order_id[RW]

The unique numeric identifier for the order. @return [String]

receipt[RW]

A text field that provides information about the receipt:

  • testcase : Whether the fulfillment was a testcase.

  • authorization : The authorization code.

@return [String]

service[RW]

The type of service used. @return [Hash]

tracking_company[RW]

The name of the tracking company. When creating a fulfillment for a supported carrier, send the `tracking_company` exactly as written in the list above. If the tracking company doesn't match one of the supported entries, then the shipping status might not be updated properly during the fulfillment process. @return [String]

tracking_numbers[RW]

A list of tracking numbers, provided by the shipping company.

It is highly recommended that you send the tracking company and the tracking URL as well. If neither one of these is sent, then the tracking company will be determined automatically. This can result in an invalid tracking URL.

The tracking URL is displayed in the shipping confirmation email, which can optionally be sent to the customer. When accounts are enabled, it is also displayed in the customer's order history.

@return [Array<String>]

tracking_urls[RW]

The URLs of tracking pages for the fulfillment. @return [Array<String>]

updated_at[RW]

The date and time ([ISO 8601 format](en.wikipedia.org/wiki/ISO_8601)) when the fulfillment was last modified.. @return [String]

variant_inventory_management[RW]

The name of the inventory management service. @return [String]