commerce/returns

Use the Returns resource to manage returned items that were previously fufilled. Returns can include any number of items associated with an original Kibo eCommerce order. Each return must either be associated with an original order or a product definition to represent each returned item.

Refer to the Returns API topic for more information about creating and processing returns using the API.

JSON Example

Return Properties

Property	Description
auditInfo	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.
auditInfo.createBy	type: string Identifier of the user that created the object. System created and read only.
auditInfo.createDate	type: DateTime The date and time in UTC format set when the object was created.
auditInfo.updateBy	type: string Identifier of the user that updated the entity most recently.
auditInfo.updateDate	type: DateTime The date and time in UTC format the object was updated most recently.
availableActions	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.
changeMessages	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.
changeMessage.amount	type: decimal The amount of the order-level adjustment, which can be a positive or negative amount.
changeMessage.appId	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.
changeMessage.appKey	type: string The application's key.
changeMessage.appName	type: string The application's name.
changeMessage.correlationId	type: string The unique identifier of the API request associated with the event action, which might contain multiple actions.
changeMessage.createDate	type: DateTime The date and time in UTC format set when the object was created.
changeMessage.id	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
changeMessage.identifier	type: string Identifier for the object associated with the change message, which can represent a cart, cart item, or an order.
changeMessage.message	type: string The text of the change message, such as "This product is no longer available." System-supplied and read-only.
changeMessage.metadata	type: object Metadata content for entities, used by document lists, document type lists, document type, views, entity lists, and list views.
changeMessage.newValue	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.
changeMessage.oldValue	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.
changeMessage.subject	type: string The text that appears on the subject line of the message, such as "The product price has changed."
changeMessage.subjectType	type: string Represents the type of object affected by the change, such as Cart Item or Product. System-supplied and read-only.
changeMessage.success	type: bool If true, the change associated with the message executed successfully.
changeMessage.userFirstName	type: string The user's first name.
changeMessage.userId	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.
changeMessage.userLastName	type: string The user's last name.
changeMessage.userScopeType	type: string The user type (e.g. Shopper, Admin, etc.).
changeMessage.verb	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.
channelCode	type: string Code that identifies the channel associated with the site for the shopper's created shopping cart, order, and return.
contact	type: contact Contact information for an account.
contact.address	type: address Address information to supply for a contact.
contact.address.address1	type: string Physical or mailing address line one. Usually includes the street number and street name or it could be a P.O. Box. Max length: 200.
contact.address.address2	type: string Physical or mailing address line two. Usually supplements the main street address with apartment, floor, suite, building, or unit information. Max length: 200.
contact.address.address3	type: string Physical or mailing address line three. Max length: 200.
contact.address.address4	type: string Physical or mailing address line four. Max length: 200.
contact.address.addressType	type: string The type of address, which is commercial or residential.
contact.address.cityOrTown	type: string The entered city or town for the address.
contact.address.countryCode	type: string The 2-letter geographic code representing the country for the physical or mailing address. Currently limited to the US.
contact.address.isValidated	type: bool Indicates if the address has been validated. If true, the address has been verified by an address validation service.
contact.address.postalOrZipCode	type: string The entered zip or postal code for an address.
contact.address.stateOrProvince	type: string The entered state or province for an address.
contact.companyOrOrganization	type: string The entered company or organization name entered for a customer account.
contact.email	type: string The email address for the customer account and contact. This email may be used for login to the storefront, receiving in-stock product notifications, and subscription mailing lists.
contact.firstName	type: string The full first name of a customer or contact name.
contact.id	type: int 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
contact.lastNameOrSurname	type: string The full last name or surname of a customer or contact name.
contact.middleNameOrInitial	type: string Character string of the middle name or initial for the customer.
contact.phoneNumbers	type: phone List of phone numbers associated with the customer account contact. The phone numbers include area codes.
contact.phone.home	type: string Home phone number.
contact.phone.mobile	type: string Mobile phone number.
contact.phone.work	type: string Work phone number.
currencyCode	type: string The localized currency code for the monetary amount.
customerAccountId	type: int Unique identifer of the customer account. This ID is used to associate numerous types of data and object with the customer account, including orders, returns, wish lists, and in-store credit.
customerInteractionType	type: string The type of customer interaction used to create this shopping cart. Possible values are Website, Call, Store, or Unknown.
id	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
items	type: list of returnItem 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.
returnItem.bundledProducts	type: list of returnBundle Properties of a collection of component products that make up a single product bundle with its own product code. Tenants can define product bundles for any product type that supports the Bundle product usage.
returnItem.returnBundle.productCode	type: string The unique, user-defined product code of a product, used throughout Kibo eCommerce to reference and associate to a product.
returnItem.returnBundle.quantity	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.
returnItem.excludeProductExtras	type: bool Specifies whether to exclude product extras when you return a product or bundle. For example, assume the following order items: Product Bundle Product A (bundle item) Product B (bundle item) Product C (bundle item) Product D (extra on bundle) Product E Product F (extra on product) If this property is false, Products D or F are included when the bundle or Product E are added to a return. If this property is true, Products D or F are not included unless added individually. Tip: This property is nullable, so the possible values are true, false, or null (empty, defaults to false behavior).
returnItem.id	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
returnItem.notes	type: list of orderNote Paged list collection of note content for objects including customers, orders, and returns.
returnItem.orderNote.auditInfo	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.
returnItem.orderNote.auditInfo.createBy	type: string Identifier of the user that created the object. System created and read only.
returnItem.orderNote.auditInfo.createDate	type: DateTime The date and time in UTC format set when the object was created.
returnItem.orderNote.auditInfo.updateBy	type: string Identifier of the user that updated the entity most recently.
returnItem.orderNote.auditInfo.updateDate	type: DateTime The date and time in UTC format the object was updated most recently.
returnItem.orderNote.id	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
returnItem.orderNote.text	type: string The text content of the order note.
returnItem.orderItemId	type: string Unique identifier of the order item associated with a validation message, order, or return.
returnItem.orderItemOptionAttributeFQN	type: string This is the Option attribute FQN for the item being returned .. typically only when the return item is a product bundle item.
returnItem.orderLineId	type: int The OrderLineId that this ReturnItem is associated with. If order item is present, the orderLineId should be present also.
returnItem.product	type: product The properties of a product, referenced and used by carts, orders, wish lists, and returns.
returnItem.product.allocationExpiration	type: DateTime Allocation ID associated with this product on this order.
returnItem.product.allocationId	type: int Allocation ID associated with this product on this order.
returnItem.product.bundledProducts	type: list of bundledProduct Properties of a collection of component products that make up a single product bundle with its own product code. Tenants can define product bundles for any product type that supports the Bundle product usage.
returnItem.product.bundledProduct.allocationExpiration	type: DateTime Allocation ID associated with this product on this order.
returnItem.product.bundledProduct.allocationId	type: int Allocation ID associated with this product on this order.
returnItem.product.bundledProduct.creditValue	type: decimal The credit value of the product or bundled product. When the `goodsType `is `DigitalCredit`, this value is populated to indicate the value of the credit. This is used to create store credit in the fulfillment of gift cards.
returnItem.product.bundledProduct.deltaPrice	type: decimal If the product is in relative pricing mode, this is the difference between associated prices for a product, variation option, or extra. The difference is calculated by subtracting the base price from the associated price with this product, option, and/or extra. For example, if a product with a defined monogram extra costs an additional $10, the `deltaPrice `value is "10". Between options, a price for a medium may be $10 and a large $12 giving a `deltaPrice `value of "2". Refer to Product Variant Pricing and Weight in the Products guides topic for more information.
returnItem.product.bundledProduct.description	type: string The localized description in text for the object, displayed per the locale code. For example, descriptions are used for product descriptions, attributes, and pre-authorization transaction types.
returnItem.product.bundledProduct.fulfillmentStatus	type: string Fulfillment status of the product.
returnItem.product.bundledProduct.goodsType	type: string The type of goods in a bundled product. A bundled product is composed of products associated to sell together. Possible values include “Physical” and “DigitalCredit”. This comes from the `productType `of the product. Products are defaulted to a Physical `goodsType`. Gift cards have a `goodsType `of DigitalCredit.
returnItem.product.bundledProduct.isPackagedStandAlone	type: bool Indicates if the product must be shipped alone in a container. This is used for products and products within a bundle. If true, this product cannot be shipped in a package with other items and must ship in a package by itself.
returnItem.product.bundledProduct.measurements	type: packageMeasurements Dimensional properties (height, length, and width) of packages, products and bundles.
returnItem.product.bundledProduct.packageMeasurements.height	type: measurement Height of the package in imperial units of feet and inches.
returnItem.product.bundledProduct.packageMeasurements.measurement.unit	type: string The unit of measurement, such as length or weight.
returnItem.product.bundledProduct.packageMeasurements.measurement.value	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.
returnItem.product.bundledProduct.packageMeasurements.length	type: measurement Length of the package in imperial units of feet and inches.
returnItem.product.bundledProduct.packageMeasurements.measurement.unit	type: string The unit of measurement, such as length or weight.
returnItem.product.bundledProduct.packageMeasurements.measurement.value	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.
returnItem.product.bundledProduct.packageMeasurements.weight	type: measurement Weight of the package in imperial units of pounds and ounces.
returnItem.product.bundledProduct.packageMeasurements.measurement.unit	type: string The unit of measurement, such as length or weight.
returnItem.product.bundledProduct.packageMeasurements.measurement.value	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.
returnItem.product.bundledProduct.packageMeasurements.width	type: measurement Width of the package in imperial units of feet and inches.
returnItem.product.bundledProduct.packageMeasurements.measurement.unit	type: string The unit of measurement, such as length or weight.
returnItem.product.bundledProduct.packageMeasurements.measurement.value	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.
returnItem.product.bundledProduct.name	type: string The user supplied name that appears in Admin. You can use this field for identification purposes.
returnItem.product.bundledProduct.optionAttributeFQN	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.
returnItem.product.bundledProduct.optionValue	type: object The value of the option attribute. These values are associated and used by product bundles and options.
returnItem.product.bundledProduct.productCode	type: string The unique, user-defined product code of a product, used throughout Kibo eCommerce to reference and associate to a product.
returnItem.product.bundledProduct.productReservationId	type: int Unique identifier of the product reservation associated with the component product in a product bundle or item in a cart/order. System-supplied and read only.
returnItem.product.bundledProduct.quantity	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.
returnItem.product.categories	type: list of category The list of all categories associated with the product. These categories contain products, can have discounts associated, and define the grouping of products to display on the storefront.
returnItem.product.category.id	type: int 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
returnItem.product.category.parent	type: Mozu.CommerceRuntime.Contracts.Products.Category If applicable, the parent category in the category tree. This can be associated to a product as the parent category.
returnItem.product.description	type: string The localized description in text for the object, displayed per the locale code. For example, descriptions are used for product descriptions, attributes, and pre-authorization transaction types.
returnItem.product.discountsRestricted	type: bool Indicates if the discount is restricted. If true, the system cannot apply any discounts to this product. Discount restrictions are defined at the master catalog level. Client administrators cannot override discount restrictions at the catalog level, but they can limit the restriction to a defined time interval. For price list entries, specifies whether discounts are restricted for the specific entry if discountRestrictedMode is set to Overridden. Refer to Discount Restriction in the Price Lists guides topic for more information.
returnItem.product.discountsRestrictedEndDate	type: DateTime The date and time on which the discount restriction period ends.
returnItem.product.discountsRestrictedStartDate	type: DateTime The date and time on which the discount restriction period starts.
returnItem.product.fulfillmentStatus	type: string Fulfillment status of the product.
returnItem.product.fulfillmentTypesSupported	type: list of string List of supported types of fulfillment for the product or variation. The types include direct ship, in-store pickup, or both.
returnItem.product.goodsType	type: string The type of goods in a bundled product. A bundled product is composed of products associated to sell together. Possible values include “Physical” and “DigitalCredit”. This comes from the `productType `of the product. Products are defaulted to a Physical `goodsType`. Gift cards have a `goodsType `of DigitalCredit.
returnItem.product.imageAlternateText	type: string The alternate image description defined for the product, in the language specified in the locale code for the storefront.
returnItem.product.imageUrl	type: string The URL link for the image file associated with a product or category.
returnItem.product.isPackagedStandAlone	type: bool Indicates if the product must be shipped alone in a container. This is used for products and products within a bundle. If true, this product cannot be shipped in a package with other items and must ship in a package by itself.
returnItem.product.isRecurring	type: bool Indicates if the product in a cart, order, or wish list is purchased on a recurring schedule. If true, the item can be purchased or fulfilled at regular intervals, such as a monthly billing cycle. For example, digital or physical product subscriptions are recurring cart items. This property is not used at this time and is reserved for future functionality.
returnItem.product.isTaxable	type: bool Indicates if the item is subject to taxation, used by products, options, extras, cart and order items, line items, and wish lists. If true, the entity is subject to tax based on the relevant tax rate and rules.
returnItem.product.measurements	type: packageMeasurements Dimensional properties (height, length, and width) of packages, products and bundles.
returnItem.product.packageMeasurements.height	type: measurement Height of the package in imperial units of feet and inches.
returnItem.product.packageMeasurements.measurement.unit	type: string The unit of measurement, such as length or weight.
returnItem.product.packageMeasurements.measurement.value	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.
returnItem.product.packageMeasurements.length	type: measurement Length of the package in imperial units of feet and inches.
returnItem.product.packageMeasurements.measurement.unit	type: string The unit of measurement, such as length or weight.
returnItem.product.packageMeasurements.measurement.value	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.
returnItem.product.packageMeasurements.weight	type: measurement Weight of the package in imperial units of pounds and ounces.
returnItem.product.packageMeasurements.measurement.unit	type: string The unit of measurement, such as length or weight.
returnItem.product.packageMeasurements.measurement.value	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.
returnItem.product.packageMeasurements.width	type: measurement Width of the package in imperial units of feet and inches.
returnItem.product.packageMeasurements.measurement.unit	type: string The unit of measurement, such as length or weight.
returnItem.product.packageMeasurements.measurement.value	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.
returnItem.product.mfgPartNumber	type: string The manufacturer's part number for the product.
returnItem.product.name	type: string The user supplied name that appears in Admin. You can use this field for identification purposes.
returnItem.product.options	type: list of productOption List of option attributes configured for an object. These values are associated and used by products, product bundles, and product types.
returnItem.product.productOption.attributeFQN	type: string The fully qualified name of the attribute. The attributeDefiniteId may be used to generate this name.
returnItem.product.productOption.dataType	type: string The data type of the source product property, typically of type Bool, DateTime, Number, or String.
returnItem.product.productOption.name	type: string The user supplied name that appears in Admin. You can use this field for identification purposes.
returnItem.product.productOption.shopperEnteredValue	type: object The value a shopper entered for an attribute that requires additional input for the product on a storefront. This entered value is a selected option or entered content for an extra, such as selecting a color or entering content for a monogram.
returnItem.product.productOption.stringValue	type: string If the object value is a String, this value provides that string value, used by vocabulary property values, products, and options.
returnItem.product.productOption.value	type: object 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.
returnItem.product.price	type: productPrice The price of either the product or shipping. This amount can be affected by discounts and/or fees. For products, this amount can also be affected by price lists.
returnItem.product.productPrice.creditValue	type: decimal The credit value of the product or bundled product. When the `goodsType `is `DigitalCredit`, this value is populated to indicate the value of the credit. This is used to create store credit in the fulfillment of gift cards.
returnItem.product.productPrice.msrp	type: decimal The manufacturer's suggested retail price (MSRP) for the product. This content may be defined by the supplier.
returnItem.product.productPrice.price	type: decimal The price of either the product or shipping. This amount can be affected by discounts and/or fees. For products, this amount can also be affected by price lists.
returnItem.product.productPrice.priceListCode	type: string If the product's price comes from a price list, this property is the code of the price list with which the product is associated.
returnItem.product.productPrice.priceListEntryMode	type: string The price list entry mode of the product. This property is for future funtionality and currently should only be Simple.
returnItem.product.productPrice.salePrice	type: decimal The set sale price for a product consisting of a price with a discount already applied. For price list entries, this property is the product's sale price if the priceListEntryPrice.salePriceMode is set to Overridden.
returnItem.product.productPrice.tenantOverridePrice	type: decimal The override price defined by the tenant for this cart or order item.
returnItem.product.productCode	type: string The unique, user-defined product code of a product, used throughout Kibo eCommerce to reference and associate to a product.
returnItem.product.productReservationId	type: int Unique identifier of the product reservation associated with the component product in a product bundle or item in a cart/order. System-supplied and read only.
returnItem.product.productType	type: string A product type is like a product template.
returnItem.product.productUsage	type: string The usage type that applies to this product, which is Standard (a single product without configurable options), Configurable (a product that includes configurable option attributes), Bundle (a collection of products sold as a single entity), or Component (an invididual product that represents a component in a bundle).
returnItem.product.properties	type: list of productProperty Collection of property attributes defined for the object. Properties are associated to all objects within Kibo eCommerce, including documents, products, and product types.
returnItem.product.productProperty.attributeFQN	type: string The fully qualified name of the attribute. The attributeDefiniteId may be used to generate this name.
returnItem.product.productProperty.dataType	type: string The data type of the source product property, typically of type Bool, DateTime, Number, or String.
returnItem.product.productProperty.isMultiValue	type: bool Indicates if the object has or can have multiple properties or values. If true, the object can have more than one value, selectable by shoppers through the storefront or configurable through the catalogs.
returnItem.product.productProperty.name	type: string The user supplied name that appears in Admin. You can use this field for identification purposes.
returnItem.product.productProperty.values	type: list of productPropertyValue List of value data for objects.
returnItem.product.productProperty.productPropertyValue.stringValue	type: string If the object value is a String, this value provides that string value, used by vocabulary property values, products, and options.
returnItem.product.productProperty.productPropertyValue.value	type: object 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.
returnItem.product.upc	type: string The universal product code (UPC) is the barcode defined for the product. The UPC is unique across all sales channels.
returnItem.product.variationProductCode	type: string Merchant-created code associated with a specific product variation. Variation product codes maintain an association with the base product code.
returnItem.productLossAmount	type: decimal The total value of the product returned to the merchant for accounting purposes, calculated by multiplying the cost of the item by its quantity returned.
returnItem.productLossTaxAmount	type: decimal The total tax amount levied on the product loss amount.
returnItem.quantityReceived	type: int The actual quantity received for the return item.
returnItem.quantityReplaced	type: int The quantity of the given line item that will be replaced.
returnItem.quantityRestockable	type: int The quantity of returned items that can be returned to active product stock.
returnItem.quantityShipped	type: int The quantity of the item shipped to the shopper in the event of a return item replacement.
returnItem.reasons	type: list of returnReason The list of return reasons for the item and the quantity associated with each return reason.
returnItem.returnReason.quantity	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.
returnItem.returnReason.reason	type: string The reason description for an action, including item return, coupon not valid, and item is taxed.
returnItem.receiveStatus	type: string The status that indicates whether the shopper has returned the item. The accepted values are Not requested, Received, or Waiting.
returnItem.refundAmount	type: decimal The amount of the refund.
returnItem.refundStatus	type: string The status of the refund for the item. The accepted values are Not requested if the shopper only wants a replacement or Refunded if either a partial or full refund is applied to the item.
returnItem.replaceStatus	type: string The status of the replacement order for the item. The accepted values are Not requested if there is no replacement order or Replaced if a replacement order exits.
returnItem.returnNotRequired	type: bool A Boolean that indicates whether the item requires the shopper to return the item.
returnItem.returnType	type: string The type of the return for the item. Either Refund or Replace.
returnItem.shippingLossAmount	type: decimal The total value of shipping the returned product to the merchant for accounting purposes, calculated by multiplying the shipping cost of the item by its quantity returned.
returnItem.shippingLossTaxAmount	type: decimal The total tax amount levied on the shipping loss amount.
returnItem.totalWithoutWeightedShippingAndHandling	type: decimal The total cost without shipping and handling applied.
returnItem.totalWithWeightedShippingAndHandling	type: decimal The total cost with shipping and handling applied.
locationCode	type: string The unique, user-defined code that identifies a location. This location can be the location where the order was entered, location for newly in-stock products, and where products are returned.
lossTotal	type: decimal The total value of the return to the merchant for accounting purposes. This total represents the combined product loss and shipping loss associated with the return.
notes	type: list of orderNote Paged list collection of note content for objects including customers, orders, and returns.
orderNote.auditInfo	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.
orderNote.auditInfo.createBy	type: string Identifier of the user that created the object. System created and read only.
orderNote.auditInfo.createDate	type: DateTime The date and time in UTC format set when the object was created.
orderNote.auditInfo.updateBy	type: string Identifier of the user that updated the entity most recently.
orderNote.auditInfo.updateDate	type: DateTime The date and time in UTC format the object was updated most recently.
orderNote.id	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
orderNote.text	type: string The text content of the order note.
originalOrderId	type: string If this return is associated with a previously completed order, the unique identifier of the original order.
originalOrderNumber	type: int The order number of the original order where the return was created.
packages	type: list of package Array list of physical packages shipped for a specified order.
package.auditInfo	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.
package.auditInfo.createBy	type: string Identifier of the user that created the object. System created and read only.
package.auditInfo.createDate	type: DateTime The date and time in UTC format set when the object was created.
package.auditInfo.updateBy	type: string Identifier of the user that updated the entity most recently.
package.auditInfo.updateDate	type: DateTime The date and time in UTC format the object was updated most recently.
package.availableActions	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.
package.changeMessages	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.
package.changeMessage.amount	type: decimal The amount of the order-level adjustment, which can be a positive or negative amount.
package.changeMessage.appId	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.
package.changeMessage.appKey	type: string The application's key.
package.changeMessage.appName	type: string The application's name.
package.changeMessage.correlationId	type: string The unique identifier of the API request associated with the event action, which might contain multiple actions.
package.changeMessage.createDate	type: DateTime The date and time in UTC format set when the object was created.
package.changeMessage.id	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
package.changeMessage.identifier	type: string Identifier for the object associated with the change message, which can represent a cart, cart item, or an order.
package.changeMessage.message	type: string The text of the change message, such as "This product is no longer available." System-supplied and read-only.
package.changeMessage.metadata	type: object Metadata content for entities, used by document lists, document type lists, document type, views, entity lists, and list views.
package.changeMessage.newValue	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.
package.changeMessage.oldValue	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.
package.changeMessage.subject	type: string The text that appears on the subject line of the message, such as "The product price has changed."
package.changeMessage.subjectType	type: string Represents the type of object affected by the change, such as Cart Item or Product. System-supplied and read-only.
package.changeMessage.success	type: bool If true, the change associated with the message executed successfully.
package.changeMessage.userFirstName	type: string The user's first name.
package.changeMessage.userId	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.
package.changeMessage.userLastName	type: string The user's last name.
package.changeMessage.userScopeType	type: string The user type (e.g. Shopper, Admin, etc.).
package.changeMessage.verb	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.
package.code	type: string The unique identifier of the object.
package.fulfillmentDate	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.
package.fulfillmentLocationCode	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).
package.hasLabel	type: bool If there is a shipping label present for this Package, this will be set to true
package.id	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
package.items	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.
package.packageItem.fulfillmentItemType	type: string This specifies the fulfillment type of digital package item.
package.packageItem.lineId	type: int The line id associated with the fulfillment.
package.packageItem.optionAttributeFQN	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.
package.packageItem.productCode	type: string The unique, user-defined product code of a product, used throughout Kibo eCommerce to reference and associate to a product.
package.packageItem.quantity	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.
package.measurements	type: packageMeasurements Dimensional properties (height, length, and width) of packages, products and bundles.
package.packageMeasurements.height	type: measurement Height of the package in imperial units of feet and inches.
package.packageMeasurements.measurement.unit	type: string The unit of measurement, such as length or weight.
package.packageMeasurements.measurement.value	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.
package.packageMeasurements.length	type: measurement Length of the package in imperial units of feet and inches.
package.packageMeasurements.measurement.unit	type: string The unit of measurement, such as length or weight.
package.packageMeasurements.measurement.value	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.
package.packageMeasurements.weight	type: measurement Weight of the package in imperial units of pounds and ounces.
package.packageMeasurements.measurement.unit	type: string The unit of measurement, such as length or weight.
package.packageMeasurements.measurement.value	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.
package.packageMeasurements.width	type: measurement Width of the package in imperial units of feet and inches.
package.packageMeasurements.measurement.unit	type: string The unit of measurement, such as length or weight.
package.packageMeasurements.measurement.value	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.
package.packagingType	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.
package.shipmentId	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.
package.shippingMethodCode	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.
package.shippingMethodName	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.
package.status	type: string The current status of the object. This value is read only. Valid values for this field are: "Active", "Expired", and "Inactive".
package.trackingNumber	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.
payments	type: list of payment Wrapper for a collection of payments associated with an order or return. An order can include a number of payments until the full total is covered.
payment.amountCollected	type: decimal The total monetary amount collected in this payment transaction for the order.
payment.amountCredited	type: decimal If the payment transaction is a shopper store credit, the total monetary amount credited in this payment transaction for the order.
payment.amountRequested	type: decimal The total amount originally requested for this payment.
payment.auditInfo	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.
payment.auditInfo.createBy	type: string Identifier of the user that created the object. System created and read only.
payment.auditInfo.createDate	type: DateTime The date and time in UTC format set when the object was created.
payment.auditInfo.updateBy	type: string Identifier of the user that updated the entity most recently.
payment.auditInfo.updateDate	type: DateTime The date and time in UTC format the object was updated most recently.
payment.availableActions	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.
payment.billingInfo	type: billingInfo Properties for the customer's billing information associated with an order or specific payment.
payment.billingInfo.auditInfo	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.
payment.billingInfo.auditInfo.createBy	type: string Identifier of the user that created the object. System created and read only.
payment.billingInfo.auditInfo.createDate	type: DateTime The date and time in UTC format set when the object was created.
payment.billingInfo.auditInfo.updateBy	type: string Identifier of the user that updated the entity most recently.
payment.billingInfo.auditInfo.updateDate	type: DateTime The date and time in UTC format the object was updated most recently.
payment.billingInfo.billingContact	type: contact The cardholder's billing contact information, including addresses.
payment.billingInfo.contact.address	type: address Address information to supply for a contact.
payment.billingInfo.contact.address.address1	type: string Physical or mailing address line one. Usually includes the street number and street name or it could be a P.O. Box. Max length: 200.
payment.billingInfo.contact.address.address2	type: string Physical or mailing address line two. Usually supplements the main street address with apartment, floor, suite, building, or unit information. Max length: 200.
payment.billingInfo.contact.address.address3	type: string Physical or mailing address line three. Max length: 200.
payment.billingInfo.contact.address.address4	type: string Physical or mailing address line four. Max length: 200.
payment.billingInfo.contact.address.addressType	type: string The type of address, which is commercial or residential.
payment.billingInfo.contact.address.cityOrTown	type: string The entered city or town for the address.
payment.billingInfo.contact.address.countryCode	type: string The 2-letter geographic code representing the country for the physical or mailing address. Currently limited to the US.
payment.billingInfo.contact.address.isValidated	type: bool Indicates if the address has been validated. If true, the address has been verified by an address validation service.
payment.billingInfo.contact.address.postalOrZipCode	type: string The entered zip or postal code for an address.
payment.billingInfo.contact.address.stateOrProvince	type: string The entered state or province for an address.
payment.billingInfo.contact.companyOrOrganization	type: string The entered company or organization name entered for a customer account.
payment.billingInfo.contact.email	type: string The email address for the customer account and contact. This email may be used for login to the storefront, receiving in-stock product notifications, and subscription mailing lists.
payment.billingInfo.contact.firstName	type: string The full first name of a customer or contact name.
payment.billingInfo.contact.id	type: int 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
payment.billingInfo.contact.lastNameOrSurname	type: string The full last name or surname of a customer or contact name.
payment.billingInfo.contact.middleNameOrInitial	type: string Character string of the middle name or initial for the customer.
payment.billingInfo.contact.phoneNumbers	type: phone List of phone numbers associated with the customer account contact. The phone numbers include area codes.
payment.billingInfo.contact.phone.home	type: string Home phone number.
payment.billingInfo.contact.phone.mobile	type: string Mobile phone number.
payment.billingInfo.contact.phone.work	type: string Work phone number.
payment.billingInfo.card	type: paymentCard Properties of a credit card used to submit payment for an order.
payment.billingInfo.paymentCard.bin	type: string The bin number of a branded credit card.
payment.billingInfo.paymentCard.cardNumberPartOrMask	type: string The masked credit card number part returned from the payment gateway.
payment.billingInfo.paymentCard.expireMonth	type: short The two-digit month a credit card expires for a payment method.
payment.billingInfo.paymentCard.expireYear	type: short The four-digit year the credit card expires for a payment method.
payment.billingInfo.paymentCard.isCardInfoSaved	type: bool If true, the credit card information is saved to the customer account for future use.
payment.billingInfo.paymentCard.isUsedRecurring	type: bool If true, the credit card is used for a recurring order payment.
payment.billingInfo.paymentCard.nameOnCard	type: string The full name printed on a credit card. The name should match what is printed on the card exactly, used in validation during a payment.
payment.billingInfo.paymentCard.paymentOrCardType	type: string The type of credit card, such as Visa or Amex.
payment.billingInfo.paymentCard.paymentServiceCardId	type: string Unique identifier of the credit card from the payment service.
payment.billingInfo.check	type: checkPayment Information about the check used in the billing information, if it exists.
payment.billingInfo.checkPayment.checkNumber	type: string If applicable, the check number associated with the payment action or interaction.
payment.billingInfo.customCreditType	type: string Indicates a custom reward type.
payment.billingInfo.data	type: Mozu.Core.Api.Contracts.Json Custom data originated by the billing service.
payment.billingInfo.externalTransactionId	type: string Holds the transaction ID for an external payment type service.
payment.billingInfo.isSameBillingShippingAddress	type: bool If true, the system overrides the customer's billing address information with the supplied fulfillment information.
payment.billingInfo.paymentType	type: string The type of payment, such as credit card, check, or PayPal Express. Additional payment types will be supported in future releases.
payment.billingInfo.paymentWorkflow	type: string Identifies a specific workflow the payment goes through. This is used to define a workflow for external payment services.
payment.billingInfo.purchaseOrder	type: purchaseOrderPayment The purchase order payment details.
payment.billingInfo.purchaseOrderPayment.customFields	type: list of purchaseOrderCustomField Details of the custom text fields associated with the purchase order. Refer to Custom Text Fields in the Purchase Order guides topic for more information.
payment.billingInfo.purchaseOrderPayment.purchaseOrderCustomField.code	type: string The unique identifier of the object.
payment.billingInfo.purchaseOrderPayment.purchaseOrderCustomField.label	type: string Descriptive text used as a label for objects, such as field names, facets, date ranges, contact information, and package information.
payment.billingInfo.purchaseOrderPayment.purchaseOrderCustomField.value	type: string 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.
payment.billingInfo.purchaseOrderPayment.paymentTerm	type: purchaseOrderPaymentTerm The details of the payment terms. The payment terms are made up of a code and a description. Refer to Payment Terms in the Purchase Order guides topic for more information.
payment.billingInfo.purchaseOrderPayment.purchaseOrderPaymentTerm.code	type: string The unique identifier of the object.
payment.billingInfo.purchaseOrderPayment.purchaseOrderPaymentTerm.description	type: string The localized description in text for the object, displayed per the locale code. For example, descriptions are used for product descriptions, attributes, and pre-authorization transaction types.
payment.billingInfo.purchaseOrderPayment.purchaseOrderNumber	type: string The purchase order number. Note: Kibo eCommerce does not validate the purchase order number by default; however, you can add validation functionality using Arc.js. Refer to Validate Purchase Orders During the Checkout Process in the Arc.js Guides for more information and examples.
payment.billingInfo.storeCreditCode	type: string The code that identifies the store credit to apply to the order.
payment.billingInfo.storeCreditType	type: string A payment referring to a store credit or gift card. StoreCredit GiftCard Custom StoreCredit and GiftCard are internally managed by Kibo eComm. Use Custom for externally managed gift cards or reward systems. If Custom is used, provide the name for the custom type in the CustomCreditType field.
payment.billingInfo.token	type: paymentToken The token to access billing information.
payment.billingInfo.paymentToken.paymentServiceTokenId	type: string The identifier of the payment service token.
payment.billingInfo.paymentToken.type	type: string The type of scope, which is a developer account or production tenant.
payment.changeMessages	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.
payment.changeMessage.amount	type: decimal The amount of the order-level adjustment, which can be a positive or negative amount.
payment.changeMessage.appId	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.
payment.changeMessage.appKey	type: string The application's key.
payment.changeMessage.appName	type: string The application's name.
payment.changeMessage.correlationId	type: string The unique identifier of the API request associated with the event action, which might contain multiple actions.
payment.changeMessage.createDate	type: DateTime The date and time in UTC format set when the object was created.
payment.changeMessage.id	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
payment.changeMessage.identifier	type: string Identifier for the object associated with the change message, which can represent a cart, cart item, or an order.
payment.changeMessage.message	type: string The text of the change message, such as "This product is no longer available." System-supplied and read-only.
payment.changeMessage.metadata	type: object Metadata content for entities, used by document lists, document type lists, document type, views, entity lists, and list views.
payment.changeMessage.newValue	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.
payment.changeMessage.oldValue	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.
payment.changeMessage.subject	type: string The text that appears on the subject line of the message, such as "The product price has changed."
payment.changeMessage.subjectType	type: string Represents the type of object affected by the change, such as Cart Item or Product. System-supplied and read-only.
payment.changeMessage.success	type: bool If true, the change associated with the message executed successfully.
payment.changeMessage.userFirstName	type: string The user's first name.
payment.changeMessage.userId	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.
payment.changeMessage.userLastName	type: string The user's last name.
payment.changeMessage.userScopeType	type: string The user type (e.g. Shopper, Admin, etc.).
payment.changeMessage.verb	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.
payment.data	type: Mozu.Core.Api.Contracts.Json Custom data originated by the payment service.
payment.externalTransactionId	type: string The external/third party transaction Id for this payment. This is used to store the transaction Id from digital wallet like Visa Checkout
payment.groupId	type: paymentActionTarget The parent group Id that this payment belongs to. This will refer to the parent checkout in the case of a multi-ship order, or the parent order in the case of a non-multi-ship order. This will (eventually) allow us to find all payments associated with a checkout, even if the payment is added directly to one of the child orders.
payment.paymentActionTarget.targetId	type: string The Id of the checkout/order to target.
payment.paymentActionTarget.targetNumber	type: int The number of the checkout/order to target.
payment.paymentActionTarget.targetType	type: string Specifies if the TargetId is a checkout Id or order Id.
payment.id	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
payment.interactions	type: list of paymentInteraction Container for the interactions associated with the payment, which includes details for each action performed for the payment.
payment.paymentInteraction.amount	type: decimal The amount of the order-level adjustment, which can be a positive or negative amount.
payment.paymentInteraction.auditInfo	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.
payment.paymentInteraction.auditInfo.createBy	type: string Identifier of the user that created the object. System created and read only.
payment.paymentInteraction.auditInfo.createDate	type: DateTime The date and time in UTC format set when the object was created.
payment.paymentInteraction.auditInfo.updateBy	type: string Identifier of the user that updated the entity most recently.
payment.paymentInteraction.auditInfo.updateDate	type: DateTime The date and time in UTC format the object was updated most recently.
payment.paymentInteraction.checkNumber	type: string If applicable, the check number associated with the payment action or interaction.
payment.paymentInteraction.currencyCode	type: string The localized currency code for the monetary amount.
payment.paymentInteraction.gatewayAuthCode	type: string If required by the payment gateway, the authorization code of the transaction.
payment.paymentInteraction.gatewayAVSCodes	type: string AVS (Address Verification Service) codes supplied by the payment gateway. The codes indicate partial to complete or failed matches against the billing address for the shopper against the financial institute data through the gateway.
payment.paymentInteraction.gatewayCVV2Codes	type: string CVV2 (Card Verification Value) codes supplied by the payment gateway. The codes indicate a verified or failed match of the encrypted code entered against the financial institution data through the gateway.
payment.paymentInteraction.gatewayInteractionId	type: int Unique identifier of the payment interaction from the payment gateway.
payment.paymentInteraction.gatewayResponseCode	type: string Response code from the gateway associated with the payment interaction. The response code is unique to the gateway. The response code is associated with the gatewayResponseText, which contains the textual response message. Refer to Gateway Response Code and Text in the API Guides for more information.
payment.paymentInteraction.gatewayResponseData	type: list of paymentGatewayResponseData Additional response data from the gateway that's unique to each gateway. This is a list of key value pairs. Refer to Gateway Response Data in the API Guides for more information.
payment.paymentInteraction.paymentGatewayResponseData.key	type: string Key used for metadata defined for objects, including extensible attributes, custom attributes associated with a shipping provider, and search synonyms definitions. This content may be user-defined depending on the object and usage. For search synonym definitions, refer to Synonym Expansion Types for more information about the key usage.
payment.paymentInteraction.paymentGatewayResponseData.value	type: string 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.
payment.paymentInteraction.gatewayResponseText	type: string Textual message returned by the payment gateway for the associated gatewayResponseCode. Refer to Gateway Response Code and Text in the API Guides for more information.
payment.paymentInteraction.gatewayTransactionId	type: string Unique identifier of the gateway transaction associated with the payment interaction.
payment.paymentInteraction.id	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
payment.paymentInteraction.interactionDate	type: DateTime Date and time of a payment interaction, including handling and processing a payment and validating and completing a payment with a payment gateway.
payment.paymentInteraction.interactionType	type: string The type of payment interaction. The payment can be Capture or CheckReceived. The value also includes customer payment interactions such as Website, Call, Store, or Unknown.
payment.paymentInteraction.isManual	type: bool If true, the payment interaction was manually defined s part of offline order processing.
payment.paymentInteraction.isRecurring	type: bool Indicates if the product in a cart, order, or wish list is purchased on a recurring schedule. If true, the item can be purchased or fulfilled at regular intervals, such as a monthly billing cycle. For example, digital or physical product subscriptions are recurring cart items. This property is not used at this time and is reserved for future functionality.
payment.paymentInteraction.note	type: string User-entered notation content for an object, used to save information such as payment, return, account, and order notes.
payment.paymentInteraction.orderId	type: string Unique identifier of the order associated with the payment.
payment.paymentInteraction.paymentEntryStatus	type: string The status of the payment prior to the interaction being performed, which enables manual rollback of previous transactions.
payment.paymentInteraction.paymentId	type: string Unique identifier of the payment associated with this transaction.
payment.paymentInteraction.paymentTransactionInteractionIdReference	type: int Unique identifier of previous interaction that this payment interaction is modifying. For example, when refunding a payment, the crediting interaction would reference the capture interaction.
payment.paymentInteraction.refundId	type: string The unique identifier of the refund for a given interaction.
payment.paymentInteraction.returnId	type: string The unique identifier of the return associated with a given interaction.
payment.paymentInteraction.status	type: string The current status of the object. This value is read only. Valid values for this field are: "Active", "Expired", and "Inactive".
payment.paymentInteraction.target	type: paymentActionTarget Targets represent the object, such as an item to apply discounts to(products or orders) or a view field for content. Targets are the dot notations that link to the source document property. For example, firstitem for the direct level or firstitem.seconditem.thirditem for a deeper property.
payment.paymentInteraction.paymentActionTarget.targetId	type: string The Id of the checkout/order to target.
payment.paymentInteraction.paymentActionTarget.targetNumber	type: int The number of the checkout/order to target.
payment.paymentInteraction.paymentActionTarget.targetType	type: string Specifies if the TargetId is a checkout Id or order Id.
payment.isRecurring	type: bool Indicates if the product in a cart, order, or wish list is purchased on a recurring schedule. If true, the item can be purchased or fulfilled at regular intervals, such as a monthly billing cycle. For example, digital or physical product subscriptions are recurring cart items. This property is not used at this time and is reserved for future functionality.
payment.orderId	type: string Unique identifier of the order associated with the payment.
payment.paymentServiceTransactionId	type: string The transaction ID supplied by the payment service to associate with this order payment.
payment.paymentType	type: string The type of payment, such as credit card, check, or PayPal Express. Additional payment types will be supported in future releases.
payment.paymentWorkflow	type: string The source of data for this payment. By default, this will be set to 'mozu'
payment.status	type: string The current status of the object. This value is read only. Valid values for this field are: "Active", "Expired", and "Inactive".
payment.subPayments	type: list of subPayment List of sub-payments that correspond to child orders in case of multiship orders. Used for tracking each order's portion of a shared payment.
payment.subPayment.amountCollected	type: decimal The amount collected for that portion of the payment.
payment.subPayment.amountCredited	type: decimal The amount credited back for that portion of the payment.
payment.subPayment.amountRefunded	type: decimal The amount refunded for that portion of the payment.
payment.subPayment.amountRequested	type: decimal The amount requested for that portion of the payment.
payment.subPayment.status	type: string The current status of the object. This value is read only. Valid values for this field are: "Active", "Expired", and "Inactive".
payment.subPayment.target	type: paymentActionTarget Targets represent the object, such as an item to apply discounts to(products or orders) or a view field for content. Targets are the dot notations that link to the source document property. For example, firstitem for the direct level or firstitem.seconditem.thirditem for a deeper property.
payment.subPayment.paymentActionTarget.targetId	type: string The Id of the checkout/order to target.
payment.subPayment.paymentActionTarget.targetNumber	type: int The number of the checkout/order to target.
payment.subPayment.paymentActionTarget.targetType	type: string Specifies if the TargetId is a checkout Id or order Id.
productLossTaxTotal	type: decimal The total tax amount levied on the product loss amount.
productLossTotal	type: decimal The total value of the product returned to the merchant for accounting purposes, calculated by multiplying the cost of the item by its quantity returned.
receiveStatus	type: string The status that indicates whether you have received the return item from the shopper. The accepted values are Not requested, Received, or Waiting.
refundAmount	type: decimal If a refund action was performed for this return, the total amount refunded to the shopper. The refund amount can differ from the sum of the price of the returned items.
refundStatus	type: string The status of the refund. The accepted values are Not requested if the shopper only wants a replacement or Refunded if either a partial or full refund is applied to the return.
replaceStatus	type: string The status of the replacement order. The accepted values are Not requested if there is no replacement order or Replaced if a replacement order exits.
returnNumber	type: int A merchant-specific identifier used to sequentially order returns.
returnOrderId	type: string Unique identifier for the last order created as a result of the return. If the return results in shipping a replacement item, the order includes shipment information for the replaced items. If the return results in a refund, the order includes payment transactions to credit the shopper. Tip: There can be multiple child orders on a return. To retrieve the full list of child orders, use the GetOrders operation with the filter 'parentReturnId eq ReturnId'.
returnType	type: string The type of return, which is Refund or Replace. At the top-level return level, this field is DEPRECATED because Refund and Replace items can now be mixed within a single return. For backwards-compatibility with older applications, the field defaults to Replace.
rmaDeadline	type: DateTime The date by which a shopper must ship items associated with a return in an "awaiting items" state to the merchant.
shippingLossTaxTotal	type: decimal The total tax amount levied on the shipping loss amount.
shippingLossTotal	type: decimal The total value of shipping the returned product to the merchant for accounting purposes, calculated by multiplying the shipping cost of the item by its quantity returned.
siteId	type: int Unique identifier for the site. This ID is used at all levels of a store, catalog, and tenant to associate objects to a site.
status	type: string The current status of the object. This value is read only. Valid values for this field are: "Active", "Expired", and "Inactive".
tenantId	type: int Unique identifier for the tenant.
userId	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.
visitId	type: string Unique identifier of the customer visit in which the cart was created or last modified.
webSessionId	type: string Unique identifier of the web session in which the cart, order, return, or wish list was created or last modified.

