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 |
type: string Identifier of the user that created the object. System created and read only. |
auditInfo |
type: DateTime The date and time in UTC format set when the object was created. |
auditInfo |
type: string Identifier of the user that updated the entity most recently. |
auditInfo |
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 |
type: decimal The amount of the order-level adjustment, which can be a positive or negative amount. |
changeMessage |
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 |
type: string The application's key. |
changeMessage |
type: string The application's name. |
changeMessage |
type: string The unique identifier of the API request associated with the event action, which might contain multiple actions. |
changeMessage |
type: DateTime The date and time in UTC format set when the object was created. |
changeMessage |
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 For email templates, the ID must be one of the following values:
|
changeMessage |
type: string Identifier for the object associated with the change message, which can represent a cart, cart item, or an order. |
changeMessage |
type: string The text of the change message, such as "This product is no longer available." System-supplied and read-only. |
changeMessage |
type: object Metadata content for entities, used by document lists, document type lists, document type, views, entity lists, and list views. |
changeMessage |
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 |
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 |
type: string The text that appears on the subject line of the message, such as "The product price has changed." |
changeMessage |
type: string Represents the type of object affected by the change, such as Cart Item or Product. System-supplied and read-only. |
changeMessage |
type: bool If true, the change associated with the message executed successfully. |
changeMessage |
type: string The user's first name. |
changeMessage |
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 |
type: string The user's last name. |
changeMessage |
type: string The user type (e.g. Shopper, Admin, etc.). |
changeMessage |
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 |
type: address Address information to supply for a contact. |
contact |
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 |
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 |
type: string Physical or mailing address line three. Max length: 200. |
contact |
type: string Physical or mailing address line four. Max length: 200. |
contact |
type: string The type of address, which is commercial or residential. |
contact |
type: string The entered city or town for the address. |
contact |
type: string The 2-letter geographic code representing the country for the physical or mailing address. Currently limited to the US. |
contact |
type: bool Indicates if the address has been validated. If true, the address has been verified by an address validation service. |
contact |
type: string The entered zip or postal code for an address. |
contact |
type: string The entered state or province for an address. |
contact |
type: string The company or organization name entered for a customer account. |
contact |
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 |
type: string The full first name of a customer or contact name. |
contact |
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 For email templates, the ID must be one of the following values:
|
contact |
type: string The full last name or surname of a customer or contact name. |
contact |
type: string Character string of the middle name or initial for the customer. |
contact |
type: phone List of phone numbers associated with the customer account contact. The phone numbers include area codes. |
contact |
type: string Home phone number. |
contact |
type: string Mobile phone number. |
contact |
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 For email templates, the ID must be one of the following values:
|
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 |
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 |
type: string The unique, user-defined product code of a product, used throughout Kibo eCommerce to reference and associate to a product. |
returnItem |
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 |
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 E
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 |
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 For email templates, the ID must be one of the following values:
|
returnItem |
type: list of orderNote Paged list collection of note content for objects including customers, orders, and returns. |
returnItem |
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 |
type: string Identifier of the user that created the object. System created and read only. |
returnItem |
type: DateTime The date and time in UTC format set when the object was created. |
returnItem |
type: string Identifier of the user that updated the entity most recently. |
returnItem |
type: DateTime The date and time in UTC format the object was updated most recently. |
returnItem |
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 For email templates, the ID must be one of the following values:
|
returnItem |
type: string The text content of the order note. |
returnItem |
type: string Unique identifier of the order item associated with a validation message, order, or return. |
returnItem |
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 |
type: int The OrderLineId that this ReturnItem is associated with. If order item is present, the orderLineId should be present also. |
returnItem |
type: product The properties of a product, referenced and used by carts, orders, wish lists, and returns. |
returnItem |
type: DateTime Allocation ID associated with this product on this order. |
returnItem |
type: int Allocation ID associated with this product on this order. |
returnItem |
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 |
type: DateTime Allocation ID associated with this product on this order. |
returnItem |
type: int Allocation ID associated with this product on this order. |
returnItem |
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 |
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 |
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 |
type: string Fulfillment status of the product. |
returnItem |
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 |
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 |
type: packageMeasurements Dimensional properties (height, length, and width) of packages, products and bundles. |
returnItem |
type: measurement Height of the package in imperial units of feet and inches. |
returnItem |
type: string The unit of measurement, such as length or weight. |
returnItem |
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 |
type: measurement Length of the package in imperial units of feet and inches. |
returnItem |
type: string The unit of measurement, such as length or weight. |
returnItem |
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 |
type: measurement Weight of the package in imperial units of pounds and ounces. |
returnItem |
type: string The unit of measurement, such as length or weight. |
returnItem |
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 |
type: measurement Width of the package in imperial units of feet and inches. |
returnItem |
type: string The unit of measurement, such as length or weight. |
returnItem |
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 |
type: string The user supplied name that appears in Admin. You can use this field for identification purposes. |
returnItem |
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 |
type: object The value of the option attribute. These values are associated and used by product bundles and options. |
returnItem |
type: string The unique, user-defined product code of a product, used throughout Kibo eCommerce to reference and associate to a product. |
returnItem |
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 |
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 |
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 |
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 For email templates, the ID must be one of the following values:
|
returnItem |
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 |
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 |
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 |
type: DateTime The date and time on which the discount restriction period ends. |
returnItem |
type: DateTime The date and time on which the discount restriction period starts. |
returnItem |
type: string Fulfillment status of the product. |
returnItem |
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 |
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 |
type: string The alternate image description defined for the product, in the language specified in the locale code for the storefront. |
returnItem |
type: string The URL link for the image file associated with a product or category. |
returnItem |
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 |
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 |
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 |
type: packageMeasurements Dimensional properties (height, length, and width) of packages, products and bundles. |
returnItem |
type: measurement Height of the package in imperial units of feet and inches. |
returnItem |
type: string The unit of measurement, such as length or weight. |
returnItem |
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 |
type: measurement Length of the package in imperial units of feet and inches. |
returnItem |
type: string The unit of measurement, such as length or weight. |
returnItem |
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 |
type: measurement Weight of the package in imperial units of pounds and ounces. |
returnItem |
type: string The unit of measurement, such as length or weight. |
returnItem |
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 |
type: measurement Width of the package in imperial units of feet and inches. |
returnItem |
type: string The unit of measurement, such as length or weight. |
returnItem |
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 |
type: string The manufacturer's part number for the product. |
returnItem |
type: string The user supplied name that appears in Admin. You can use this field for identification purposes. |
returnItem |
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 |
type: string The fully qualified name of the attribute. The attributeDefiniteId may be used to generate this name. |
returnItem |
type: string The data type of the source product property, typically of type Bool, DateTime, Number, or String. |
returnItem |
type: string The user supplied name that appears in Admin. You can use this field for identification purposes. |
returnItem |
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 |
type: string If the object value is a String, this value provides that string value, used by vocabulary property values, products, and options. |
returnItem |
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 |
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 |
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 |
type: decimal The manufacturer's suggested retail price (MSRP) for the product. This content may be defined by the supplier. |
returnItem |
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 |
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 |
type: string The price list entry mode of the product. This property is for future funtionality and currently should only be Simple. |
returnItem |
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 |
type: decimal The override price defined by the tenant for this cart or order item. |
returnItem |
type: string The unique, user-defined product code of a product, used throughout Kibo eCommerce to reference and associate to a product. |
returnItem |
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 |
type: string A product type is like a product template. |
returnItem |
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 |
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 |
type: string The fully qualified name of the attribute. The attributeDefiniteId may be used to generate this name. |
returnItem |
type: string The data type of the source product property, typically of type Bool, DateTime, Number, or String. |
returnItem |
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 |
type: string The user supplied name that appears in Admin. You can use this field for identification purposes. |
returnItem |
type: list of productPropertyValue List of value data for objects. |
returnItem |
type: string If the object value is a String, this value provides that string value, used by vocabulary property values, products, and options. |
returnItem |
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 |
type: string The universal product code (UPC) is the barcode defined for the product. The UPC is unique across all sales channels. |
returnItem |
type: string Merchant-created code associated with a specific product variation. Variation product codes maintain an association with the base product code. |
returnItem |
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 |
type: decimal The total tax amount levied on the product loss amount. |
returnItem |
type: int The actual quantity received for the return item. |
returnItem |
type: int The quantity of the given line item that will be replaced. |
returnItem |
type: int The quantity of returned items that can be returned to active product stock. |
returnItem |
type: int The quantity of the item shipped to the shopper in the event of a return item replacement. |
returnItem |
type: list of returnReason The list of return reasons for the item and the quantity associated with each return reason. |
returnItem |
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 |
type: string The reason description for an action, including item return, coupon not valid, and item is taxed. |
returnItem |
type: string The status that indicates whether the shopper has returned the item. The accepted values are Not requested, Received, or Waiting. |
returnItem |
type: decimal The amount of the refund. |
returnItem |
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 |
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 |
type: bool A Boolean that indicates whether the item requires the shopper to return the item. |
returnItem |
type: string The type of the return for the item. Either Refund or Replace. |
returnItem |
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 |
type: decimal The total tax amount levied on the shipping loss amount. |
returnItem |
type: decimal The total cost without shipping and handling applied. |
returnItem |
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 |
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 |
type: string Identifier of the user that created the object. System created and read only. |
orderNote |
type: DateTime The date and time in UTC format set when the object was created. |
orderNote |
type: string Identifier of the user that updated the entity most recently. |
orderNote |
type: DateTime The date and time in UTC format the object was updated most recently. |
orderNote |
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 For email templates, the ID must be one of the following values:
|
orderNote |
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 |
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 |
type: string Identifier of the user that created the object. System created and read only. |
package |
type: DateTime The date and time in UTC format set when the object was created. |
package |
type: string Identifier of the user that updated the entity most recently. |
package |
type: DateTime The date and time in UTC format the object was updated most recently. |
package |
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 |
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 |
type: decimal The amount of the order-level adjustment, which can be a positive or negative amount. |
package |
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 |
type: string The application's key. |
package |
type: string The application's name. |
package |
type: string The unique identifier of the API request associated with the event action, which might contain multiple actions. |
package |
type: DateTime The date and time in UTC format set when the object was created. |
package |
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 For email templates, the ID must be one of the following values:
|
package |
type: string Identifier for the object associated with the change message, which can represent a cart, cart item, or an order. |
package |
type: string The text of the change message, such as "This product is no longer available." System-supplied and read-only. |
package |
type: object Metadata content for entities, used by document lists, document type lists, document type, views, entity lists, and list views. |
package |
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 |
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 |
type: string The text that appears on the subject line of the message, such as "The product price has changed." |
package |
type: string Represents the type of object affected by the change, such as Cart Item or Product. System-supplied and read-only. |
package |
type: bool If true, the change associated with the message executed successfully. |
package |
type: string The user's first name. |
package |
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 |
type: string The user's last name. |
package |
type: string The user type (e.g. Shopper, Admin, etc.). |
package |
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 |
type: string The unique identifier of the object. |
package |
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 |
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 |
type: bool If there is a shipping label present for this Package, this will be set to true |
package |
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 For email templates, the ID must be one of the following values:
|
package |
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 |
type: string This specifies the fulfillment type of digital package item. |
package |
type: int The line id associated with the fulfillment. |
package |
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 |
type: string The unique, user-defined product code of a product, used throughout Kibo eCommerce to reference and associate to a product. |
package |
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 |
type: packageMeasurements Dimensional properties (height, length, and width) of packages, products and bundles. |
package |
type: measurement Height of the package in imperial units of feet and inches. |
package |
type: string The unit of measurement, such as length or weight. |
package |
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 |
type: measurement Length of the package in imperial units of feet and inches. |
package |
type: string The unit of measurement, such as length or weight. |
package |
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 |
type: measurement Weight of the package in imperial units of pounds and ounces. |
package |
type: string The unit of measurement, such as length or weight. |
package |
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 |
type: measurement Width of the package in imperial units of feet and inches. |
package |
type: string The unit of measurement, such as length or weight. |
package |
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 |
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 |
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 |
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 |
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 |
type: string The current status of the object. This value is read only. Valid values for this field are: "Active", "Expired", and "Inactive". |
package |
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 |
type: decimal The total monetary amount collected in this payment transaction for the order. |
payment |
type: decimal If the payment transaction is a shopper store credit, the total monetary amount credited in this payment transaction for the order. |
payment |
type: decimal The total amount originally requested for this payment. |
payment |
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 |
type: string Identifier of the user that created the object. System created and read only. |
payment |
type: DateTime The date and time in UTC format set when the object was created. |
payment |
type: string Identifier of the user that updated the entity most recently. |
payment |
type: DateTime The date and time in UTC format the object was updated most recently. |
payment |
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 |
type: billingInfo Properties for the customer's billing information associated with an order or specific payment. |
payment |
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 |
type: string Identifier of the user that created the object. System created and read only. |
payment |
type: DateTime The date and time in UTC format set when the object was created. |
payment |
type: string Identifier of the user that updated the entity most recently. |
payment |
type: DateTime The date and time in UTC format the object was updated most recently. |
payment |
type: contact The cardholder's billing contact information, including addresses. |
payment |
type: address Address information to supply for a contact. |
payment |
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 |
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 |
type: string Physical or mailing address line three. Max length: 200. |
payment |
type: string Physical or mailing address line four. Max length: 200. |
payment |
type: string The type of address, which is commercial or residential. |
payment |
type: string The entered city or town for the address. |
payment |
type: string The 2-letter geographic code representing the country for the physical or mailing address. Currently limited to the US. |
payment |
type: bool Indicates if the address has been validated. If true, the address has been verified by an address validation service. |
payment |
type: string The entered zip or postal code for an address. |
payment |
type: string The entered state or province for an address. |
payment |
type: string The company or organization name entered for a customer account. |
payment |
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 |
type: string The full first name of a customer or contact name. |
payment |
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 For email templates, the ID must be one of the following values:
|
payment |
type: string The full last name or surname of a customer or contact name. |
payment |
type: string Character string of the middle name or initial for the customer. |
payment |
type: phone List of phone numbers associated with the customer account contact. The phone numbers include area codes. |
payment |
type: string Home phone number. |
payment |
type: string Mobile phone number. |
payment |
type: string Work phone number. |
payment |
type: paymentCard Properties of a credit card used to submit payment for an order. |
payment |
type: string The bin number of a branded credit card. |
payment |
type: string The masked credit card number part returned from the payment gateway. |
payment |
type: short The two-digit month a credit card expires for a payment method. |
payment |
type: short The four-digit year the credit card expires for a payment method. |
payment |
type: bool If true, the credit card information is saved to the customer account for future use. |
payment |
type: bool If true, the credit card is used for a recurring order payment. |
payment |
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 |
type: string The type of credit card, such as Visa or Amex. |
payment |
type: string Unique identifier of the credit card from the payment service. |
payment |
type: checkPayment Information about the check used in the billing information, if it exists. |
payment |
type: string If applicable, the check number associated with the payment action or interaction. |
payment |
type: string Indicates a custom reward type. |
payment |
type: Mozu.Core.Api.Contracts.Json Custom data originated by the billing service. |
payment |
type: string Holds the transaction ID for an external payment type service. |
payment |
type: bool If true, the system overrides the customer's billing address information with the supplied fulfillment information. |
payment |
type: string The type of payment, such as credit card, check, or PayPal Express. Additional payment types will be supported in future releases. |
payment |
type: string Identifies a specific workflow the payment goes through. This is used to define a workflow for external payment services. |
payment |
type: purchaseOrderPayment The purchase order payment details. |
payment |
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 |
type: string The unique identifier of the object. |
payment |
type: string Descriptive text used as a label for objects, such as field names, facets, date ranges, contact information, and package information. |
payment |
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 |
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 |
type: string The unique identifier of the object. |
payment |
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 |
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 |
type: string The code that identifies the store credit to apply to the order. |
payment |
type: string A payment referring to a store credit or gift card.
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 |
type: paymentToken The token to access billing information. |
payment |
type: string The identifier of the payment service token. |
payment |
type: string The type of scope, which is a developer account or production tenant. |
payment |
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 |
type: decimal The amount of the order-level adjustment, which can be a positive or negative amount. |
payment |
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 |
type: string The application's key. |
payment |
type: string The application's name. |
payment |
type: string The unique identifier of the API request associated with the event action, which might contain multiple actions. |
payment |
type: DateTime The date and time in UTC format set when the object was created. |
payment |
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 For email templates, the ID must be one of the following values:
|
payment |
type: string Identifier for the object associated with the change message, which can represent a cart, cart item, or an order. |
payment |
type: string The text of the change message, such as "This product is no longer available." System-supplied and read-only. |
payment |
type: object Metadata content for entities, used by document lists, document type lists, document type, views, entity lists, and list views. |
payment |
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 |
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 |
type: string The text that appears on the subject line of the message, such as "The product price has changed." |
payment |
type: string Represents the type of object affected by the change, such as Cart Item or Product. System-supplied and read-only. |
payment |
type: bool If true, the change associated with the message executed successfully. |
payment |
type: string The user's first name. |
payment |
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 |
type: string The user's last name. |
payment |
type: string The user type (e.g. Shopper, Admin, etc.). |
payment |
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 |
type: Mozu.Core.Api.Contracts.Json Custom data originated by the payment service. |
payment |
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 |
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 |
type: string The Id of the checkout/order to target. |
payment |
type: int The number of the checkout/order to target. |
payment |
type: string Specifies if the TargetId is a checkout Id or order Id. |
payment |
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 For email templates, the ID must be one of the following values:
|
payment |
type: list of paymentInteraction Container for the interactions associated with the payment, which includes details for each action performed for the payment. |
payment |
type: decimal The amount of the order-level adjustment, which can be a positive or negative amount. |
payment |
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 |
type: string Identifier of the user that created the object. System created and read only. |
payment |
type: DateTime The date and time in UTC format set when the object was created. |
payment |
type: string Identifier of the user that updated the entity most recently. |
payment |
type: DateTime The date and time in UTC format the object was updated most recently. |
payment |
type: string If applicable, the check number associated with the payment action or interaction. |
payment |
type: string The localized currency code for the monetary amount. |
payment |
type: string If required by the payment gateway, the authorization code of the transaction. |
payment |
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 |
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 |
type: int Unique identifier of the payment interaction from the payment gateway. |
payment |
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 |
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 |
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 |
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 |
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 |
type: string Unique identifier of the gateway transaction associated with the payment interaction. |
payment |
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 For email templates, the ID must be one of the following values:
|
payment |
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 |
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 |
type: bool If true, the payment interaction was manually defined s part of offline order processing. |
payment |
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 |
type: string User-entered notation content for an object, used to save information such as payment, return, account, and order notes. |
payment |
type: string Unique identifier of the order associated with the payment. |
payment |
type: string The status of the payment prior to the interaction being performed, which enables manual rollback of previous transactions. |
payment |
type: string Unique identifier of the payment associated with this transaction. |
payment |
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 |
type: string The unique identifier of the refund for a given interaction. |
payment |
type: string The unique identifier of the return associated with a given interaction. |
payment |
type: string The current status of the object. This value is read only. Valid values for this field are: "Active", "Expired", and "Inactive". |
payment |
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 |
type: string The Id of the checkout/order to target. |
payment |
type: int The number of the checkout/order to target. |
payment |
type: string Specifies if the TargetId is a checkout Id or order Id. |
payment |
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 |
type: string Unique identifier of the order associated with the payment. |
payment |
type: string The transaction ID supplied by the payment service to associate with this order payment. |
payment |
type: string The type of payment, such as credit card, check, or PayPal Express. Additional payment types will be supported in future releases. |
payment |
type: string The source of data for this payment. By default, this will be set to 'mozu' |
payment |
type: string The current status of the object. This value is read only. Valid values for this field are: "Active", "Expired", and "Inactive". |
payment |
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 |
type: decimal The amount collected for that portion of the payment. |
payment |
type: decimal The amount credited back for that portion of the payment. |
payment |
type: decimal The amount refunded for that portion of the payment. |
payment |
type: decimal The amount requested for that portion of the payment. |
payment |
type: string The current status of the object. This value is read only. Valid values for this field are: "Active", "Expired", and "Inactive". |
payment |
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 |
type: string The Id of the checkout/order to target. |
payment |
type: int The number of the checkout/order to target. |
payment |
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:
|
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. |