Package com.commercetools.api.models.type

Interface ResourceTypeId

All Superinterfaces:
JsonEnum
All Known Implementing Classes:
ResourceTypeId.ResourceTypeIdEnum
public interface ResourceTypeId extends JsonEnum

With Types, you can model your own Custom Fields on the following resources and data types.

  • Field Details

    • ADDRESS

      static final ResourceTypeId ADDRESS

      Address on BusinessUnit, Cart, Order, OrderEdit, Customer, and Channel

    • ASSET

      static final ResourceTypeId ASSET

      Asset on Category and ProductVariant

    • APPROVAL_FLOW

      static final ResourceTypeId APPROVAL_FLOW

      ApprovalFlow

    • APPROVAL_RULE

      static final ResourceTypeId APPROVAL_RULE

      ApprovalRule

    • ASSOCIATE_ROLE

      static final ResourceTypeId ASSOCIATE_ROLE

      AssociateRole

    • BUSINESS_UNIT

      static final ResourceTypeId BUSINESS_UNIT

      BusinessUnit

    • CART_DISCOUNT

      static final ResourceTypeId CART_DISCOUNT

      CartDiscount

    • CATEGORY

      static final ResourceTypeId CATEGORY

      Category

    • CHANNEL

      static final ResourceTypeId CHANNEL

      Channel

    • CUSTOMER

      static final ResourceTypeId CUSTOMER

      Customer

    • CUSTOMER_GROUP

      static final ResourceTypeId CUSTOMER_GROUP

      CustomerGroup

    • CUSTOM_LINE_ITEM

      static final ResourceTypeId CUSTOM_LINE_ITEM

      CustomLineItem on Cart and Order

    • DISCOUNT_CODE

      static final ResourceTypeId DISCOUNT_CODE

      DiscountCode

    • INVENTORY_ENTRY

      static final ResourceTypeId INVENTORY_ENTRY

      InventoryEntry

    • LINE_ITEM

      static final ResourceTypeId LINE_ITEM

      LineItem on Cart and Order, and LineItem on ShoppingList

    • ORDER

      static final ResourceTypeId ORDER

      Cart and Order. When a Cart is ordered, the CustomFields need to be copied to the Order. For this reason, the Types for Carts are also valid for Orders, and hence both have the same identifier: order.

    • ORDER_EDIT

      static final ResourceTypeId ORDER_EDIT

      OrderEdit

    • ORDER_DELIVERY

      static final ResourceTypeId ORDER_DELIVERY

      Delivery

    • ORDER_PARCEL

      static final ResourceTypeId ORDER_PARCEL

      Parcel

    • ORDER_RETURN_ITEM

      static final ResourceTypeId ORDER_RETURN_ITEM

      ReturnItem

    • PAYMENT

      static final ResourceTypeId PAYMENT

      Payment

    • PAYMENT_INTERFACE_INTERACTION

      static final ResourceTypeId PAYMENT_INTERFACE_INTERACTION

      InterfaceInteraction on Payment

    • PRODUCT_PRICE

      static final ResourceTypeId PRODUCT_PRICE

      Embedded Price on ProductVariant

    • PRODUCT_SELECTION

      static final ResourceTypeId PRODUCT_SELECTION

      ProductSelection

    • PRODUCT_TAILORING

      static final ResourceTypeId PRODUCT_TAILORING

      ProductTailoring

    • QUOTE

      static final ResourceTypeId QUOTE

      Quote, QuoteRequest and StagedQuote. When a StagedQuote is created, the CustomFields will be copied from the QuoteRequest and when a Quote is created, the CustomFields will be copied from the StagedQuote. For this reason, the Types for Quotes are also valid for QuoteRequests and StagedQuotes, and hence all have the same identifier: quote.

    • REVIEW

      static final ResourceTypeId REVIEW

      Review

    • SHIPPING

      static final ResourceTypeId SHIPPING

      Shipping

    • SHIPPING_METHOD

      static final ResourceTypeId SHIPPING_METHOD

      ShippingMethod

    • SHOPPING_LIST

      static final ResourceTypeId SHOPPING_LIST

      ShoppingList

    • SHOPPING_LIST_TEXT_LINE_ITEM

      static final ResourceTypeId SHOPPING_LIST_TEXT_LINE_ITEM

      TextLineItem on ShoppingList

    • STANDALONE_PRICE

      static final ResourceTypeId STANDALONE_PRICE

      StandalonePrice

    • STORE

      static final ResourceTypeId STORE

      Store

    • TRANSACTION

      static final ResourceTypeId TRANSACTION

      Transaction on Payment

  • Method Details

    • getJsonName

      String getJsonName()
      the JSON value
      Specified by:
      getJsonName in interface JsonEnum
      Returns:
      json value

    • name

      String name()
      the enum value
      Specified by:
      name in interface JsonEnum
      Returns:
      name

    • toString

      String toString()
      convert value to string
      Specified by:
      toString in interface JsonEnum
      Overrides:
      toString in class Object
      Returns:
      string representation

    • findEnum

      static ResourceTypeId findEnum(String value)
      factory method for a enum value of ResourceTypeId if no enum has been found an anonymous instance will be created
      Parameters:
      value - the enum value to be wrapped
      Returns:
      enum instance

    • findEnumViaJsonName

      static Optional<ResourceTypeId> findEnumViaJsonName(String jsonName)
      method to find enum using the JSON value
      Parameters:
      jsonName - the json value to be wrapped
      Returns:
      optional of enum instance

    • values

      static ResourceTypeId[] values()
      possible enum values
      Returns:
      array of possible enum values