Guías de remisión

Listar guías de remisión

GET
/v1/ec/delivery-notes

Del más reciente al más antiguo, en el ambiente de tu clave.

Autorización

AutorizaciónBearer <tu clave API>

Tu clave API: fb_sandbox_… emite en Sandbox, fb_test_… en test, el servicio de pruebas de la autoridad tributaria, y fb_live_… en live, su producción.

En: header

Parámetros de consulta

limit?integer

Cuántos por página, de 1 a 100.

Rango1 <= value <= 100
Por defecto20
cursor?string

El next_cursor o el prev_cursor de una respuesta anterior. Sin cursor, la primera página.

Longitudlength <= 200
status?|array<>

Solo en estos estados; repítelo para varios (status=returned&status=not_authorized).

channel?|array<>

Solo los que llegaron por estos canales; repítelo para varios.

entity_id?string

Solo los de este negocio; sin él, los de todos los negocios de tu organización en este ambiente.

Formatouuid
counterparty?string

La identificación del comprador o proveedor del comprobante; en una guía de remisión, la del transportista o la de cualquiera de sus destinatarios.

q?string

Busca palabras en el número (001-001-000000123), la clave de acceso, el nombre de quien figura en el comprobante (sin distinguir mayúsculas ni tildes) o el inicio de su identificación. Cada palabra debe aparecer en alguna parte; se combina con los demás filtros.

Longitud1 <= length <= 100
issue_date[gte]?string
Formatodate
issue_date[lte]?string
Formatodate
created_at[gte]?string
Formatodate-time
created_at[lte]?string
Formatodate-time
metadata?

Solo los comprobantes cuya metadata tiene exactamente estos pares, por ejemplo metadata[shopify_order_id]=5812345678901. Hasta 20; todos deben coincidir.

Cuerpo de la respuesta

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/v1/ec/delivery-notes"
{  "object": "list",  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "country": "ec",      "currency": "string",      "environment": "sandbox",      "status": "pending",      "status_transitions": {        "pending": "2019-08-24T14:15:22Z",        "submitted": "2019-08-24T14:15:22Z",        "authorized": "2019-08-24T14:15:22Z",        "returned": "2019-08-24T14:15:22Z",        "not_authorized": "2019-08-24T14:15:22Z",        "annulled": "2019-08-24T14:15:22Z"      },      "entity_id": "8161163a-f227-466f-bc01-090a01e80165",      "number": "string",      "access_key": "stringstringstringstringstringstringstringstrings",      "authorization": {        "number": "string",        "authorized_at": "2019-08-24T14:15:22Z"      },      "sri_messages": [        {          "code": "string",          "message": "string",          "detail": "string",          "type": "error"        }      ],      "metadata": {        "property1": "string",        "property2": "string"      },      "issued_at": "2019-08-24T14:15:22Z",      "delivery_status": "sent",      "emails": [        {          "to": "string",          "status": "sent",          "sent_at": "2019-08-24T14:15:22Z",          "delivered_at": "2019-08-24T14:15:22Z",          "opened_at": "2019-08-24T14:15:22Z",          "bounced_at": "2019-08-24T14:15:22Z",          "complained_at": "2019-08-24T14:15:22Z",          "bounce_type": "permanent"        }      ],      "portal_views": 0,      "portal_last_viewed_at": "2019-08-24T14:15:22Z",      "channel": "api",      "import_id": "13230382-dadc-41f2-963d-e123bd5c0585",      "verification": "sri",      "listing": {        "import_id": "13230382-dadc-41f2-963d-e123bd5c0585",        "file": "string",        "entry": "string",        "sha256": "stringstringstringstringstringstringstringstringstringstringstri",        "line": 1,        "authorized_at": "2019-08-24T14:15:22Z"      },      "object": "delivery_note",      "issue_date": "string",      "origin_address": "string",      "carrier": {        "identification_type": "ruc",        "identification": "string",        "name": "string"      },      "plate": "string",      "transport_start": "string",      "transport_end": "string",      "recipients": [        {          "identification": "string",          "name": "string",          "address": "string",          "email": "string",          "reason": "string",          "route": "string",          "customs_document": "string",          "destination_establishment": "string",          "support_document": {            "document_type": "factura",            "number": "string",            "issue_date": "string",            "authorization_number": "string"          },          "items": [            {              "code": "string",              "auxiliary_code": "string",              "description": "string",              "quantity": "string",              "additional_info": [                {                  "name": "string",                  "value": "string"                }              ]            }          ]        }      ],      "fiscal_machine": {        "brand": "string",        "model": "string",        "serial": "string"      },      "additional_info": [        {          "name": "string",          "value": "string"        }      ],      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "next_cursor": "string",  "prev_cursor": "string",  "total_count": 0,  "offset": 0}