List Fulfillments

List fulfillments with filtering, sorting and pagination support.

Response Body

Field	Description	Type	Notes
data	List of Fulfillments	Fulfillment Objects Array	See - Fulfillment Object
metadata	List fulfillment metadata	List Metadata Object	See - Metadata Object

Fulfillment Object

Field	Description	Type	Notes
id	Fulfillment metallic id	UUID
status	Fulfillment status	String Enumeration - Fulfillment Status Enumeration	Refer to Fulfillment Status Enumeration.
accountId	Account metallic id	UUID	For 'New customer' fulfillment request, this field only present when fulfillment status is 'complete'.
insertTs	Fulfillment created time	Timestamp
updateTs	Fulfillment last updated time	Timestamp
externalAccountId	Account id in partner system	String / UUID
type	Fulfillment type	String	msp_create_account, reseller_cancel_service etc.
userId	User who submitted filfillment request	String	User email.

Metadata Object

Field	Description	Type	Notes
filter	Filter string that contains search parameters	String
sort	Sort string that contains sorting criteria	String
pagination	Pagination Info	Pagination Object	See - Pagination Object

Pagination Object

Field	Description	Type	Notes
pageNumber	Page number	Integer	0 to x
pageSize	Page size	Integer
totalRecords	Total number of records	Integer

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

• 200

---

OK

application/json

• Schema
• List Fulfillments - Success

---

Schema

{
  "data": [
    {
      "id": "587d4d28-066c-406e-b975-5d04e4e47373",
      "insertTs": "2021-11-08T06:50:04",
      "updateTs": "2021-11-08T06:50:40",
      "status": "complete",
      "accountId": "2a920aeb-0ec0-463c-b623-de8c23a48813",
      "externalAccountId": "SWO-ACC-1",
      "type": "msp_cancel_service",
      "userId": "swo-app"
    },
    {
      "id": "08d706b1-9962-44f9-9a6e-a35cb87ac4d1",
      "insertTs": "2021-11-08T06:48:02",
      "updateTs": "2021-11-08T06:48:15",
      "status": "complete",
      "accountId": "2a920aeb-0ec0-463c-b623-de8c23a48813",
      "externalAccountId": "SWO-ACC-1",
      "type": "msp_add_service",
      "userId": "admin@swo.com"
    }
  ],
  "metadata": {
    "sort": "desc:insertTs",
    "filter": "filter=status:complete",
    "pagination": {
      "pageNumber": 0,
      "pageSize": 25,
      "totalRecords": 2
    }
  }
}

Loading...