Pedidos, Produtos e Promoções API

AcceptOrder

Aceita um pedido específico.

Parâmetros de requisição

| Parâmetro | Tipo | Obrigatório | Descrição |
|-----------------|--------|------------|-----------------------------------------|
| action | string | Sim | "AcceptOrder" |
| orderid | int | Sim | ID do pedido |
| serverid | int | Não | ID do servidor para atribuir aos produtos|
| serviceusername | string | Não | Nome de usuário a atribuir aos produtos |
| servicepassword | string | Não | Senha a atribuir aos produtos |
| responsetype | string | Não | "json" |

Exemplo JSON de resposta

{
    "result": "success"
}

AddOrder

Adiciona um novo pedido.

Parâmetros de requisição

| Parâmetro | Tipo | Obrigatório | Descrição |
|-----------------|--------|------------|----------------------------------------|
| action | string | Sim | "AddOrder" |
| userid | int | Sim | ID do usuário |
| pid | string | Sim | Lista de IDs de produtos separados por vírgula |
| responsetype | string | Não | "json" |

Exemplo JSON de resposta

{
    "result": "success",
    "orderid": 123
}

CancelOrder

Cancela um pedido específico.

Parâmetros de requisição

| Parâmetro | Tipo | Obrigatório | Descrição |
|-----------------|--------|------------|-----------------------------------------|
| action | string | Sim | "CancelOrder" |
| orderid | int | Sim | ID do pedido |
| responsetype | string | Não | "json" |

Possíveis respostas de erro

"ID do pedido não encontrado"

Exemplo JSON de resposta

{
    "result": "success"
}

DeleteOrder

Remove um pedido específico.

Parâmetros de requisição

| Parâmetro | Tipo | Obrigatório | Descrição |
|-----------------|--------|------------|-----------------------------------------|
| action | string | Sim | "DeleteOrder" |
| orderid | int | Sim | ID do pedido |
| responsetype | string | Não | "json" |

Possíveis respostas de erro

"ID do pedido não encontrado"

Exemplo JSON de resposta

{
    "result": "success"
}

FraudOrder

Marca um pedido como fraudulento.

Parâmetros de requisição

| Parâmetro | Tipo | Obrigatório | Descrição |
|-----------------|--------|------------|-----------------------------------------|
| action | string | Sim | "FraudOrder" |
| orderid | int | Sim | ID do pedido |
| cancelsub | bool | Não | Cancelar assinaturas associadas |
| responsetype | string | Não | "json" |

Possíveis respostas de erro

"ID do pedido não encontrado"
"Falha ao cancelar assinatura"

Exemplo JSON de resposta

{
    "result": "success"
}

GetOrders

Obtém pedidos que correspondem aos critérios fornecidos.

Parâmetros de requisição

| Parâmetro | Tipo | Obrigatório | Descrição |
|-----------------|--------|------------|----------------------------------------|
| action | string | Sim | "GetOrders" |
| limitstart | int | Não | Offset do retorno (padrão: 0) |
| limitnum | int | Não | Número de registros (padrão: 25) |
| id | int | Não | Buscar pedido específico por ID |
| userid | int | Não | Buscar pedidos de um usuário específico|
| requestor_id | int | Não | Buscar por ID de quem solicitou |
| status | string | Não | Buscar por status |
| responsetype | string | Não | "json" |

Exemplo JSON de resposta

{
    "result": "success",
    "totalresults": 1,
    "startnumber": 0,
    "numreturned": 1,
    "orders": [
        {
            "id": 1,
            "ordernum": 7858259149,
            "userid": 1,
            "status": "Active",
            "amount": "8.00"
        }
    ]
}

GetOrderStatuses

Recupera lista de status de pedidos.

Parâmetros de requisição

| Parâmetro | Tipo | Obrigatório | Descrição |
|----------------|--------|------------|----------------------------|
| action | string | Sim | "GetOrderStatuses" |
| responsetype | string | Não | "json" |

Exemplo JSON de resposta

{
    "result": "success",
    "totalresults": 4,
    "statuses": [
        {"title": "Pending", "count": 1},
        {"title": "Active", "count": 15},
        {"title": "Fraud", "count": 0},
        {"title": "Cancelled", "count": 1}
    ]
}

GetProducts

Obtém produtos que correspondem aos critérios fornecidos.

Parâmetros de requisição

| Parâmetro | Tipo | Obrigatório | Descrição |
|----------------|--------|------------|--------------------------------|
| action | string | Sim | "GetProducts" |
| pid | int | Não | Buscar produto específico |
| gid | int | Não | Buscar produtos por grupo |
| module | string | Não | Buscar produtos por módulo |
| responsetype | string | Não | "json" |

Exemplo JSON de resposta

{
    "result": "success",
    "totalresults": 1,
    "products": [
        {"pid": 1, "name": "Best Hosting Plan", "module": "cpanel", "paytype": "recurring"}
    ]
}

GetPromotions

Obtém promoções que correspondem aos critérios fornecidos.

Parâmetros de requisição

| Parâmetro | Tipo | Obrigatório | Descrição |
|----------------|--------|------------|--------------------------------|
| action | string | Sim | "GetPromotions" |
| code | string | Não | Código promocional específico |
| responsetype | string | Não | "json" |

Exemplo JSON de resposta

{
    "result": "success",
    "totalresults": 1,
    "promotions": [
        {"id": 1, "code": "sample", "type": "Percentage", "value": 10}
    ]
}

OrderFraudCheck

Executa verificação de fraude em um pedido.

Parâmetros de requisição

| Parâmetro | Tipo | Obrigatório | Descrição |
|-----------------|--------|------------|--------------------------------|
| action | string | Sim | "OrderFraudCheck" |
| orderid | int | Sim | ID do pedido |
| ipaddress | string | Não | IP para sobrescrever |
| responsetype | string | Não | "json" |

Possíveis respostas de erro

"ID do pedido não encontrado"
"Nenhum módulo de fraude ativo"

Exemplo JSON de resposta

{
    "result": "success",
    "module": "maxmind",
    "status": "Pass"
}

PendingOrder

Define um pedido e itens como pendentes.

Parâmetros de requisição

| Parâmetro | Tipo | Obrigatório | Descrição |
|-----------------|--------|------------|--------------------------------|
| action | string | Sim | "PendingOrder" |
| orderid | int | Sim | ID do pedido |
| responsetype | string | Não | "json" |

Possíveis respostas de erro

"ID do pedido não encontrado"

Exemplo JSON de resposta

{
    "result": "success"
}