Skip to main content

Fulfillment

Fulfillment is all the steps a organisation takes between receiving a new order and placing that order into the customer’s hands. The practice involves warehousing, picking and packing the product, shipping it.

Fulfillment Object

Attributes


AttributeTypeDescription
autoFulfilledbooleanFlag will pass as true for auto fulfilled flow.
documentCodestringDocument code
documentTypestringDocument Type, Stage from where fulfillment is requested.
fulfillmentDatestringFulfillment date
fulfillmentItemslistFulfillment item details. Attribute for fulfillmentItems
fulfillmentTypeenumPossible values for fulfillmentType
fulfillmentCodestringFulfillment specific unique code
idlongUnique identifier for the fulfillment.
sequenceintFulfillment group sequence
statusstringFulfillment status
warehouseCodestringwarehouse code

API


List All Fulfillments

Returns list of fulfillments.

Parameters

Code

  @Autowired
private InventoryApiClient inventoryApiClient;

public RestResponsePage getFulfillmentData(String accessToken, String page, String limit){
return this.inventoryApiClient.getFulfillmentData(accessToken, page, limit);
}

Objects


FulfillmentItemDto

NameTypeDescription
availableProductQuantityBigDecimal
documentItemCodestringDocument order code, It will be Quotaion/Invoice item code.
fulfilledQuantityBigDecimalFulfilled quantity
fulfillmentDatestringFulfillment date
idlongUnique identifier for the fulfillment item.
pendingQuantityBigDecimal
productCodestringProduct code
productDescriptionstringProduct description
productNamestringProduct Name
productTypestringProduct type
sequenceintFulfillment item sequence
quantityRequiredBigDecimalOrdered Quantity
warehouseCodestringWarehouse code

Pageable

NameTypeDescription
offsetlong
pageNumberint
pageSizeint
pagedboolean
sortSort
unpagedboolean

Sort

NameTypeDescription
emptyboolean
sortedboolean
unsortedboolean

Page«FulfillmentResponse»

NameTypeDescription
contentlistList of Fulfillment. Attribute for content
emptyboolean
firstboolean
lastboolean
numberint
numberOfElementsint
pageablePageable
sizeint
sortSort
totalElementslong
totalPagesint

Enums


FULFILLMENT_TYPE

  • NONE
  • DEFAULT
  • PICK_PACK_SHIP
  • DROP_SHIP