Skip to main content

List Fulfillments

List fulfillments with filtering, sorting and pagination support.

Response Body

FieldDescriptionTypeNotes
dataList of FulfillmentsFulfillment Objects ArraySee - Fulfillment Object
metadataList fulfillment metadataList Metadata ObjectSee - Metadata Object
Fulfillment Object
FieldDescriptionTypeNotes
idFulfillment metallic idUUID
statusFulfillment statusString Enumeration - Fulfillment Status EnumerationRefer to Fulfillment Status Enumeration.
accountIdAccount metallic idUUIDFor 'New customer' fulfillment request, this field only present when fulfillment status is 'complete'.
insertTsFulfillment created timeTimestamp
updateTsFulfillment last updated timeTimestamp
externalAccountIdAccount id in partner systemString / UUID
typeFulfillment typeStringmsp_create_account, reseller_cancel_service etc.
userIdUser who submitted filfillment requestStringUser email.
Metadata Object
FieldDescriptionTypeNotes
filterFilter string that contains search parametersString
sortSort string that contains sorting criteriaString
paginationPagination InfoPagination ObjectSee - Pagination Object
Pagination Object
FieldDescriptionTypeNotes
pageNumberPage numberInteger0 to x
pageSizePage sizeInteger
totalRecordsTotal number of recordsInteger
Query Parameters
  • filter string

    Optional - Filter.Only status filter is available on search fulfillments.

  • sort string

    Optional - Sort order. default desc:updateTs

  • pageNumber int32

    Optional - Page number >=0. default 0

  • pageSize int32

    Optional - Size of each page. default 25

Responses

OK


Schema
    Loading...