Tipos de despacho

Listar tipos de despacho en la generación de un documento despacho.

Estructura JSON

Al realizar una petición HTTP, el servicio retornara un JSON con la siguiente estructura:

{
 "href": "https://api.bsale.com.pe/v1/shipping_types/1.json",
 "id": 1,
 "name": "Operación constituye venta",
 "code": 1,
 "useDestinationOffice": 0,
 "state": 1
}
  • href, url del tipo de despacho (String).
  • id, identificador único del tipo de despacho (Integer).
  • name, nombre del tipo de despacho (String).
  • code, código del tipo de despacho (String).
  • useDestinationOffice, indica si el tipo de despacho requiere una sucursal de destino No(0) o Si (1) (Boolean).
  • state, estado del tipo de despacho activo(0) o inactivo (1) (Boolean).

GET lista de tipos de despacho

  • GET /v1/shipping_types.json retornara todos los tipos de libro.

####Parametros

  • limit, limita la cantidad de items de una respuesta JSON, por defecto el limit es 25, el máximo permitido es 50.
  • offset, permite paginar los items de una respuesta JSON, por defecto el offset es 0.
  • fields, solo devolver atributos específicos de un recurso
  • expand, permite expandir instancias y colecciones.
  • name, Permite filtrar por nombre tipo libro.
  • code, filtra por el código del tipo de despacho.
  • state, boolean (0 o 1) indica si los tipos de libro están activos(0) inactivos(1).

####Ejemplos

  • GET /v1/shipping_types.json?limit=10&offset=0
  • GET /v1/book_types.json?fields=[name,code,state]

####Respuesta

{
  "href": "https://api.bsale.com.pe/v1/shipping_types.json",
  "count": 18,
  "limit": 25,
  "offset": 0,
  "items": [
    {
      "href": "https://api.bsale.com.pe/v1/shipping_types/12.json",
      "id": 12,
      "name": "Compra",
      "code": 2,
      "useDestinationOffice": 1,
      "state": 1
    },
    {
      "href": "https://api.bsale.com.pe/v1/shipping_types/3.json",
      "id": 3,
      "name": "Consignaciones",
      "code": 3,
      "useDestinationOffice": 0,
      "state": 1
    },
    {
      "href": "https://api.bsale.com.pe/v1/shipping_types/4.json",
      "id": 4,
      "name": "Entrega gratuita",
      "code": 4,
      "useDestinationOffice": 0,
      "state": 1
    },
    {
      "href": "https://api.bsale.com.pe/v1/shipping_types/16.json",
      "id": 16,
      "name": "Exportación",
      "code": 9,
      "useDestinationOffice": 0,
      "state": 1
    },
    {
      "href": "https://api.bsale.com.pe/v1/shipping_types/7.json",
      "id": 7,
      "name": "Guía de devolución",
      "code": 7,
      "useDestinationOffice": 0,
      "state": 1
    },
    {
      "href": "https://api.bsale.com.pe/v1/shipping_types/15.json",
      "id": 15,
      "name": "Importación",
      "code": 8,
      "useDestinationOffice": 0,
      "state": 1
    },
    {
      "href": "https://api.bsale.com.pe/v1/shipping_types/1.json",
      "id": 1,
      "name": "Operación constituye venta",
      "code": 1,
      "useDestinationOffice": 0,
      "state": 1
    },
    {
      "href": "https://api.bsale.com.pe/v1/shipping_types/18.json",
      "id": 18,
      "name": "Otros",
      "code": 13,
      "useDestinationOffice": 0,
      "state": 0
    },
    {
      "href": "https://api.bsale.com.pe/v1/shipping_types/6.json",
      "id": 6,
      "name": "Otros traslados no venta",
      "code": 6,
      "useDestinationOffice": 0,
      "state": 1
    },
    {
      "href": "https://api.bsale.com.pe/v1/shipping_types/5.json",
      "id": 5,
      "name": "Traslados internos (no constituye venta)",
      "code": 5,
      "useDestinationOffice": 1,
      "state": 1
    },
    {
      "href": "https://api.bsale.com.pe/v1/shipping_types/14.json",
      "id": 14,
      "name": "Traslado emisor itinerante CP",
      "code": 18,
      "useDestinationOffice": 0,
      "state": 0
    },
    {
      "href": "https://api.bsale.com.pe/v1/shipping_types/13.json",
      "id": 13,
      "name": "Traslado entre establecimientos",
      "code": 4,
      "useDestinationOffice": 1,
      "state": 0
    },
    {
      "href": "https://api.bsale.com.pe/v1/shipping_types/8.json",
      "id": 8,
      "name": "Traslado para exportación. (no venta)",
      "code": 8,
      "useDestinationOffice": 0,
      "state": 1
    },
    {
      "href": "https://api.bsale.com.pe/v1/shipping_types/17.json",
      "id": 17,
      "name": "Traslado a zona primaria",
      "code": 19,
      "useDestinationOffice": 0,
      "state": 0
    },
    {
      "href": "https://api.bsale.com.pe/v1/shipping_types/10.json",
      "id": 10,
      "name": "Venta",
      "code": 1,
      "useDestinationOffice": 0,
      "state": 0
    },
    {
      "href": "https://api.bsale.com.pe/v1/shipping_types/2.json",
      "id": 2,
      "name": "Ventas por efectuar",
      "code": 2,
      "useDestinationOffice": 0,
      "state": 1
    },
    {
      "href": "https://api.bsale.com.pe/v1/shipping_types/9.json",
      "id": 9,
      "name": "Venta para exportación",
      "code": 9,
      "useDestinationOffice": 0,
      "state": 1
    },
    {
      "href": "https://api.bsale.com.pe/v1/shipping_types/11.json",
      "id": 11,
      "name": "Venta sujeta a confirmación del comprador",
      "code": 14,
      "useDestinationOffice": 0,
      "state": 0
    }
  ]
}

GET un tipo de despacho

  • GET /v1/shipping_types/12.json retornara un tipo de despacho específico.

####Respuesta

{
  "href": "https://api.bsale.com.pe/v1/shipping_types/12.json",
  "id": 12,
  "name": "Compra",
  "code": 2,
  "useDestinationOffice": 1,
  "state": 1
}