8000 Stocks · gmontero/ex-documentacion Wiki · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Stocks

Jump to bottom Edit New page
8000 EstebanBah edited this page Dec 31, 2019 · 16 revisions

https://apidoc.bsalelab.com/ ### Clic aquí para ir!

Estructura JSON

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

{
  "quantity": 60.36,
  "quantityReserved": 0.0,
  "quantityAvailable": 60.36,
  "variant": {
    "href": "https://api.bsale.cl/v1/variants/351.json",
    "id": "351"
  },
  "office": {
    "href": "https://api.bsale.cl/v1/offices/2.json",
    "id": "2"
  }
}
  • quantity, cantidad real de la variante (Float).
  • quantityReserved, cantidad reservada de la variante en borradores o en documento pendientes de despachar (Float).
  • quantityAvailable, cantidad disponible de la variante (Float).
  • variant, nodo que indica la relación con la variante.
  • office, nodo que indica la relación con la sucursal.

GET lista de stocks

  • GET /v1/stocks.json retornara todos los stocks.

Parámetros

  • 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.
  • expand, permite expandir instancias y colecciones.
  • officeid, Permite filtrar por sucursal.
  • variantid, filtra por el identificador de la variante (Integer)
  • code, filtra por el SKU de la variante (String).
  • barcode, filtra por el codigo de barras de la variante (String).

En el caso de necesitar el stock de un pack, se debe filtrar por un identificador (variantid, code, barcode) y además la sucursal requerida (officeid). El stock de los packs solo considera el stock físico, lo que quiere decir que no contempla las cantidades por despachar.

Ejemplos

  • GET /v1/stocks.json?limit=10&offset=0
  • GET /v1/stocks.json?expand=[office,variant]

Respuesta

{
  "href": "https://api.bsale.cl/v1/stocks.json",
  "count": 1049,
  "limit": 2,
  "offset": 0,
  "items": [
    {
      "quantity": 60.36,
      "quantityReserved": 0.0,
      "quantityAvailable": 60.36,
      "variant": {
        "href": "https://api.bsale.cl/v1/variants/351.json",
        "id": "351"
      },
      "office": {
        "href": "https://api.bsale.cl/v1/offices/2.json",
        "id": "2"
      }
    },
    {
      "quantity": 0.0,
      "quantityReserved": 0.0,
      "quantityAvailable": 0.0,
      "variant": {
        "href": "https://api.bsale.cl/v1/variants/351.json",
        "id": "351"
      },
      "office": {
        "href": "https://api.bsale.cl/v1/offices/1.json",
        "id": "1"
      }
    }
  ]
}

GET recepciones de stock

  • GET /v1/stocks/receptions.json retornara todos las recepciones.

Parámetros

  • 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.
  • admissiondate, Permite filtrar por la fecha de la recepción.
  • documentnumber, filtra por el numero del documento de la recepción.
  • officeid, Permite filtrar por sucursal.

Ejemplos

  • GET /v1/stocks/receptions.json?limit=10&offset=0
  • GET /v1/stocks/receptions.json?fields=[admissiondate,document,documentnumber]
  • GET /v1/stocks/receptions.json?expand=[office,details]

Respuesta

{
  "href": "https://api.bsale.cl/v1/stocks/receptions.json",
  "count": 819,
  "limit": 3,
  "offset": 0,
  "items": [
    {
      "href": "https://api.bsale.cl/v1/stocks/receptions/12.json",
      "id": 12,
      "admissionDate": 1371182400,
      "document": "Guía",
      "documentNumber": 14524,
      "note": "Frival",
      "imagestionCctId": 0,
      "imagestionCcDescription": "",
      "internalDispatchId": 0,
      "office": {
        "href": "https://api.bsale.cl/v1/offices/1.json",
        "id": "1"
      },
      "details": {
        "href": "https://api.bsale.cl/v1/stocks/receptions/12/details.json"
      }
    },
    {
      "href": "https://api.bsale.cl/v1/stocks/receptions/13.json",
      "id": 13,
      "admissionDate": 1371182400,
      "document": "Factura",
      "documentNumber": 3560,
      "note": "Charcuteria",
      "imagestionCctId": 0,
      "imagestionCcDescription": "",
      "internalDispatchId": 0,
      "office": {
        "href": "https://api.bsale.cl/v1/offices/1.json",
        "id": "1"
      },
      "details": {
        "href": "https://api.bsale.cl/v1/stocks/receptions/13/details.json"
      }
    },
    {
      "href": "https://api.bsale.cl/v1/stocks/receptions/14.json",
      "id": 14,
      "admissionDate": 1371182400,
      "document": "Factura",
      "documentNumber": 2558,
      "note": "Ingreso Bodega Bsale / Jessica Vargas",
      "imagestionCctId": 0,
      "imagestionCcDescription": "",
      "internalDispatchId": 0,
      "office": {
        "href": "https://api.bsale.cl/v1/offices/1.json",
        "id": "1"
      },
      "details": {
        "href": "https://api.bsale.cl/v1/stocks/receptions/14/details.json"
      }
    }
  ]
}