Operations

Operation Name	Request URI	Description
CreatePaymentActionForReturn	POST %7breturnId%7d%2fpayments%2factions%3fresponseFields%3d%7bresponseFields%7d	Creates a new payment for a return that results in a refund to the customer.
CreateReturn	POST %3fresponseFields%3d%7bresponseFields%7d	Creates a return for previously fulfilled items. Each return must either be associated with an original order or a product definition to represent each returned item. When you create a return, you must specify the following fields: OriginalOrderId Items OrderLineId OrderItemId (Optional, but recommended) Reasons Reason Quantity Product (required for bundle items or product extras, but null for parent product or bundles) ProductCode VariantProductCode OrderItemOptionAttributeFQN (required for product extras, but otherwise null) ExcludeProductExtras (set to true to target parent products or bundles without extras)
CreateReturnItem	POST %7breturnId%7d%2fitems%3fresponseFields%3d%7bresponseFields%7d	Adds a return item to the return.
CreateReturnShippingOrder	POST %7breturnId%7d%2fship%3fresponseFields%3d%7bresponseFields%7d	Creates a replacement order for the return. Note: The request body (a collection of ReturnItemSpecifier) is optional. If the body is empty, the operation replaces all remaining items marked for replace. If you want to replace only a specific item(s) marked for return, you must specify the item(s) in the request body.
DeleteOrderItem	DELETE %7borderId%7d%2fitems%2f%7borderItemId%7d%3fupdatemode%3d%7bupdateMode%7d%26version%3d%7bversion%7d	Removes a particular order item from the order of the current shopper.
DeleteReturn	DELETE %7breturnId%7d	Deletes the return specified in the request.
GetAvailablePaymentActionsForReturn	GET %7breturnId%7d%2fpayments%2f%7bpaymentId%7d%2factions	Retrieves a list of the payment actions available to perform for the specified return when a return results in a refund to the customer.
GetAvailableReturnActions	GET %7breturnId%7d%2factions	Retrieves a list of the actions available to perform for the specified return based on its current state.
GetPayment	GET %7breturnId%7d%2fpayments%2f%7bpaymentId%7d%3fresponseFields%3d%7bresponseFields%7d	Retrieves the details of a payment submitted as part of a refund associated with a customer return.
GetPayments	GET %7breturnId%7d%2fpayments%3fresponseFields%3d%7bresponseFields%7d	Retrieves a list of all payments submitted as part of a refund associated with a customer return.
GetReasons	GET reasons%3fresponseFields%3d%7bresponseFields%7d	Returns a list of reasons for a return.
GetReturn	GET %7breturnId%7d%3fresponseFields%3d%7bresponseFields%7d	Retrieves a list of properties for the specified return.
GetReturnItem	GET %7breturnId%7d%2fitems%2f%7breturnItemId%7d%3fresponseFields%3d%7bresponseFields%7d	Retrieves the details of a single return item.
GetReturnItems	GET %7breturnId%7d%2fitems%3fresponseFields%3d%7bresponseFields%7d	Retrieves the details of all return items in an order.
GetReturns	GET %3fstartIndex%3d%7bstartIndex%7d%26pageSize%3d%7bpageSize%7d%26sortBy%3d%7bsortBy%7d%26filter%3d%7bfilter%7d%26q%3d%7bq%7d%26responseFields%3d%7bresponseFields%7d	Retrieves a list of all returns according to any filter and sort criteria.
PerformPaymentActionForReturn	POST %7breturnId%7d%2fpayments%2f%7bpaymentId%7d%2factions%3fresponseFields%3d%7bresponseFields%7d	Updates a refund payment associated with a customer return by performing the specified action.
PerformReturnActions	POST actions%3fresponseFields%3d%7bresponseFields%7d	Updates the return by performing the action specified in the request.
ResendReturnEmail	PUT email%2fresend	Resend the email notification to a shopper that a return has been created.
UpdateReturn	PUT %7breturnId%7d%3fresponseFields%3d%7bresponseFields%7d	Updates one or more properties of a return for items previously shipped in a completed order.