API docs by Redocly

Documentación Oficial de API-CONNECT (1.0.11)

Documentación oficial para realizar las implementaciones de los servicios API de CT-CONNECT donde se hara la integracion de nuestro catalogo a su tienda online.

Regresar a CT-Connect

Autenticación

Las credenciales de autenticación son utilizadas para acreditación de todas las llamadas al servidor de CT-CONNECT por medio de la autenticación basada en Tokens.

Generación de token

Se requiere solicitar integración a un representante CT para poder generar un token valido y vigente.

Request Body schema: application/json
required

Para genrar un token son necesarios 3 atributos proporcionados por un representante de CT

email
required
string

Correo con el cual se registro como cliente CT

cliente
required
string

Número de cliente CT

rfc
required
string

RFC proporcionado en el registro como cliente CT

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJfaWQiOiI1ODZkNTM5MmY1ZmYwZjQ5NTcwOTk5ZjYiLCJhY2Nlc3MiOiJhdXRoIiwiaWF0IjoxNDgzNTU5OTM0fQ.lHoLBCLDYiM6jmgnxTdj0v5GGB8jkpiJtZF2Obyh9X4",
  • "time": "2023-11-23T18:30:02.046Z"
}

Artículos

Servicios de consulta de información de artículos.

Listado de productos

Listado completo de articulos para la verificacion de existencia, promociones y precio. Solo puede ser utilizado con token valido y vigente.

header Parameters
x-auth
required
string

Token de autorización

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Existencia por codigo

Verificar la existencia por artículo en almacenes solo puede ser realizado con el código, un token valido y vigente.

query Parameters
codigo
required
string

Clave CT del articulo a consultar

header Parameters
x-auth
required
string

Token de autorización

Responses

Response samples

Content type
application/json
{
  • "01A": {
    },
  • "02A": {
    },
  • "03A": {
    },
  • "04A": {
    },
  • "05A": {
    },
  • "06A": {
    },
  • "07A": {
    },
  • "08A": {
    },
  • "09A": {
    },
  • "10A": {
    },
  • "11A": {
    },
  • "12A": {
    },
  • "13A": {
    },
  • "14A": {
    },
  • "15A": {
    },
  • "16A": {
    },
  • "17A": {
    },
  • "18A": {
    },
  • "19A": {
    },
  • "20A": {
    },
  • "21A": {
    },
  • "22A": {
    },
  • "23A": {
    },
  • "24A": {
    },
  • "25A": {
    },
  • "26A": {
    },
  • "27A": {
    },
  • "28A": {
    },
  • "29A": {
    },
  • "30A": {
    },
  • "31A": {
    },
  • "32A": {
    },
  • "33A": {
    },
  • "34A": {
    },
  • "35A": {
    },
  • "36A": {
    },
  • "37A": {
    },
  • "38A": {
    },
  • "39A": {
    },
  • "40A": {
    },
  • "41A": {
    },
  • "42A": {
    },
  • "43A": {
    },
  • "44A": {
    },
  • "45A": {
    },
  • "46A": {
    },
  • "47A": {
    },
  • "48A": {
    },
  • "49A": {
    }
}

Artículo por almacén

Verificar la existencia por artículo en un almacén solo puede ser realizado con el código, un token valido y vigente.

query Parameters
codigo
required
string

Clave CT del articulo a consultar

almacen
string

Codigo de almacén a consultar

header Parameters
x-auth
required
string

Token de autorización

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Detalle por almacén

Verificar la existencia detallada por artículo en un almacén solo puede ser realizado con el código, un token valido y vigente.

query Parameters
codigo
required
string

Clave CT del articulo a consultar

almacen
required
string

Codigo de almacén a consultar

header Parameters
x-auth
required
string

Token de autorización

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Total de artículo

Verificar la existencia Total de un artículo en todos los almacenes solo puede ser realizado con el código, un token valido y vigente.

query Parameters
codigo
required
string

Clave CT del articulo a consultar

header Parameters
x-auth
required
string

Token de autorización

Responses

Response samples

Content type
application/json
{
  • "existencia_total": 5696
}

Promoción y precio por artículo

Verificar el artículo que tengan existencia, promoción y precio solo puede ser realizado con un código, un token valido y vigente.

query Parameters
codigo
required
string

Clave CT del articulo a consultar

header Parameters
x-auth
required
string

Token de autorización

Responses

Response samples

Content type
application/json
{
  • "codigo": "ACCBLC010",
  • "precio": 6.14,
  • "moneda": "USD",
  • "almacenes": [
    ]
}

Orden de Compra

Servicios esenciales para la generación y seguimiento de una orden de compra, para el uso de los servicios es necesario contar un el token de autorización y que se encuentre vigente.

Solicitar Pedido

Servicio para la petición de solicitud de un pedido, para la solicitud de pedido es necesario consultar previamente la existencia y precios de los productos con el apoyo de los servicios de artículos. Para el uso del servicio se requiere un token valido y vigente.

header Parameters
x-auth
required
string

Token de autorización

Request Body schema: application/json
required
idPedido
integer

Número de referencia por parte del cliente.

almacen
string

Código del almácen donde se va a tomar la existencia.

tipoPago
string

Número que identifica el tipo de pago (99-Crédito CT).

cfdi
string

Clave fiscal con la que se hara la facturacion (G01 por defecto).

Array of objects (Envio)

Arreglo de objetos con los datos para realizar el envió.

Array of objects (Producto)

Arreglo de objetos con el detalle de cada producto del pedido.

Responses

Request samples

Content type
application/json
{
  • "idPedido": 1,
  • "almacen": "01A",
  • "tipoPago": "99",
  • "cfdi": "G01",
  • "envio": [
    ],
  • "producto": [
    ]
}

Response samples

Content type
application/json
{
  • "idPedido": 1,
  • "almacen": "01A",
  • "tipoPago": "99",
  • "envio": [
    ],
  • "producto": [
    ],
  • "respuestaCT": {
    }
}

Confirmar pedido

Confirmar pedido solo puede ser realizado con el folio, un token valido y vigente. !Nota! Si el pedido no es confirmado en un lapso de 48 horas, será cancelado automáticamente por el sistema.

header Parameters
x-auth
required
string

Token de autorización

Request Body schema: application/json
required
Schema not provided

Responses

Response samples

Content type
application/json
{
  • "okCode": "2000",
  • "okMessage": "¡Ok, se procesó satisfactoriamente!",
  • "okReference": "Se ha confirmado el pedido"
}

Enviar guías

Enviar guias solo puede ser realizado con un token valido y vigente. !Nota! El envio de guias es necesario si el cliente requiere se agreguen a los pedidos solicitados.

header Parameters
x-auth
required
string

Token de autorización

Request Body schema: application/json
required
folio
string

Folio de identificacion de pedido.

Array of objects (Guia)

Array de objecto con las guías que se van asociar al pedido.

Responses

Request samples

Content type
application/json
{
  • "folio": "W01-000001",
  • "guias": [
    ]
}

Response samples

Content type
application/json
{
  • "okCode": "2000",
  • "okMessage": "¡Ok, se procesó satisfactoriamente!",
  • "okReference": "Guías recibidas, el pedido se encuentra en proceso de envió"
}

Listar Pedidos

Listar pedidos solo puede ser realizado con un token valido y vigente. !Nota! El cliente puede generar una lista de los pedidos realizados a CT.

header Parameters
x-auth
required
string

Token de autorización

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Consultar Estatus

Consultar el estatus de un pedido solo puede ser realizado con el folio, un token valido y vigente. !Nota! El cliente puede consultar el estatus de un pedido realizados a CT.

query Parameters
folio
required
string

folio de pedido CT

header Parameters
x-auth
required
string

Token de autorización

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Consultar Detalle

Consultar el detalle de un pedido solo puede ser realizado con el folio, un token valido y vigente. !Nota! El cliente puede consultar el detalle de un pedido realizados a CT.

query Parameters
folio
required
string

folio de pedido CT

header Parameters
x-auth
required
string

Token de autorización

Responses

Response samples

Content type
application/json
{
  • "idPedido": 1,
  • "almacen": "01A",
  • "tipoPago": "99",
  • "envio": [
    ],
  • "producto": [
    ],
  • "respuestaCT": {
    }
}

Utilidades

Servicios adicionales para la verificacion de elementos para la elaboracion de una orden de compra y para el conocimiento de los productos.

Tipo de cambio

Obtener el tipo de cambio solo puede ser realizado con un token valido y vigente.

header Parameters
x-auth
required
string

Token de autorización

Responses

Response samples

Content type
application/json
{
  • "tipoCambio": 21.1
}

Volumetría

Consultar las dimensión de un producto solo puede ser realizado con el código, un token valido y vigente.

query Parameters
codigo
required
string

Clave CT del artículo

header Parameters
x-auth
required
string

Token de autorización

Responses

Response samples

Content type
application/json
{
  • "peso": 5.5,
  • "largo": 40,
  • "alto": 28.9,
  • "ancho": 18,
  • "UPC": 97855070081,
  • "EAN": 17825670088
}

Consultar Series

Consultar las series asociadas a una factura, se requiere token valido y vigente.

query Parameters
factura
required
string

Folio de la factura

header Parameters
x-auth
required
string

Token de autorización

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]