GET una recepción

  • GET /v1/stocks/receptions/12.json retorna una recepción específica.

Parámetros

  • expand, permite expandir instancias y colecciones.

Ejemplos

  • GET /v1/stocks/receptions/12.json?expand=[office,details]

Respuesta

{
  "href": "https://api.bsale.cl/v1/stocks/receptions/12.json",
  "id": 12,
  "admissionDate": 1371182400,
  "document": "Guía",
  "documentNumber": 14524,
  "note": "Frival",
  "imagestionCctId": 0,
  "imagestionCcDescription": "",
  "internalDispatchId": 0,
  "office": {
    "href": "https://api.bsale.cl/v1/offices/1.json",
    "id": "1"
  },
  "details": {
    "href": "https://api.bsale.cl/v1/stocks/receptions/12/details.json"
  }
}

GET detalles de una recepción

  • GET /v1/stocks/receptions/12/details.json
{
  "href": "https://api.bsale.cl/v1/stocks/receptions/12/details.json",
  "count": 13,
  "limit": 25,
  "offset": 0,
  "items": [
    {
      "href": "https://api.bsale.cl/v1/stocks/receptions/12/details/65.json",
      "id": 65,
      "quantity": 32.02,
      "cost": 3200.0,
      "variantStock": 85.55,
      "serialNumber": null,
      "variant": {
        "href": "https://api.bsale.cl/v1/variant/391.json",
        "id": "391"
      }
    },
    {
      "href": "https://api.bsale.cl/v1/stocks/receptions/12/details/66.json",
      "id": 66,
      "quantity": 32.22,
      "cost": 3200.0,
      "variantStock": 185.2,
      "serialNumber": null,
      "variant": {
        "href": "https://api.bsale.cl/v1/variant/388.json",
        "id": "388"
      }
    },
    {
      "href": "https://api.bsale.cl/v1/stocks/receptions/12/details/67.json",
      "id": 67,
      "quantity": 14.46,
      "cost": 3200.0,
      "variantStock": 107.84,
      "serialNumber": null,
      "variant": {
        "href": "https://api.bsale.cl/v1/variant/393.json",
        "id": "393"
      }
    }
  ]
}

GET un de detalle de una recepción

  • GET /v1/stocks/receptions/12/details/65.json
{
  "href": "https://api.bsale.cl/v1/stocks/receptions/12/details/65.json",
  "id": 65,
  "quantity": 32.02,
  "cost": 3200.0,
  "variantStock": 85.55,
  "serialNumber": null,
  "variant": {
    "href": "https://api.bsale.cl/v1/variant/391.json",
    "id": "391"
  }
}

POST una recepción de stock

  • POST /v1/stocks/receptions.json

Se debe enviar un Json con la siguiente estructura.

{
  "document": "Guía",
  "officeId": 1,
  "documentNumber": "123",
  "note": "prueba api",
  "details": [
    {
      "quantity": 32.22,
      "variantId": 629,
      "cost": 3200
    }
  ],
}

Respuesta

{
  "admissionDate": 1407297600,
  "imagestionCcDescription": null,
  "href": "https://api.bsale.cl/v1/stocks/receptions/831.json",
  "id": 831,
  "details": {
    "href": "https://api.bsale.cl/v1/stocks/receptions/831/details.json"
  },
  "document": "Guía",
  "documentNumber": 123,
  "office": {
    "href": "https://api.bsale.cl/v1/offices/1.json",
    "id": "1"
  },
  "imagestionCctId": 0,
  "note": "prueba api",
  "internalDispatchId": 0
}

PUT una recepción de stock

  • PUT /v1/stocks/receptions/831.json

Se debe enviar un Json con la siguiente estructura.

