Get Number Order by Customer ID

GET

https://api.eis.it/v1/numbers/orders/customer/:idCustomer

GET

/v1/numbers/orders/customer/:idCustomer

curl -G https://api.eis.it/v1/numbers/orders/customer/1 \
     -d type=1

[
  {
    "id": 1,
    "tipo": "string",
    "quantity": 1,
    "organization": {
      "organizationId": 1,
      "userId": 1,
      "userName": "string",
      "createDate": "string",
      "modifiedDate": "string",
      "parentOrganizationId": 1,
      "name": "string",
      "type_": "string",
      "sbcId": 1,
      "documentation_URL": "string",
      "support_URL": "string",
      "status_URL": "string",
      "redirect_URL": "string",
      "notificationEmailFromAddress": "string",
      "customerId": 1,
      "manualCoverage": true,
      "coverageIntegration": 1
    },
    "service": {
      "id": 1,
      "serviceList": {
        "id": 1,
        "name": "string",
        "serviceProvider": {
          "id": 1,
          "description": "string"
        },
        "carrier": {
          "id": 1,
          "name": "string"
        },
        "type": {
          "id": 1,
          "name": "string"
        },
        "supplierProductId": 1
      },
      "organizationId": 1,
      "integration": {
        "id": 1,
        "name": "string"
      },
      "name": "string",
      "forDirect": true,
      "forSub": true,
      "carrierType": "string",
      "offsetDays": 1,
      "attributes": null
    },
    "customer": {
      "id": 1,
      "organizationId": 1,
      "name": "string",
      "ragioneSociale": "string",
      "rappresentante": "string",
      "indirizzo": "string",
      "civico": "string",
      "indSedLeg": "string",
      "civicoSedLeg": "string",
      "comuneSedLeg": "string",
      "provinciaSedLeg": "string",
      "regioneSedLeg": "string",
      "capSedLeg": "string",
      "comune": "string",
      "provincia": "string",
      "regione": "string",
      "country": "string",
      "cap": "string",
      "tel": "string",
      "fiscalCode": "string",
      "company": true,
      "userid": 1,
      "mainCustomer": null,
      "createDate": "string",
      "organization": {
        "organizationId": 1,
        "name": "string",
        "documentation_URL": "string",
        "support_URL": "string",
        "status_URL": "string",
        "redirect_URL": "string",
        "notificationEmailFromAddress": "string",
        "customerId": 1,
        "manualCoverage": true,
        "coverageIntegration": 1
      },
      "user": {
        "userId": 1,
        "emailAddress": "string",
        "firstName": "string",
        "lastName": "string",
        "type": {
          "id": 1,
          "name": "string"
        },
        "organizationId": 1,
        "parentOrganizationId": 1,
        "organizationName": "string"
      },
      "associated_users": [
        {}
      ],
      "egonCodeAddress": "string",
      "egonCodeCity": "string",
      "egonCodeMain": "string",
      "rawAddress": "string",
      "piva": "string",
      "ptoponomastica": "string",
      "mainCustomerInfo": null
    },
    "status": {
      "id": 1,
      "code": "string",
      "description": "string",
      "finishStatus": true
    },
    "codeOrderOlo": "string",
    "idOrderOlo": 1,
    "note": "string",
    "region": "string",
    "province": "string",
    "city": "string",
    "prefix": "string",
    "created_time": "string",
    "npDetails": null
  }
]

Retrieve a numbering order by its customer ID. If the organization is not specified, the authenticated user's organization is used.

Path parameters

idCustomerintegerRequired

The customer identifier

Query parameters

typeintegerRequired

Service type identifier used to filter the number orders. This parameter is required; omitting it returns HTTP 400.

Response

Number order retrieved successfully.

idinteger

The unique order identifier

tipostring

The order type

quantityinteger

The ordered quantity

organizationobject

The organization associated with the order

serviceobject

The service associated with the order

customerobject

The customer associated with the order

statusobject

The order status

codeOrderOlostring or nullOptional

The OLO order code

idOrderOlointeger or nullOptional

The OLO order identifier

notestring or nullOptional

Additional notes for the order

regionstring or nullOptional

The region associated with the order

provincestring or nullOptional

The province associated with the order

citystring or nullOptional

The city associated with the order

prefixstring or nullOptional

The number prefix

created_timestring or nullOptional

The order creation date

npDetailsany or nullOptional

Additional numbering plan details

Errors

400

Bad Request Error

404

Not Found Error

500

Internal Server Error