APIs V2

Descreve as APIs disponíveis no sistema

Relatório - Listagem de Ingressos

Essa API irá retornar todos os ingressos gerados no sistema:

Formato da requisição:
Parâmetros aceitos: 
Exemplo de requisição:
Reposta da requisição:

Será retornado um JSON com os seguintes dados:

{
  "status": "success",
  "message": "Ingressos listados com sucesso!",
  "data": {
    "current_page": 2,
    "data": [
      {
        "identifier": "",
        "company_sequence": "",
        "type": {
          "value": "",
          "key": "",
          "description": ""
        },
        "status": {
          "value": "",
          "key": "",
          "description": ""
        },
        "created_at": "",
        "updated_at": "",
        "deleted_at": "",
        "certificate_released": "",
        "ticket_released": "",
        "product": {
          "name": "",
          "company_sequence": "",
          "description": "",
          "short_description": "",
          "rules_and_polices": "",
          "slug": "",
          "created_at": "",
          "updated_at": "",
          "deleted_at": "",
          "control_product_variation": "",
          "availability_control": "",
          "inform_user": "",
          "tickets_amount": "",
          "enable_pdf_ticket": "",
          "enable_period": "",
          "ticket_type": {
            "value": "",
            "key": "",
            "description": ""
          },
          "release_certificate": "",
          "certificates_sent_at": "",
          "send_to_yazo": "",
          "from_value": "",
          "product_certificate": {
            "id": "",
            "product_id": "",
            "name": "",
            "path": "",
            "created_at": "",
            "updated_at": "",
            "elements": ""
          }
        },
        "order_item": {
          "company_sequence": "",
          "product_name": "",
          "product_control_variation": "",
          "product_variation_name": "",
          "date": "",
          "time": "",
          "gross_value": "",
          "discount": "",
          "amount": "",
          "net_value": "",
          "created_at": "",
          "updated_at": "",
          "deleted_at": "",
          "product_variation_description": "",
          "product_inform_user": "",
          "tickets_amount": "",
          "displayed_tax": "",
          "unitary_discount_value": "",
          "order": {
            "company_sequence": "",
            "status": {
              "value": "",
              "key": "",
              "description": ""
            },
            "sale_origin": "",
            "created_at": "",
            "updated_at": "",
            "deleted_at": "",
            "confirmation_date": "",
            "valid_until": "",
            "customer": {
              "company_sequence": "",
              "email": "",
              "phone": "",
              "types": "",
              "created_at": "",
              "updated_at": "",
              "token_created_at": "",
              "token_valid_at": "",
              "type": {
                "company_sequence": "",
                "company_name": "",
                "trade_name": "",
                "document_number": "",
                "state_registration": "",
                "created_at": "",
                "updated_at": ""
              }
            }
          }
        },
        "person": null,
        "ticket_credential_printouts": []
      }
    ],
    "first_page_url": "https://app.ciano.app/api/v2/ticket/report?page=1",
    "from": 31,
    "last_page": 15,
    "last_page_url": "https://app.ciano.app/api/v2/ticket/report?page=15",
    "links": [
      {
        "url": "https://app.ciano.app/api/v2/ticket/report?page=1",
        "label": "«",
        "active": false
      },
      {
        "url": "https://app.ciano.app/api/v2/ticket/report?page=1",
        "label": "1",
        "active": false
      },
      {
        "url": "https://app.ciano.app/api/v2/ticket/report?page=2",
        "label": "2",
        "active": true
      },
      {
        "url": "https://app.ciano.app/api/v2/ticket/report?page=3",
        "label": "3",
        "active": false
      },
      {
        "url": "https://app.ciano.app/api/v2/ticket/report?page=4",
        "label": "4",
        "active": false
      },
      {
        "url": "https://app.ciano.app/api/v2/ticket/report?page=5",
        "label": "5",
        "active": false
      },
      {
        "url": "https://app.ciano.app/api/v2/ticket/report?page=6",
        "label": "6",
        "active": false
      },
      {
        "url": "https://app.ciano.app/api/v2/ticket/report?page=7",
        "label": "7",
        "active": false
      },
      {
        "url": "https://app.ciano.app/api/v2/ticket/report?page=8",
        "label": "8",
        "active": false
      },
      {
        "url": "https://app.ciano.app/api/v2/ticket/report?page=9",
        "label": "9",
        "active": false
      },
      {
        "url": "https://app.ciano.app/api/v2/ticket/report?page=10",
        "label": "10",
        "active": false
      },
      {
        "url": null,
        "label": "...",
        "active": false
      },
      {
        "url": "https://app.ciano.app/api/v2/ticket/report?page=14",
        "label": "14",
        "active": false
      },
      {
        "url": "https://app.ciano.app/api/v2/ticket/report?page=15",
        "label": "15",
        "active": false
      },
      {
        "url": "https://app.ciano.app/api/v2/ticket/report?page=3",
        "label": "»",
        "active": false
      }
    ],
    "next_page_url": "https://app.ciano.app/api/v2/ticket/report?page=3",
    "path": "https://app.ciano.app/api/v2/ticket/report",
    "per_page": 30,
    "prev_page_url": "https://app.ciano.app/api/v2/ticket/report?page=1",
    "to": 60,
    "total": 432
  },
  "validation_errors": []
}

Relatório - Listagem de Pedidos

Essa API irá retornar todos os pedidos :

Formato da requisição:
Parâmetros aceitos: 
Exemplo de requisição:
Status:
Status Código
discarded 0
open 1
confirmed 2
canceled 4
unknown 5
processing 6

Reposta da requisição:

Será retornado um JSON com os seguintes dados:

{
    "status": "success",
    "message": "Pedidos listados com sucesso!",
    "data": {
        "current_page": 1,
        "data": [
            {
                "company_sequence": 20,
                "status": {
                    "value": 0,
                    "key": "discarded",
                    "description": "Descartado"
                },
                "sale_origin": 1,
                "created_at": "2023-11-09T19:41:34.000000Z",
                "updated_at": "2023-11-09T19:42:06.000000Z",
                "confirmation_date": null,
                "items": [
                    {
                        "company_sequence": 14,
                        "product_name": "Ingresso",
                        "product_control_variation": 0,
                        "product_variation_name": "Default",
                        "gross_value": 5,
                        "amount": 1,
                        "net_value": 5,
                        "unitary_discount_value": 0
                    }
                ],
                "order_transactions": []
            }
        ],
        "first_page_url": "https://app.ciano.app/api/v2/order/report?page=1",
        "from": 1,
        "last_page": 2,
        "last_page_url": "https://app.ciano.app/api/v2/order/report?page=2",
        "links": [
            {
                "url": null,
                "label": "«",
                "active": false
            },
            {
                "url": "https://app.ciano.app/api/v2/order/report?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": "https://app.ciano.app/api/v2/order/report?page=2",
                "label": "2",
                "active": false
            },
            {
                "url": "https://app.ciano.app/api/v2/order/report?page=2",
                "label": "»",
                "active": false
            }
        ],
        "next_page_url": "https://app.ciano.app/api/v2/order/report?page=2",
        "path": "https://app.ciano.app/api/v2/order/report",
        "per_page": 30,
        "prev_page_url": null,
        "to": 30,
        "total": 57
    },
    "validation_errors": []
}