Skip to main content

Order Service

Order services includes purchase and sales order details. These details includes the product quantities and costs.

Order specifies what a buyer must pay the seller according to the seller’s payment terms.

Fulfillment DTO Object

Attributes


AttributeTypeDescription
sequenceintegerSequence format id.
fulfillmentCodestringUnique code for fulfillment.
documentCodestringUnique code for order.
documentTypestringDocument type. Possible values for document type.
fulfillmentItemDtoslistList of items associated with fulfillment. Attributes of Fulfillment Items.
statusstringStatus of the order. Possible values for order status.
autoFulfilledbooleanHas the value true if fulfilled is auto converted or false if it is not.
fulfillmentDatestringDate of the fulillment.
fulfillmentTypeenumFulfillment type of order. Possible values for Fulfillment type
warehouseCodestringUnique code related to the warehouse.

API


Create Fulfillment

Creates a new fulfillment.

Code

  @Autowired
private OrdersApiClient ordersApiClient;

public FulfillmentResponse createFulfillment(FulfillmentRequest fulfillmentRequest, String accessToken){
return this.ordersApiClient.createFulfillment(fulfillmentRequest, accessToken);
}

Objects


FulfillmentItemDetails

AttributeTypeDescription
idlongUnique identifier for item.
pendingQuantityBigDecimalPending quantity of the product.
quantityRequiredBigDecimalThe needed quantity for the product.
productCodestringProduct code of the item.
sequenceintegerSequence format id.
documentItemCodestringProduct code of the item.
fulfilledQuantityBigDecimalThe product quantity needed to fulfilled the order.
fulfillmentDatestringDate of the fulillment.
availableProductQuantityBigDecimalNumber of quantity left of the product.
productNamestringName of product.
productTypestringType of product.
productDescriptionstringDescription of product.
warehouseCodestringUnique code related to the warehouse.

Enums


DOCUMENT_TYPE

  • QUOTATION
  • PURCHASE_ORDER
  • SALES_ORDER
  • PURCHASE_INVOICE
  • SALES_INVOICE
  • MAKE_PAYMENT
  • RECEIVE_PAYMENT
  • JOURNAL_ENTRY
  • CREDIT_NOTE
  • DEBIT_NOTE
  • EXPENSE
  • EXPENSE_PREPAYMENT
  • DEPOSIT
  • DEPOSIT_ADVPAYMENT

ORDER_STATUS

  • UNFULFILLED
  • PARTIAL_FULFILLED
  • FULLY_FULFILLED

FULFILLMENT_TYPE

  • None
  • Default
  • Pick_Pack_Ship
  • Drop_Ship