commerce/orders/packages

type: auditInfo

Basic audit info about the object, including date, time, and user account. This data may be captured when creating, updating, and removing data.

type: string

Identifier of the user that created the object. System created and read only.

type: DateTime

The date and time in UTC format set when the object was created.

type: string

Identifier of the user that updated the entity most recently.

type: DateTime

The date and time in UTC format the object was updated most recently.

type: list of string

Available actions you can complete for an order. These actions may differ depending on the status of the order, such as actions required to enter a payment, return of a package, and fulfillment of a shipment.

type: list of changeMessage

Collection (list or paged) of change messages logged for each modification made by a shopper to their carts, wishlists, orders, package, payment, pickup, and returns. Change log messages are system-supplied based on shopper actions and read only.

type: decimal

The amount of the order-level adjustment, which can be a positive or negative amount.

type: string

Unique identifier of an app available in your Kibo eCommerce tenant or within Kibo eCommerce Dev Center. This ID is unique across all apps installed, initialized, and enabled in the Admin and those in development through the Dev Center Console.

type: string

The application's key.

type: string

The application's name.

type: string

The unique identifier of the API request associated with the event action, which might contain multiple actions.

type: DateTime

The date and time in UTC format set when the object was created.

type: string

Unique identifier of the source property, such as a catalog, discount, order, or email template.

For a product field it will be the name of the field.

For a category ID, must be a positive integer not greater than 2000000. By default, Kibo eCommerce auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the useProvidedId query string in the endpoint. For example, api/commerce/catalog/admin/categories/?useProvidedId=true. Then, use the id property to specify the desired category ID.

For a product attribute it will be the Attribute FQN.

For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, bba0a1a885e2413bb097ceacf7bac366
or
bba0a1a8-85e2-413b-b097-ceacf7bac366.

For email templates, the ID must be one of the following values:
BackInStock
OrderChanged
OrderShipped
OrderFulfillmentDetailsChanged
ShopperLoginCreated
ShopperPasswordReset
ReturnCreated
ReturnAuthorized
ReturnUpdated
ReturnRejected
ReturnCancelled
ReturnClosed
RefundCreated
StoreCreditCreated
StoreCreditUpdated
GiftCardCreated

type: string

Identifier for the object associated with the change message, which can represent a cart, cart item, or an order.

type: string

The text of the change message, such as "This product is no longer available." System-supplied and read-only.

type: object

Metadata content for entities, used by document lists, document type lists, document type, views, entity lists, and list views.

type: string

The new value of the object affected by the change, such as the new price of the product. System-supplied and read-only.

type: string

The prior value of the object affected by the change, such as the price of the product when it was added to the cart. System-supplied and read-only.

type: string

The text that appears on the subject line of the message, such as "The product price has changed."

type: string

Represents the type of object affected by the change, such as Cart Item or Product. System-supplied and read-only.

type: bool

If true, the change associated with the message executed successfully.

type: string

The user's first name.

type: string

Unique identifier of the customer account (shopper or system user). System-supplied and read-only. If the shopper user is anonymous, the user ID represents a system-generated user ID string.

type: string

The user's last name.

type: string

The user type (e.g. Shopper, Admin, etc.).

type: string

The action associated with this message. For example, if the price of a product changes, the verb could be "Increased" or "Decreased". If the product is no longer available, the verb could be "Invalidated". System-supplied and read-only.

type: string

The unique identifier of the object.

type: DateTime

Date and time when a shipment completes fulfillment by delivery to a customer's physical address, picked up by a customer at a store, or delivered digitally for downloadable products.

type: string

The code that identifies the location used to fulfill the cart/cart item or order/order item. This code can include physical store locations for in-store pickup, warehouse locations providing the products for shipment, or the location for the digital file(s).

type: bool

If there is a shipping label present for this Package, this will be set to true

type: string

Unique identifier of the source property, such as a catalog, discount, order, or email template.

For a product field it will be the name of the field.

For a category ID, must be a positive integer not greater than 2000000. By default, Kibo eCommerce auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the useProvidedId query string in the endpoint. For example, api/commerce/catalog/admin/categories/?useProvidedId=true. Then, use the id property to specify the desired category ID.

