List port-in orders

Request

Retrieve a list of port-in based on the search parameters, you can also specify view here to get less detail

Security

basicAuth or bearerAuth

Query

orderIdnumber

Search by the ID of the order.

orderStatusstring(OrderStatus)read-only

Search by the status of the order.

Enum Value	Description
ORDER_BUILDING	The order is being created
PENDING	The order is pending, and can be updated
CONFIRMED	The order is confirmed, and can not be updated but if onDemand is true it can be activated
COMPLETED	The order is completed, the port has completed and the numbers are active
PENDING_CANCELATION	The order is in the process of being cancelled. During this time you cannot submit the same numbers on a new order
CANCELED	The order is cancelled, either by the customer or by the system

customerOrderReferencestring

The reference you specified when creating the order.

createdDateStartstring, (date-time)

Search by the created date. This query sets the start date of the search period. Formatted as ISO-8601: YYYY-MM-DDThh:mm:ss.SSSZ.

Example:createdDateStart=2024-09-24T12:00:00Z

createdDateEndstring, (date-time)

Search by the created date. This query sets the end date of the search period. Formatted as ISO-8601: YYYY-MM-DDThh:mm:ss.SSSZ.

Example:createdDateEnd=2024-09-24T12:00:00Z

phoneNumberstring

Search by a phone number.

focStartDatestring, (date-time)

Search by the firm order confirmation. This query sets the start date of the search period. Formatted as ISO-8601: YYYY-MM-DDThh:mm:ss.SSSZ.

Example:focStartDate=2024-09-24T12:00:00Z

focEndDatestring, (date-time)

Search by the firm order confirmation. This query sets the end date of the search period. Formatted as ISO-8601: YYYY-MM-DDThh:mm:ss.SSSZ.

Example:focEndDate=2024-09-24T12:00:00Z

pageSizeinteger, [ 1 .. 1000 ]

The maximum number of items to return per request. The default is 100 and the maximum is 1000. If you need to export larger amounts and pagination is not suitable for you can use the Export function in the dashboard.

pagestring

The page you want to retrieve returned from a previous List request, if any

curl -i -X GET \
  -u '<username>:<password>' \
  'https://porting.api.sinch.com/v1/projects/YOUR_project_id/orders/portIns?orderId=0&orderStatus=PENDING&customerOrderReference=string&createdDateStart=2024-09-24T12%3A00%3A00Z&createdDateEnd=2024-09-24T12%3A00%3A00Z&phoneNumber=string&focStartDate=2024-09-24T12%3A00%3A00Z&focEndDate=2024-09-24T12%3A00%3A00Z&pageSize=1&page=string'

Responses

Successful operation

Bodyapplication/json

ordersArray of objects(OrderListItem)

pageintegerread-only

Current page.

totalPagesintegerread-only

Total number of pages.

pageSizeintegerread-only

Number of items per page.

totalItemsinteger, (int32)read-only

Total size of the result.

Response

{
  "orders": [
    { … }
  ],
  "page": 0,
  "totalPages": 0,
  "pageSize": 0,
  "totalItems": 0
}

We'd love to hear from you!