{
  "document": "Guía",
  "officeId": 2,
  "documentNumber": "123",
  "note": "Prueba api",
  "details": [
    {
      "quantity": 27,
      "variantId": 629,
      "cost": 2970
    }
  ]

Respuesta

{
  "admissionDate": 1407297600,
  "imagestionCcDescription": null,
  "href": "https://api.bsale.cl/v1/stocks/receptions/831.json",
  "id": 831,
  "details": {
    "href": "https://api.bsale.cl/v1/stocks/receptions/831/details.json"
  },
  "document": "Guía",
  "documentNumber": 123,
  "office": {
    "href": "https://api.bsale.cl/v1/offices/1.json",
    "id": "1"
  },
  "imagestionCctId": 0,
  "note": "prueba api",
  "internalDispatchId": 0
}

GET consumos de stock

  • GET /v1/stocks/consumptions.json retornara todos las recepciones.

Parámetros

  • 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.
  • consumptiondate, Permite filtrar por la fecha del consumo.
  • officeid, Permite filtrar por sucursal.

Ejemplos

  • GET /v1/stocks/consumptions.json?limit=10&offset=0
  • GET /v1/stocks/consumptions.json?fields=[consumptiondate,note]
  • GET /v1/stocks/consumptions.json?expand=[office,details]

Respuesta

{
  "href": "https://api.bsale.cl/v1/stocks/consumptions.json",
  "count": 591,
  "limit": 3,
  "offset": 0,
  "items": [
    {
      "href": "https://api.bsale.cl/v1/stocks/consumptions/1.json",
      "id": 1,
      "consumptionDate": 1371441600,
      "note": "traslado a los angeles",
      "imagestionCcdescription": "",
      "imagestionCenterCostId": 0,
      "office": {
        "href": "https://api.bsale.cl/v1/offices/1.json",
        "id": "1"
      },
      "details": {
        "href": "https://api.bsale.cl/v1/stocks/consumptions/1/details.json"
      }
    },
    {
      "href": "https://api.bsale.cl/v1/stocks/consumptions/2.json",
      "id": 2,
      "consumptionDate": 1375070400,
      "note": "Ajuste de Stock: Jessica Vargas",
      "imagestionCcdescription": "",
      "imagestionCenterCostId": 0,
      "office": {
        "href": "https://api.bsale.cl/v1/offices/1.json",
        "id": "1"
      },
      "details": {
        "href": "https://api.bsale.cl/v1/stocks/consumptions/2/details.json"
      }
    },
    {
      "href": "https://api.bsale.cl/v1/stocks/consumptions/3.json",
      "id": 3,
      "consumptionDate": 1376452800,
      "note": "Ajuste de Stock: Jessica Vargas",
      "imagestionCcdescription": "",
      "imagestionCenterCostId": 0,
      "office": {
        "href": "https://api.bsale.cl/v1/offices/1.json",
        "id": "1"
      },
      "details": {
        "href": "https://api.bsale.cl/v1/stocks/consumptions/3/details.json"
      }
    }
  ]
}

GET un consumo

  • GET /v1/stocks/consumptions/1.json retorna un consumo específico.

Parámetros

  • expand, permite expandir instancias y colecciones.

Ejemplos

  • GET /v1/stocks/consumptions/1.json?expand=[office,details]

Respuesta

{
  "href": "https://api.bsale.cl/v1/stocks/consumptions/1.json",
  "id": 1,
  "consumptionDate": 1371441600,
  "note": "traslado a los angeles",
  "imagestionCcdescription": "",
  "imagestionCenterCostId": 0,
  "office": {
    "href": "https://api.bsale.cl/v1/offices/1.json",
    "id": "1"
  },
  "details": {
    "href": "https://api.bsale.cl/v1/stocks/consumptions/1/details.json"
  }
}

GET detalles de un consumo

  • GET /v1/stocks/consumptions/1/details.json
{
  "href": "https://api.bsale.cl/v1/stocks/consumptions/1/details.json",
  "count": 2,
  "limit": 25,
  "offset": 0,
  "items": [
    {
      "href": "https://api.bsale.cl/v1/stocks/consumptions/1/details/1.json",
      "id": 1,
      "quantity": 36.78,
      "cost": 3200.0,
      "variantStock": 42.2,
      "variant": {
        "href": "https://api.bsale.cl/v1/variant/355.json",
        "id": "355"
      }
    },
    {
      "href": "https://api.bsale.cl/v1/stocks/consumptions/2/details/2.json",
      "id": 2,
      "quantity": 78.64,
      "cost": 1311.08850457782,
      "variantStock": 106.56,
      "variant": {
        "href": "https://api.bsale.cl/v1/variant/388.json",
        "id": "388"
      }
    }
  ]
}

GET un de detalle de un consumo

  • GET /v1/stocks/consumptions/1/details/1.json
{
  "href": "https://api.bsale.cl/v1/stocks/consumptions/1/details/1.json",
  "id": 1,
  "quantity": 36.78,
  "cost": 3200.0,
  "variantStock": 42.2,
  "variant": {
    "href": "https://api.bsale.cl/v1/variant/355.json",
    "id": "355"
  }
}

POST un consumo de stock

  • POST /v1/stocks/consumptions.json

Se debe enviar un Json con la siguiente estructura.

{
  "note": "prueba api",
  "officeId": 1,
  "details": [
    {
      "quantity": 13,
      "variantId": 629
    }
  ]
}

Respuesta

{
  "office": {
    "id": "1",
    "href": "https://api.bsale.cl/v1/offices/1.json"
  },
  "imagestionCenterCostId": null,
  "details": {
    "href": "https://api.bsale.cl/v1/stocks/consumptions/593/details.json"
  },
  "note": "prueba api",
  "consumptionDate": 1407297600,
  "imagestionCcdescription": null,
  "id": 593,
  "href": "https://api.bsale.cl/v1/stocks/consumptions/593.json"
}
Add a custom footer
Clone this wiki locally
0