For a product attribute it will be the Attribute FQN.

For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, bba0a1a885e2413bb097ceacf7bac366
or
bba0a1a8-85e2-413b-b097-ceacf7bac366.

For email templates, the ID must be one of the following values:
BackInStock
OrderChanged
OrderShipped
OrderFulfillmentDetailsChanged
ShopperLoginCreated
ShopperPasswordReset
ReturnCreated
ReturnAuthorized
ReturnUpdated
ReturnRejected
ReturnCancelled
ReturnClosed
RefundCreated
StoreCreditCreated
StoreCreditUpdated
GiftCardCreated

type: list of packageItem

A list of requested items. All returned data is provided in an items array.

For a failed request, the returned response may be success with an empty item array.

type: string

This specifies the fulfillment type of digital package item.

type: int

The line id associated with the fulfillment.

type: string

Fully qualified name of the selected option's attribute. Bundledproducts result from a static bundle or are dynamically added as a result of the shopper selecting products as extras. When the bundled item is dynamic, it includes the attribute's fully qualified name of the extra that it came from. When `optionAttributeFQN `is null, the bundled item was statically defined. When not null, the item came from an extra selection.

type: string

The unique, user-defined product code of a product, used throughout Kibo eCommerce to reference and associate to a product.

type: int

The specified quantity of objects and items. This property is used for numerous object types including products, options, components within a product bundle, cart and order items, returned items, shipping line items, items in a digital product. and items associated with types and reservations.

type: packageMeasurements

Dimensional properties (height, length, and width) of packages, products and bundles.

type: measurement

Height of the package in imperial units of feet and inches.

type: string

The unit of measurement, such as length or weight.

type: decimal

The value of a property, used by numerous objects within Kibo eCommerce including facets, attributes, products, localized content, metadata, capabilities (Kibo eCommerce and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type.

type: measurement

Length of the package in imperial units of feet and inches.

type: string

The unit of measurement, such as length or weight.

type: decimal

The value of a property, used by numerous objects within Kibo eCommerce including facets, attributes, products, localized content, metadata, capabilities (Kibo eCommerce and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type.

type: measurement

Weight of the package in imperial units of pounds and ounces.

type: string

The unit of measurement, such as length or weight.

type: decimal

The value of a property, used by numerous objects within Kibo eCommerce including facets, attributes, products, localized content, metadata, capabilities (Kibo eCommerce and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type.

type: measurement

Width of the package in imperial units of feet and inches.

type: string

The unit of measurement, such as length or weight.

type: decimal

The value of a property, used by numerous objects within Kibo eCommerce including facets, attributes, products, localized content, metadata, capabilities (Kibo eCommerce and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type.

type: string

The package type associated with this physical package. Possible values include Tube, Letter, Pak, Carrier_Box_Small, Carrier_Box_Medium, Carrier_Box_Large, or Custom.

type: string

The read-only, system-generated ID of the shipment associated with the shipment. When a package is first created, it is not associated with a shipment. However, once the CreatePackageShipments operation runs, it creates a shipment for the package (and any other packages that are part of the shipment) and generates shipping labels.

type: string

The code associated with a carrier's shipping method service type, used during fulfillment of packages and shipments. Service type codes include a prefix that indicates the carrier. For example: FEDEX_INTERNATIONAL_STANDARD and UPS_GROUND.

If using a custom rate, this property corresponds to the Custom Code field in Admin when you navigate to System > Shipping > Carriers, and then click on an existing rate or on Create New Custom Rate.

type: string

The carrier-supplied name for the shipping service type, such as "UPS Ground" or "2nd Day Air".

If using a custom rate, this property corresponds to the Name field in Admin when you navigate to System > Shipping > Carriers, and then click on an existing rate or on Create New Custom Rate.

type: string

The current status of the object.

This value is read only. Valid values for this field are: "Active", "Expired", and "Inactive".

type: string

Tracking number for the package or shipment, supplied by the shipping carrier to track the shipment until fulfillment completes. The tracking number format may differ between carriers.