Package com.commercetools.importapi.models.inventories

Interface InventoryImport

All Superinterfaces:
ImportResource
public interface InventoryImport extends ImportResource

Represents the data used to import an InventoryEntry. Once imported, this data is persisted as a InventoryEntry in the Project.

Example to create an instance using the builder pattern 

     InventoryImport inventoryImport = InventoryImport.builder()
             .key("{key}")
             .sku("{sku}")
             .quantityOnStock(0.3)
             .build()

  • Method Details

    • getKey

      @NotNull @NotNull String getKey()

      User-defined unique identifier. If an InventoryEntry with this key exists, it is updated with the imported data.

      Specified by:
      getKey in interface ImportResource
      Returns:
      key

    • getSku

      @NotNull @NotNull String getSku()

      Maps to InventoryEntry.sku

      Returns:
      sku

    • getQuantityOnStock

      @NotNull @NotNull Long getQuantityOnStock()

      Maps to InventoryEntry.quantityOnStock

      Returns:
      quantityOnStock

    • getRestockableInDays

      Long getRestockableInDays()

      Maps to InventoryEntry.restockableInDays

      Returns:
      restockableInDays

    • getExpectedDelivery

      ZonedDateTime getExpectedDelivery()

      Maps to InventoryEntry.expectedDelivery

      Returns:
      expectedDelivery

    • getSupplyChannel

      @Valid @Valid ChannelKeyReference getSupplyChannel()

      Maps to InventoryEntry.supplyChannel. If the referenced Channel does not exist, the state of the ImportOperation will be set to unresolved until the referenced Channel is created.

      Returns:
      supplyChannel

    • getCustom

      @Valid @Valid Custom getCustom()

      Maps to InventoryEntry.custom.

      Returns:
      custom

    • setKey

      void setKey(String key)

      User-defined unique identifier. If an InventoryEntry with this key exists, it is updated with the imported data.

      Specified by:
      setKey in interface ImportResource
      Parameters:
      key - value to be set

    • setSku

      void setSku(String sku)

      Maps to InventoryEntry.sku

      Parameters:
      sku - value to be set

    • setQuantityOnStock

      void setQuantityOnStock(Long quantityOnStock)

      Maps to InventoryEntry.quantityOnStock

      Parameters:
      quantityOnStock - value to be set

    • setRestockableInDays

      void setRestockableInDays(Long restockableInDays)

      Maps to InventoryEntry.restockableInDays

      Parameters:
      restockableInDays - value to be set

    • setExpectedDelivery

      void setExpectedDelivery(ZonedDateTime expectedDelivery)

      Maps to InventoryEntry.expectedDelivery

      Parameters:
      expectedDelivery - value to be set

    • setSupplyChannel

      void setSupplyChannel(ChannelKeyReference supplyChannel)

      Maps to InventoryEntry.supplyChannel. If the referenced Channel does not exist, the state of the ImportOperation will be set to unresolved until the referenced Channel is created.

      Parameters:
      supplyChannel - value to be set

    • setCustom

      void setCustom(Custom custom)

      Maps to InventoryEntry.custom.

      Parameters:
      custom - value to be set

    • of

      static InventoryImport of()
      factory method
      Returns:
      instance of InventoryImport

    • of

      static InventoryImport of(InventoryImport template)
      factory method to create a shallow copy InventoryImport
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • copyDeep

      InventoryImport copyDeep()
      Specified by:
      copyDeep in interface ImportResource

    • deepCopy

      @Nullable static InventoryImport deepCopy(@Nullable InventoryImport template)
      factory method to create a deep copy of InventoryImport
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • builder

      static InventoryImportBuilder builder()
      builder factory method for InventoryImport
      Returns:
      builder

    • builder

      static InventoryImportBuilder builder(InventoryImport template)
      create builder for InventoryImport instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder

    • withInventoryImport

      default <T> T withInventoryImport(Function<InventoryImport,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value

    • typeReference

      static com.fasterxml.jackson.core.type.TypeReference<InventoryImport> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference