Documentación para servicio API REST.

Catalogo.

Última actualización 18 Enero 2018.

GET   - Obtener todas las monedas

https://app.logiety.com/api/v1/monedas/

Acción de visualizar las claves de monedas.

Campo Descripción Tipo
id Identificador de la moneda ID
clave Clave de la moneda string
pais País de la moneda array
moneda Moneda array

Headers

Authorization

<< token >>

Obtener todas las partidas por contenedor

curl --request GET \
  --url https://app.logiety.com/api/v1/monedas/ \
  --header 'Authorization: Token f4f86fc515c85b4da3c0a455e9b708574b4e0929'

Sample Response


[
  {
            "id": 1,
            "clave": "XOF",
            "pais": "africa central",
            "moneda": "franco"
        },
        {
            "id": 2,
            "clave": "ALL",
            "pais": "albania",
            "moneda": "lek"
        },
        {
            "id": 3,
            "clave": "EUR",
            "pais": "alemania",
            "moneda": "euro"
        },
        {
            "id": 4,
            "clave": "ANG",
            "pais": "antillas holan.",
            "moneda": "florin"
        },
        {
            "id": 5,
            "clave": "SAR",
            "pais": "arabia saudita",
            "moneda": "riyal"
        }
]

GET - Obtener unidades de medida

https://app.logiety.com/api/v1/unidadesmedida/

Acción de visualizar las unidades de medida.

Campo Descripción Tipo
clave Clave de unidad de medida. ID
descripción Descripción de unidad de medida. string

Headers

Authorization

<< token >>

Obtener unidades de medida

curl --request GET \
  --url https://app.logiety.com/api/v1/unidadesmedida/ \
  --header 'Authorization: Token f4f86fc515c85b4da3c0a455e9b708574b4e0929'

Sample Response


        {
            "clave": 1,
            "descripcion": "kilo"
        },
        {
            "clave": 2,
            "descripcion": "gramo"
        },
        {
            "clave": 3,
            "descripcion": "metro lineal"
        }

GET - Obtener incoterms

https://app.logiety.com/api/v1/incoterms/

Acción de agregar una partida dentro de un contenedor.

Nombre Descripción Tipo Atributos
descripción Texto descriptivo de la mercancía en español string requerido
numero_parte Código alfanumérico que hace referencia a una pieza string requerido
sugerencia Cadena que sugiere fracciones a la clasificación

Headers

Authorization

<< token >>

tubos de jabón

Body

descripcion

cigarros API2

numero_parte

12345

sugerencia

@1234.12.12

Agregar partida por contenedor

curl --request POST \
  --url https://app.logiety.com/api/v1/contenedor/%3C%3Ccontenedor-id%3E%3E/partida/ \
  --header 'Authorization: <>' \
  --header 'content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' \
  --form 'descripcion=cigarros API2' \
  --form numero_parte=12345 \
  --form sugerencia=@1234.12.12
											

PUT  Modificar partida por contenedor.

https://app.logiety.com/api/v1/contenedor/<< id-contenedor >>/partida/<< id-partida >>/

Acción por la cual se editarán los campos de una partida dentro de un determinado contenedor, el id del contenedor tiene que existir, mientras que el id de la partida tiene que existir dentro del contenedor.

Nombre Descripción Tipo Atributos
descripcion Texto descriptivo de la mercancía en español string requerido
numero_parte Código alfanumérico que hace referencia a una pieza string requerido
sugerencia Cadena que sugiere fracciones a la clasificación string

Headers

Authorization

<< token >>

Body

descripcion

yerba mate

numero_parte

1234

sugerencia

123.12.12

Modificar partida por contenedor

curl --request PUT \
  --url https://app.logiety.com/api/v1/contenedor/Co-eL60-XbFz-XCdJ-gLwv/partida/Pa-qkLf-ePec-foF0-niro/ \
  --header 'Authorization: Token f4f86fc515c85b4da3c0a455e9b708574b4e0929' \
  --header 'content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' \
  --form 'descripcion=yerba mate' \
  --form numero_parte=1234
											

Sample Response


{
  "id": "Pa-qkLf-ePec-foF0-niro",
  "descripcion": "yerba mate",
  "sugerencia": "",
  "numero_parte": "1234"
}

										

DELETE  Eliminar partida por contenedor

https://app.logiety.com/api/v1/contenedor/<< id-contenedor >>//partida/<< id-partida >>/

Acción en la cual se suprime del sistema una partida por medio del ID.

Headers

Authorization

<< token >>

Eliminar partida por contenedor

curl --request DELETE \
  --url https://app.logiety.com/api/v1/contenedor/Co-eL60-XbFz-XCdJ-gLwv/partida/Pa-qkLf-ePec-foF0-niro/ \
  --header 'Authorization: Token f4f86fc515c85b4da3c0a455e9b708574b4e0929'

											

Sample Response


[
  "No se puede eliminar una partida cuando el estado del contenedor es diferente a Pendiente"
]