Skip to main content
GET
/
broker
/
order
cURL
curl --request GET \
  --url https://apicorp.algartelecom.com.br/telecom/product-Inventory-management/management/v1/broker/order \
  --header 'Content-Type: <content-type>' \
  --header 'access_token: <access_token>' \
  --header 'client_id: <client_id>'
[
  {
    "id": 442,
    "name": "Teste Pedido",
    "customer": {
      "id": 567878,
      "name": "TESTE CLIENTES"
    },
    "customerId": 10258,
    "virtualContract": {
      "id": 784,
      "planDesc": "Silver plan",
      "franchise": 10,
      "operatorDiffChargeFlag": "T",
      "payPerUseFlag": "T",
      "sharingType": 1
    },
    "virtualPlanId": 3119,
    "createdAt": "2021-11-09T18:06:35.000Z",
    "cpfCnpj": "6357980698",
    "status": "ACTIVE",
    "value": "7.5",
    "activationPrice": "4.5",
    "createdBy": "[email protected]",
    "megabyteExcPrice": "12",
    "automaticBlocking": true,
    "loyaltyType": 1,
    "loyaltyTime": 12012021,
    "penalty": "125,00",
    "tradeInMonths": 2,
    "preActivationExemptTraffic": 8,
    "activationDate": "string",
    "nbSimcards": 2,
    "trackingNumbers": [
      "CODIGO_1,CODIGO_2,CODIGO_3"
    ]
  }
]

Headers

​
Content-Type
string
default:application/json
required

Define o formato da requisição.

🔹 Valor padrão:

application/json

📌 Dica: Copie e cole esse valor no campo Content-Type.

Example:

"application/json"

​
client_id
string
required
Example:

"client_id"

​
access_token
string
required

Token gerado.

Example:

"access_token"

Query Parameters

​
costumerId
integer

Identificador do pedido

Example:

"676543"

​
id
number

Identificador do plano

Example:

"id"

​
name
string

Nome do pedido

Example:

"name"

​
type
string
default:pay

Identifica se a consulta é de pedidos a pagar ou receber (pay ou receive)

Example:

"pay"

​
status
string

Status do pedido. Available values : ACTIVE, PROCESSING, ERROR, ERROR_SENDING_KAFKA, ARCHIVED

Example:

"status"

​
showContracted
boolean

Contratos a pagar e a receber

Example:

" true (Contratos a pagar), false (Contrato a receber)"

​
page
integer<int32>
default:0
required

Número da página para paginação.

Example:

0

​
pageSize
integer<int32>
default:24

Tamanho da página para paginação.

Example:

24

​
unit
string
default:MB, B, KB, GB

Unidade que deseja retorno

Example:

"MB"

Response

OK