Este endpoint crea/modifica el stock de seguridad de un item en uno o más sources, los source y su cantidad de stock de seguridad son recibidos en el payload como key/value.
\n","urlObject":{"protocol":"https","path":["v3","inventory","item","{{sku}}","safety","source"],"host":["{{subdomain}}-oim","omnixsystem","com"],"query":[],"variable":[]}},"response":[{"id":"d374a721-8135-4b50-bd4e-70025947a638","name":"Set Item Safety By Sources","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"CD15\": 10,\n \"FMM\": 14\n}","options":{"raw":{"language":"json"}}},"url":"https://{{subdomain}}-oim.omnixsystem.com/v3/inventory/item/{{sku}}/safety/source"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"Este endpoint crea/modifica el stock de seguridad de uno o muchos items en un canal, los items (sku) son recibidos como array en el payload donde cada uno cuenta con una propiedad que define la cantidad de stock de seguridad a asignar en dicho canal. El canal es recibido por url parameter.
\n","urlObject":{"protocol":"https","path":["v3","inventory","item","safety","{{channel}}"],"host":["{{subdomain}}-oim","omnixsystem","com"],"query":[],"variable":[]}},"response":[{"id":"acb6a784-8475-4a68-91bc-bf1766cc7802","name":"Set Bulk Items Safety By Channel","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","type":"text","value":"Bearer {{token}}","warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman."}],"body":{"mode":"raw","raw":"[\n {\n \"sku\": \"SKU0001\",\n \"safety\": 10\n },\n {\n \"sku\": \"SKU0002\",\n \"safety\": 11\n }\n]","options":{"raw":{"language":"json"}}},"url":"https://{{subdomain}}-oim.omnixsystem.com/v3/inventory/item/safety/ecommerce"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"Este endpoint crea/modifica el stock de seguridad de uno o muchos items en un source, los items (sku) son recibidos como array en el payload donde cada uno cuenta con una propiedad que define la cantidad de stock de seguridad a asignar en dicho source. El source es recibido por url parameter.
\n","urlObject":{"protocol":"https","path":["v3","inventory","item","safety","source","{{source}}"],"host":["{{subdomain}}-oim","omnixsystem","com"],"query":[],"variable":[]}},"response":[{"id":"745c3daf-33c5-4755-b14d-fb67533ea84e","name":"Set Bulk Items Safety By Source","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","type":"text","value":"Bearer {{token}}","warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman."}],"body":{"mode":"raw","raw":"[\n {\n \"sku\": \"SKU0001\",\n \"safety\": 10\n },\n {\n \"sku\": \"SKU0002\",\n \"safety\": 11\n }\n]","options":{"raw":{"language":"json"}}},"url":"https://{{subdomain}}-oim.omnixsystem.com/v3/inventory/item/safety/source/CD15"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"Servicio para obtener items, filtrando por distintos parámetros.
\nRequest
\n- \n
- channel (Opcional): (String) Identificador único del canal a consultar. \n
- skipRecords (Requerido): (Number) Cantidad de registros a saltarse, esto con el fin de paginar los resultados. \n
- maxRecords (Requerido): (Number) Cantidad de registros máximos a retornar. \n
- query (Opcional): (String) Nombre de producto a tener en cuenta en la consulta. Ej: juguete. \n
- filter (Opcional): (JSON) Objeto con propiedades filtrables, estas pueden ser cualquier parámetro del producto utilizando la forma Dot-Notation, por ejemplo:
- \n
- sku: Sku del producto. \n
- categories: Categorías. \n
- custom.code: Valor custom. \n
\n - project (Opcional): (Array[String]) Lista de atributos a devolver en la consulta, si no se especifica esta propiedad, se retornan todos los atributos del producto. \n
Ejemplos:
\nFiltros variables, cada parámetro puede ser consultado con un valor o un arreglo de valores.
\n{\n \"channel\": \"ecommerce\",\n \"skipRecords\": 0,\n \"maxRecords\": 10,\n \"filter\":{,\n \"sku\": \"SKU001\",\n \"custom.propiedad1\": \"valor\",\n \"propiedad1.propiedadHija1\": \"valor\",\n \"propiedad1.propiedadHija2\": [\"valor1\", \"valor2\"]\n },\n \"project\": [\"sku\",\"custom.propiedad1\",\"propiedad1\",\"propiedad2\"]\n}\nResponse:
\n- \n
- message.numRecordsReturned: (Number) Cantidad de registros retornados. \n
- message.skippedRecords: (Number) Cantidad de registros saltados. \n
- message.totalRecordsMatched: Cantidad de registros que coinciden con la búsqueda. \n
- message.records: Array[Items] Registros (Productos) que coinciden con la búsqueda. \n
{\n \"transactionId\": \"326f89d0-5862-11e8-92a0-fb2a57096715\",\n \"code\": 200,\n \"message\": {\n \"numRecordsReturned\": 1,\n \"skippedRecords\": 0,\n \"totalRecordsMatched\": 100,\n \"records\":[{\n \"sku\" : \"SKU0001\",\n \"categories\" : [ \n \"CATEGORY01\"\n ],\n \"custom\" : {\n \"code\" : 00000\n },\n \"enabled\" : true,\n \"logisticAttributes\" : {\n \"volume\" : 93.75\n },\n \"name\" : \"ITEM NAME\",\n \"type\" : \"Default\"\n }]\n }\n}\nEl Inventario en Omnix tiene 4 actores principales, los cuales son:
\n- \n
- Source: Representa locaciones físicas ó virtuales que contienen y venden productos, como por ejemplo bodegas, tiendas, etc.. \n
- Stocks: Los stocks son agrupadores de Sources, estos sirven para disponibilizar stock de uno o más Sources a uno ó muchos canales de venta. \n
- Channel: Los Channel representan canales de venta, estos pueden ser por ejemplo un sitio e-commerce hasta un POS en una tienda, los Channel apuntan a un Stock disponibilizando así los productos de los Source agrupados por este. \n
- Item: Los item son productos como tal, los productos pertenecen a uno o muchos Source, los Source a su vez se agrupan en Stock, lo que quiere decir que la cantidad disponible de un producto en un canal es igual a la sumatoria de las cantidades en todas las tiendas que conforman un Stock menos los ajustes de stock de seguridad. \n
Stock de seguridad (Safety)
\nEl stock de seguridad en el Omnix Inventory tiene 3 niveles:
\n- \n
- Source: Cada Source tiene asociado un safety stock, lo cual quiere decir que la cantidad disponible de cada producto perteneciente a dicho Source es igual a su cantidad menos el safety del Source. \n
- Stock: Cada Stock tiene asociado un safety stock, la cantidad de stock disponible por cada producto es igual a la sumatoria total de este producto en todas los Source que conforman el Stock, el safety stock del Stock es restado a esta sumatoria. \n
- Item: Cada Item tiene asociado un safety stock, lo que quiere decir que su suma en bruto es la cantidad cargada menos su valor de safety stock, este valor de safety puede ser expresado en tres formas:
- \n
- Valor fijo: Se asigna un entero mayor que cero y este se resta al valor disponible del producto en cualquier canal y stock. \n
- Valor por canal: Se asigna un entero mayor que cero el cual se resta al valor disponible del producto siempre que la consulta de stock sea por el canal configurado. \n
- Valor por source: Se asigna un entero mayor que cero el cual se resta al valor disponible del producto siempre que la consulta de stock sea por el source configurado. \n
\n
Relación Source / Stock / Channel
\n![\"Omnix](\"https://omnix-v3-res.s3.amazonaws.com/Omnix+v3+-+Asoci.png\")
Algoritmo para calcular \"Safety Total\".
\n- \n
Source Safety:\nEste safety puede ser tomado del item o directamente del source, el algoritmo para este safety funciona así:
\n- \n
- Si el item tiene configurado safety para este source, asigna este safety como source safety, sino si el source tiene su propio safety, asigna este source safety, sino asigne cero. \n
\n
SourceSafety = item.safety[SourceId] ? item.safety[SourceId] : source.safety ? source.safety : 0;
- \n
ChannelSafety\nEste safety Solo se aplica si el item lo tiene configurado y la consulta de stock se hace sobre un canal configurado con safety en el item.
\n- \n
- Si el item tiene configurado safety para el canal actual de la consulta, asigne este safety, sino, asigne cero. \n
\n
ChannelSafety = item.safety[ChannelId] ? item.safety[ChannelId] : 0;
- \n
FixedSafety\nUn item puede tener un safety fijo o un safety por source/channel, no es posible tener fixed + source/channel. El valor fixed de safety de un item es un entero que se aplica independientemente del channel o source.
\n- \n
- Si el item tiene configurado fixed safety asigne este safety, sino, asigne cero.\n
* FixedSafety = item.safety >= 0 ? item.safety : 0 \n
\n- Si el item tiene configurado fixed safety asigne este safety, sino, asigne cero.\n
StockSafety\nA nivel de stock se puede configurar un fixed safety que aplicaría en conjunto con el resto de safeties.
\n- \n
- Cuando una consulta de stock pregunta por un item en específico en un source específico se restará el SourceSafety + StockSafety al total del item. \n
- Cuando una consulta de stock se hace consolidando el total del item en N tiendas, entonces el safety se calcula: ∑SourceSafety + (StockSafety*Sources.length).
\nSafety total
\n \nPara una consulta de un item en un source específico en un canal:
\n
\n SafetyTotal = SourceSafety + StockSafety + (ChannelSafety or FixedSafety)
\nPara una consulta de un item todos los sources donde está asociado en un canal:
\n
\n SafetyTotal = ∑SourceSafety + (StockSafety*Sources.length) + (ChannelSafety or FixedSafety) \n
A continuación una ilustración de cómo se calcularía el stock de un producto \"Android Phone\" usando Sources, Stocks y Channels.
\n![\"Omnix](\"https://omnix-v3-res.s3.amazonaws.com/Omnix+v3-SSC-OIM.png\")
Error Responses
\nLos errores comunes entregados en la respuesta por Omnix son los siguientes:
\nShared Models
\nLa información a continuación describe los modelos y sus atributos públicos disponibles para consulta, modificación e inserción.
\nSource
\nStock
\nChannel
\nItem
\nReserve
\n","event":[{"listen":"prerequest","script":{"id":"b6725919-42a0-46b9-9be1-d32cf245d1b8","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e21022c3-6d58-455f-8d9a-195ca74845dc","type":"text/javascript","exec":[""]}}],"_postman_id":"0bb78be5-c08a-4377-b942-1b55ca1b4128"},{"name":"Omnix Order Management API (OOM)","item":[{"name":"Order","item":[{"name":"Create order","event":[{"listen":"test","script":{"id":"c5c3a2ce-7a33-421a-94d4-829218b8d119","exec":[""],"type":"text/javascript"}}],"id":"bfe0f468-458b-4610-95bf-7ecda11a636a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Bearer {{token}}"}],"body":{"mode":"raw","raw":"{\n \"rawAmount\": 2.2,\n \"totalAmount\": 2.2,\n \"discount\": 2.2,\n \"taxesAmount\": 2.2,\n \"shippingAmount\": 2.2,\n \"creationDate\": \"2020-04-11T12:00:00+00:00\",\n \"site\": \"logytech.co\",\n \"shippingType\": \"HD\",\n \"deliveryType\": \"SD\",\n \"estimatedDeliveryDate\": \"2020-04-15\",\n \"salesChannelId\": \"Logytech_001\",\n \"channel\": \"omnicanal\",\n \"billingAddress\": {\n \"country\": \"\",\n \"city\": \"\",\n \"address\": \"\",\n \"location\": {},\n \"contact\": {\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"custom\": {}\n },\n \"custom\": {}\n },\n \"shippingAddress\": {\n \"country\": \"Colombia\",\n \"address\": \"Calle 13 # 108-85 Manz. 18 Int. 121\",\n \"location\": {\n \"departamento\": \"Cundinamarca\"\n },\n \"city\": \"Bogota\",\n \"contact\": {\n \"name\": \"Jose Lopez\",\n \"email\": \"jlopez@gmail.com\",\n \"phone\": \"3190022929\",\n \"custom\": {}\n },\n \"custom\": {}\n },\n \"items\": [\n {\n \"sku\": \"HUAWEI_P30_001\",\n \"name\": \"Huawei P30\",\n \"quantity\": 2,\n \"rawPrice\": 2.2,\n \"listPrice\": 2.2,\n \"salePrice\": 2.2,\n \"discount\": 2.2,\n \"barcodes\": [\n \"\"\n ],\n \"media\": {\n \"thumb\": \"\",\n \"medium\": \"\",\n \"large\": \"\"\n },\n \"custom\": {},\n \"detailLink\": \"\",\n \"color\": {\n \"code\": \"\",\n \"name\": \"\"\n },\n \"size\": {\n \"code\": \"\",\n \"name\": \"\"\n },\n \"model\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"brand\": \"\"\n }\n ],\n \"custom\": {},\n \"customer\": {\n \"id\": \"10992283939\",\n \"name\": \"Alex Mauricio Villagran\",\n \"email\": \"avillagran@correo.co\",\n \"phone\": \"57427984\",\n \"systemId\": \"Customer_ID_on_ERP\",\n \"custom\": {}\n },\n \"paymentInfo\": [\n {\n \"type\": \"DC\",\n \"amount\": 2.2,\n \"custom\": {}\n }\n ]\n}"},"url":"https://{{subdomain}}-oom.omnixsystem.com/v3/order","description":"Servicio para inyectar órdenes, estas pueden ser de 5 tipos:
\n- \n
- HD (Home Delivery): Despacho a domicilio. \n
- SP (Store Pickup): Retiro en tienda. \n
- TR (Transfer): Transferencia de inventario. \n
- RT (Return): Retorno de productos desde el destino final. \n
- POS (Mesón): Ordenes de mesón. \n
Request:
\nEl request de este servicio es un JSON que está compuesto por las siguientes propiedades.
\n- \n
- totalAmount (Opcional): Esta propiedad es de tipo Number y define el total pagado en la orden. \n
- rawAmount (Opcional): Esta propiedad es de tipo Number y define el total pagado en la orden sin descuentos aplicados y sin recargos por shipping aplicados. \n
- discount (Opcional): Esta propiedad es de tipo Number y define el total descontado en la orden. \n
- taxesAmount (Opcional): Esta propiedad es de tipo Number y define el total cobrado en al orden por el concepto de impuestos. \n
- shippingAmount (Opcional): Esta propiedad es de tipo Number y define el total pagado por concepto de envíos. \n
- creationDate (Requerida): Esta propiedad contiene la fecha de creación de la orden en el e-commerce, formato: YYYY-MM-DDThh:mm:ss+00:00 ó YYYY-MM-DDThh:mm:ssZ - Ejemplo: 2018-11-13T20:20:39+00:00 ó 2018-11-13T20:20:39Z \n
- site (Opcional): Esta propiedad es de tipo String y define el nombre del sitio desde donde se realizó la compra. \n
- shippingType (Requerido): Esta propiedad puede tomar 4 valores (SP|HD|TR|RT). \n
- storePickupId (Requerido si SP): Esta propiedad contiene el id de la tienda que se seleccionó para retiro. \n
- deliveryType (Requerido): Esta propiedad puede tomar los valores definidos en Schedule Settings (Tipos de entrega) de OLM, por ejemplo: (SD|ED) estos cuales equivalen a \"Standard Delivery\" y \"Express Delivery\". \n
- estimatedDeliveryDate (Required if HD|SP): Esta propiedad contiene la fecha estimada de entrega, el valor de esta propiedad es entregado por la consulta de agendamiento. \n
- scheduledId (Opcional): Esta propiedad contiene un identificador del proceso de agendamiento de la orden, este valor es entregado por agendamiento. \n
- salesChannelId (Opcional): Esta propiedad contiene el id de la orden en el canal de venta donde se está creando dicha orden. Esta propiedad es única por cliente. \n
- systemId (Opcional): Esta propiedad contiene el id de la orden en el sistema ERP. \n
- shippingAddress (Requerida si HD): Esta propiedad es de tipo JSON y contiene los atributos country, address, location (JSON (any)), city, contact (JSON(name, email, phone), custom (JSON[any])). \n
- billingAddress (Requerida si HD): Esta propiedad es de tipo JSON y contiene los atributos country, address, location (JSON (any)), city, contact (JSON(name, email, phone), custom (JSON[any])). \n
- items (Requerida): Esta propiedad es de tipo JSON Array y cada elemento contiene los atributos: \n
- \n
- sku (String): Identificador del producto \n
- name (String): Nombre del producto \n
- quantity (Number): Unidades \n
- rawPrice (Number): Precio del producto sin descuento (unitario) \n
- listPrice (Number): Precio de lista del producto sin descuento (unitario) \n
- salePrice (Number): Precio de venta del producto con descuento (unitario) \n
- discount (Number): Descuento del producto (unitario) \n
- barcodes (Array[String]): Código de barras \n
- color (JSON(code, name)) \n
- size (JSON(code,name)) \n
- model (JSON(code,name)) \n
- brand (String): Marca \n
- detailLink (String): Link de la ficha de producto \n
- media (JSON(thumb: Imágen pequeña, medium: Imágen media, large: Imágen grande)) \n
- custom(JSON[any]). \n
- \n
- customer (Opcional): Esta propiedad es de tipo JSON y tiene las propiedades (String)(id, name, email, phone, systemId, custom (JSON[any])). \n
- paymentInfo (Opcional): Esta propiedad es un JSON Array y cada uno de sus elementos tiene las propiedades (type (String), amount (Number), custom (JSON[any])). \n
- source (Requerido si TR,POS/Opcional RT):
- \n
- POS: (String) Esta propiedad contiene el id del source desde donde se realizó la venta. \n
- TR: (String)Esta propiedad contiene el id del source desde donde se moverá el inventario. \n
- RT: (Object) Esta propiedad en este caso es un objeto que puede representar un source (id) o un shippingAddress (country, address, location (JSON (any)), city, contact (JSON(name, email, phone), custom (JSON[any]))) \n
\n - target (Requerido si TR/Opciona RT):
- \n
- TR: (String) Esta propiedad contiene el id del source hacia donde se moverá el inventario. \n
- RT: (Object) Esta propiedad en este caso es un objeto que representa un source (id) \n
\n - custom (Opcional): (JSON[any]) Propiedad genérica, puede tener propiedades personalizadas. \n
- channel (Requerido): (String) Identificador del canal de venta desde donde se obtendrá el stock. \n
- reference: (Opcional RT) (String) Esta propiedad puede indentificar un shipping group o una orden que se tomaría como base para la creación del retorno. \n
Query parameters
\n- \n
- channel: Cuando se desea crear órdenes de tipo transferencia (TR), se debe enviar como parámetro channel el cual identifia el canal de venta, para este caso no se envía el channel en el payload de la órden debido a que tocaría repetirlo por cada orden enviada. \n
- orderReservationId: Identificador de la reserva de una orden TR, esta se genera cuando previamente si intentó hacer una transferencia y el stock no estaba completo. Al reintentar una transferencia se debe especificar este identificador. \n
- autoConfirm: Boolean este query parameter debe ir en true cuando se desea que la orden se confirme automáticamente. \n
Ejemplo de request en una orden de tipo TR
\n- \n
- https://<host>:<port>/v3/order?channel=televentas \n
- https://<host>:<port>/v3/order?channel=televentas&orderReservationId=ASPOO1010101I \n
[{\n \"creationDate\": \"MM-DD-YYYYThh:mm:ss+00:00\",\n \"shippingType\": \"TR\",\n \"systemId\": \"external_id\",\n \"items\":[\n {\n \"sku\": \"SKU001\",\n \"quantity\": 10\n }\n ],\n \"custom\":{\n \"custom_property\": \"custom_data\"\n },\n \"source\": \"STORE001\",\n \"target\": \"STORE002\"\n}]\nSalidas y entradas a terceros
\n- \n
- https://<host>:<port>/v3/order?thirdparty=true \n
Query parameters
\n- \n
- thirdparty: Boolean este query parameter debe ir en true cuando la transferencia es desde o hacia un third party. \n
Ejemplo:
\n[{\n \"shippingType\": \"TR\",\n \"items\":[\n {\n \"sku\": \"001.002.1700\",\n \"quantity\": 1\n }\n ],\n \"source\": \"FSN\",\n \"target\": \"MAQ\"\n}]\nComplex Orders
\nEn Omnix se pueden crear dos tipos de órdenes.
\n- \n
- Simple Order: Esta es una orden normal con un tipo de despacho el cual puede ser HD, SP o RT. \n
- Complex Order: Esta es una orden con la capacidad de permitir multiples tipos de despacho por productos, por lo que estos podrían tener múltiples HD, SP y RT. Nota: no se aceptan multiples despachos TR. \n
Estos tipos de órdenes se diferencian por el input que es enviado al servicio, cada uno tiene su propio esquema, el la sección de ejemplos se pueden encontrar ejemplos de cada uno.
\nOmnix al recibir una complex order lo que hace es crear simple orders a partir de la información de la complex order, generando así una nueva simple order por cada tipo de despacho+productos relacionados en la complex order.
\nComplex Orders - confirm action
\nPara confirmar una orden es necesario solo hacer la acción confirm sobre el id de la complex order, no es necesario hacerlo por cada orden hija.
\nComplex Orders - Response
\nA diferencia de la respuesta de la creación de una simple order Omnix entrega un array con los ids de las simple orders generadas en el proceso de creación, ejemplo:
\n{\n \"transactionId\": \"c96db35f-7092-472b-86de-e958e5d8650a\",\n \"code\": 200,\n \"message\": {\n \"orderId\": \"1FR78KJ5T40X4\",\n \"childOrders\": [\n \"1FR78KJ5T3QKJ\",\n \"1FR78KJ5T3QKK\"\n ]\n }\n}\nÓrdenes de Retorno (RT)
\nLas órdenes de tipo RT crean retornos a partir de una orden o shippinggroup, si se crea a partir de una orden todos los shippinggroups deben estar en estado DELIVERED, si se crea a partir de un shippinggroup este debe estar en estado DELIVERED.
\nEn el request se puede sobreescribir los items, source y target especificando dichos valores. Las propiedades que recibe una orden RT son:
\n- \n
- shippingType (Requerido) \n
- estimatedDeliveryDate (Requerido): Este valor es entregado por la consulta de agendamiento. \n
- channel (Requerido) \n
- deliveryType (Requerido) \n
- reference (Opcional) \n
- items (Opcional) \n
- source (Opcional) \n
- target (Opcional) \n
Request con referencia
\n{\n \"channel\": \"something\",\n \"shippingType\": \"RT\",\n \"reference\": \"SG4AX27Y6KLN2E0SZ\",\n \"deliveryType\": \"SD\",\n \"estimatedDeliveryDate\": \"2020-03-03\"\n}\nRequest con sobreescritura de datos
\n{\n \"channel\": \"something\",\n \"shippingType\": \"RT\",\n \"reference\": \"SG4AX27Y6KLN2E0SZ\",\n \"deliveryType\": \"SD\",\n \"estimatedDeliveryDate\": \"2020-03-03\",\n \"items\": [\n {\n \"sku\": \"SKU0001\",\n \"quantity\": 10\n }\n ],\n \"source\": {\n \"id\": \"SRC0001\"\n },\n \"target\": {\n \"id\": \"BOD0001\"\n }\n}\nOrdenes POS (Mesón)
\nEste tipo de órdenes registra en Omnix ventas de tipo mesón, estas son las ventas que se realizan de forma física en un POS.
\nEste tipo de órdenes se crean en estado CLOSED con un shippingGroup en estado DELIVERED, además hace rebaja de inventario de los items en la orden en OIM.
\nSchemas
\nLos esquemas que especifican cuales las propiedades, sus tipos y cómo deben ser enviadas son:
\n- \n
- Simple Order: https://jsoneditoronline.org/#left=cloud.801648b0bac0443e8f5783d84ed82941 \n
- Complex Order: https://jsoneditoronline.org/#left=cloud.a862a0971e8847d199cd9e12cf847c99 \n
Custom error message
\n⚠️Nota⚠️: Estos mensajes de error son utilizados por el orquestador de creación de órdenes, las implementaciones de orquestación son personalizadas por cliente, no necesariamente se utilizarán todos los mensajes de error en el mismo flujo sino que se utilizarán a conveniencia.
\nError examples
\n{\n \"transactionId\": \"<UUID_V4>\",\n \"code\":500,\n \"message\": \"OrchException: NO_COMBINATIONS\"\n}\n{\n \"transactionId\": \"<UUID_V4>\",\n \"code\":500,\n \"message\": \"OrchException: NO_NEARBY_DATES_FOUND\"\n}\n{\n \"transactionId\": \"<UUID_V4>\",\n \"code\":500,\n \"message\": \"OrchException: UNCOVERED_ROUTES\"\n}\nServicio para actualizar órdenes. Las órdenes pueden modificarse mientras estén en estado RESERVED.
\nRequest:
\nEl request de este servicio es un JSON que está compuesto por las siguientes propiedades.
\n- \n
- totalAmount (Opcional): Esta propiedad es de tipo Number y define el total pagado en la orden. \n
- rawAmount (Opcional): Esta propiedad es de tipo Number y define el total pagado en la orden sin descuentos aplicados y sin recargos por shipping aplicados. \n
- discount (Opcional): Esta propiedad es de tipo Number y define el total descontado en la orden. \n
- taxesAmount (Opcional): Esta propiedad es de tipo Number y define el total cobrado en al orden por el concepto de impuestos. \n
- shippingAmount (Opcional): Esta propiedad es de tipo Number y define el total pagado por concepto de envíos. \n
- creationDate (Requerida): Esta propiedad contiene la fecha de creación de la orden en el e-commerce. \n
- site (Opcional): Esta propiedad es de tipo String y define el nombre del sitio desde donde se realizó la compra. \n
- shippingType (Requerido): Esta propiedad puede tomar 3 valores (SP|HD|TR). \n
- storePickupId (Requerido si SP): Esta propiedad contiene el id de la tienda que se seleccionó para retiro. \n
- deliveryType (Requerido): Esta propiedad puede tomar dos valores (SD|ED) los cuales equivalen a \"Standard Delivery\" y \"Express Delivery\". \n
- estimatedDeliveryDate (Requerido): Esta propiedad contiene la fecha estimada de entrega, el valor de esta propiedad es entregado por agendamiento. \n
- scheduledId (Requerido): Esta propiedad contiene un identificador del proceso de agendamiento de la orden, este valor es entregado por agendamiento. \n
- salesChannelId (Opcional): Esta propiedad contiene el id de la orden en el canal de venta desde donde se está creando la orden. \n
- systemId (Opcional): Esta propiedad contiene el id de la orden en el sistema ERP. \n
- shippingAddress (Requerida si HD): Esta propiedad es de tipo JSON y contiene los atributos country, address, location (JSON (any)), city, contact (JSON(name, email, phone), custom (JSON[any])). \n
- items (Requerida): Esta propiedad es de tipo JSON Array y cada elemento contiene los atributos sku, name, quantity, rawPrice, listPrice, salePrice, discount, barcodes, color (JSON(code, name)), size , JSON(code,name)), model (JSON(code,name)), brand, detailLink: Link de la ficha de producto, media (thumb: Imágen pequeña, medium: Imágen media, large: Imágen grande). \n
- customer (Opcional): Esta propiedad es de tipo JSON y tiene las propiedades (id, name, email, phone, systemId, custom (JSON[any])). \n
- paymentInfo (Opcional): Esta propiedad es un JSON Array y cada uno de sus elementos tiene las propiedades (type, amount, custom (JSON[any])). \n
- source (Requerido si TR): Esta propiedad contiene el id del source desde donde se moverá el inventario. \n
- target (Requerido si TR): Esta propiedad contiene el id del source hacia donde se moverá el inventario. \n
- custom (Opcional): (JSON[any]) Propiedad genérica, puede tener propiedades personalizadas. \n
Cada vez que se modifique los items en una orden RESERVED Omnix confirmará si tiene stock para reservar, si no puede reservar entonces se mantienen los items originales y no se actualiza dicha propiedad.
\n","urlObject":{"protocol":"https","path":["v3","order","{{id}}"],"host":["{{subdomain}}-oom","omnixsystem","com"],"query":[],"variable":[]}},"response":[{"id":"cb66879e-6e33-4b0e-8ed5-3038d3d308de","name":"Update Order","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"rawAmount\": 2.2,\r\n \"totalAmount\": 2.2,\r\n \"discount\": 2.2,\r\n \"taxesAmount\": 2.2,\r\n \"shippingAmount\": 2.2,\r\n \"creationDate\": \"\",\r\n \"site\": \"\",\r\n \"shippingType\": \"SP|HD|TR\",\r\n \"storePickupId\": \"Servicio para ejecutar acciones en la orden, estas son:
\n- \n
- confirm: Especifica qué la orden está ahora confirmada, al confirmar la orden opcionalmente se podría especificar información del pago de la siguiente manera: \n
[\n {\n \"type\": \"DC|CC\",\n \"amount\": 10\n }\n]\n- \n
- cancel: Especifica qué la orden debe ser cancelada, al cancelar una orden opcionalmente se puede especificar información acerca de la cancelación. \n
{\n \"reason\": \"free text here...\"\n}\nPath params
\nEste servicio contiene dos parámetro en el path id, action los cuales deben contener el id/commerceId/systemId de la orden y la acción a ejecutar. \nEjemplo: \n/v3/order/M10099912/confirm
\nCustom error message - Action: confirm()
\n","urlObject":{"protocol":"https","path":["v3","order","{{id}}","{{action}}"],"host":["{{subdomain}}-oom","omnixsystem","com"],"query":[],"variable":[]}},"response":[{"id":"127bd922-e07c-4ca8-82bc-516d954155b3","name":"Order Actions","originalRequest":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Bearer {{token}}"}],"body":{"mode":"raw","raw":"[\n\t{\n\t\t\"type\": \"VD|VC\",\n\t\t\"amount\": 10\n\t}\n]"},"url":"https://{{subdomain}}-oom.omnixsystem.com/v3/order/{{id}}/{{action}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"326f89d0-5862-11e8-92a0-fb2a57096715\",\n \"code\": 200,\n \"message\": \"OK\"\n}"},{"id":"9f337211-1f45-493d-97ab-8f12b27735ef","name":"Confirm Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"[\n\t{\n\t\t\"type\": \"DC|CC\",\n\t\t\"amount\": 10\n\t}\n]"},"url":"https://{{subdomain}}-oom.omnixsystem.com/v3/order/{{id}}/{{action}}"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"326f89d0-5862-11e8-92a0-fb2a57096715\",\n \"code\": 200,\n \"message\": {\n \"orderId\": \"Servicio para obtener información de una orden:
\nPath params
\nEste servicio contiene un parámetro en el path id el cual debe contener el id/commerceId/systemId de la orden.\nEjemplo: \n/v3/order/M10099912
\n","urlObject":{"protocol":"https","path":["v3","order","{{id}}"],"host":["{{subdomain}}-oom","omnixsystem","com"],"query":[{"description":{"content":"Si se especifica como \"true\" la respuesta solo tendrá información de los estados de la orden.
\n","type":"text/plain"},"key":"status","value":"true|false"}],"variable":[]}},"response":[{"id":"1e606dc1-62a2-46f7-9e3f-f05e36e55af6","name":"Get Order - Only Status","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":{"raw":"https://{{subdomain}}-oom.omnixsystem.com/v3/order/{{id}}?status=true|false","protocol":"https","host":["{{subdomain}}-oom","omnixsystem","com"],"path":["v3","order","{{id}}"],"query":[{"key":"status","value":"true|false","description":"Si se especifica como \"true\" la respuesta solo tendrá información de los estados de la orden."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"326f89d0-5862-11e8-92a0-fb2a57096715\",\n \"code\": 200,\n \"message\": {\n \"id\": \"...\",\n \"salesChannelId\": \"...\",\n \"systemId\": \"...\",\n \"currentStatus\": {\n \"tag\": \"PENDING_PREPARATION\",\n \"date\": \"2019-01-01 01:00:00\"\n },\n \"status\": [\n {\n \"tag\": \"RESERVED\",\n \"date\": \"2019-01-01 00:00:00\"\n },\n {\n \"tag\": \"PENDING_PREPARATION\",\n \"date\": \"2019-01-01 01:00:00\"\n }\n ]\n }\n}"},{"id":"3946b97d-9310-4783-baa8-4a8c24276be9","name":"Get Order","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"https://{{subdomain}}-oom.omnixsystem.com/v3/order/{{id}}"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"rawAmount\": 2.2,\n \"totalAmount\": 2.2,\n \"discount\": 2.2,\n \"taxesAmount\": 2.2,\n \"shippingAmount\": 2.2,\n \"creationDate\": \"\",\n \"site\": \"\",\n \"shippingType\": \"SP|HD|TR\",\n \"storePickupId\": \"Servicio para obtener información órdenes por status, filtrando por días, meses ó fechas absolutas.
\nPath params
\n- \n
- status: Identificador del status a consultar, este parámetro puede tomar uno de los siguientes valores:
- \n
- RESERVED \n
- PENDING_PREPARATION \n
- IN_TRANSIT \n
- READY_FOR_PICKUP \n
- CLOSED \n
- CANCELED \n
\n
Ejemplo: \n/v3/order/all/status/RESERVED
\nRequest
\n- \n
skipRecords (Requerido): (Number) Cantidad de registros a saltarse, esto con el fin de paginar los resultados.
\n \nmaxRecords (Requerido): (Number) Cantidad de registros máximos a retornar.
\n \nfilter (Opcional): (JSON) Objeto con propiedades filtrables, estas pueden ser cualquier parámetro de la orden utilizando la forma Dot-Notation, por ejemplo:
\n- \n
- id: ID de la orden en Omnix \n
- items.sku: SKU \n
- channel: Canal de venta \n
- shippingType: Tipo de envío \n
- deliveryType: Tipo de despacho \n
- customer.id: ID del cliente (RUT) \n
- source: ID del source (NO aplica para HD y SP) \n
- custom.folio: Número de DTE asociado a la orden \n
\nrange (Opcional): (JSON) Objeto utilizado para el filtrado por rangos, sus atributos son:
\n- \n
- type: Puede tomar uno de los siguientes valores: monthly, absolute. \n
- from: (Any) Valor inferior en el rango \n
- to: (Any) Valor superior en el rango. \n
- year: (Opcional, Requerido si type = \"monthly\") Año de la búsqueda. \n
\nproject (Opcional): (Array[String]) Lista de atributos a devolver en la consulta, si no se especifica esta propiedad, se retornan todos los atributos de la orden.
\n \n
Ejemplos:
\nFiltros variables
\n{\n \"skipRecords\": 0,\n \"maxRecords\": 10,\n \"filter\":{\n \"id\": \"OrderID00\",\n \"items.sku\": \"SKU001\",\n \"channel\": \"ecommerce\",\n \"shippingType\":\"HD\",\n \"deliveryType\": \"SD\",\n \"customer.id\": \"0000000\",\n \"source\": \"SOURCEID\",\n \"custom.folio\": \"123456\",\n \"propiedad1\": \"valor\",\n \"propiedad2.propiedadHija1\": \"valor\",\n \"propiedad2.propiedadHija2\": [\"valor1\", \"valor2\"]\n }\n}\nRegistros desde Enero hasta Junio del año 2019
\n{\n \"skipRecords\": 0,\n \"maxRecords\": 10,\n \"range\":{\n \"type\": \"monthly\",\n \"from\": 1,\n \"to\": 6,\n \"year\": 2019\n }\n}\nRegistros desde el 1 de enero hasta el 20 de enero del 2019
\n{\n \"skipRecords\": 0,\n \"maxRecords\": 10,\n \"range\":{\n \"type\": \"absolute\",\n \"from\": \"2019-01-01 00:00:00\",\n \"to\": \"2019-01-20 00:00:00\"\n }\n}\nResponse:
\n- \n
- message.numRecordsReturned: (Number) Cantidad de registros retornados. \n
- message.skippedRecords: (Number) Cantidad de registros saltados. \n
- message.totalRecordsMatched: Cantidad de registros que coinciden con la búsqueda. \n
- message.records: Array[Order] Registros (Órdenes) que coinciden con la búsqueda. \n
{\n \"transactionId\": \"326f89d0-5862-11e8-92a0-fb2a57096715\",\n \"code\": 200,\n \"message\": {\n \"numRecordsReturned\": 1,\n \"skippedRecords\": 0,\n \"totalRecordsMatched\": 100,\n \"records\":[{\n \"id\": \"...\",\n \"salesChannelId\": \"...\",\n \"systemId\": \"...\",\n \"currentStatus\":{\n \"tag\": \"RESERVED\",\n \"date\": \"2019-01-01 01:00:00\"\n },\n \"status\":[\n {\n \"tag\": \"RESERVED\",\n \"date\": \"2019-01-01 00:00:00\"\n }\n ]\n }]\n }\n}\nIncremental Omnix ID
\nOmnix soporta generar un id incremental partiendo desde 1 con padding string de ceros a la izquierda hasta completar el tamaño fijo configurado (length). Ejemplo:
\nincrementalOmnixId: 0000000001 (length 10)
\nEl incrementalOmnixId se genera de la siguiente manera:
\n{prefix}{prefixSeparator}{incremental}{suffixSeparator}{suffix}
\nEjemplo: ecommerce-0000000001-mow
\nRequest
\n- \n
- prefix: (String) Define un prefijo para el incremental id, esta propiedad soporta Template Literal con la cual se puede definir por ejemplo que tome un campo de la orden usando el objeto order y dot notation, ejemplo, suponga que desea colocar como prefijo el canal de venta, entonces el valor de este campo debería ser: \n
{\n \"prefix\": \"${order.channel}\"\n}\n- \n
prefixSeparator: (String) define una cadena que separará el prefijo del incremental.
\n \nsuffix: (String) Define un sufijo para el incremental id, esta propiedad soporta Template Literal con la cual se puede definir por ejemplo que tome un campo de la orden usando el objeto order y dot notation, ejemplo, suponga que desea colocar como sufijo el canal de venta, entonces el valor de este campo debería ser:
\n \n
{\n \"suffix\": \"${order.channel}\"\n}\n- \n
suffixSeparator: (String) define una cadena que separará el incremental del sufijo.
\n \nlength: (Integer >= 10) Define el tamaño en caracteres del incremental, por defecto este tiene un tamaño de 10, cuando el incremental tiene un tamaño en caracteres menor que length entonces se rellenará con ceros a la izquierda hasta alcanzar el total de length.
\n \n
Template Literals
\nNo todos los atributos de la orden son soportados en prefix y suffix, las propiedades soportadas son:
\n- \n
- ${order.site} \n
- ${order.shippingType} \n
- ${order.deliveryType} \n
- ${order.salesChannelId} \n
- ${order.channel} \n
- ${order.ownerId} \n
Cada una de estas propiedades puede especificarse también forzando mayúsculas (.toUpperCase()) ó minúsculas (.toLowerCase()). Ejemplo:
\n- \n
- Atributo site en mayúsculas: ${order.site.toUpperCase()} \n
- Atributo site en minúsculas: ${order.site.toLowerCase()} \n
Incremental Omnix ID
\nEste servicio retorna los parámetros configurados para la generación del incrementalOmnixId.
\n","urlObject":{"protocol":"https","path":["v3","order","sequencer"],"host":["{{subdomain}}-oom","omnixsystem","com"],"query":[],"variable":[]}},"response":[{"id":"e5c25045-af62-4e74-8d9a-79bfe0e1ad1c","name":"Get Sequence Configuration","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://{{subdomain}}-oom.omnixsystem.com/v3/order/sequence"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"prefix\": \"${order.channel}\",\n \"prefixSeparator\": \"-\",\n \"suffix\": \"something\",\n \"suffixSeparator\": \"-\",\n \"length\": 12\n}"}],"_postman_id":"72989a37-5816-4e9d-93f3-f09b80427335"}],"id":"f18dae67-49b9-4ab9-a9a7-bd481bded5c2","_postman_id":"f18dae67-49b9-4ab9-a9a7-bd481bded5c2","description":""},{"name":"ShippingGroup","item":[{"name":"SG Actions","id":"d961c413-9048-44c2-9bbe-5d423f5b4f33","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Bearer {{token}}"}],"body":{"mode":"raw","raw":"{\t\n \"custom\":{\n \"something\": \"here 2\"\n }\n}"},"url":"https://{{subdomain}}-oom.omnixsystem.com/v3/order/all/shippinggroup/{{id}}/{{action}}","description":"Servicio para ejecutar acciones en el Shipping Group, estas son:
\n- \n
- reschedule: Esta acción permite que un shipping group pueda re-agendarse especificando una nueva fecha de despacho, tipo de despacho y de manera opcional cambio de dirección ó tienda de retiro. Para que un shipping group pueda ser elegible para re-agendamiento, debe ser HD, SP o RT y este debe estar en alguno de estos estados: \n
- AWAITING_STORE_CONFIRMATION \n
- PENDING_PACKAGE \n
- AWAITING_DELIVERY \n
- REJECTED \n
- RETURN_IN_REVIEW \n
- RETURNED \n
Datos sobre-escribibles en re-agendamiento:
- \n
- estimatedDeliveryDate (String) (Requerido): Este valor es entregado por la consulta de agendamiento. \n
- deliveryType (String) (Requerido) \n
- source/target (Ordenes RT) (Opcional) \n
- shippingAddress (Ordenes HD) (Opcional) \n
- storePickupId (Ordenes SP) (Opcional) \n
Reschedule - INPUTS:
\nHD:
\n{\n \"deliveryType\": \"\",\n \"estimatedDeliveryDate\": \"\",\n \"shippingAddress\": {}\n}\nSP:
\n{\n \"deliveryType\": \"\",\n \"estimatedDeliveryDate\": \"\",\n \"storePickupId\": \"\"\n}\nRT:
\n{\n \"deliveryType\": \"\",\n \"estimatedDeliveryDate\": \"\",\n \"source\": {},\n \"target\": {\n \"source\": {\n \"id\": \"\"\n }\n }\n}\nReschedule - ORDER HISTORY: La orden contiene un atributo array reschedule como histórico de los re-agendamientos, los atributos de cada elemento de reschedule dependen de si el re-agendamiento fue HD, SP ó RT, para este ejemplo se colocaron todos los posibles.
\n{\n \"id\": \"ORDER000001\",\n \"reschedule\": [\n {\n \"deliveryType\": \"\",\n \"estimatedDeliveryDate\": \"\",\n \"items\": [],\n \"reference\": \"SG00000000001\",\n \"shippingAddress\": {},\n \"source\": {},\n \"storePickupId\": \"\",\n \"target\": {\n \"source\": {\n \"id\": \"\"\n }\n }\n }\n ]\n}\nReschedule - SHIPPINGGROUP Properties Como referencia en el proceso de re-agendamiento los shippinggroups almacenan dos propiedades, estas son:
\n- \n
- rescheduledFrom: Esta propiedad es asignada al nuevo shippinggroup y contiene el identificador del shippinggroup al cual se le aplicó la acción de reschedule. \n
- rescheduledBy: Esta propiedad es asignada al shippinggroup al cual se le aplicó la acción de reschedule y contiene el identificador del shippinggroup nuevo. \n
Reschedule - SHIPPINGGROUP Status Al shippinggroup reagendado se le asigna un nuevo estado, este estado es RESCHEDULED y el nuevo shippinggroup parte desde el estado AWAITING_STORE_CONFIRMATION.
\n\n
- \n
- accept: Esta acción especifica que uno o más items de la SG fueron aceptados por la tienda y ahora van a ser empacados. Ejemplo:\n/v3/order/all/shippinggroup/SG199928910/accept \n
{\n \"assignDroppedItemsToSameSource\": true,\n \"seller\":{\n \"id\": \"....\"\n },\n \"items\":[\n {\n \"sku\": \"SKU0001\",\n \"quantity\": 1,\n \"custom\":{\n \"custom_data_1\": \"custom_value_1\"\n }\n }\n ]\n}\n* La propiedad **assignDroppedItemsToSameSource** (true|false) (Opcional) si se envía en **true** entonces los items no aceptados se asignan a la misma tienda, sino, Omnix buscará otro source para completar la orden. Se asume false por defecto\n* **Seller id (String)** (Requerido): corresponde al Id del vendedor o el valor 1 como parámetro por defecto.\n* **Items (Array)** (Requerido): corresponde al detalle de los artículos aceptados.\n\n
- \n
- packed: Esta acción especifica que la SG ya fue empacada y se encuentra lista para ser recogida por el courier.
- \n
- En esta acción se puede enviar los siguientes campos: \n
- shippingManifest (String) (Opcional): Identificador del manifiesto. \n
- trackingNumber (String) (Opcional): Número de tracking del envío \n
- custom (JSON) (Opcional): Información adicional custom en forma de key/value.\n/v3/order/all/shippinggroup/SG199928910/packed \n
\n
{\n \"trackingNumber\": \"TRACKING0001\",\n \"shippingManifest\": \"SOME_ID\",\n \"custom\":{\n \"foo\": \"bar\"\n }\n }\n\n
- \n
- shipped: Esta acción especifica que la SG ya fue recogida por el courier.
- \n
- En esta acción se puede enviar los siguientes campos: \n
- shippingManifest (String) (Opcional): Identificador del manifiesto. \n
- trackingNumber (String) (Opcional): Número de tracking del envío \n
- custom (JSON) (Opcional): Información adicional custom en forma de key/value.\n/v3/order/all/shippinggroup/SG199928910/shipped \n
\n
{\n \"trackingNumber\": \"TRACKING0001\",\n \"shippingManifest\": \"SOME_ID\",\n \"custom\":{\n \"foo\": \"bar\"\n }\n }\n\n
- \n
- delivered: Esta acción especifica que la SG fue entregada en la tienda ó dirección destino por parte del courier. \n
\n
- \n
- delivered_reject: Esta acción rechaza el delivery del shippinggroup, pasa este a estado AWAITING_STORE_CONFIRMATION asignando como source nuevamente la tienda de donde originalmente salió el stock. Ejemplo: \n
/v3/order/all/shippinggroup/SG199928910/delivered_reject
\n{\n \"comment\": \"All products broken\"\n}\nDe forma opcional puede ser enviado a esta acción un flag generateNewShippingGroup, el cual hace que Omnix genere un nuevo ShippingGroup a partir del ShippingGroup que recibe la acción delivered_reject. Ejemplo:
\n{\n \"comment\": \"All products broken\",\n \"generateNewShippingGroup\": true\n}\n\n
- \n
- delivered_inc: Esta acción especifica que la SG fue entregada al destino pero la cantidad de items recibidas no es la misma que fue despachada. Se debe especificar la información de items esperados vs items recibidos.
- \n
- items (Array) (Requerido): corresponde al detalle de los artículos. \n
- custom (JSON) (Opcional): Información adicional custom en forma de key/value. \n
\n
Ejemplo:\n/v3/order/all/shippinggroup/SG199928910/delivered_inc\njson { \"items\":[ { \"sku\": \"SKU0001\", \"quantity\": 3, \"deliveredQuantity\": 2, \"custom\":{ \"custom_data_1\": \"custom_value_1\" }, \"comment\": \"...\" } ] }
\n- \n
courier_reject: Esta acción puede ser lanzada desde el courier por dos razones:
\n- \n
- La primera razón es porque hay algo mal con el paquete y este debe ser retornado a su origen, para este caso el request body debe ir de la siguiente manera:
- \n
- reason (String) (Requerido): Único valor \"RETURN\". \n
- comment (String) (Requerido): Comentario al que hace referencia el retorno. \n
\n
\n{\n \"reason\": \"RETURN\",\n \"comment\": \"....\"\n}\n- \n
- La segunda razón sería por un problema de etiquetas, en este caso esta acción puede ser removida cuando se ejecute nuevamente una acción de shipped y así el courier puede seguir en el flujo normal esperado. El request body para este caso sería: \n
- reason (String) (Requerido): Único valor \"SOMETHING_WRONG\". \n
- comment (String) (Requerido): Comentario al que hace referencia el retorno. \n
\n{\n \"reason\": \"SOMETHING_WRONG\",\n \"comment\": \"...\"\n}\n\n- La primera razón es porque hay algo mal con el paquete y este debe ser retornado a su origen, para este caso el request body debe ir de la siguiente manera:
\n
- \n
- customer_reject: Esta acción representa un problema con el paquete y es reportado/rechazado por el cliente. \n
\n
- \n
- reject: Esta acción puede ser lanzada desde la tienda y lo que indicaría a Omnix es que debe buscar una siguiente tienda que pueda entregar estos items.
- \n
- custom (JSON) (Opcional): Información adicional custom en forma de key/value.
\n{\n \"custom\":{\n \"foo\": \"bar\"\n }\n}\n\n
\n - custom (JSON) (Opcional): Información adicional custom en forma de key/value.
\n
- \n
- delivered_return: Esta acción es lanzada desde la tienda que recibe un pedido rechazado por courier. \n
\n
- \n
- prepared: Esta acción es lanzada desde la tienda cuando ha preparado el pedido y esta listo para ser recogido por el usuario \n
\n
- \n
- picked_up: Esta acción se espera cuando una SG de tipo SP es recogida por el usuario. \n
\n
- \n
- keep: Cuando el shipping group es RT (Retorno) y está en estado RETURN_IN_REVIEW la acción keep coloca DELIVERED como nuevo estado y agrega el stock al target. \n
\n
- \n
- discard: Cuando el shipping group es RT (Retorno) y está en estado RETURN_IN_REVIEW la acción discard coloca DELIVERED como nuevo estado SIN agregar el stock al target. \n
\n
- \n
- cancel: Esta acción cancela la SG.
- \n
- custom (JSON) (Opcional): Información adicional custom en forma de key/value.
\n{\n \"custom\":{\n \"foo\": \"bar\"\n }\n}\n\n
\n - custom (JSON) (Opcional): Información adicional custom en forma de key/value.
\n
- \n
- cancel_decrease: Esta acción genera una cancelación sin regresar el stock al source.
- \n
- custom (JSON) (Opcional): Información adicional custom en forma de key/value.
\n{\n \"custom\":{\n \"foo\": \"bar\"\n }\n}\n\n
\n - custom (JSON) (Opcional): Información adicional custom en forma de key/value.
\n
- \n
- cancel_logistic: Acción de cancelación por logística.
- \n
- custom (JSON) (Opcional): Información adicional custom en forma de key/value.
\n{\n \"custom\":{\n \"foo\": \"bar\"\n }\n}\n\n
\n - custom (JSON) (Opcional): Información adicional custom en forma de key/value.
\n
- \n
- cancel_items: Esta acción cancela items en un ShippingGroup, estos items NO son reprocesados por omnix y quedan almacenados como histórico en una propiedad canceledItems del SG que puede ser consultado por el servicio de Get SG, además de esto Omnix actualiza el nuevo quantity de los items en source.items.\nComo request de esta acción se espera se envíe un array de items con las propiedades sku/quantity a cancelar.
Ejemplo:\n
Request: \n
{\n \"items\": [\n {\n \"sku\": \"SKU0001\",\n \"quantity\": 2\n }\n ]\n}\nAsí sería la estructura de la propiedad canceledItems que quedaría en el ShippingGroup:\njson { \"canceledItems\": [ { \"sku\": \"SKU0001\", \"orderedQuantity\": 4, \"canceledQuantity\": 2, \"date\": \"2022-04-04T16:38:33.700Z\" } ] }
\n- \n
- trace: Esta acción permite agregar una o más trazas al SG, enviando name y description como información de la misma. Ejemplo de request de traza:
- \n
- name (String) (Requerido): Nombre de la traza. \n
- description (String) (Requerido): Descripción de la traza. \n
\n
[\n {\n \"name\": \"cuorier_delivered\",\n \"description\": \"Courier delivery ends\"\n }\n]\n\n
- \n
- pick: Esta acción se usa de forma incremental y en cada llamado aumenta la cantidad confirmada (pickeada) de un determinado producto. \nCada llamado a esta acción va a incrementar y no reemplazar el valor confirmado (pickeado) del producto.
Ejemplo:
\n/v3/order/all/shippinggroup/SG199928910/pick \n
[\n {\n \"sku\": \"SKU0001\",\n \"quantity\": 2\n },\n {\n \"sku\": \"SKU0002\",\n \"quantity\": 1\n }\n]\n* Esta acción se puede mandar más de una vez, los valores de **quantity** enviado por cada sku incrementarán el valor actual, para ajustar dicho valor se debe usar **drop**. \n* Para ajustar dicho valor a la baja se debe usar el SG action: **drop** (en caso de que se deba reducir la cantidad confirmada por algún error o problema).\n* Omnix dejará de incrementar el valor de **quantity** pickeado si este alcanza la cantidad total ordenada.\n\n
- \n
- drop: Esta acción hace la operación inversa de pick, esto es, en vez de incrementar la cantidad confirmada (pickeada) hace un decremento de esta por producto del shippinggroup en una cantidad específica. Al igual que pick esta acción se puede llamar en forma recurrente con el fin de ajustar la cantidad confirmada (pickeada)
Ejemplo:
\n/v3/order/all/shippinggroup/SG199928910/drop \n
[\n {\n \"sku\": \"SKU0001\",\n \"quantity\": 2\n },\n {\n \"sku\": \"SKU0002\",\n \"quantity\": 1\n }\n]\n* Esta acción se puede mandar más de una vez, los valores de **quantity** enviado por cada sku decrementarán el valor actual.\n* Omnix dejará de decrementar el valor de **quantity** pickeado si este alcanza la cantidad de cero.\n\n
- \n
- confirm: Esta acción confirma que la operación de confirmación (pickeo) del shippinggroup ha terminado y podría esto desencadenar en una acción accept ó reject automáticamente. Las condiciones para ir por accept o reject son:
- \n
- Si al menos hay un producto con una cantidad pickeada >= 1, entonces ejecuta automáticamente un accept con el resumen de productos aceptados. \n
- Si no hay ningún producto con una cantidad pickeada >= 1, entonces ejecuta automáticamente un reject para que omnix genere un nuevo shippinggroup para completar el pedido.
\n
/v3/order/all/shippinggroup/SG199928910/drop
{\n \"assignDroppedItemsToSameSource\": true,\n \"seller\": {\n \"id\": \"...\"\n }\n}\n* Como el confirm puede desencadenar un **accept** se requiere la propiedad **assignDroppedItemsToSameSource** (true|false). Si se envía en **true** entonces los items no confirmados (pickeados) se asignan a la misma tienda, sino, Omnix buscará otro source para completar la orden con los items no confirmados (pickeados).\n* Como el confirm desencadenar un **accept** se requiere la propiedad **seller**.\nPick / Drop / Confirm
\nEn la sección de ejemplo se puede visualizar el uso de estas tres acciones.
\nPath params
\nEste servicio contiene tres parámetros en el path id, action los cuales deben contener el id de la SG y la acción a ejecutar.\nEjemplo: \n/v3/order/M90011921/shippinggroup/SG199928910/delivered_inc
\nRequest:
\nPara el caso de accept se deben enviar las siguientes propiedades:
\n- \n
- items (Requerida): Esta propiedad es de tipo JSON Array y cada elemento contiene las siguientes propiedades:
- \n
- seller (Requerido): Este parámetro es un JSON con las siguientes propiedades:
- \n
- id: representa el identificador del vendedor o persona encargada de aceptar la SG, esta debe estar previamente creada en Omnix. \n
\n - sku (Requerido): Contiene el código sku del producto. \n
- quantity (Requerido): Contiene la cantidad de items que se aceptaron despachar. \n
- custom (Opcional): Contiene información personalizada del item a despachar, tal como números de serie, etc... \n
\n - seller (Requerido): Este parámetro es un JSON con las siguientes propiedades:
Para el caso de delivered_inc se deben enviar las siguientes propiedades:\n3. items (Requerida): Esta propiedad es de tipo JSON Array y cada elemento contiene las siguientes propiedades:\n * sku (Requerido): Contiene el código sku del producto.\n * quantity (Requerido): Contiene la cantidad de items esperados.\n * deliveredQuantity (Requerido): Contiene la cantidad de items entregados.\n * custom (Opcional): Contiene información personalizada del item a despachar, tal como números de serie, etc...\n * comment (Opcional): Contiene un comentario opcional.
\nError codes
\n","urlObject":{"protocol":"https","path":["v3","order","all","shippinggroup","{{id}}","{{action}}"],"host":["{{subdomain}}-oom","omnixsystem","com"],"query":[],"variable":[]}},"response":[{"id":"0ab90de6-d196-49cc-a924-051484fbcfd8","name":"SG Actions - Drop","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","type":"text","value":"Bearer {{token}}"}],"body":{"mode":"raw","raw":"[\n {\n \"sku\": \"SKU0001\",\n \"quantity\": 1\n },\n {\n \"sku\": \"SKU0002\",\n \"quantity\": 1\n }\n]","options":{"raw":{"language":"json"}}},"url":"https://{{subdomain}}-oom.omnixsystem.com/v3/order/all/shippinggroup/SG0001/drop"},"code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"transactionId\": \"Servicio para actualizar información no sensible de un shippinggroup.
\nEste endpoint permite modificar la propiedad custom raíz y la propiedad custom de cada item. \nSi una propiedad custom ya existe tanto en la raíz como en el item, esta será reemplazada por el nuevo valor, los valores que se envíen en el payload del request se van combinar con los valores de custom ya existentes.
\nEjemplos:
\n- \n
- Custom Actual: \n
\"custom\":{\n \"something\": 100\n }\n- \n
- Custom enviado en el payload: \n
\"custom\":{\n \"foo\": \"bar\"\n }\n- \n
- Resultado final: \n
\"custom\":{\n \"something\": 100,\n \"foo\": \"bar\"\n }\n- \n
- Custom en item \n
{ \n \"items\":[\n {\n \"sku\": \"SKU0001\",\n \"custom\":{\n \"bar\": \"foo\"\n }\n }\n ]\n}\nServicio para consultar Shipping Group por orderId e Id.
\nPath parameters
\n- \n
- oid: Representa el Id de la orden, si no se cuenta con el id de la orden se debe enviar all, quedando de la forma -> /v3/order/all/shippinggroup/{{shippinggroup_id}}. \n
- sgid: Representa el identificador del shipping group. \n
Servicio para obtener información shipping groups por status, filtrando por días, meses ó fechas absolutas.
\nPath params
\n- \n
- status: Identificador del status a consultar, este parámetro puede tomar uno de los siguientes valores:
- \n
- AWAITING_STORE_CONFIRMATION \n
- PENDING_PACKAGE \n
- AWAITING_DELIVERY \n
- IN_TRANSIT \n
- READY_FOR_PICKUP \n
- CLOSED \n
\n
Ejemplo: \n/v3/order/all/shippinggroup/all/status/AWAITING_STORE_CONFIRMATION
\nRequest
\n- \n
- skipRecords (Opcional): (Number) Cantidad de registros a saltarse, esto con el fin de paginar los resultados. \n
- maxRecords (Opcional): (Number) Cantidad de registros máximos a retornar. \n
- filter (Opcional): (JSON) Objeto con propiedades filtrables, por el momento solo soportado source.id el cual representa el id del Source por el cual se consultarán las SGs por estado. \n
- range (Opcional): (JSON) Objeto utilizado para el filtrado por rangos, sus atributos son:
- \n
- type: Puede tomar uno de los siguientes valores: monthly, absolute. \n
- from: (Any) Valor inferior en el rango \n
- to: (Any) Valor superior en el rango. \n
- year: (Opcional, Requerido si type = \"monthly\") Año de la búsqueda. \n
\n - project (Opcional): (Array[String]) Lista de atributos a devolver en la consulta, si no se especifica esta propiedad, se retornan todos los atributos de la orden. \n
Ejemplos:
\nRegistros desde Enero hasta Junio del año 2019
\n{\n \"skipRecords\": 0,\n \"maxRecords\": 10,\n \"range\":{\n \"type\": \"monthly\",\n \"from\": 1,\n \"to\": 6,\n \"year\": 2019\n }\n}\nRegistros desde el 1 de enero hasta el 20 de enero del 2019
\n{\n \"skipRecords\": 0,\n \"maxRecords\": 10,\n \"range\":{\n \"type\": \"absolute\",\n \"from\": \"2019-01-01 00:00:00\",\n \"to\": \"2019-01-20 00:00:00\"\n }\n}\nResponse:
\n- \n
- message.numRecordsReturned: (Number) Cantidad de registros retornados. \n
- message.skippedRecords: (Number) Cantidad de registros saltados. \n
- message.totalRecordsMatched: Cantidad de registros que coinciden con la búsqueda. \n
- message.records: Array[Order] Registros (SGs) que coinciden con la búsqueda. \n
{\n \"transactionId\": \"326f89d0-5862-11e8-92a0-fb2a57096715\",\n \"code\": 200,\n \"message\": {\n \"numRecordsReturned\": 1,\n \"skippedRecords\": 0,\n \"totalRecordsMatched\": 100,\n \"records\":[{\n \"id\": \"...\",\n \"salesChannelId\": \"...\",\n \"currentStatus\":{\n \"tag\": \"AWAITING_STORE_CONFIRMATION\",\n \"date\": \"2019-01-01 01:00:00\"\n }\n }]\n }\n}\nServicio para obtener información shipping groups por Source, filtrando por días, meses ó fechas absolutas.
\nPath params
\n- \n
- sid: Identificador del Source \n
Ejemplo: \n/v3/order/all/shippinggroup/all/source/SOURCE001
\nRequest
\n- \n
- skipRecords (Opcional): (Number) Cantidad de registros a saltarse, esto con el fin de paginar los resultados. \n
- maxRecords (Opcional): (Number) Cantidad de registros máximos a retornar. \n
- range (Opcional): (JSON) Objeto utilizado para el filtrado por rangos, sus atributos son:
- \n
- type: Puede tomar uno de los siguientes valores: monthly, absolute. \n
- from: (Any) Valor inferior en el rango \n
- to: (Any) Valor superior en el rango. \n
- year: (Opcional, Requerido si type = \"monthly\") Año de la búsqueda. \n
\n - project (Opcional): (Array[String]) Lista de atributos a devolver en la consulta, si no se especifica esta propiedad, se retornan todos los atributos de la orden. \n
Ejemplos:
\nRegistros desde Enero hasta Junio del año 2019
\n{\n \"skipRecords\": 0,\n \"maxRecords\": 10,\n \"range\":{\n \"type\": \"monthly\",\n \"from\": 1,\n \"to\": 6,\n \"year\": 2019\n }\n}\nRegistros desde el 1 de enero hasta el 20 de enero del 2019
\n{\n \"skipRecords\": 0,\n \"maxRecords\": 10,\n \"range\":{\n \"type\": \"absolute\",\n \"from\": \"2019-01-01 00:00:00\",\n \"to\": \"2019-01-20 00:00:00\"\n }\n}\nResponse:
\n- \n
- message.numRecordsReturned: (Number) Cantidad de registros retornados. \n
- message.skippedRecords: (Number) Cantidad de registros saltados. \n
- message.totalRecordsMatched: Cantidad de registros que coinciden con la búsqueda. \n
- message.records: Array[Order] Registros (SGs) que coinciden con la búsqueda. \n
{\n \"transactionId\": \"326f89d0-5862-11e8-92a0-fb2a57096715\",\n \"code\": 200,\n \"message\": {\n \"numRecordsReturned\": 1,\n \"skippedRecords\": 0,\n \"totalRecordsMatched\": 100,\n \"records\":[{\n \"id\": \"...\",\n \"salesChannelId\": \"...\",\n \"currentStatus\":{\n \"tag\": \"AWAITING_STORE_CONFIRMATION\",\n \"date\": \"2019-01-01 01:00:00\"\n }\n }]\n }\n}\nServicio para obtener SGs a partir del ir de la orden.
\nPath Parameters:
\n- \n
- orderId: Identificador de la orden. \n
Servicio para obtener contador de SGs agrupados por estado.
\nRequest
\n- \n
- shippingTypes (Requerido): (Array[String]) Lista de shippingTypes por los cuales se filtrará la búsqueda. \n
- sources (Opcional): (Array[String]) Lista de sourceID por los cuales se filtrará la búsqueda. \n
- couriers (Opcional): (Array[String]) Lista de couriers por los cuales se filtrará la búsqueda. \n
- status (Requerido): (Array[String]) Lista de estados (currentStatus) por los cuales se filtrará la búsqueda. \n
- range (Opcional): (JSON) Objeto utilizado para el filtrado por rangos, sus atributos son:
- \n
- from: (Any) Valor inferior en el rango \n
- to: (Any) Valor superior en el rango. \n
\n
Ejemplo:
\n{\n \"shippingTypes\": [\"HD\", \"SP\"],\n \"sources\": [\"WWH\", \"FSN\"],\n \"status\":[\"AWAITING_STORE_CONFIRMATION\", \"PENDING_PACKAGE\", \"AWAITING_DELIVERY\"],\n \"couriers\": [\"COURIER1\", \"COURIER2\"],\n \"range\":{\n \"from\": \"now-1d\",\n \"to\": \"now\"\n }\n}\n\nResponse:
\n- \n
- code: (Number) Código de respuesta de la petición. \n
- message: (Array[object]) Lista de objetos con su respectivo estado y contador. \n
{\n \"code\": 200,\n \"message\": [\n { \"status\": \"AWAITING_STORE_CONFIRMATION\", \"count\": 14452 },\n { \"status\": \"IN_TRANSIT\", \"count\": 5945 },\n { \"status\": \"AWAITING_DELIVERY\", \"count\": 129 },\n { \"status\": \"PENDING_PACKAGE\", \"count\": 65 },\n { \"status\": \"READY_FOR_PICKUP\", \"count\": 42 },\n { \"status\": \"CLOSED\", \"count\": 2 }\n ]\n}\n\nSome jpeg, png or pdf attachment
\n","type":"file","value":null},{"key":"attach1","description":"Some jpeg, png or pdf attachment
\n","type":"file","value":null},{"key":"tags","value":"tag001,tag002","description":"Optional tags separated by comma
\n","type":"text"}]},"url":"https://{{subdomain}}-oom.omnixsystem.com/v3/order/all/shippinggroup/{{id}}/attachments","description":"Este servicio permite agregar archivos adjuntos al estado actual del ShippingGroup. \nLos mimetype permitidos son:
\n- \n
- image/jpeg \n
- image/png \n
- application/pdf \n
En cada estado del ShippingGroup donde haya un archivo asociado se verá de la siguiente forma:
\n{\n \"id\": \"SG0001\",\n \"currentStatus\": {\n \"tag\": \"DELIVERED\",\n \"date\": \"2020-01-01T00:00:00\",\n \"media\": {\n \"ref\": [\n {\n \"type\": \"image/jpeg\",\n \"id\": \"5e6d6d9f2e6862a673fbc442\"\n }\n ]\n }\n },\n \"status\": [\n {\n \"tag\": \"AWAITING_STORE_CONFIRMATION\",\n \"date\": \"2020-01-01T00:00:00\"\n },\n {\n \"tag\": \"PENDING_PACKAGE\",\n \"date\": \"2020-01-01T00:00:00\",\n \"media\": {\n \"ref\": [\n {\n \"type\": \"image/jpeg\",\n \"id\": \"5e6d6d9f2e6862a673fbc439\"\n }\n ]\n }\n },\n {\n \"tag\": \"AWAITING_DELIVERY\",\n \"date\": \"2020-01-01T00:00:00\",\n \"media\": {\n \"ref\": [\n {\n \"type\": \"application/pdf\",\n \"id\": \"5e6d6d9f2e6862a673fbc440\"\n }\n ]\n }\n },\n {\n \"tag\": \"IN_TRANSIT\",\n \"date\": \"2020-01-01T00:00:00\",\n \"media\": {\n \"ref\": [\n {\n \"type\": \"image/jpeg\",\n \"id\": \"5e6d6d9f2e6862a673fbc441\"\n }\n ]\n }\n },\n {\n \"tag\": \"DELIVERED\",\n \"date\": \"2020-01-01T00:00:00\",\n \"media\": {\n \"ref\": [\n {\n \"type\": \"image/jpeg\",\n \"id\": \"5e6d6d9f2e6862a673fbc442\"\n }\n ]\n }\n }\n ]\n}\nAcceso a los archivos
\nLos archivos asociados a un ShippingGroup se encuentran guardados sin acceso público, para obtener una pre-signed URL del archivo adjuntado y así poder abrirlo, se debe consumir el servicio Media / Get Media.
\nLas pre-signed URLs son generadas al momento del consultar por el recurso, estas URLs tienen un tiempo de expiración con el fin de garantizar la seguridad de los mismos.
\nRestricciones:
\n- \n
- Solo se podrán subir máximo 2 archivos por estado. \n
- El tamaño de cada archivo no puede exceder los 5MB. \n
Este servicio quita de forma permanente los archivos asociados a un estado del ShippingGroup, para borrarlos solamente son necesarios los ids de los archivos a borrar.
\n","urlObject":{"protocol":"https","path":["v3","order","all","shippinggroup","{{id}}","attachments"],"host":["{{subdomain}}-oom","omnixsystem","com"],"query":[],"variable":[]}},"response":[{"id":"24233e7e-2277-4b3e-aab8-c85fd9cde8b8","name":"Detach file","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"ids\": [\n \"ID000001\",\n \"ID000002\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://{{subdomain}}-oom.omnixsystem.com/v3/order/all/shippinggroup/{{id}}/attachments"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"transactionId\": \"Incremental Omnix SG ID
\nOmnix soporta generar un id incremental partiendo desde 1 con padding string de ceros a la izquierda hasta completar el tamaño fijo configurado (length). Ejemplo:
\nincrementalOmnixSgId: 0000000001 (length 10)
\nEl incrementalOmnixSgId se genera de la siguiente manera:
\n{prefix}{prefixSeparator}{incremental}{suffixSeparator}{suffix}
\nEjemplo: ecommerce-0000000001-mow
\nRequest
\n- \n
- prefix: (String) Define un prefijo para el incremental id, esta propiedad soporta Template Literal con la cual se puede definir por ejemplo que tome un campo del shipping group usando el objeto shippinggroup y dot notation, ejemplo, suponga que desea colocar como prefijo el canal de venta, entonces el valor de este campo debería ser: \n
{\n \"prefix\": \"${shippinggroup.channel}\"\n}\n\n- \n
- prefixSeparator: (String) define una cadena que separará el prefijo del incremental. \n
- suffix: (String) Define un sufijo para el incremental id, esta propiedad soporta Template Literal con la cual se puede definir por ejemplo que tome un campo de la shipping group usando el objeto shippinggroup y dot notation, ejemplo, suponga que desea colocar como sufijo el canal de venta, entonces el valor de este campo debería ser: \n
{\n \"suffix\": \"${shippinggroup.channel}\"\n}\n\n- \n
- suffixSeparator: (String) define una cadena que separará el incremental del sufijo. \n
- length: (Integer >= 10) Define el tamaño en caracteres del incremental, por defecto este tiene un tamaño de 10, cuando el incremental tiene un tamaño en caracteres menor que length entonces se rellenará con ceros a la izquierda hasta alcanzar el total de length. \n
Template Literals
\nNo todos los atributos del shipping group son soportados en prefix y suffix, las propiedades soportadas son:
\n- \n
- ${shippinggroup.shippingType} \n
- ${shippinggroup.salesChannelId} \n
- ${shippinggroup.channel} \n
- ${shippinggroup.ownerId} \n
Cada una de estas propiedades puede especificarse también forzando mayúsculas (.toUpperCase()) ó minúsculas (.toLowerCase()). Ejemplo:
\n- \n
- Atributo channel en mayúsculas: ${shippinggroup.channel.toUpperCase()} \n
- Atributo channel en minúsculas: ${shippinggroup.channel.toLowerCase()} \n
Incremental Omnix SG ID
\nEste servicio retorna los parámetros configurados para la generación del incrementalOmnixSgId.
\n","urlObject":{"protocol":"https","path":["v3","order","all","shippinggroup","sequencer"],"host":["{{subdomain}}-oom","omnixsystem","com"],"query":[],"variable":[]}},"response":[{"id":"69eee458-d873-4b8f-9608-5687e8bc54b9","name":"Get Sequence Configuration","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"https://{{subdomain}}-oom.omnixsystem.com/v3/order/all/shippinggroup/sequencer"},"_postman_previewlanguage":"json","header":[{}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"prefix\": \"${shippinggroup.channel}\",\n \"prefixSeparator\": \"-\",\n \"suffix\": \"something\",\n \"suffixSeparator\": \"-\",\n \"length\": 12\n}"}],"_postman_id":"36f7f335-9e3d-4c3d-9250-34b14508608e"}],"id":"14017f1c-8278-4b41-8029-f6e24d866658","_postman_id":"14017f1c-8278-4b41-8029-f6e24d866658","description":""},{"name":"Schedule","item":[{"name":"Get Schedule","id":"3308fbf7-d5a9-484a-85d7-f7a894624910","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"shippingType\": \"HD\",\n \"shippingAddress\": {\n \"country\": \"Chile\",\n \"city\": \"SAN VICENTE\",\n \"address\": \"CALLE RIO CLARO 12\",\n \"location\": {\n \"commune\": \"SAN VICENTE\"\n },\n \"contact\": {\n \"name\": \"LILIAN HERRERA \",\n \"email\": \"ignacio.garcia@domain.cl\",\n \"phone\": \"878562761\"\n }\n },\n \"items\": [\n {\n \"sku\": \"001.002.1299\",\n \"name\": \"Simcard Trio\",\n \"quantity\": 1\n },\n {\n \t\"sku\": \"001.002.1346\",\n \t\"quantity\": 1\n },\n {\n \t\"sku\": \"001.008.1323\",\n \t\"quantity\": 1\n }\n ]\n}"},"url":"http://{{subdomain}}-oom.omnixsystem.com/v3/order/schedule/{{channel}}","description":"Servicio para obtener información de agendamiento.
\nPath Parameters
\n- \n
- channel (Requerido): (String) Canal de venta que está consultando agendamiento. \n
Request
\n- \n
- rescheduleFrom (Opcional): (String) Especifica un id de un shippinggroup sobre cual se calcularán nuevas fechas de agendamiento, este parámetro debe ser enviado si se desea calcular nuevas fechas para un shippinggroup ya existente y que además se tenga en cuenta el stock actual de la tienda asociada al shippinggroup. \n
- shippingType (Requerido): (String) Especifica el tipo de envío HD para despacho a domicilio y SP para retiro en tienda. \n
- storePickupId (Requerido si shippingType==\"SP\"): (String) Especifica el identificador del Source donde se hará el retiro en tienda. \n
- shippingAddress (Requerido si shippingType==\"HD\"): (JSON) Especifica la dirección de despacho del pedido, sus propiedades son:
- \n
- address (Requerido): (String) Dirección completa \n
- location (Requerido): (JSON[any]) Objeto de localización que es personalizado por cliente. \n
- city (Requerido): (String) Ciudad \n
- contact (Opcional): (JSON) Especifica los datos de contacto, sus propiedades son:
- \n
- name (Requerido): (String) Nombre de contacto \n
- email (Requerido): (String) Dirección de email \n
- phone (Opcional): (String) Número telefónico \n
\n
\n - items (Requerido): Representa los productos de la orden a agendar, sus propiedades son:
- \n
- sku (Requerido): (String) Código sku del producto. \n
- quantity (Requerido): (Number) Cantidad del producto en la orden. \n
\n
Custom error message
\n⚠️Nota⚠️: Estos mensajes de error son utilizados por el orquestador de consulta de agendamiento, las implementaciones de orquestación son personalizadas por cliente, no necesariamente se utilizarán todos los mensajes de error en el mismo flujo sino que se utilizarán a conveniencia.
\n","urlObject":{"protocol":"http","path":["v3","order","schedule","{{channel}}"],"host":["{{subdomain}}-oom","omnixsystem","com"],"query":[],"variable":[]}},"response":[{"id":"c28ef1fc-aa27-49b8-a7f8-02ba29eb9f77","name":"Get Schedule - Omnix v2","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"shippingType\": \"HD|SP\",\n \"storePickupId\": \"SOURCE0001\",\n \"shippingAddress\": {\n \"address\": \"Hamlet 4200\",\n \"location\": {\n \"bar\": \"foo\"\n },\n \"city\": \"Santiago\",\n \"contact\": {\n \"name\": \"Brenda Lopez\",\n \"email\": \"blopez@rfid.cl\",\n \"phone\": \"+57300929918\"\n }\n },\n \"items\": [\n {\n \"sku\": \"SKU001\",\n \"quantity\": 2\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://{{subdomain}}-oom.omnixsystem.com/v3/order/schedule/ecommerce"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"27c9d820-aef9-11e9-beda-85da6d3a40ce\",\n \"code\": 200,\n \"message\": {\n \"scheduling\": [\n {\n \"scheduleId\": \"1LCUMKSYLZTJYIW4QS2\",\n \"deliveryType\": \"SD\",\n \"dates\": [\n {\n \"estimatedShippingDate\": \"2019-07-30\",\n \"estimatedDeliveryDate\": \"2019-07-31\",\n \"couriers\": [\n \"TORRES\"\n ],\n \"estimatedCost\": 59.68,\n \"source\": \"NT06\",\n \"items\": [\n {\n \"sku\": \"ODI12\",\n \"quantity\": 1,\n \"cost\": 6.98\n },\n {\n \"sku\": \"HMM28PSX\",\n \"quantity\": 1,\n \"cost\": 52.7\n }\n ]\n },\n {\n \"estimatedShippingDate\": \"2019-07-31\",\n \"estimatedDeliveryDate\": \"2019-08-01\",\n \"couriers\": [\n \"TORRES\"\n ],\n \"estimatedCost\": 59.68,\n \"source\": \"NT06\",\n \"items\": [\n {\n \"sku\": \"ODI12\",\n \"quantity\": 1,\n \"cost\": 6.98\n },\n {\n \"sku\": \"HMM28PSX\",\n \"quantity\": 1,\n \"cost\": 52.7\n }\n ]\n },\n {\n \"estimatedShippingDate\": \"2019-08-01\",\n \"estimatedDeliveryDate\": \"2019-08-02\",\n \"couriers\": [\n \"TORRES\"\n ],\n \"estimatedCost\": 59.68,\n \"source\": \"NT06\",\n \"items\": [\n {\n \"sku\": \"ODI12\",\n \"quantity\": 1,\n \"cost\": 6.98\n },\n {\n \"sku\": \"HMM28PSX\",\n \"quantity\": 1,\n \"cost\": 52.7\n }\n ]\n },\n {\n \"estimatedShippingDate\": \"2019-08-02\",\n \"estimatedDeliveryDate\": \"2019-08-03\",\n \"couriers\": [\n \"TORRES\"\n ],\n \"estimatedCost\": 59.68,\n \"source\": \"NT06\",\n \"items\": [\n {\n \"sku\": \"ODI12\",\n \"quantity\": 1,\n \"cost\": 6.98\n },\n {\n \"sku\": \"HMM28PSX\",\n \"quantity\": 1,\n \"cost\": 52.7\n }\n ]\n },\n {\n \"estimatedShippingDate\": \"2019-08-03\",\n \"estimatedDeliveryDate\": \"2019-08-05\",\n \"couriers\": [\n \"TORRES\"\n ],\n \"estimatedCost\": 59.68,\n \"source\": \"NT06\",\n \"items\": [\n {\n \"sku\": \"ODI12\",\n \"quantity\": 1,\n \"cost\": 6.98\n },\n {\n \"sku\": \"HMM28PSX\",\n \"quantity\": 1,\n \"cost\": 52.7\n }\n ]\n },\n {\n \"estimatedShippingDate\": \"2019-08-05\",\n \"estimatedDeliveryDate\": \"2019-08-06\",\n \"couriers\": [\n \"TORRES\"\n ],\n \"estimatedCost\": 59.68,\n \"source\": \"NT06\",\n \"items\": [\n {\n \"sku\": \"ODI12\",\n \"quantity\": 1,\n \"cost\": 6.98\n },\n {\n \"sku\": \"HMM28PSX\",\n \"quantity\": 1,\n \"cost\": 52.7\n }\n ]\n },\n {\n \"estimatedShippingDate\": \"2019-08-06\",\n \"estimatedDeliveryDate\": \"2019-08-07\",\n \"couriers\": [\n \"TORRES\"\n ],\n \"estimatedCost\": 59.68,\n \"source\": \"NT06\",\n \"items\": [\n {\n \"sku\": \"ODI12\",\n \"quantity\": 1,\n \"cost\": 6.98\n },\n {\n \"sku\": \"HMM28PSX\",\n \"quantity\": 1,\n \"cost\": 52.7\n }\n ]\n }\n ]\n }\n ]\n }\n}"},{"id":"503074aa-3af9-4d05-88be-14f22706b2b1","name":"Get Schedule - Omnix v3","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"rescheduledFrom\": \"SGASJSJ0012898\",\n \"shippingType\": \"HD|SP\",\n \"storePickupId\": \"SOURCE0001\",\n \"shippingAddress\": {\n \"address\": \"Hamlet 4200\",\n \"location\": {\n \"bar\": \"foo\"\n },\n \"city\": \"Santiago\",\n \"contact\": {\n \"name\": \"Brenda Lopez\",\n \"email\": \"blopez@rfid.cl\",\n \"phone\": \"+57300929918\"\n }\n },\n \"items\": [\n {\n \"sku\": \"SKU001\",\n \"quantity\": 2\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://{{subdomain}}-oom.omnixsystem.com/v3/order/schedule/ecommerce"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"07b11572-1a2b-4276-acb2-b584d53342ab\",\n \"code\": 200,\n \"message\": {\n \"target\": {\n \"type\": \"Location\",\n \"data\": {\n \"criteria0\": \"056\",\n \"criteria1\": \"005\",\n \"criteria2\": \"056051\",\n \"criteria3\": \"05605109\"\n }\n },\n \"shippingType\": \"HD\",\n \"schedules\": [\n {\n \"deliveryType\": \"NORMAL\",\n \"sources\": [\n {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"DHCLCD150001\",\n \"name\": \"CD La Farfana\"\n },\n \"items\": [\n {\n \"sku\": \"2000000868080\",\n \"quantity\": 1,\n \"type\": \"MiniTicket\",\n \"volume\": 0.39,\n \"criterias\": [],\n \"cost\": 1\n }\n ],\n \"route\": [\n {\n \"source\": {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"DHCLCD150001\",\n \"name\": \"CD La Farfana\"\n }\n },\n \"target\": {\n \"type\": \"Location\",\n \"data\": {\n \"criteria1\": \"005\",\n \"criteria2\": \"056051\",\n \"criteria0\": \"056\",\n \"criteria3\": \"05605109\"\n }\n },\n \"courier\": {\n \"id\": \"NORMAL - INTERNO\",\n \"name\": \"INTERNO\",\n \"alias\": \"NORMAL - INTERNO\"\n },\n \"cost\": [\n {\n \"sku\": \"2000000868080\",\n \"cost\": 1\n }\n ]\n }\n ]\n }\n ],\n \"dates\": [\n {\n \"shipping\": \"2021-05-06T11:13:28.934\",\n \"delivery\": \"2021-05-08T07:00:28.934\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"07:00\",\n \"to\": \"23:00\",\n \"label\": \"standard\"\n }\n ]\n }\n }\n ],\n \"cost\": 1\n }\n ]\n }\n}"}],"_postman_id":"3308fbf7-d5a9-484a-85d7-f7a894624910"}],"id":"e1788d75-44d0-49e3-b2f2-68d54470e637","_postman_id":"e1788d75-44d0-49e3-b2f2-68d54470e637","description":""},{"name":"Media","item":[{"name":"Get Media","id":"e6365be7-4b56-40c5-8d31-265a21f6ec3b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"ids\": [\n \"ID0000001\",\n \"ID0000002\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://{{subdomain}}-oom.omnixsystem.com/v3/order/media","description":"Este servicio permite obtener un listado de archivos media por ids ó por tags. Si se envían ids buscará por ids, si se envían tags no se deben enviar ids porque siempre dará preferencia a los ids.
\n","urlObject":{"protocol":"https","path":["v3","order","media"],"host":["{{subdomain}}-oom","omnixsystem","com"],"query":[],"variable":[]}},"response":[{"id":"e064c3f2-0e91-429b-bbc8-23eb3fb27e72","name":"Get Media","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"ids\": [\n \"5e6d6d9f2e6862a673fbc442\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://{{subdomain}}-oom.omnixsystem.com/v3/order/media"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"Este servicio crea/modifica la configuración de skip para inventory, capacity, schedule y coverage.
\n","urlObject":{"protocol":"https","path":["v3","order","configuration"],"host":["{{subdomain}}-oom","omnixsystem","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"8826721d-7f6a-439b-8f75-41612f130789"},{"name":"Get Configuration","id":"82303f7d-63e7-4112-bc6e-da9d194d2c47","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"https://{{subdomain}}-oom.omnixsystem.com/v3/order/configuration","description":"Este servicio consulta la configuración de skip para inventory, capacity, schedule y coverage.
\n","urlObject":{"protocol":"https","path":["v3","order","configuration"],"host":["{{subdomain}}-oom","omnixsystem","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"82303f7d-63e7-4112-bc6e-da9d194d2c47"}],"id":"3d34ea63-3a89-485b-8850-93f6351ded6d","description":"Skip Configuration
\nOmnix soporta configurar flags para comunicarle a los sistemas internos y de integración que deben omitir algunos pasos en el proceso fulfillment o en las actions de orden y shipping group.
\nLos flags son:
\n- \n
- inventory
- \n
- skip (boolean): true|false define si el skip inventory está activo o no. \n
- channels (json array): Lista de objetos con información de los canales a los que se le aplica el flag de skip inventory.
- \n
- name (string): Nombre del canal. \n
- defaultSource (json): Objeto con las propiedades del source por defecto.
- \n
- id (string) \n
- name (string) \n
- type (string) - (Physical|Virtual) \n
- storePickup (boolean) \n
\n
\n
\n - capacity
- \n
- skip (boolean): true|false define si el skip capacity está activo o no. \n
\n - coverage
- \n
- skip (boolean): true|false define si el skip coverage está activo o no. \n
\n - schedule
- \n
- skip (boolean): true|false define si el skip schedule está activo o no. \n
- channels (string array): Lista de nombres de canales a aplicar el flag de skip schedule. \n
\n
Comportamiento
\n- \n
- Cuando el skip inventory está activado y el canal en la consulta de agenda o creación de orden coincide con algún canal configurado en channels, Omnix no valida el inventario de los productos al momento de consultar agenda o crear una orden, por lo tanto tampoco crea reservas en OIM ni descuenta inventario. \n
- Cuando el skip capacity está activado Omnix no hace consulta de capacidad en OLM y por lo tanto no reserva ni libera capacidad. \n
- Cuando el skip coverage está activado Omnix no consulta la cobertura en OLM entre el punto de dónde sale el pedido hasta su destino final. \n
- Cuando el skip schedule está activado Omnix no valida en OLM la disponibilidad de la fecha enviada al momento de crear la orden. \n
Las ordenes en Omnix tienen 2 actores principales, los cuales son:
\nOrder: Representa la orden a procesar que contiene la información sobre la transacción.\nShipping Group: Representa el movimiento interno que debe hacer el cliente de Omnix para cumplir con la orden, una orden puede tener muchos shipping groups.
\nOrden
\nEs la entidad que contiene la información general de la orden, punto de origen y punto destino, información de contacto del cliente, ruta y plan logístico que seguirá el o los ShippingGroup pertenecientes a la misma.
\nShippingGroups
\nSon entidades que contienen información acerca de las tiendas/productos que deben ser movidos de un punto A a un punto B para cumplir con la entrega de la orden, El punto A puede ser una origen con el stock deseado y el punto B puede ser desde una tienda hasta una dirección de usuario.
\nLos ShippingGroups manejan una relación entre acciones y estados dónde los estados son cambiados como consecuencia de una acción.
\nACCIONES/ESTADOS SG
\nEn la tabla anterior se puede observar que cada acción gatilla un estado en la SG, teniendo como estado inicial de toda SG asignada a una tienda el estado AWAITING_STORE_CONFIRMATION.
\n- \n
- accept: El SG ha sido aceptado por el source y está esperando por ser empacado \n
- packed: El SG ha sido empacado y está esperando por ser enviado \n
- shipped: El SG ha sido enviado y está ahora en tránsito a destino \n
- delivered: El SG se ha entregado, su siguiente estado depende de las siguientes condiciones: \n
- Si es una orden SP entonces su estado será [DELIVERED, READY_FOR_PICKUP] si el target es el destino final. \n
- Si es una orden HD y si el target es el destino final su estado será DELIVERED. \n
- Si el target es un punto de la ruta y no su destino final, su estado será [DELIVERED, AWAITING_DELIVERY].
- \n
- delivered_inc: El despacho fue entrega do de forma incompleta, los estados siguientes pueden ser: \n
\n - Si la orden es SP y el target es el destino final, entonces su estado será [DELIVERED_INCOMPLETE, READY_FOR_PICKUP] \n
- Si la orden es HD y el target es el destino final, entonces el estado será DELIVERED_INCOMPLETE \n
- Si la orden es HD y el target no es el destino final, entonces su estado será [DELIVERED_INCOMPLETE, AWAITING_DELIVERY]
- \n
- courier_reject: Si el courier falla en todos sus intentos de entrega puede ejecutar una acción de courier_reject para iniciar el retorno del pedido, el estado resultante sería un IN_RETURN_COURIER. \n
- customer_reject: Si el usuario rechaza el pedido por algún motivo, el courier puede ejecutar una acción de customer_reject para iniciar el retorno del pedido, el estado resultante sería un IN_RETURN. \n
- delivered_return: Esta acción se ejecuta cuando un pedido es devuelto y el source lo recibe satisfactoriamente \n
- prepared: Esta acción se ejecuta cuando un pedido ha sido preparado por la tienda y esta listo para ser recogido por el usuario. \n
- picked_up: Esta acción se espera cuando una SG de tipo SP es recogida por el usuario. \n
- reject: Esta acción se ejecuta cuando un source no puede despachar una SG. \n
- cancel: Esta acción se ejecuta en cualquier estado de la orden para cancelar un SG \n
- cancel_decrease: Esta acción se ejecuta cuando se desea cancelar un SG sin que el stock sea devuelto al inventario del source \n
- cancel_logistic: Funciona igual que el cancel pero esta acción la ejecuta el courier. \n
- reschedule: Esta acción se ejecuta cuando se desea cambiar la fecha de entrega asociada a la SG, esta fecha es obtenida por el servicio de agendamiento. \n
- pick: Esta acción realiza confirmaciones de productos de manera incremental. \n
- drop: Esta acción realiza confirmaciones de productos de manera decremental. \n
- confirm: Esta acción es en reemplazo de accept, su función es confirmar las acciones ejecutadas por pick y drop \n
\n
FLUJO DE ESTADOS DE ORDEN Y SHIPPINGGROUPS
\nFlujo de estados de orden y shippingGroups de tipo HD y SP\n![\"SGs\"](\"https://omnix-v3-res.s3.amazonaws.com/Omnix+Order+and+SG+Flow-Omnix+SG+Actions+-+Status.drawio.png\")
Flujo de estados de orden y shippingGroups de tipo RT\n![\"SGs\"](\"https://omnix-v3-res.s3.amazonaws.com/Omnix+Order+and+SG+Flow-RT+-+Omnix+SG+Actions+-+Status.drawio.png\")
Por su parte las órdenes manejan las siguiente Acciones/Estados.
\nACCIONES/ESTADOS ORDEN
\n- \n
- RESERVED: Cuando una orden es creada este es su estado inicial, mientras la orden está en este estado se puede actualizar su información incluyendo los items y sus cantidades, el cambio de items y cantidades solo es aceptado si hay stock para cumplir la orden. \n
- PENDING_PREPARATION: Cuando una orden es confirmada con la acción confirm, Omnix pasa a este siguiente estado, desde aquí en adelante no se puede modificar la información de la orden. \n
- IN_TRANSIT: Cuando todas las SGs de una orden pasan a estado IN_TRANSIT, la orden es pasada a este estado. \n
- IN_SOURCE_PREPARATION: Cuando el pedido de tipo SP ha sigo entregado en la tienda y queda en espera de ser dispuesto para retiro. Esta funcionalidad es opcional, se debe activar en configuración \n
- READY_FOR_PICKUP: Cuando la orden es de tipo SP y todos sus SGs están en estado READY_FOR_PICKUP la orden pasa a este estado. \n
- CLOSED: Una vez la orden es completada, el cliente que está integrado con Omnix debe realizar una acción de close para pasar la orden a este estado. \n
- CANCELED: Si el cliente que está integrado con Omnix realiza una acción de cancel entonces la orden pasará a este estado. \n
Shared Models
\nLa información a continuación describe los modelos y sus atributos públicos disponibles para consulta, modificación e inserción.
\nOrder
\nShipping Group
\nResponses and errors management
\n![\"Errors\"](\"https://omnix-v3-res.s3.amazonaws.com/Omnix+v3+-+Errors.png\")
En Omnix todos los endpoints entregarán code/message asociados a una operación de éxito ó a un error tales como están ilustrados en la imagen anterior, los responses son:
\n- \n
- Security error: Respuesta con error asociado a temas de seguridad tales como que la URL no está permitida ó el token no fue enviado. \n
{\n \"transactionId\": \"<UUID_V4>\",\n \"code\": 401,\n \"message\": \"UNAUTHORIZED\"\n}\n{\n \"transactionId\": \"<UUID_V4>\",\n \"code\": 403,\n \"message\": \"FORBIDDEN\"\n}\n- \n
- Request format error: Respuesta con error asociado a que el input no está formado como el endpoint lo espera. \n
{\n \"transactionId\": \"<UUID_V4>\",\n \"code\": 400,\n \"message\": \"<input error detailed here>\"\n}\n- \n
- Resource not found: Respuesta con error asociado a que el recurso que se quiere consultar ó actualizar no existe. \n
{\n \"transactionId\": \"<UUID_V4>\",\n \"code\": 404,\n \"message\": \"NOT_FOUND\"\n}\n- \n
- Omnix Crash: Respuesta con error asociado a que hubo un error no esperado en Omnix. \n
{\n \"transactionId\": \"<UUID_V4>\",\n \"code\": 500,\n \"message\": \"UNEXPECTED_ERROR\"\n}\nSe debe asumir que todos los endpoints responderan en caso de error con alguno de los mensajes descritos anteriormente y no van a ser especificados por cada endpoint ya que son globales.
\nResponses by endpoint
\nA diferencia de los responses definidos en la sección anterior, por cada endpoint definimos cuál sería la respuesta exitosa y cuál sería el custom message (code: 500) por cada endpoint en caso de existir un error puntual y clasificado en el endpoint, este error custom vendría en la forma:
\n- \n
- Custom endpoint error \n
{\n \"transactionId\": \"<UUID_V4>\",\n \"code\": 500,\n \"message\": \"<error message defined here>\"\n}\nY para el caso de mensage de éxito sería:
\n- \n
- Succeed: \n
{\n \"transactionId\": \"<UUID_V4>\",\n \"code\": 200,\n \"message\": \"OK\"\n}\n{\n \"transactionId\": \"<UUID_V4>\",\n \"code\": 200,\n \"message\": [ .... ]\n}\n{\n \"transactionId\": \"<UUID_V4>\",\n \"code\": 200,\n \"message\": { ... }\n}\nServicio para obtener conjunto de fechas para cada uno de los tipos de agendamiento soportados por los actores (sources, target, routes y couriers) involucrados en el proceso.\nSe puede consultar tanto por listado de sources (una combinacion, atributo sources en el input) o por varias combinaciones de sources (atributo combinations en el input).
\n\n\nSe hace referencia a source en el contexto de movimiento de inventario
\n
Mock Server
\nhttps://c6ec6c36-0750-406b-a4b0-52de03a0674e.mock.pstmn.io/v3/schedule/get
Request
\nResponse para escenarios con sources
\n{\n \"target\": {\n \"type\": \"Location\",\n \"data\": {\n \"criteria0\": \"Barranquilla\",\n \"criteria1\": \"Atlantico\",\n \"criteria2\": \"Betania\",\n \"criteria3\": \"\",\n \"criteria4\": \"\"\n }\n },\n \"shippingType\": \"HD\",\n \"schedules\": [\n {\n \"name\": \"estandar\",\n \"deliveryType\": \"SD\",\n \"sources\": [\n {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"CT15\",\n \"name\": \"Bodega\"\n },\n \"items\": [\n {\n \"sku\": \"ABC1\",\n \"quantity\": 2,\n \"type\": \"pequeño\",\n \"volume\": 20,\n \"availabilityDate\": \"YYYY-MM-DD,\n \"leadtime\": 8,\n \"criterias\": [\n \"pequeño\",\n \"sensible\"\n ],\n \"cost\": 0\n },\n {\n \"sku\": \"ABC2\",\n \"quantity\": 1,\n \"type\": \"sensible\",\n \"volume\": 20,\n \"availabilityDate\": \"YYYY-MM-DD\",\n \"leadtime\": 8,\n \"criterias\": [\n \"pequeño\",\n \"sensible\"\n ],\n \"cost\": 0\n }\n ],\n \"route\": [\n {\n \"source\": {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"CT15\",\n \"name\": \"Bodega\"\n }\n },\n \"target\": {\n \"type\": \"location\",\n \"data\": {\n \"criteria0\": \"Barranquilla\",\n \"criteria1\": \"Atlantico\",\n \"criteria2\": \"Betania\",\n \"criteria3\": \"\",\n \"criteria4\": \"\",\n \"coordinate\": [\n -10,\n 11\n ],\n \"address\": \"Calle 1234\"\n }\n },\n \"courier\": {\n \"id\": \"1234\",\n \"name\": \"1234\",\n \"alias\": \"1234\"\n },\n \"cost\": [\n {\n \"sku\": \"ABC1\",\n \"cost\": 0\n },\n {\n \"sku\": \"ABC2\",\n \"cost\": 0\n }\n ]\n }\n ]\n }\n ],\n \"dates\": [\n {\n \"shipping\": \"YYYY-MM-DDThh:MM:ss.mmm\",\n \"delivery\": \"YYYY-MM-DDThh:MM:ss.mmm\",\n \"custom\": {\n \"key\": \"value\"\n }\n },\n {\n \"shipping\": \"YYYY-MM-DDThh:MM:ss.mmm\",\n \"delivery\": \"YYYY-MM-DDThh:MM:ss.mmm\",\n \"custom\": {\n \"key\": \"value\"\n }\n },\n {\n \"shipping\": \"YYYY-MM-DD\",\n \"delivery\": \"YYYY-MM-DD\",\n \"custom\": {\n \"key\": \"value\"\n }\n }\n ],\n \"cost\": 0\n },\n {\n \"name\": \"express\",\n \"deliveryType\": \"ED\",\n \"sources\": [\n {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"CT15\",\n \"name\": \"Bodega\"\n },\n \"items\": [\n {\n \"sku\": \"ABC1\",\n \"quantity\": 2,\n \"type\": \"pequeño\",\n \"volume\": 20,\n \"availabilityDate\": \"YYYY-MM-DD\",\n \"cost\": 0,\n \"price\": 0\n },\n {\n \"sku\": \"ABC2\",\n \"quantity\": 1,\n \"type\": \"sensible\",\n \"volume\": 20,\n \"availabilityDate\": \"YYYY-MM-DD\",\n \"cost\": 0,\n \"price\": 0\n }\n ],\n \"route\": [\n {\n \"source\": {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"CT15\",\n \"name\": \"Bodega\"\n }\n },\n \"target\": {\n \"type\": \"location\",\n \"data\": {\n \"city\": \"Barranquilla\",\n \"state\": \"Atlantico\",\n \"district\": \"Betania\",\n \"coordinate\": [\n -10,\n 11\n ],\n \"address\": \"Calle 1234\"\n }\n },\n \"courier\": {\n \"id\": \"1234\",\n \"name\": \"1234\",\n \"alias\": \"1234\"\n },\n \"cost\": [\n {\n \"sku\": \"ABC1\",\n \"cost\": 0\n },\n {\n \"sku\": \"ABC2\",\n \"cost\": 0\n }\n ]\n }\n ]\n }\n ],\n \"dates\": [\n {\n \"shipping\": \"YYYY-MM-DDThh:MM:ss.mmm\",\n \"delivery\": \"YYYY-MM-DDThh:MM:ss.mmm\",\n \"custom\": {\n \"key\": \"value\"\n }\n },\n {\n \"shipping\": \"YYYY-MM-DDThh:MM:ss.mmm\",\n \"delivery\": \"YYYY-MM-DDThh:MM:ss.mmm\",\n \"custom\": {\n \"key\": \"value\"\n }\n },\n {\n \"shipping\": \"YYYY-MM-DDThh:MM:ss.mmm\",\n \"delivery\": \"YYYY-MM-DDThh:MM:ss.mmm\",\n \"custom\": {\n \"key\": \"value\"\n }\n }\n ],\n \"cost\": 0\n }\n ]\n}\nResponse para escenarios con combinations
\n{\n \"target\": {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE40\",\n \"name\": \"SOURCE40\"\n }\n },\n \"shippingType\": \"SP\",\n \"combinations\": [\n [\n {\n \"deliveryType\": \"meet\",\n \"sources\": [\n {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE20\",\n \"name\": \"SOURCE20\"\n },\n \"items\": [\n {\n \"sku\": \"ABC1\",\n \"quantity\": 1,\n \"type\": \"productType2\",\n \"volume\": 5,\n \"leadtime\": 8,\n \"cost\": 0\n },\n {\n \"sku\": \"ABC2\",\n \"quantity\": 1,\n \"type\": \"productType2\",\n \"volume\": 5,\n \"leadtime\": 16,\n \"cost\": 0\n }\n ],\n \"route\": [\n {\n \"source\": {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE20\",\n \"name\": \"SOURCE20\"\n }\n },\n \"target\": {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE40\",\n \"name\": \"SOURCE40\"\n }\n },\n \"courier\": {\n \"id\": \"OERKNYHIKJLWQ1F1\",\n \"name\": \"Courier20\",\n \"alias\": \"Courier20\"\n },\n \"cost\": [\n {\n \"sku\": \"ABC1\",\n \"cost\": 0\n },\n {\n \"sku\": \"ABC2\",\n \"cost\": 0\n }\n ]\n }\n ]\n }\n ],\n \"dates\": [\n {\n \"shipping\": \"2021-01-27T09:00:00.000\",\n \"delivery\": \"2021-01-28T10:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"10:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"17:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-01-28T09:00:00.000\",\n \"delivery\": \"2021-02-01T10:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"10:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"17:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-01-29T09:00:00.000\",\n \"delivery\": \"2021-02-01T10:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"10:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"17:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-01-30T09:00:00.000\",\n \"delivery\": \"2021-02-01T10:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"10:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"17:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-02-01T09:00:00.000\",\n \"delivery\": \"2021-02-02T10:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"10:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"17:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-02-02T09:00:00.000\",\n \"delivery\": \"2021-02-03T10:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"10:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"17:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-02-03T09:00:00.000\",\n \"delivery\": \"2021-02-04T10:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"10:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"17:00\",\n \"label\": \"PM\"\n }\n ]\n }\n }\n ],\n \"cost\": 0\n }\n ],\n [\n {\n \"deliveryType\": \"meet\",\n \"sources\": [\n {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE10\",\n \"name\": \"SOURCE10\"\n },\n \"items\": [\n {\n \"sku\": \"ABC1\",\n \"quantity\": 1,\n \"type\": \"productType2\",\n \"volume\": 5,\n \"leadtime\": 8,\n \"cost\": 0\n },\n {\n \"sku\": \"ABC2\",\n \"quantity\": 1,\n \"type\": \"productType2\",\n \"volume\": 5,\n \"leadtime\": 16,\n \"cost\": 0\n }\n ],\n \"route\": [\n {\n \"source\": {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE10\",\n \"name\": \"SOURCE10\"\n }\n },\n \"target\": {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE30\",\n \"name\": \"SOURCE30\"\n }\n },\n \"courier\": {\n \"id\": \"OERKNYHIKJLWPVR7\",\n \"name\": \"Courier10\",\n \"alias\": \"Courier10\"\n },\n \"cost\": [\n {\n \"sku\": \"ABC1\",\n \"cost\": 0\n },\n {\n \"sku\": \"ABC2\",\n \"cost\": 0\n }\n ]\n },\n {\n \"source\": {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE30\",\n \"name\": \"SOURCE30\"\n }\n },\n \"target\": {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE40\",\n \"name\": \"SOURCE40\"\n }\n },\n \"courier\": {\n \"id\": \"OERKNYHIKJLWQ6BU\",\n \"name\": \"Courier30\",\n \"alias\": \"Courier30\"\n },\n \"cost\": [\n {\n \"sku\": \"ABC1\",\n \"cost\": 0\n },\n {\n \"sku\": \"ABC2\",\n \"cost\": 0\n }\n ]\n }\n ]\n }\n ],\n \"dates\": [\n {\n \"shipping\": \"2021-01-27T09:00:00.000\",\n \"delivery\": \"2021-02-01T11:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"11:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"17:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-01-28T09:00:00.000\",\n \"delivery\": \"2021-02-03T11:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"11:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"17:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-01-29T09:00:00.000\",\n \"delivery\": \"2021-02-03T11:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"11:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"17:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-01-30T09:00:00.000\",\n \"delivery\": \"2021-02-03T11:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"11:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"17:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-02-01T09:00:00.000\",\n \"delivery\": \"2021-02-03T11:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"11:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"17:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-02-02T09:00:00.000\",\n \"delivery\": \"2021-02-03T11:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"11:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"17:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-02-03T09:00:00.000\",\n \"delivery\": \"2021-02-08T11:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"11:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"17:00\",\n \"label\": \"PM\"\n }\n ]\n }\n }\n ],\n \"cost\": 0\n }\n ]\n ]\n}\nCustom error message
\n","urlObject":{"protocol":"https","path":["v3","schedule","get"],"host":["subdomain-olm","omnixsystem","com"],"query":[],"variable":[]}},"response":[{"id":"3faad948-4d98-4279-98af-fb38f27a02aa","name":"Get Schedule with skipCapacity","originalRequest":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Bearer {{token}}"}],"body":{"mode":"raw","raw":"{\n \"shippingType\": \"SP\",\n \"skipCapacity\": true,\n \"target\": {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE40\",\n \"alias\": \"SOURCE40\"\n }\n },\n \"sources\": [\n {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE10\",\n \"alias\": \"SOURCE10\"\n },\n \"items\": [\n {\n \"sku\": \"ABC1\",\n \"quantity\": 2,\n \"type\": \"productType1\",\n \"volume\": 20,\n \"leadtime\": 8\n },\n {\n \"sku\": \"ABC2\",\n \"quantity\": 1,\n \"type\": \"productType2\",\n \"volume\": 20,\n \"leadtime\": 16\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://subdomain-olm.omnixsystem.com/v3/schedule/get"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"b5b01058-965f-4398-9136-087635f38eb1\",\n \"code\": 200,\n \"message\": {\n \"target\": {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE40\",\n \"name\": \"SOURCE40\"\n }\n },\n \"shippingType\": \"SP\",\n \"schedules\": [\n {\n \"deliveryType\": \"meet\",\n \"sources\": [\n {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE10\",\n \"name\": \"SOURCE10\"\n },\n \"items\": [\n {\n \"sku\": \"ABC1\",\n \"quantity\": 2,\n \"type\": \"productType1\",\n \"volume\": 20,\n \"leadtime\": 8,\n \"cost\": 0\n },\n {\n \"sku\": \"ABC2\",\n \"quantity\": 1,\n \"type\": \"productType2\",\n \"volume\": 20,\n \"leadtime\": 16,\n \"cost\": 0\n }\n ],\n \"route\": [\n {\n \"source\": {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE10\",\n \"name\": \"SOURCE10\"\n }\n },\n \"target\": {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE30\",\n \"name\": \"SOURCE30\"\n }\n },\n \"courier\": {\n \"id\": \"OERKNYHIKJLWPVR7\",\n \"name\": \"Courier10\",\n \"alias\": \"Courier10\"\n },\n \"cost\": [\n {\n \"sku\": \"ABC1\",\n \"cost\": 0\n },\n {\n \"sku\": \"ABC2\",\n \"cost\": 0\n }\n ]\n },\n {\n \"source\": {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE30\",\n \"name\": \"SOURCE30\"\n }\n },\n \"target\": {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE40\",\n \"name\": \"SOURCE40\"\n }\n },\n \"courier\": {\n \"id\": \"OERKNYHIKJLWQ6BU\",\n \"name\": \"Courier30\",\n \"alias\": \"Courier30\"\n },\n \"cost\": [\n {\n \"sku\": \"ABC1\",\n \"cost\": 0\n },\n {\n \"sku\": \"ABC2\",\n \"cost\": 0\n }\n ]\n }\n ]\n }\n ],\n \"dates\": [\n {\n \"shipping\": \"2021-01-27T09:00:00.000\",\n \"delivery\": \"2021-02-01T11:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"11:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"17:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-01-28T09:00:00.000\",\n \"delivery\": \"2021-02-03T11:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"11:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"17:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-01-29T09:00:00.000\",\n \"delivery\": \"2021-02-03T11:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"11:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"17:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-01-30T09:00:00.000\",\n \"delivery\": \"2021-02-03T11:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"11:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"17:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-02-01T09:00:00.000\",\n \"delivery\": \"2021-02-03T11:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"11:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"17:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-02-02T09:00:00.000\",\n \"delivery\": \"2021-02-03T11:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"11:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"17:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-02-03T09:00:00.000\",\n \"delivery\": \"2021-02-08T11:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"11:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"17:00\",\n \"label\": \"PM\"\n }\n ]\n }\n }\n ],\n \"cost\": 0\n }\n ]\n }\n}"},{"id":"e8130883-ab0c-4dc7-85c4-7b7c173c073f","name":"Get Schedule HD Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"shippingType\": \"HD\",\n \"target\": {\n \"type\": \"location\",\n \"data\": {\n \"criteria0\": \"Barranquilla\",\n \"criteria1\": \"Atlantico\",\n \"criteria2\": \"Betania\",\n \"criteria3\": \"\",\n \"criteria4\": \"\",\n \"coordinate\": [\n -10,\n 11\n ],\n \"address\": \"Calle 1234\"\n }\n },\n \"channel\": \"channel1\",\n \"sources\": [\n {\n \"type\": \"source\",\n \"data\": {\n \"id\": \"CT15\",\n \"alias\": \"ES15\",\n \"name\": \"Bodega\"\n },\n \"items\": [\n {\n \"sku\": \"ABC1\",\n \"quantity\": 2,\n \"type\": \"pequeño\",\n \"volume\": 20,\n \"leadtime\": 8,\n \"criterias\": [\n \"pequeño\",\n \"sensible\"\n ],\n \"availabilityDate\": \"YYYY-MM-DD\"\n },\n {\n \"sku\": \"ABC2\",\n \"quantity\": 1,\n \"type\": \"sensible\",\n \"volume\": 20,\n \"leadtime\": 8,\n \"criterias\": [\n \"pequeño\",\n \"sensible\"\n ],\n \"availabilityDate\": \"YYYY-MM-DD\"\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://subdomain-olm.omnixsystem.com/v3/schedule/get"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"326f89d0-5862-11e8-92a0-fb2a57096715\",\n \"code\": 200,\n \"message\": {\n \"target\": {\n \"type\": \"Location\",\n \"data\": {\n \"criteria0\": \"Barranquilla\",\n \"criteria1\": \"Atlantico\",\n \"criteria2\": \"Betania\",\n \"criteria3\": \"\",\n \"criteria4\": \"\",\n \"coordinate\": [\n -10,\n 11\n ],\n \"address\": \"Calle 1234\"\n }\n },\n \"shippingType\": \"HD\",\n \"schedules\": [\n {\n \"name\": \"estandar\",\n \"deliveryType\": \"SD\",\n \"sources\": [\n {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"CT15\",\n \"name\": \"Bodega\"\n },\n \"items\": [\n {\n \"sku\": \"ABC1\",\n \"quantity\": 2,\n \"type\": \"pequeño\",\n \"volume\": 20,\n \"availabilityDate\": \"YYYY-MM-DD\",\n \"leadtime\": 8,\n \"criterias\": [\n \"pequeño\",\n \"sensible\"\n ],\n \"cost\": 0\n },\n {\n \"sku\": \"ABC2\",\n \"quantity\": 1,\n \"type\": \"sensible\",\n \"volume\": 20,\n \"availabilityDate\": \"YYYY-MM-DD\",\n \"leadtime\": 8,\n \"criterias\": [\n \"pequeño\",\n \"sensible\"\n ],\n \"cost\": 0\n }\n ],\n \"route\": [\n {\n \"source\": {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"CT15\",\n \"name\": \"Bodega\"\n }\n },\n \"target\": {\n \"type\": \"location\",\n \"data\": {\n \"criteria0\": \"Barranquilla\",\n \"criteria1\": \"Atlantico\",\n \"criteria2\": \"Betania\",\n \"criteria3\": \"\",\n \"criteria4\": \"\",\n \"coordinate\": [\n -10,\n 11\n ],\n \"address\": \"Calle 1234\"\n }\n },\n \"courier\": {\n \"id\": \"1234\",\n \"name\": \"1234\",\n \"alias\": \"1234\"\n },\n \"cost\": [\n {\n \"sku\": \"ABC1\",\n \"cost\": 0\n },\n {\n \"sku\": \"ABC2\",\n \"cost\": 0\n }\n ]\n }\n ]\n }\n ],\n \"dates\": [\n {\n \"shipping\": \"YYYY-MM-DD\",\n \"delivery\": \"YYYY-MM-DD\",\n \"custom\": {\n \"key\": \"value\"\n }\n },\n {\n \"shipping\": \"YYYY-MM-DD\",\n \"delivery\": \"YYYY-MM-DD\",\n \"custom\": {\n \"key\": \"value\"\n }\n },\n {\n \"shipping\": \"YYYY-MM-DD\",\n \"delivery\": \"YYYY-MM-DD\",\n \"custom\": {\n \"key\": \"value\"\n }\n }\n ],\n \"cost\": 0\n },\n {\n \"name\": \"express\",\n \"deliveryType\": \"ED\",\n \"sources\": [\n {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"CT15\",\n \"name\": \"Bodega\"\n },\n \"items\": [\n {\n \"sku\": \"ABC1\",\n \"quantity\": 2,\n \"type\": \"pequeño\",\n \"volume\": 20,\n \"availabilityDate\": \"YYYY-MM-DD\",\n \"cost\": 0,\n \"price\": 0\n },\n {\n \"sku\": \"ABC2\",\n \"quantity\": 1,\n \"type\": \"sensible\",\n \"volume\": 20,\n \"availabilityDate\": \"YYYY-MM-DD\",\n \"cost\": 0,\n \"price\": 0\n }\n ],\n \"route\": [\n {\n \"source\": {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"CT15\",\n \"name\": \"Bodega\"\n }\n },\n \"target\": {\n \"type\": \"location\",\n \"data\": {\n \"city\": \"Barranquilla\",\n \"state\": \"Atlantico\",\n \"district\": \"Betania\",\n \"coordinate\": [\n -10,\n 11\n ],\n \"address\": \"Calle 1234\"\n }\n },\n \"courier\": {\n \"id\": \"1234\",\n \"name\": \"1234\",\n \"alias\": \"1234\"\n },\n \"cost\": [\n {\n \"sku\": \"ABC1\",\n \"cost\": 0\n },\n {\n \"sku\": \"ABC2\",\n \"cost\": 0\n }\n ]\n }\n ]\n }\n ],\n \"dates\": [\n {\n \"shipping\": \"YYYY-MM-DD\",\n \"delivery\": \"YYYY-MM-DD\",\n \"custom\": {\n \"key\": \"value\"\n }\n },\n {\n \"shipping\": \"YYYY-MM-DD\",\n \"delivery\": \"YYYY-MM-DD\",\n \"custom\": {\n \"key\": \"value\"\n }\n },\n {\n \"shipping\": \"YYYY-MM-DD\",\n \"delivery\": \"YYYY-MM-DD\",\n \"custom\": {\n \"key\": \"value\"\n }\n }\n ],\n \"cost\": 0\n }\n ]\n }\n}"},{"id":"73a811a7-67ca-470d-8a5d-e2261364159b","name":"Get Schedule - source to same source","originalRequest":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Bearer {{token}}"}],"body":{"mode":"raw","raw":"{\n \"shippingType\": \"SP\",\n \"baseDate\": \"2021-01-25\",\n \"target\": {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE10\",\n \"alias\": \"SOURCE10\"\n }\n },\n \"sources\": [\n {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE10\",\n \"alias\": \"SOURCE10\"\n },\n \"items\": [\n {\n \"sku\": \"ABC1\",\n \"quantity\": 2,\n \"type\": \"productType1\",\n \"volume\": 20,\n \"leadtime\": 8\n },\n {\n \"sku\": \"ABC2\",\n \"quantity\": 1,\n \"type\": \"productType2\",\n \"volume\": 20,\n \"leadtime\": 16\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://subdomain-olm.omnixsystem.com/v3/schedule/get"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"bd86ed2e-5df0-45ff-9534-857c9f5c82bb\",\n \"code\": 200,\n \"message\": {\n \"target\": {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE10\",\n \"name\": \"SOURCE10\"\n }\n },\n \"shippingType\": \"SP\",\n \"schedules\": [\n {\n \"deliveryType\": \"prueba2\",\n \"sources\": [\n {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE10\",\n \"name\": \"SOURCE10\"\n },\n \"items\": [\n {\n \"sku\": \"ABC1\",\n \"quantity\": 2,\n \"type\": \"productType1\",\n \"volume\": 20,\n \"leadtime\": 8,\n \"cost\": 0\n },\n {\n \"sku\": \"ABC2\",\n \"quantity\": 1,\n \"type\": \"productType2\",\n \"volume\": 20,\n \"leadtime\": 16,\n \"cost\": 0\n }\n ],\n \"route\": []\n }\n ],\n \"dates\": [\n {\n \"shipping\": \"2021-01-27T09:00:00.000\",\n \"delivery\": \"2021-01-27T09:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"09:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"16:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-01-28T09:00:00.000\",\n \"delivery\": \"2021-01-28T09:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"09:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"16:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-01-29T09:00:00.000\",\n \"delivery\": \"2021-01-29T09:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"09:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"16:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-01-30T09:00:00.000\",\n \"delivery\": \"2021-01-30T09:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"09:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"16:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-02-01T09:00:00.000\",\n \"delivery\": \"2021-02-01T09:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"09:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"16:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-02-02T09:00:00.000\",\n \"delivery\": \"2021-02-02T09:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"09:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"16:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-02-03T09:00:00.000\",\n \"delivery\": \"2021-02-03T09:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"09:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"16:00\",\n \"label\": \"PM\"\n }\n ]\n }\n }\n ],\n \"cost\": 0\n },\n {\n \"deliveryType\": \"prueba3\",\n \"sources\": [\n {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE10\",\n \"name\": \"SOURCE10\"\n },\n \"items\": [\n {\n \"sku\": \"ABC1\",\n \"quantity\": 2,\n \"type\": \"productType1\",\n \"volume\": 20,\n \"leadtime\": 8,\n \"cost\": 0\n },\n {\n \"sku\": \"ABC2\",\n \"quantity\": 1,\n \"type\": \"productType2\",\n \"volume\": 20,\n \"leadtime\": 16,\n \"cost\": 0\n }\n ],\n \"route\": []\n }\n ],\n \"dates\": [\n {\n \"shipping\": \"2021-01-27T09:00:00.000\",\n \"delivery\": \"2021-01-27T09:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"09:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"16:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-01-28T09:00:00.000\",\n \"delivery\": \"2021-01-28T09:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"09:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"16:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-01-29T09:00:00.000\",\n \"delivery\": \"2021-01-29T09:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"09:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"16:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-01-30T09:00:00.000\",\n \"delivery\": \"2021-01-30T09:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"09:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"16:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-02-01T09:00:00.000\",\n \"delivery\": \"2021-02-01T09:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"09:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"16:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-02-02T09:00:00.000\",\n \"delivery\": \"2021-02-02T09:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"09:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"16:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-02-03T09:00:00.000\",\n \"delivery\": \"2021-02-03T09:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"09:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"16:00\",\n \"label\": \"PM\"\n }\n ]\n }\n }\n ],\n \"cost\": 0\n },\n {\n \"deliveryType\": \"meet\",\n \"sources\": [\n {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE10\",\n \"name\": \"SOURCE10\"\n },\n \"items\": [\n {\n \"sku\": \"ABC1\",\n \"quantity\": 2,\n \"type\": \"productType1\",\n \"volume\": 20,\n \"leadtime\": 8,\n \"cost\": 0\n },\n {\n \"sku\": \"ABC2\",\n \"quantity\": 1,\n \"type\": \"productType2\",\n \"volume\": 20,\n \"leadtime\": 16,\n \"cost\": 0\n }\n ],\n \"route\": []\n }\n ],\n \"dates\": [\n {\n \"shipping\": \"2021-01-27T09:00:00.000\",\n \"delivery\": \"2021-01-27T09:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"09:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"17:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-01-28T09:00:00.000\",\n \"delivery\": \"2021-01-28T09:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"09:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"17:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-01-29T09:00:00.000\",\n \"delivery\": \"2021-01-29T09:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"09:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"17:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-01-30T09:00:00.000\",\n \"delivery\": \"2021-01-30T09:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"09:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"17:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-02-01T09:00:00.000\",\n \"delivery\": \"2021-02-01T09:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"09:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"17:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-02-02T09:00:00.000\",\n \"delivery\": \"2021-02-02T09:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"09:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"17:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-02-03T09:00:00.000\",\n \"delivery\": \"2021-02-03T09:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"09:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"17:00\",\n \"label\": \"PM\"\n }\n ]\n }\n }\n ],\n \"cost\": 0\n }\n ]\n }\n}"},{"id":"dffe9aa1-93be-45c4-ad12-6e9a8ee69a9d","name":"Get Schedule - Source to Location","originalRequest":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Bearer {{token}}"}],"body":{"mode":"raw","raw":"{\n \"shippingType\": \"HD\",\n \"baseDate\": \"2021-01-25\",\n \"target\": {\n \"type\": \"Location\",\n \"data\": {\n \"criteria0\": \"lcriteria1\",\n \"criteria1\": \"lcriteria2\",\n \"criteria2\": \"lcriteria3\"\n }\n },\n \"sources\": [\n {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE40\",\n \"alias\": \"SOURCE40\"\n },\n \"items\": [\n {\n \"sku\": \"ABC1\",\n \"quantity\": 2,\n \"type\": \"productType1\",\n \"volume\": 5,\n \"leadtime\": 8\n },\n {\n \"sku\": \"ABC2\",\n \"quantity\": 1,\n \"type\": \"productType2\",\n \"volume\": 5,\n \"leadtime\": 16\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://subdomain-olm.omnixsystem.com/v3/schedule/get"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"d0df9e97-c894-4b77-b9e7-7025c9ee1b1e\",\n \"code\": 200,\n \"message\": {\n \"target\": {\n \"type\": \"Location\",\n \"data\": {\n \"criteria0\": \"LCRITERIA1\",\n \"criteria1\": \"LCRITERIA2\",\n \"criteria2\": \"LCRITERIA3\"\n }\n },\n \"shippingType\": \"HD\",\n \"schedules\": [\n {\n \"deliveryType\": \"meet\",\n \"sources\": [\n {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE40\",\n \"name\": \"SOURCE40\"\n },\n \"items\": [\n {\n \"sku\": \"ABC1\",\n \"quantity\": 2,\n \"type\": \"productType1\",\n \"volume\": 5,\n \"leadtime\": 8,\n \"cost\": 0\n },\n {\n \"sku\": \"ABC2\",\n \"quantity\": 1,\n \"type\": \"productType2\",\n \"volume\": 5,\n \"leadtime\": 16,\n \"cost\": 0\n }\n ],\n \"route\": [\n {\n \"source\": {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE40\",\n \"name\": \"SOURCE40\"\n }\n },\n \"target\": {\n \"type\": \"Location\",\n \"data\": {\n \"criteria1\": \"LCRITERIA2\",\n \"criteria2\": \"LCRITERIA3\",\n \"criteria0\": \"LCRITERIA1\"\n }\n },\n \"courier\": {\n \"id\": \"OERKNYHIKJLWQA8S\",\n \"name\": \"Courier40\",\n \"alias\": \"Courier40\"\n },\n \"cost\": [\n {\n \"sku\": \"ABC1\",\n \"cost\": 0\n },\n {\n \"sku\": \"ABC2\",\n \"cost\": 0\n }\n ]\n }\n ]\n }\n ],\n \"dates\": [\n {\n \"shipping\": \"2021-01-28T08:00:00.000\",\n \"delivery\": \"2021-02-01T08:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"08:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"16:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-01-29T08:00:00.000\",\n \"delivery\": \"2021-02-01T08:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"08:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"16:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-01-30T08:00:00.000\",\n \"delivery\": \"2021-02-01T08:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"08:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"16:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-02-01T08:00:00.000\",\n \"delivery\": \"2021-02-02T08:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"08:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"16:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-02-02T08:00:00.000\",\n \"delivery\": \"2021-02-03T08:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"08:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"16:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-02-03T08:00:00.000\",\n \"delivery\": \"2021-02-04T08:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"08:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"16:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-02-04T08:00:00.000\",\n \"delivery\": \"2021-02-08T08:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"08:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"16:00\",\n \"label\": \"PM\"\n }\n ]\n }\n }\n ],\n \"cost\": 0\n }\n ]\n }\n}"},{"id":"6ee98b84-038b-4d92-bd44-32c5e84719d8","name":"Get Schedule - Source to Source","originalRequest":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Bearer {{token}}"}],"body":{"mode":"raw","raw":"{\n \"shippingType\": \"SP\",\n \"baseDate\": \"2021-01-25\",\n \"target\": {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE40\",\n \"alias\": \"SOURCE40\"\n }\n },\n \"sources\": [\n {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE10\",\n \"alias\": \"SOURCE10\"\n },\n \"items\": [\n {\n \"sku\": \"ABC1\",\n \"quantity\": 2,\n \"type\": \"productType1\",\n \"volume\": 20,\n \"leadtime\": 8\n },\n {\n \"sku\": \"ABC2\",\n \"quantity\": 1,\n \"type\": \"productType2\",\n \"volume\": 20,\n \"leadtime\": 16\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://subdomain-olm.omnixsystem.com/v3/schedule/get"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"b5b01058-965f-4398-9136-087635f38eb1\",\n \"code\": 200,\n \"message\": {\n \"target\": {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE40\",\n \"name\": \"SOURCE40\"\n }\n },\n \"shippingType\": \"SP\",\n \"schedules\": [\n {\n \"deliveryType\": \"meet\",\n \"sources\": [\n {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE10\",\n \"name\": \"SOURCE10\"\n },\n \"items\": [\n {\n \"sku\": \"ABC1\",\n \"quantity\": 2,\n \"type\": \"productType1\",\n \"volume\": 20,\n \"leadtime\": 8,\n \"cost\": 0\n },\n {\n \"sku\": \"ABC2\",\n \"quantity\": 1,\n \"type\": \"productType2\",\n \"volume\": 20,\n \"leadtime\": 16,\n \"cost\": 0\n }\n ],\n \"route\": [\n {\n \"source\": {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE10\",\n \"name\": \"SOURCE10\"\n }\n },\n \"target\": {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE30\",\n \"name\": \"SOURCE30\"\n }\n },\n \"courier\": {\n \"id\": \"OERKNYHIKJLWPVR7\",\n \"name\": \"Courier10\",\n \"alias\": \"Courier10\"\n },\n \"cost\": [\n {\n \"sku\": \"ABC1\",\n \"cost\": 0\n },\n {\n \"sku\": \"ABC2\",\n \"cost\": 0\n }\n ]\n },\n {\n \"source\": {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE30\",\n \"name\": \"SOURCE30\"\n }\n },\n \"target\": {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE40\",\n \"name\": \"SOURCE40\"\n }\n },\n \"courier\": {\n \"id\": \"OERKNYHIKJLWQ6BU\",\n \"name\": \"Courier30\",\n \"alias\": \"Courier30\"\n },\n \"cost\": [\n {\n \"sku\": \"ABC1\",\n \"cost\": 0\n },\n {\n \"sku\": \"ABC2\",\n \"cost\": 0\n }\n ]\n }\n ]\n }\n ],\n \"dates\": [\n {\n \"shipping\": \"2021-01-27T09:00:00.000\",\n \"delivery\": \"2021-02-01T11:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"11:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"17:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-01-28T09:00:00.000\",\n \"delivery\": \"2021-02-03T11:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"11:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"17:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-01-29T09:00:00.000\",\n \"delivery\": \"2021-02-03T11:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"11:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"17:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-01-30T09:00:00.000\",\n \"delivery\": \"2021-02-03T11:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"11:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"17:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-02-01T09:00:00.000\",\n \"delivery\": \"2021-02-03T11:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"11:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"17:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-02-02T09:00:00.000\",\n \"delivery\": \"2021-02-03T11:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"11:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"17:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-02-03T09:00:00.000\",\n \"delivery\": \"2021-02-08T11:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"11:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"17:00\",\n \"label\": \"PM\"\n }\n ]\n }\n }\n ],\n \"cost\": 0\n }\n ]\n }\n}"},{"id":"bd6f7d3a-8bf6-494e-80d8-d7d69074f7ea","name":"Get Schedule - Multiple source to source","originalRequest":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Bearer {{token}}"}],"body":{"mode":"raw","raw":"{\n \"shippingType\": \"SP\",\n \"baseDate\": \"2021-01-25\",\n \"target\": {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE40\",\n \"alias\": \"SOURCE40\"\n }\n },\n \"sources\": [\n {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE10\",\n \"alias\": \"SOURCE10\"\n },\n \"items\": [\n {\n \"sku\": \"ABC1\",\n \"quantity\": 2,\n \"type\": \"productType1\",\n \"volume\": 20,\n \"leadtime\": 8\n }\n ]\n },\n {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE10\",\n \"alias\": \"SOURCE10\"\n },\n \"items\": [\n {\n \"sku\": \"ABC2\",\n \"quantity\": 1,\n \"type\": \"productType2\",\n \"volume\": 20,\n \"leadtime\": 16\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://subdomain-olm.omnixsystem.com/v3/schedule/get"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"539ddea4-b7ea-4089-911b-80afd37d9b45\",\n \"code\": 200,\n \"message\": {\n \"target\": {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE40\",\n \"name\": \"SOURCE40\"\n }\n },\n \"shippingType\": \"SP\",\n \"schedules\": [\n {\n \"deliveryType\": \"meet\",\n \"sources\": [\n {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE10\",\n \"name\": \"SOURCE10\"\n },\n \"items\": [\n {\n \"sku\": \"ABC1\",\n \"quantity\": 2,\n \"type\": \"productType1\",\n \"volume\": 20,\n \"leadtime\": 8,\n \"cost\": 0\n }\n ],\n \"route\": [\n {\n \"source\": {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE10\",\n \"name\": \"SOURCE10\"\n }\n },\n \"target\": {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE30\",\n \"name\": \"SOURCE30\"\n }\n },\n \"courier\": {\n \"id\": \"OERKNYHIKJLWPVR7\",\n \"name\": \"Courier10\",\n \"alias\": \"Courier10\"\n },\n \"cost\": [\n {\n \"sku\": \"ABC1\",\n \"cost\": 0\n }\n ]\n },\n {\n \"source\": {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE30\",\n \"name\": \"SOURCE30\"\n }\n },\n \"target\": {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE40\",\n \"name\": \"SOURCE40\"\n }\n },\n \"courier\": {\n \"id\": \"OERKNYHIKJLWQ6BU\",\n \"name\": \"Courier30\",\n \"alias\": \"Courier30\"\n },\n \"cost\": [\n {\n \"sku\": \"ABC1\",\n \"cost\": 0\n }\n ]\n }\n ]\n },\n {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE10\",\n \"name\": \"SOURCE10\"\n },\n \"items\": [\n {\n \"sku\": \"ABC2\",\n \"quantity\": 1,\n \"type\": \"productType2\",\n \"volume\": 20,\n \"leadtime\": 16,\n \"cost\": 0\n }\n ],\n \"route\": [\n {\n \"source\": {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE10\",\n \"name\": \"SOURCE10\"\n }\n },\n \"target\": {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE30\",\n \"name\": \"SOURCE30\"\n }\n },\n \"courier\": {\n \"id\": \"OERKNYHIKJLWPVR7\",\n \"name\": \"Courier10\",\n \"alias\": \"Courier10\"\n },\n \"cost\": [\n {\n \"sku\": \"ABC2\",\n \"cost\": 0\n }\n ]\n },\n {\n \"source\": {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE30\",\n \"name\": \"SOURCE30\"\n }\n },\n \"target\": {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE40\",\n \"name\": \"SOURCE40\"\n }\n },\n \"courier\": {\n \"id\": \"OERKNYHIKJLWQ6BU\",\n \"name\": \"Courier30\",\n \"alias\": \"Courier30\"\n },\n \"cost\": [\n {\n \"sku\": \"ABC2\",\n \"cost\": 0\n }\n ]\n }\n ]\n }\n ],\n \"dates\": [\n {\n \"shipping\": \"2021-01-27T09:00:00.000\",\n \"delivery\": \"2021-02-01T11:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"11:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"17:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-01-28T09:00:00.000\",\n \"delivery\": \"2021-02-03T11:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"11:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"17:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-01-29T09:00:00.000\",\n \"delivery\": \"2021-02-03T11:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"11:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"17:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-01-30T09:00:00.000\",\n \"delivery\": \"2021-02-03T11:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"11:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"17:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-02-01T09:00:00.000\",\n \"delivery\": \"2021-02-03T11:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"11:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"17:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-02-02T09:00:00.000\",\n \"delivery\": \"2021-02-03T11:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"11:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"17:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-02-03T09:00:00.000\",\n \"delivery\": \"2021-02-08T11:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"11:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"17:00\",\n \"label\": \"PM\"\n }\n ]\n }\n }\n ],\n \"cost\": 0\n }\n ]\n }\n}"},{"id":"dbf8ab4f-8c31-4641-9188-5e920d25f9ab","name":"Get Schedule - Location to source","originalRequest":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Bearer {{token}}"}],"body":{"mode":"raw","raw":"{\n \"shippingType\": \"RT\",\n \"baseDate\": \"2021-01-25\",\n \"target\": {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE40\",\n \"alias\": \"SOURCE40\"\n }\n },\n \"sources\": [\n {\n \"type\": \"Location\",\n \"data\": {\n \"criteria0\": \"lcriteria1\",\n \"criteria1\": \"lcriteria2\",\n \"criteria2\": \"lcriteria3\"\n },\n \"items\": [\n {\n \"sku\": \"ABC1\",\n \"quantity\": 2,\n \"type\": \"productType1\",\n \"volume\": 5,\n \"leadtime\": 8\n },\n {\n \"sku\": \"ABC2\",\n \"quantity\": 1,\n \"type\": \"productType2\",\n \"volume\": 5,\n \"leadtime\": 16\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://subdomain-olm.omnixsystem.com/v3/schedule/get"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"02ad242c-254a-477a-86fb-68dc6ab192a6\",\n \"code\": 200,\n \"message\": {\n \"target\": {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE40\",\n \"name\": \"SOURCE40\"\n }\n },\n \"shippingType\": \"RT\",\n \"schedules\": [\n {\n \"deliveryType\": \"meet\",\n \"sources\": [\n {\n \"type\": \"Location\",\n \"data\": {\n \"criteria0\": \"LCRITERIA1\",\n \"criteria1\": \"LCRITERIA2\",\n \"criteria2\": \"LCRITERIA3\"\n },\n \"items\": [\n {\n \"sku\": \"ABC1\",\n \"quantity\": 2,\n \"type\": \"productType1\",\n \"volume\": 5,\n \"leadtime\": 8,\n \"cost\": 0\n },\n {\n \"sku\": \"ABC2\",\n \"quantity\": 1,\n \"type\": \"productType2\",\n \"volume\": 5,\n \"leadtime\": 16,\n \"cost\": 0\n }\n ],\n \"route\": [\n {\n \"source\": {\n \"type\": \"Location\",\n \"data\": {\n \"criteria1\": \"LCRITERIA2\",\n \"criteria2\": \"LCRITERIA3\",\n \"criteria0\": \"LCRITERIA1\"\n }\n },\n \"target\": {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE40\",\n \"name\": \"SOURCE40\"\n }\n },\n \"courier\": {\n \"id\": \"OERKNYHIKJLWQA8S\",\n \"name\": \"Courier40\",\n \"alias\": \"Courier40\"\n },\n \"cost\": [\n {\n \"sku\": \"ABC1\",\n \"cost\": 0\n },\n {\n \"sku\": \"ABC2\",\n \"cost\": 0\n }\n ]\n }\n ]\n }\n ],\n \"dates\": [\n {\n \"shipping\": \"2021-01-30T09:00:00.000\",\n \"delivery\": \"2021-02-01T10:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"10:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"16:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-02-01T09:00:00.000\",\n \"delivery\": \"2021-02-02T10:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"10:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"16:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-02-02T09:00:00.000\",\n \"delivery\": \"2021-02-03T10:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"10:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"16:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-02-03T09:00:00.000\",\n \"delivery\": \"2021-02-04T10:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"10:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"16:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-02-04T09:00:00.000\",\n \"delivery\": \"2021-02-08T10:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"10:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"16:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-02-05T09:00:00.000\",\n \"delivery\": \"2021-02-08T10:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"10:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"16:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-02-06T09:00:00.000\",\n \"delivery\": \"2021-02-08T10:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"10:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"16:00\",\n \"label\": \"PM\"\n }\n ]\n }\n }\n ],\n \"cost\": 0\n }\n ]\n }\n}"},{"id":"f4eb85ba-b8f7-4648-8288-253998638eea","name":"Get Schedule - with combinations","originalRequest":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Bearer {{token}}"}],"body":{"mode":"raw","raw":"{\n \"shippingType\": \"SP\",\n \"baseDate\": \"2021-01-25\",\n \"target\": {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE40\",\n \"alias\": \"SOURCE40\"\n }\n },\n \"combinations\": [\n [\n {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE10\",\n \"alias\": \"SOURCE10\"\n },\n \"items\": [\n {\n \"sku\": \"ABC1\",\n \"quantity\": 1,\n \"type\": \"productType2\",\n \"volume\": 5,\n \"leadtime\": 8\n },\n {\n \"sku\": \"ABC2\",\n \"quantity\": 1,\n \"type\": \"productType2\",\n \"volume\": 5,\n \"leadtime\": 16\n }\n ]\n }\n ],\n [\n {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE20\",\n \"alias\": \"SOURCE20\"\n },\n \"items\": [\n {\n \"sku\": \"ABC1\",\n \"quantity\": 1,\n \"type\": \"productType2\",\n \"volume\": 5,\n \"leadtime\": 8\n },\n {\n \"sku\": \"ABC2\",\n \"quantity\": 1,\n \"type\": \"productType2\",\n \"volume\": 5,\n \"leadtime\": 16\n }\n ]\n }\n ]\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://subdomain-olm.omnixsystem.com/v3/schedule/get"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"625f83bc-2b74-4b35-9f35-9a538b857288\",\n \"code\": 200,\n \"message\": {\n \"target\": {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE40\",\n \"name\": \"SOURCE40\"\n }\n },\n \"shippingType\": \"SP\",\n \"combinations\": [\n [\n {\n \"deliveryType\": \"meet\",\n \"sources\": [\n {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE20\",\n \"name\": \"SOURCE20\"\n },\n \"items\": [\n {\n \"sku\": \"ABC1\",\n \"quantity\": 1,\n \"type\": \"productType2\",\n \"volume\": 5,\n \"leadtime\": 8,\n \"cost\": 0\n },\n {\n \"sku\": \"ABC2\",\n \"quantity\": 1,\n \"type\": \"productType2\",\n \"volume\": 5,\n \"leadtime\": 16,\n \"cost\": 0\n }\n ],\n \"route\": [\n {\n \"source\": {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE20\",\n \"name\": \"SOURCE20\"\n }\n },\n \"target\": {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE40\",\n \"name\": \"SOURCE40\"\n }\n },\n \"courier\": {\n \"id\": \"OERKNYHIKJLWQ1F1\",\n \"name\": \"Courier20\",\n \"alias\": \"Courier20\"\n },\n \"cost\": [\n {\n \"sku\": \"ABC1\",\n \"cost\": 0\n },\n {\n \"sku\": \"ABC2\",\n \"cost\": 0\n }\n ]\n }\n ]\n }\n ],\n \"dates\": [\n {\n \"shipping\": \"2021-01-27T09:00:00.000\",\n \"delivery\": \"2021-01-28T10:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"10:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"17:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-01-28T09:00:00.000\",\n \"delivery\": \"2021-02-01T10:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"10:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"17:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-01-29T09:00:00.000\",\n \"delivery\": \"2021-02-01T10:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"10:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"17:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-01-30T09:00:00.000\",\n \"delivery\": \"2021-02-01T10:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"10:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"17:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-02-01T09:00:00.000\",\n \"delivery\": \"2021-02-02T10:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"10:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"17:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-02-02T09:00:00.000\",\n \"delivery\": \"2021-02-03T10:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"10:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"17:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-02-03T09:00:00.000\",\n \"delivery\": \"2021-02-04T10:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"10:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"17:00\",\n \"label\": \"PM\"\n }\n ]\n }\n }\n ],\n \"cost\": 0\n }\n ],\n [\n {\n \"deliveryType\": \"meet\",\n \"sources\": [\n {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE10\",\n \"name\": \"SOURCE10\"\n },\n \"items\": [\n {\n \"sku\": \"ABC1\",\n \"quantity\": 1,\n \"type\": \"productType2\",\n \"volume\": 5,\n \"leadtime\": 8,\n \"cost\": 0\n },\n {\n \"sku\": \"ABC2\",\n \"quantity\": 1,\n \"type\": \"productType2\",\n \"volume\": 5,\n \"leadtime\": 16,\n \"cost\": 0\n }\n ],\n \"route\": [\n {\n \"source\": {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE10\",\n \"name\": \"SOURCE10\"\n }\n },\n \"target\": {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE30\",\n \"name\": \"SOURCE30\"\n }\n },\n \"courier\": {\n \"id\": \"OERKNYHIKJLWPVR7\",\n \"name\": \"Courier10\",\n \"alias\": \"Courier10\"\n },\n \"cost\": [\n {\n \"sku\": \"ABC1\",\n \"cost\": 0\n },\n {\n \"sku\": \"ABC2\",\n \"cost\": 0\n }\n ]\n },\n {\n \"source\": {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE30\",\n \"name\": \"SOURCE30\"\n }\n },\n \"target\": {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE40\",\n \"name\": \"SOURCE40\"\n }\n },\n \"courier\": {\n \"id\": \"OERKNYHIKJLWQ6BU\",\n \"name\": \"Courier30\",\n \"alias\": \"Courier30\"\n },\n \"cost\": [\n {\n \"sku\": \"ABC1\",\n \"cost\": 0\n },\n {\n \"sku\": \"ABC2\",\n \"cost\": 0\n }\n ]\n }\n ]\n }\n ],\n \"dates\": [\n {\n \"shipping\": \"2021-01-27T09:00:00.000\",\n \"delivery\": \"2021-02-01T11:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"11:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"17:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-01-28T09:00:00.000\",\n \"delivery\": \"2021-02-03T11:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"11:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"17:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-01-29T09:00:00.000\",\n \"delivery\": \"2021-02-03T11:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"11:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"17:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-01-30T09:00:00.000\",\n \"delivery\": \"2021-02-03T11:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"11:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"17:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-02-01T09:00:00.000\",\n \"delivery\": \"2021-02-03T11:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"11:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"17:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-02-02T09:00:00.000\",\n \"delivery\": \"2021-02-03T11:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"11:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"17:00\",\n \"label\": \"PM\"\n }\n ]\n }\n },\n {\n \"shipping\": \"2021-02-03T09:00:00.000\",\n \"delivery\": \"2021-02-08T11:00:00.000\",\n \"custom\": {\n \"slots\": [\n {\n \"from\": \"11:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"17:00\",\n \"label\": \"PM\"\n }\n ]\n }\n }\n ],\n \"cost\": 0\n }\n ]\n ]\n }\n}"}],"_postman_id":"8b7befe1-b7e2-4c55-9421-9cf62623adf2"},{"name":"Reserve Schedule","id":"b9fc30aa-dce8-45ff-bbaa-4db22e4c8fa7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"BearerServicio para reservar fechas de agendamiento a partir de una fecha de entrega (delivery).
\nMock Server
\nhttps://c6ec6c36-0750-406b-a4b0-52de03a0674e.mock.pstmn.io/v3/schedule/reserve
Request
\nResponse
\nLa estructura es similar al response de la consulta de agendamiento excepto por las siguientes diferencias:
\n- \n
schedule: Este atributo es de tipo JSON y contiene la informacion del itinerario de la ruta (saltos y fechas) de cada source.
\n \nse omite el atributo dates
\n \nDentro del array de sources, en cada elemento se agregan los siguientes atributos:
- capacityReserveKey: Llave con la que se crearon las reservas de capacidad (de todo el flujo) del source en cuestión.
- baseDate: Fecha en que el source inicia la preparación.
- shipping: Fecha en que el source termina la preparación
- delivery: Fecha en el source hará la entrega
\nroute: En este atributo se mantiene la estructura en cada elemento del arreglo: source, target, courier, cost. Y adicional se incluye dates (JSON) que contiene:
\n \n
\n\n
- \n
- deliveryDate: Fecha de entrega puede o no ser igual a la recibida en el input \n
{\n \"target\": {\n \"type\": \"Location\",\n \"data\": {\n \"criteria0\": \"Barranquilla\",\n \"criteria1\": \"Atlantico\",\n \"criteria2\": \"Betania\",\n \"criteria3\": \"\",\n \"criteria4\": \"\"\n }\n },\n \"shippingType\": \"HD\",\n \"deliveryDate\": \"YYYY-MM-DD\",\n \"schedule\": {\n \"name\": \"estandar\",\n \"deliveryType\": \"SD\",\n \"sources\": [\n {\n \"type\": \"source\",\n \"capacityReserveKey\": \"capacityReserveKey\",\n \"baseDate\": \"YYYY-MM-DDThh:mm:ss.mmm\",\n \"shipping\": \"YYYY-MM-DDThh:mm:ss.mmm\",\n \"delivery\": \"YYYY-MM-DDThh:mm:ss.mmm\",\n \"data\": {\n \"id\": \"CT15\",\n \"name\": \"Bodega\"\n },\n \"items\": [\n {\n \"sku\": \"ABC1\",\n \"quantity\": 2,\n \"type\": \"pequeño\",\n \"volume\": 20,\n \"availabilityDate\": \"YYYY-MM-DD\",\n \"leadtime\": 8,\n \"criterias\": [\n \"pequeño\",\n \"sensible\"\n ],\n \"cost\": 0\n },\n {\n \"sku\": \"ABC2\",\n \"quantity\": 1,\n \"type\": \"sensible\",\n \"availabilityDate\": \"YYYY-MM-DD\",\n \"leadtime\": 8,\n \"criterias\": [\n \"pequeño\",\n \"sensible\"\n ],\n \"volume\": 20,\n \"cost\": 0\n }\n ],\n \"route\": [\n {\n \"source\": {\n \"type\": \"source\",\n \"data\": {\n \"id\": \"CT15\",\n \"name\": \"Bodega\"\n }\n },\n \"target\": {\n \"type\": \"location\",\n \"data\": {\n \"city\": \"Barranquilla\",\n \"state\": \"Atlantico\",\n \"district\": \"Betania\",\n \"coordinate\": [\n -10,\n 11\n ],\n \"address\": \"Calle 1234\"\n }\n },\n \"courier\": {\n \"id\": \"1234\",\n \"name\": \"1234\",\n \"alias\": \"1234\"\n },\n \"cost\": [\n {\n \"sku\": \"ABC1\",\n \"cost\": 0\n },\n {\n \"sku\": \"ABC2\",\n \"cost\": 0\n }\n ],\n \"dates\": {\n \"pickup\": \"YYYY-MM-DDThh:mm:ss.mmm\",\n \"delivery\": \"YYYY-MM-DDThh:mm:ss.mmm\"\n }\n }\n ]\n }\n ],\n \"cost\": 0\n }\n}\nCustom error message
\n","urlObject":{"protocol":"https","path":["v3","schedule","reserve"],"host":["subdomain-olm","omnixsystem","com"],"query":[],"variable":[]}},"response":[{"id":"73455fff-7b8b-434c-931d-65b5a128c8aa","name":"Reserve Schedule HD Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"shippingType\": \"HD\",\n \"deliveryType\": \"SD\",\n \"deliveryDate\": \"YYYY-MM-DD\",\n \"consolidate\": false,\n \"target\": {\n \"type\": \"location\",\n \"data\": {\n \"city\": \"Barranquilla\",\n \"state\": \"Atlantico\",\n \"district\": \"Betania\",\n \"coordinate\": [\n -10,\n 11\n ],\n \"address\": \"Calle 1234\"\n }\n },\n \"channel\": \"channel1\",\n \"sources\": [\n {\n \"type\": \"source\",\n \"data\": {\n \"id\": \"CT15\",\n \"name\": \"Bodega\"\n },\n \"items\": [\n {\n \"sku\": \"ABC1\",\n \"quantity\": 2,\n \"type\": \"pequeño\",\n \"leadtime\": 8,\n \"criterias\": [\n \"pequeño\",\n \"sensible\"\n ],\n \"volume\": 20\n },\n {\n \"sku\": \"ABC2\",\n \"quantity\": 1,\n \"type\": \"sensible\",\n \"leadtime\": 8,\n \"criterias\": [\n \"pequeño\",\n \"sensible\"\n ],\n \"volume\": 20\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://subdomain-olm.omnixsystem.com/v3/schedule/reserve"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"326f89d0-5862-11e8-92a0-fb2a57096715\",\n \"code\": 200,\n \"message\": {\n \"target\": {\n \"type\": \"Location\",\n \"data\": {\n \"criteria0\": \"LCRITERIA1\",\n \"criteria1\": \"LCRITERIA2\",\n \"criteria2\": \"LCRITERIA3\"\n }\n },\n \"shippingType\": \"HD\",\n \"deliveryDate\": \"YYYY-MM-DD\",\n \"schedule\": {\n \"name\": \"estandar\",\n \"deliveryType\": \"SD\",\n \"sources\": [\n {\n \"type\": \"source\",\n \"data\": {\n \"id\": \"CT15\",\n \"name\": \"Bodega\"\n },\n \"items\": [\n {\n \"sku\": \"ABC1\",\n \"quantity\": 2,\n \"type\": \"pequeño\",\n \"volume\": 20,\n \"availabilityDate\": \"YYYY-MM-DD\",\n \"leadtime\": 8,\n \"criterias\": [\n \"pequeño\",\n \"sensible\"\n ],\n \"cost\": 0\n },\n {\n \"sku\": \"ABC2\",\n \"quantity\": 1,\n \"type\": \"sensible\",\n \"availabilityDate\": \"YYYY-MM-DD\",\n \"leadtime\": 8,\n \"criterias\": [\n \"pequeño\",\n \"sensible\"\n ],\n \"volume\": 20,\n \"cost\": 0\n }\n ],\n \"capacityReservedKey\": \"reserve001\",\n \"route\": [\n {\n \"source\": {\n \"type\": \"source\",\n \"data\": {\n \"id\": \"CT15\",\n \"name\": \"Bodega\"\n }\n },\n \"target\": {\n \"type\": \"location\",\n \"data\": {\n \"criteria0\": \"LCRITERIA1\",\n \"criteria1\": \"LCRITERIA2\",\n \"criteria2\": \"LCRITERIA3\"\n }\n },\n \"courier\": {\n \"id\": \"1234\",\n \"name\": \"1234\",\n \"alias\": \"1234\"\n },\n \"cost\": [\n {\n \"sku\": \"ABC1\",\n \"cost\": 0\n },\n {\n \"sku\": \"ABC2\",\n \"cost\": 0\n }\n ],\n \"dates\": {\n \"shipping\": \"YYYY-MM-DD\",\n \"delivery\": \"YYYY-MM-DD\",\n \"custom\": {\n \"key\": \"value\"\n }\n }\n }\n ]\n }\n ],\n \"cost\": 0\n }\n }\n}"},{"id":"ebb0386c-f2ba-4b8d-90de-07da041103f8","name":"Source to same source","originalRequest":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"BearerServicio para crear/actualizar configuraciones de agendamiento (tipos de entrega) por tipo de despacho. Si este existe la información será actualizada, si no, será creada.
\nMock Server
\nhttps://c6ec6c36-0750-406b-a4b0-52de03a0674e.mock.pstmn.io/v3/schedule
Request
\n","urlObject":{"protocol":"https","path":["v3","schedule"],"host":["subdomain-olm","omnixsystem","com"],"query":[],"variable":[]}},"response":[{"id":"1fe03bdf-d33f-49b4-83b3-fbe33a537911","name":"Create/update schedule setting","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"BearerServicio para obtener detalle de la configuración de un tipo de agendamiento específico.
\nMock Server
\nhttps://c6ec6c36-0750-406b-a4b0-52de03a0674e.mock.pstmn.io/v3/schedule/:scheduleId
Path Parameters
\n- \n
- scheduleId: Identificador del tipo de agendamiento (entrega). \n
Identificador del tipo de agendamiento (entrega).
\n","type":"text/plain"},"type":"any","value":"schedule01","key":"scheduleId"}]}},"response":[{"id":"425bfe70-189c-4db8-afd6-3da406f505a1","name":"Get Schedule Settings Details","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":{"raw":"https://{{subdomain}}-olm.omnixsystem.com/v3/schedule/:scheduleId","protocol":"https","host":["{{subdomain}}-olm","omnixsystem","com"],"path":["v3","schedule",":scheduleId"],"variable":[{"key":"scheduleId","value":"schedule01","description":"Identificador del tipo de agendamiento (entrega)."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"326f89d0-5862-11e8-92a0-fb2a57096715\",\n \"code\": 200,\n \"message\": {\n \"id\": \"schedule01\",\n \"type\": \"leadtimes\",\n \"deliveryType\": \"estandar\",\n \"shippingType\": [\n \"SP\",\n \"HD\"\n ],\n \"datesToReturn\": 7,\n \"slots\": [\n {\n \"from\": \"08:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"16:00\",\n \"label\": \"PM\"\n }\n ],\n \"sourceDefaultSettings\": {\n \"leadtime\": {\n \"value\": 1,\n \"unit\": \"d\"\n },\n \"crossdock\": {\n \"value\": 1,\n \"unit\": \"d\"\n },\n \"workingSessions\": [\n {\n \"productType\": [\n \"productType1\"\n ],\n \"from\": \"08:00\",\n \"to\": \"15:00\",\n \"lockTime\": {\n \"from\": \"12:00\",\n \"to\": \"13:00\"\n }\n },\n {\n \"productType\": [\n \"productType2\"\n ],\n \"from\": \"08:00\",\n \"to\": \"11:00\"\n }\n ],\n \"workingTime\": {\n \"from\": \"08:00\",\n \"to\": \"17:00\"\n }\n },\n \"productDefaultSettings\": {\n \"leadtime\": {\n \"value\": 1,\n \"unit\": \"h\"\n },\n \"volume\": 1,\n \"cost\": 0\n },\n \"status\": 1\n }\n}"}],"_postman_id":"88e420e2-fce7-4313-82d3-cdc53363da3a"},{"name":"Get all Schedule Settings Details","id":"832bf5de-bceb-4cde-ac05-1191d541de38","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"skipRecords\": 0,\n \"maxRecords\": 10,\n \"project\": [\n \"id\",\n \"deliveryType\",\n \"shippingType\"\n ]\n}"},"url":"https://{{subdomain}}-olm.omnixsystem.com/v3/schedule/all","description":"Servicio para consultar los tipos de agendamiento (entrega).
\nMock Server
\nhttps://c6ec6c36-0750-406b-a4b0-52de03a0674e.mock.pstmn.io/v3/schedule/all
Request:
\n- \n
- skipRecords (Requerida): (Int) Cantidad de registros a saltarse en la consulta. \n
- maxRecords (Requerida): (Int) Cantidad de registros a devolver en la consulta. \n
- project (Opcional): (Array[String]) Nombre de las propiedades que queremos ver en la respuesta. \n
\n\n","urlObject":{"protocol":"https","path":["v3","schedule","all"],"host":["{{subdomain}}-olm","omnixsystem","com"],"query":[],"variable":[]}},"response":[{"id":"01ec0e6a-ba46-44b1-95cc-58cc88884bc7","name":"Get all Schedule Settings Details","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"skipRecords\": 0,\n \"maxRecords\": 10,\n \"project\": [\n \"id\",\n \"deliveryType\",\n \"shippingType\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://{{subdomain}}-olm.omnixsystem.com/v3/schedule/all"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"e587f6ac-ed06-406b-97ce-0ec41a719b4a\",\n \"code\": 200,\n \"message\": {\n \"numRecordsReturned\": 2,\n \"skippedRecords\": 0,\n \"maxPages\": 1,\n \"totalRecordsMatched\": 1,\n \"records\": [\n {\n \"id\": \"schedule01\",\n \"type\": \"leadtimes\",\n \"deliveryType\": \"estandar\",\n \"shippingType\": [\n \"SP\",\n \"HD\"\n ]\n }\n ]\n }\n}"},{"id":"ac4630dd-4329-44f4-90ea-c29ff74d1e55","name":"Get all Schedule Settings - NO MATCH","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"skipRecords\": 0,\n \"maxRecords\": 10,\n \"project\": [\n \"id\",\n \"deliveryType\",\n \"shippingType\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://{{subdomain}}-olm.omnixsystem.com/v3/schedule/all"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"11f4d47b-9fca-4152-8435-e44b078e1a1d\",\n \"code\": 200,\n \"message\": {\n \"numRecordsReturned\": 0,\n \"skippedRecords\": 0,\n \"maxPages\": 0,\n \"totalRecordsMatched\": 0,\n \"records\": []\n }\n}"}],"_postman_id":"832bf5de-bceb-4cde-ac05-1191d541de38"},{"name":"Remove schedule Setting","id":"de6f96ac-dfaf-467e-b4ee-b1d2490552c9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Bearer {{token}}"}],"body":{"mode":"raw","raw":"{\n \"ids\": [\"schedule01\"],\n \"comment\": \"remove from monitor\"\n}"},"url":"https://{{subdomain}}-olm.omnixsystem.com/v3/schedule","description":"Si no se especifica project entonces se entregarán todas las propiedades públicas del modelo Courier
\n
Servicio para eliminar configuraciones de agendamiento (entrega).
\nMock Server
\nhttps://c6ec6c36-0750-406b-a4b0-52de03a0674e.mock.pstmn.io/v3/schedule
Request
\n","urlObject":{"protocol":"https","path":["v3","schedule"],"host":["{{subdomain}}-olm","omnixsystem","com"],"query":[],"variable":[]}},"response":[{"id":"36b6136b-21ea-49c1-88fb-9e923056c88b","name":"Remove schedule Setting","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"ids\": [\"schedule01\"],\n \"comment\": \"remove from monitor\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{subdomain}}-olm.omnixsystem.com/v3/schedule"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"326f89d0-5862-11e8-92a0-fb2a57096715\",\n \"code\": 200,\n \"message\": \"OK\"\n}"}],"_postman_id":"de6f96ac-dfaf-467e-b4ee-b1d2490552c9"}],"id":"53bc5b36-20e7-4e2e-a4c5-0710d6bc056b","description":"Una de las características de Omnix es que permite estimar tiempos de entrega de pedidos teniendo en cuenta las capacidades y cobertura de los diferentes actores.
\nTipos de estimaciones de fechas de entrega
\nOLM ofrece dos formas de estimar fechas de entrega:
\n1- Estimaciones basadas en tiempos de preparación
\nEn este tipo de estimación la fecha de entrega se define a partir de la sumatoria de tiempos de preparación y validación de capacidades de cada uno de los actores que intervienen en el flujo.
\nleadtimes
![\"Agendamiento](\"https://omnix-v3-res.s3.amazonaws.com/OLM/Agendamiento_dinamico.jpg\")
2 - Estimaciones basadas en reglas
\nrules
En este tipo de estimación la fecha de entrega está condicionada por el rango horario en el que se recibe un pedido y se encuentra listo para ser recogido por el Courier.
\nAquí solo se validan capacidades de despacho del Source.
\n![\"Agendamiento](\"https://omnix-v3-res.s3.amazonaws.com/OLM/Agendamiento_Estatico.jpg\")
3 - Estimaciones basadas en la fecha de entrega
\nskip
En este tipo de estimación la fecha de entrega está condicionada por la entrada al servicio en el campo deliveryDate, se tendrá en cuenta la cobertura y capacidades correspondientes, El uso de esta sera exclusivo de la reserva de agendamiento y estará condicionado al envio del parámetro skipDeliveryDate con el valor true.
![\"Agendamiento](\"https://omnix-v3-res.s3.amazonaws.com/OLM/Agendamiento_skip.jpg\")
A continuación se describen los servicios de agendamiento
\n","_postman_id":"53bc5b36-20e7-4e2e-a4c5-0710d6bc056b"},{"name":"Couriers","item":[{"name":"Create/update Courier","id":"486a194d-5054-4e5d-8ee4-7bf15d9241ab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Bearer {{token}}"}],"body":{"mode":"raw","raw":"{\n \"id\": \"CO12123\",\n \"name\": \"Courier 1\",\n \"alias\": \"Alias 1\",\n \"shippingType\": [\n \"HD\"\n ],\n \"deliveryType\": \"standar\",\n \"costStrategy\": \"productType\",\n \"locationStrategy\": \"strategy 1\",\n \"dispatchCapacity\": [\n {\n \"daysOfWeek\": [\n 1,\n 2,\n 3,\n 4,\n 5\n ],\n \"overCapacity\": 10,\n \"capacity\": 10\n }\n ],\n \"volumeCapacity\": [\n {\n \"daysOfWeek\": [\n 1,\n 2,\n 3,\n 4,\n 5\n ],\n \"overCapacity\": 10,\n \"capacity\": 10\n }\n ],\n \"nonWorkingDays\": [\n 7\n ],\n \"workingTime\": [\n {\n \"daysOfWeek\": [\n 1,\n 2,\n 3,\n 4,\n 5,\n 6\n ],\n \"from\": \"08:00\",\n \"to\": \"17:00\"\n }\n ],\n \"channel\": [\n \"televentas\",\n \"omnicanal\"\n ],\n \"productType\": [\n \"grande\"\n ],\n \"criterias\": [\n \"pequeño\",\n \"sensible\",\n \"jugueton\"\n ],\n \"nonWorkingDates\": [\n \"08/21\",\n \"05/14\",\n \"04/12\",\n \"04/13\",\n \"04/14\",\n \"04/15\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://{{subdomain}}-olm.omnixsystem.com/v3/couriers","description":"Servicio para crear/actualizar Courier, si este existe la información entonces es actualizada, si no, este será creado.
\nMock Server
\nhttps://c6ec6c36-0750-406b-a4b0-52de03a0674e.mock.pstmn.io/v3/couriers
Request
\nCustom error message
\n","urlObject":{"protocol":"https","path":["v3","couriers"],"host":["{{subdomain}}-olm","omnixsystem","com"],"query":[],"variable":[]}},"response":[{"id":"c36d7a13-0519-4ea6-b4f6-bf5f0043b214","name":"Create multiple courier","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"id\": \"CO1214\",\n \"name\": \"Courier 2\",\n \"alias\": \"Alias 1\",\n \"shippingType\": [\n \"HD\"\n ],\n \"deliveryType\": \"standar\",\n \"costStrategy\": \"productType\",\n \"locationStrategy\": \"strategy 1\",\n \"dispatchCapacity\": [\n {\n \"daysOfWeek\": [\n 1,\n 2,\n 3,\n 4,\n 5\n ],\n \"capacity\": 10,\n \"overCapacity\": 10\n }\n ],\n \"volumeCapacity\": [\n {\n \"daysOfWeek\": [\n 1,\n 2,\n 3,\n 4,\n 5\n ],\n \"capacity\": 10,\n \"overCapacity\": 10\n }\n ],\n \"nonWorkingDays\": [\n 7\n ],\n \"workingTime\": [\n {\n \"daysOfWeek\": [\n 1,\n 2,\n 3,\n 4,\n 5,\n 6\n ],\n \"from\": \"08:00\",\n \"to\": \"17:00\"\n }\n ],\n \"channel\": [\n \"televentas\",\n \"omnicanal\"\n ],\n \"productType\": [\n \"grande\"\n ]\n },\n {\n \"id\": \"CO12123\",\n \"name\": \"Courier 1\",\n \"alias\": \"Alias 1\",\n \"shippingType\": \"HD\",\n \"deliveryType\": \"standar\",\n \"costStrategy\": \"productType\",\n \"locationStrategy\": \"strategy 2\",\n \"dispatchCapacity\": [\n {\n \"daysOfWeek\": [\n 1,\n 2,\n 3,\n 4,\n 5\n ],\n \"capacity\": 10\n }\n ],\n \"volumeCapacity\": [\n {\n \"daysOfWeek\": [\n 1,\n 2,\n 3,\n 4,\n 5\n ],\n \"capacity\": 10\n }\n ],\n \"nonWorkingDays\": [\n 7\n ],\n \"workingTime\": {\n \"daysOfWeek\": [\n 1,\n 2,\n 3,\n 4,\n 5,\n 6\n ],\n \"from\": \"08:00\",\n \"to\": \"17:00\"\n },\n \"channel\": [\n \"televentas\",\n \"omnicanal\"\n ],\n \"productType\": [\n \"grande\"\n ],\n \"criterias\": [\n \"pequeño\",\n \"sensible\",\n \"jugueton\"\n ]\n }\n]","options":{"raw":{"language":"json"}}},"url":"https://{{subdomain}}-olm.omnixsystem.com/v3/couriers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"326f89d0-5862-11e8-92a0-fb2a57096715\",\n \"code\": 200,\n \"message\": \"OK\"\n}"},{"id":"f02cf89b-7c6f-4ad5-afd7-a3d49237dafb","name":"Create single courier ","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"CO12123\",\n \"name\": \"Courier 1\",\n \"alias\": \"Alias 1\",\n \"shippingType\": [\n \"HD\"\n ],\n \"deliveryType\": \"standar\",\n \"costStrategy\": \"productType\",\n \"locationStrategy\": \"strategy 1\",\n \"dispatchCapacity\": [\n {\n \"daysOfWeek\": [\n 1,\n 2,\n 3,\n 4,\n 5\n ],\n \"capacity\": 10,\n \"overCapacity\": 10\n }\n ],\n \"volumeCapacity\": [\n {\n \"daysOfWeek\": [\n 1,\n 2,\n 3,\n 4,\n 5\n ],\n \"capacity\": 10,\n \"overCapacity\": 10\n }\n ],\n \"nonWorkingDays\": [\n 7\n ],\n \"workingTime\": [\n {\n \"daysOfWeek\": [\n 1,\n 2,\n 3,\n 4,\n 5,\n 6\n ],\n \"from\": \"08:00\",\n \"to\": \"17:00\"\n }\n ],\n \"channel\": [\n \"televentas\",\n \"omnicanal\"\n ],\n \"productType\": [\n \"grande\"\n ],\n \"criterias\": [\n \"pequeño\",\n \"sensible\",\n \"jugueton\"\n ],\n \"nonWorkingDates\" : [ \n \"08/21\", \n \"05/14\", \n \"04/12\", \n \"04/13\", \n \"04/14\", \n \"04/15\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://{{subdomain}}-olm.omnixsystem.com/v3/couriers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"326f89d0-5862-11e8-92a0-fb2a57096715\",\n \"code\": 200,\n \"message\": \"OK\"\n}"}],"_postman_id":"486a194d-5054-4e5d-8ee4-7bf15d9241ab"},{"name":"Remove couriers","id":"f9e7b0ba-6976-4222-84cb-f38c412bd258","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"ids\": [\"CO1214\", \"CO12123\"],\n \"comment\": \"remove from monitor\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{subdomain}}-olm.omnixsystem.com/v3/couriers","description":"Servicio para eliminar Couriers y todas sus coberturas.
\nMock Server
\nhttps://c6ec6c36-0750-406b-a4b0-52de03a0674e.mock.pstmn.io/v3/couriers
Request
\n","urlObject":{"protocol":"https","path":["v3","couriers"],"host":["{{subdomain}}-olm","omnixsystem","com"],"query":[],"variable":[]}},"response":[{"id":"55c1a938-64af-48f3-a6a2-3d321a1602ed","name":"Remove courier","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"ids\": [\"CO1214\", \"CO12123\"],\n \"comment\": \"remove from monitor\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{subdomain}}-olm.omnixsystem.com/v3/couriers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"326f89d0-5862-11e8-92a0-fb2a57096715\",\n \"code\": 200,\n \"message\": \"OK\"\n}"}],"_postman_id":"f9e7b0ba-6976-4222-84cb-f38c412bd258"},{"name":"Get Courier by Id","id":"d23ff993-9d34-4625-9e93-4f764c9a2bac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"https://{{subdomain}}-olm.omnixsystem.com/v3/couriers/:courierId","description":"Servicio para obtener Courier por id
\nMock Server
\nhttps://c6ec6c36-0750-406b-a4b0-52de03a0674e.mock.pstmn.io/v3/couriers/:courierId
Path parameters
\n- \n
- courierId: Identificador del courier. \n
Servicio para consultar todos los Couriers de forma paginada y es posible filtrar por propiedades del modelo.
\nMock Server
\nhttps://c6ec6c36-0750-406b-a4b0-52de03a0674e.mock.pstmn.io/v3/couriers/all
Request:
\n- \n
- skipRecords (Requerida): (Int) Cantidad de registros a saltarse en la consulta. \n
- maxRecords (Requerida): (Int) Cantidad de registros a devolver en la consulta. \n
- project (Opcional): (Array[String]) Nombre de las propiedades que queremos ver en la respuesta. \n
- filter (Opcional): (Object) Permite especificar la consulta por propiedades especificas. ej:
{shippingType: [\"SP\"]}(traerá solo couriers que cumplan con esta condición). \n
\n\n","urlObject":{"protocol":"https","path":["v3","couriers","all"],"host":["{{subdomain}}-olm","omnixsystem","com"],"query":[],"variable":[]}},"response":[{"id":"caff471a-1513-4822-9182-cb8f6b93e0d5","name":"Get Couriers","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"skipRecords\": 0,\n \"maxRecords\": 10,\n \"project\": [\n \"id\",\n \"name\",\n \"alias\",\n \"shippingType\",\n \"deliveryType\",\n \"costStrategy\",\n \"locationStrategy\"\n ],\n \"filter\": {\n \"alias\": \"Courier\",\n \"nonWorkingDays\": [\n 7\n ],\n \"channel\": [\n \"televentas\"\n ],\n \"productType\": [\n \"grandes\"\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://{{subdomain}}-olm.omnixsystem.com/v3/couriers/all"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"e587f6ac-ed06-406b-97ce-0ec41a719b4a\",\n \"code\": 200,\n \"message\": {\n \"numRecordsReturned\": 2,\n \"skippedRecords\": 0,\n \"maxPages\": 1,\n \"totalRecordsMatched\": 2,\n \"records\": [\n {\n \"id\": \"CO1214\",\n \"name\": \"Courier 2\",\n \"alias\": \"Alias 1\",\n \"shippingType\": \"HD\",\n \"deliveryType\": \"standar\",\n \"costStrategy\": \"productType\",\n \"locationStrategy\": \"strategy 1\"\n },\n {\n \"id\": \"CO12123\",\n \"name\": \"Courier 1\",\n \"alias\": \"Alias 1\",\n \"shippingType\": \"HD\",\n \"deliveryType\": \"standar\",\n \"costStrategy\": \"productType\",\n \"locationStrategy\": \"strategy 2\"\n }\n ]\n }\n}"},{"id":"85d2c5c3-35ac-4afc-aefd-8606fc5a1cdc","name":"Get Couriers - NO MATCH","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"skipRecords\": 0,\n \"maxRecords\": 10,\n \"project\": [\n \"name\",\n \"channel\"\n ],\n \"filter\": {\n \"id\": \"\",\n \"name\": \"\",\n \"alias\": \"\",\n \"shippingType\": \"\",\n \"deliveryType\": \"\",\n \"costStrategy\": \"\",\n \"locationStrategy\": \"\",\n \"capacity\": \"\",\n \"nonWorkingDays\": [1,2,3],\n \"channel\": [\"televentas\"],\n \"productType\": [\"grandes\"]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://{{subdomain}}-olm.omnixsystem.com/v3/couriers/all"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"11f4d47b-9fca-4152-8435-e44b078e1a1d\",\n \"code\": 200,\n \"message\": {\n \"numRecordsReturned\": 0,\n \"skippedRecords\": 0,\n \"maxPages\": 0,\n \"totalRecordsMatched\": 0,\n \"records\": []\n }\n}"}],"_postman_id":"2fcca18f-2a0c-4b01-8961-4a2c932d2680"},{"name":"Query Couriers","id":"97142c17-e4c7-4a12-b36a-ab88df087217","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Bearer {{token}}"}],"body":{"mode":"raw","raw":"{\n\t\"idsOrAliases\":[\"COURIER01\"],\n\t\"project\": [\"id\", \"name\"]\n}"},"url":"https://{{subdomain}}-olm.omnixsystem.com/v3/couriers","description":"Si no se especifica project entonces se entregarán todas las propiedades públicas del modelo Courier
\n
Servicio para consultar multiples Couriers por ids o aliases, además es posible especificar que propiedades específicas se requieren para la respuesta.
\nMock Server
\nhttps://c6ec6c36-0750-406b-a4b0-52de03a0674e.mock.pstmn.io/v3/couriers
Request
\n","urlObject":{"protocol":"https","path":["v3","couriers"],"host":["{{subdomain}}-olm","omnixsystem","com"],"query":[],"variable":[]}},"response":[{"id":"286cc078-ea0c-4a3a-9358-ecfe006fb8f3","name":"Search Couriers","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"idsOrAliases\":[\"COURIER01\"],\n\t\"project\": [\"id\", \"name\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://subdomain-olm.omnixsystem.com/v3/couriers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"326f89d0-5862-11e8-92a0-fb2a57096715\",\n \"code\": 200,\n \"message\": [\n {\n \"id\": \"COURIER01\",\n \"name\": \"COURIER01\"\n }\n ]\n}"}],"_postman_id":"97142c17-e4c7-4a12-b36a-ab88df087217"}],"id":"bb99ab6b-08ed-4b4e-82bc-bf58f4db8ec4","description":"A continuación se describen los servicios de administración para couriers
\n","_postman_id":"bb99ab6b-08ed-4b4e-82bc-bf58f4db8ec4"},{"name":"Routes and Coverage","item":[{"name":"Coverages","item":[{"name":"Get Coverage","id":"6b83539c-251e-4463-9130-252f4da9e38f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"shippingType\": \"HD\",\n \"channel\": \"channel1\",\n \"sources\": [\n {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"CT15\",\n \"name\": \"Bodega\"\n },\n \"items\": [\n {\n \"sku\": \"ABC1\",\n \"quantity\": 2,\n \"type\": \"pequeño\",\n \"criterias\": [\n \"pequeño\",\n \"sensible\"\n ],\n \"volume\": 20\n },\n {\n \"sku\": \"ABC2\",\n \"quantity\": 1,\n \"type\": \"sensible\",\n \"criterias\": [\n \"pequeño\",\n \"sensible\"\n ],\n \"volume\": 20\n }\n ]\n }\n ],\n \"target\": {\n \"type\": \"Location\",\n \"data\": {\n \"criteria0\": \"Barranquilla\",\n \"criteria1\": \"Atlantico\",\n \"criteria2\": \"Betania\",\n \"criteria3\": \"\",\n \"criteria4\": \"\",\n \"coordinate\": [\n -10,\n 11\n ]\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://{{subdomain}}-olm.omnixsystem.com/v3/routes/coverage?response=full","description":"\nhttps://c6ec6c36-0750-406b-a4b0-52de03a0674e.mock.pstmn.io/v3/routes/coverage?response=minimal\n\n\nServicio de consulta de cobertura. Dado un arreglo de sources y un target, entregará como respuesta una los sources que tengan ruta hacia el target y omitirá los que no.
\nRequest
\nBody
\nQueryParams
\n- \n
- order: Orden en el que se entregaran los sources en la respuesta.
ascpara orden ascendente odescpara orden descendente \n - response: Permite definir la cantidad de informacion entregada en la respuesta con base en los siguientes valores: \n
- best_route: Cuando se necesita conocer la mejor ruta de cada source hacia el target
\n
\n```
\n \n
{\n \"shippingType\": \"HD\",\n \"sources\": [\n {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"CT15\",\n \"name\": \"Bodega\"\n },\n \"hops\": 1,\n \"route\": [\n {\n \"checksum\": \"h4sh\",\n \"source\": {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"CT15\",\n \"name\": \"Bodega\"\n }\n },\n \"target\": {\n \"type\": \"Location\",\n \"data\": {\n \"criteria0\": \"Barranquilla\",\n \"criteria1\": \"Atlantico\",\n \"criteria2\": \"Betania\",\n \"criteria3\": \"\",\n \"criteria4\": \"\",\n \"coordinate\": [\n -10,\n 11\n ],\n \"address\": \"Calle 1234\"\n }\n },\n \"couriers\": [\n {\n \"id\": \"1234\",\n \"name\": \"1234\",\n \"alias\": \"1234\"\n }\n ]\n }\n ]\n }\n ]\n}
\n\n\n\n
- \n
- minimal: Cuando solo se necesita validar si existe una ruta entre los sources y el target pero no se requiere el detalle de las ruta
\n
\n{\n \"shippingType\": \"HD\",\n \"sources\": [\n {\n \"type\": \"Source\",\n \"hops\": 1,\n \"data\": {\n \"id\": \"CT15\",\n \"name\": \"Bodega\"\n }\n }\n ]\n}\n\n - full: Cuando se necesita conocer todas las rutas de cada uno de los sources hacia el target
\n
\n{\n \"shippingType\": \"HD\",\n \"sources\": [\n {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"CT15\",\n \"name\": \"Bodega\"\n },\n \"routes\": [\n [\n {\n \"checksum\": \"h4sh\",\n \"source\": {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"CT15\",\n \"name\": \"Bodega\"\n }\n },\n \"target\": {\n \"type\": \"Location\",\n \"data\": {\n \"criteria0\": \"Barranquilla\",\n \"criteria1\": \"Atlantico\",\n \"criteria2\": \"Betania\",\n \"criteria3\": \"\",\n \"criteria4\": \"\",\n \"coordinate\": [\n -10,\n 11\n ],\n \"address\": \"Calle 1234\"\n }\n },\n \"couriers\": [\n {\n \"id\": \"1234\",\n \"name\": \"1234\",\n \"alias\": \"1234\"\n }\n ]\n }\n ]\n ]\n }\n ]\n}\n\n
Custom error message
\n","urlObject":{"protocol":"https","path":["v3","routes","coverage"],"host":["{{subdomain}}-olm","omnixsystem","com"],"query":[{"key":"response","value":"full"}],"variable":[]}},"response":[{"id":"b99d4648-f0a2-4633-a5b7-1520b433cec4","name":"Get Coverage Success full Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"shippingType\": \"HD\",\n \"channel\": \"channel1\",\n \"sources\": [\n {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"CT15\",\n \"name\": \"Bodega\"\n }\n }\n ],\n \"target\": {\n \"type\": \"Location\",\n \"data\": {\n \"criteria0\": \"Barranquilla\",\n \"criteria1\": \"Atlantico\",\n \"criteria2\": \"Betania\",\n \"criteria3\": \"\",\n \"criteria4\": \"\",\n \"coordinate\": [\n -10,\n 11\n ],\n \"address\": \"Calle 1234\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{subdomain}}-olm.omnixsystem.com/v3/routes/coverage?response=full","protocol":"https","host":["{{subdomain}}-olm","omnixsystem","com"],"path":["v3","routes","coverage"],"query":[{"key":"response","value":"full"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"326f89d0-5862-11e8-92a0-fb2a57096715\",\n \"code\": 200,\n \"message\": {\n \"shippingType\": \"HD\",\n \"sources\": [\n {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"CT15\",\n \"name\": \"Bodega\"\n },\n \"routes\": [\n [\n {\n \"checksum\": \"h4sh\",\n \"source\": {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"CT15\",\n \"name\": \"Bodega\"\n }\n },\n \"target\": {\n \"type\": \"Location\",\n \"data\": {\n \"criteria0\": \"Barranquilla\",\n \"criteria1\": \"Atlantico\",\n \"criteria2\": \"Betania\",\n \"coordinate\": [\n -10,\n 11\n ],\n \"address\": \"Calle 1234\"\n }\n },\n \"couriers\": [\n {\n \"id\": \"1234\",\n \"name\": \"1234\",\n \"alias\": \"1234\"\n }\n ]\n }\n ]\n ]\n }\n ]\n }\n}"},{"id":"2bb31d42-3511-446c-9e1f-46506d0751e1","name":"Get Coverage Success minimal Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"shippingType\": \"HD\",\n \"channel\": \"channel1\",\n \"sources\": [\n {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"CT15\",\n \"name\": \"Bodega\"\n }\n }\n ],\n \"target\": {\n \"type\": \"Location\",\n \"data\": {\n \"criteria0\": \"Barranquilla\",\n \"criteria1\": \"Atlantico\",\n \"criteria2\": \"Betania\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{subdomain}}-olm.omnixsystem.com/v3/routes/coverage?response=minimal","protocol":"https","host":["{{subdomain}}-olm","omnixsystem","com"],"path":["v3","routes","coverage"],"query":[{"key":"response","value":"minimal"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"326f89d0-5862-11e8-92a0-fb2a57096715\",\n \"code\": 200,\n \"message\": {\n \"shippingType\": \"HD\",\n \"sources\": [\n {\n \"type\": \"Source\",\n \"hops\": 1,\n \"data\": {\n \"id\": \"CT15\",\n \"name\": \"Bodega\"\n }\n }\n ]\n }\n}"},{"id":"b28e1e65-dc9d-4d30-b5de-f2cc5b0cc61e","name":"Get coverage with items","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"shippingType\": \"HD\",\n \"channel\": \"channel1\",\n \"sources\": [\n {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"CT15\",\n \"name\": \"Bodega\"\n },\n \"items\": [\n {\n \"sku\": \"ABC1\",\n \"quantity\": 2,\n \"type\": \"pequeño\",\n \"volume\": 20,\n \"criterias\": [\n \"pequeño\",\n \"sensible\"\n ]\n },\n {\n \"sku\": \"ABC2\",\n \"quantity\": 1,\n \"type\": \"sensible\",\n \"volume\": 20,\n \"criterias\": [\n \"pequeño\",\n \"sensible\"\n ]\n }\n ]\n }\n ],\n \"target\": {\n \"type\": \"Location\",\n \"data\": {\n \"criteria0\": \"Barranquilla\",\n \"criteria1\": \"Atlantico\",\n \"criteria2\": \"Betania\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{subdomain}}-olm.omnixsystem.com/v3/routes/coverage?response=minimal","protocol":"https","host":["{{subdomain}}-olm","omnixsystem","com"],"path":["v3","routes","coverage"],"query":[{"key":"response","value":"minimal"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"326f89d0-5862-11e8-92a0-fb2a57096715\",\n \"code\": 200,\n \"message\": {\n \"shippingType\": \"HD\",\n \"sources\": [\n {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"CT15\",\n \"name\": \"Bodega\"\n }\n }\n ]\n }\n}"},{"id":"d92fd9e3-c063-44ce-9881-416a5d204c81","name":"Get Coverage Success best_route Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"shippingType\": \"HD\",\n \"channel\": \"channel1\",\n \"sources\": [\n {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"CT15\",\n \"name\": \"Bodega\"\n }\n }\n ],\n \"target\": {\n \"type\": \"Location\",\n \"data\": {\n \"criteria0\": \"Barranquilla\",\n \"criteria1\": \"Atlantico\",\n \"criteria2\": \"Betania\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{subdomain}}-olm.omnixsystem.com/v3/routes/coverage?response=best_route&order=desc","protocol":"https","host":["{{subdomain}}-olm","omnixsystem","com"],"path":["v3","routes","coverage"],"query":[{"key":"response","value":"best_route"},{"key":"order","value":"desc"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"326f89d0-5862-11e8-92a0-fb2a57096715\",\n \"code\": 200,\n \"message\": {\n \"shippingType\": \"HD\",\n \"sources\": [\n {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"CT15\",\n \"name\": \"Bodega\"\n },\n \"hops\": 1,\n \"route\": [\n {\n \"checksum\": \"h4sh\",\n \"source\": {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"CT15\",\n \"name\": \"Bodega\"\n }\n },\n \"target\": {\n \"type\": \"Location\",\n \"data\": {\n \"criteria0\": \"Barranquilla\",\n \"criteria1\": \"Atlantico\",\n \"criteria2\": \"Betania\",\n \"coordinate\": [\n -10,\n 11\n ],\n \"address\": \"Calle 1234\"\n }\n },\n \"couriers\": [\n {\n \"id\": \"1234\",\n \"name\": \"1234\",\n \"alias\": \"1234\"\n }\n ]\n }\n ]\n }\n ]\n }\n}"}],"_postman_id":"6b83539c-251e-4463-9130-252f4da9e38f"},{"name":"Create/update Coverage","id":"e601d60d-4d8f-435c-9595-03344df29076","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"routeId\": \"route01\",\n \"courierId\": \"CO12123\",\n \"shippingType\": [\"HD\", \"SP\"],\n \"deliveryType\": \"Estandar\",\n \"leadtime\": {\n \"value\": 1,\n \"unit\": \"d\"\n },\n \"workingTime\": [\n {\n \"daysOfWeek\": [1,2,3,4],\n \"from\": \"08:00\",\n \"to\": \"17:00\"\n }\n ],\n \"deliveryDays\": [1,2,3,4],\n \"cost\": {\n \"productType1\": 20,\n \"productType2\": 10,\n \"productTypeN\": 5\n }\n}"},"url":"https://{{subdomain}}-olm.omnixsystem.com/v3/routes/coverages","description":"Servicio para crear/actualizar Coverage, si este existe la información entonces es actualizada, si no, este será creado.
\nMock Server
\nhttps://c6ec6c36-0750-406b-a4b0-52de03a0674e.mock.pstmn.io/v3/routes/coverage
Request
\n","urlObject":{"protocol":"https","path":["v3","routes","coverages"],"host":["{{subdomain}}-olm","omnixsystem","com"],"query":[],"variable":[]}},"response":[{"id":"0832156d-719d-4a09-808b-1bb4929b55c0","name":"Update coverage","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","type":"text","value":"Bearer {{token}}"}],"body":{"mode":"raw","raw":"{\n \"id\": \"coverage1\",\n \"shippingType\": [\n \"HD\",\n \"SP\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://subdomain-olm.omnixsystem.com/v3/routes/coverages"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"326f89d0-5862-11e8-92a0-fb2a57096715\",\n \"code\": 200,\n \"message\": \"OK\"\n}"},{"id":"b7be10cf-2030-4185-8770-937a330b82d3","name":"Create single Coverage","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"routeId\": \"route01\",\n \"courierId\": \"CO12123\",\n \"shippingType\": [\"HD\", \"SP\"],\n \"deliveryType\": \"Estandar\",\n \"leadtime\": {\n \"value\": 1,\n \"unit\": \"d\"\n },\n \"workingTime\": [\n {\n \"daysOfWeek\": [1,2,3,4],\n \"from\": \"08:00\",\n \"to\": \"17:00\"\n }\n ],\n \"deliveryDays\": [1,2,3,4],\n \"cost\": {\n \"productType1\": 20,\n \"productType2\": 10,\n \"productTypeN\": 5,\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://subdomain-olm.omnixsystem.com/v3/routes/coverages","protocol":"https","host":["subdomain-olm","omnixsystem","com"],"path":["v3","routes","coverages"],"variable":[{"key":"routeId","value":"route01"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"326f89d0-5862-11e8-92a0-fb2a57096715\",\n \"code\": 200,\n \"message\": \"OK\"\n}"},{"id":"1445ad7b-33a9-4fa1-ae61-8ddc33091d27","name":"Create multiple Coverages","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"routeId\": \"route01\",\n \"courierId\": \"CO12123\",\n \"shippingType\": [\n \"HD\",\n \"SP\"\n ],\n \"deliveryType\": \"Estandar\",\n \"leadtime\": {\n \"value\": 1,\n \"unit\": \"d\"\n },\n \"workingTime\": [\n {\n \"daysOfWeek\": [\n 1,\n 2,\n 3,\n 4\n ],\n \"from\": \"08:00\",\n \"to\": \"17:00\"\n }\n ],\n \"deliveryDays\": [\n 1,\n 2,\n 3,\n 4\n ],\n \"cost\": {\n \"productType1\": 20,\n \"productType2\": 10,\n \"productTypeN\": 5\n }\n },\n {\n \"routeId\": \"route01\",\n \"courierId\": \"CO1214\",\n \"shippingType\": [\n \"HD\",\n \"SP\"\n ],\n \"deliveryType\": \"Estandar\",\n \"leadtime\": {\n \"value\": 1,\n \"unit\": \"d\"\n },\n \"workingTime\": [\n {\n \"daysOfWeek\": [\n 1,\n 2,\n 3,\n 4\n ],\n \"from\": \"08:00\",\n \"to\": \"17:00\"\n }\n ],\n \"deliveryDays\": [\n 1,\n 2,\n 3,\n 4\n ],\n \"cost\": {\n \"productType1\": 20,\n \"productType2\": 10,\n \"productTypeN\": 5\n }\n } \n]","options":{"raw":{"language":"json"}}},"url":{"raw":"https://subdomain-olm.omnixsystem.com/v3/routes/coverages","protocol":"https","host":["subdomain-olm","omnixsystem","com"],"path":["v3","routes","coverages"],"variable":[{"key":"routeId","value":"route01"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"326f89d0-5862-11e8-92a0-fb2a57096715\",\n \"code\": 200,\n \"message\": \"OK\"\n}"}],"_postman_id":"e601d60d-4d8f-435c-9595-03344df29076"},{"name":"Remove coverages","id":"346f99f0-93fb-467f-94e4-7491feaef7dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"ids\": [\"coverage01\"],\n \"comment\": \"remove from monitor\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{subdomain}}-olm.omnixsystem.com/v3/routes/coverages","description":"Servicio para eliminar Coverages.
\nMock Server
\nhttps://c6ec6c36-0750-406b-a4b0-52de03a0674e.mock.pstmn.io/v3/routes/coverages
Request
\n","urlObject":{"protocol":"https","path":["v3","routes","coverages"],"host":["{{subdomain}}-olm","omnixsystem","com"],"query":[],"variable":[]}},"response":[{"id":"f1d00e56-8896-4736-a8d2-563a529fa99e","name":"Remove cobertures","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"ids\": [\"coverage01\"],\n \"comment\": \"remove from monitor\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{subdomain}}-olm.omnixsystem.com/v3/routes/:routeId/coverages","protocol":"https","host":["{{subdomain}}-olm","omnixsystem","com"],"path":["v3","routes",":routeId","coverages"],"variable":[{"key":"routeId","value":"route01"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"326f89d0-5862-11e8-92a0-fb2a57096715\",\n \"code\": 200,\n \"message\": \"OK\"\n}"}],"_postman_id":"346f99f0-93fb-467f-94e4-7491feaef7dc"},{"name":"Get Coverages","id":"7372e08b-f685-4fc1-b9dc-d73f36a4f3ce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"skipRecords\": 0,\n \"maxRecords\": 10,\n \"project\": [\"id\", \"shippingType\", \"courierId\"],\n \"filter\": {\n \"routeId\": \"route01\",\n \"courierId\": \"CO12123\",\n \"shippingType\": [\n \"HD\",\n \"SP\"\n ],\n \"deliveryType\": \"Estandar\"\n }\n}"},"url":"https://{{subdomain}}-olm.omnixsystem.com/v3/routes/coverages/all","description":"Servicio para consultar todos las Coverages de forma paginada y es posible filtrar por propiedades del modelo.
\nMock Server
\nhttps://c6ec6c36-0750-406b-a4b0-52de03a0674e.mock.pstmn.io/v3/routes/coverages/all
Request:
\n- \n
- skipRecords (Requerida): (Int) Cantidad de registros a saltarse en la consulta. \n
- maxRecords (Requerida): (Int) Cantidad de registros a devolver en la consulta. \n
- project (Opcional): (Array[String]) Nombre de las propiedades que queremos ver en la respuesta. \n
- filter (Opcional): (Object) Permite especificar la consulta por propiedades especificas. ej:
{\"routeId\": \"route01\"}(traerá todas las coberturas pertenecientes a la ruta route01). \n
\n\nSi no se especifica project entonces se entregarán todas las propiedades públicas del modelo Coverage
\n
QueryParams
\n- \n
- response:
expanded, Incluye en la respuesta el detalle del courier y la ruta relacionada con la cobertura \n
Servicio para obtener Route por id
\nMock Server
\nhttps://c6ec6c36-0750-406b-a4b0-52de03a0674e.mock.pstmn.io/v3/routes/coverages/:coverageId
Identificador de la cobertura
\n","type":"text/plain"},"type":"any","value":"","key":"coverageId"}]}},"response":[{"id":"42766167-267e-401d-b710-f3704e71c649","name":"Get Coverage by id","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":{"raw":"https://{{subdomain}}-olm.omnixsystem.com/v3/routes/coverages/:coverageId","protocol":"https","host":["{{subdomain}}-olm","omnixsystem","com"],"path":["v3","routes","coverages",":coverageId"],"variable":[{"key":"coverageId","value":"coverage001"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"e587f6ac-ed06-406b-97ce-0ec41a719b4a\",\n \"code\": 200,\n \"message\": {\n \"id\": \"coverage001\",\n \"routeId\": \"route01\",\n \"courierId\": \"CO12123\",\n \"shippingType\": [\n \"HD\",\n \"SP\"\n ],\n \"deliveryType\": \"Estandar\",\n \"leadtime\": {\n \"value\": 1,\n \"unit\": \"d\"\n },\n \"workingTime\": [\n {\n \"daysOfWeek\": [\n 1,\n 2,\n 3,\n 4\n ],\n \"from\": \"08:00\",\n \"to\": \"17:00\"\n }\n ],\n \"deliveryDays\": [\n 1,\n 2,\n 3,\n 4\n ],\n \"cost\": {\n \"productType1\": 20,\n \"productType2\": 10,\n \"productTypeN\": 5\n }\n }\n}"}],"_postman_id":"60b07c95-237a-436e-8a9a-bd6ba1ac494a"}],"id":"df277239-2241-44fc-b001-9fd191a0e262","_postman_id":"df277239-2241-44fc-b001-9fd191a0e262","description":""},{"name":"Routes","item":[{"name":"Create/update route","id":"3af4148f-b6e5-4856-bd2b-d8de9ecaa55d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"source\": {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE01\"\n }\n },\n \"target\": {\n \"type\": \"Location\",\n \"data\": {\n \"criteria0\": \"Colombia\",\n \"criteria1\": \"Atlantico\",\n \"criteria2\": \"Barranquilla\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://{{subdomain}}-olm.omnixsystem.com/v3/routes","description":"Servicio para crear/actualizar Routes, si este existe la información entonces es actualizada, si no, este será creado.
\nEn caso de querer actualizar información de nodos (origen o destino), se deberá hacer a traves del servicio de creación o actualización de la entidad correspondiente:
\n\nMock Server
\nhttps://c6ec6c36-0750-406b-a4b0-52de03a0674e.mock.pstmn.io/v3/routes
Request
\nCustom error message
\n{\n \"transactionId\": \"b0dad4c8-568a-4d78-a1d8-927a1f10e1dc\",\n \"code\": 500,\n \"message\": \"SourceNotFoundException: STORE90\"\n}\nServicio para obtener Route por id
\nMock Server
\nhttps://c6ec6c36-0750-406b-a4b0-52de03a0674e.mock.pstmn.io/v3/routes/:routeId
Path parameters
\n- \n
- routeId: Identificador de la ruta. \n
Servicio para consultar todos los Routes de forma paginada y es posible filtrar por propiedades del modelo.
\nMock Server
\nhttps://c6ec6c36-0750-406b-a4b0-52de03a0674e.mock.pstmn.io/v3/routes/all
Request:
\n- \n
- skipRecords (Requerida): (Int) Cantidad de registros a saltarse en la consulta. \n
- maxRecords (Requerida): (Int) Cantidad de registros a devolver en la consulta. \n
- project (Opcional): (Array[String]) Nombre de las propiedades que queremos ver en la respuesta. \n
- filter (Opcional): (Object) Permite especificar la consulta por propiedades especificas. ej:
{{\"source\": {\"type\": \"source\",\"data\": {\"id\": \"SOURCE01\"}}(traerá todas las rutas salientes de SOURCE01). \n
\n\n","urlObject":{"protocol":"https","path":["v3","routes","all"],"host":["{{subdomain}}-olm","omnixsystem","com"],"query":[],"variable":[]}},"response":[{"id":"cc1364b5-8330-4ef5-b8f7-888ae69398d8","name":"Get Routes","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"skipRecords\": 0,\n \"maxRecords\": 10,\n \"filter\": {\n \"source\": {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE01\"\n }\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://{{subdomain}}-olm.omnixsystem.com/v3/routes/all"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"e587f6ac-ed06-406b-97ce-0ec41a719b4a\",\n \"code\": 200,\n \"message\": {\n \"numRecordsReturned\": 1,\n \"skippedRecords\": 0,\n \"maxPages\": 1,\n \"totalRecordsMatched\": 1,\n \"records\": [\n {\n \"id\": \"route01\",\n \"source\": {\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"SOURCE01\",\n \"name\": \"Source\",\n \"alias\": \"sourceAlias\"\n }\n },\n \"target\": {\n \"type\": \"Location\",\n \"data\": {\n \"criteria0\": \"Colombia\",\n \"criteria1\": \"Atlantico\",\n \"criteria2\": \"Barranquilla\"\n }\n },\n \"status\": 1\n }\n ]\n }\n}"},{"id":"80c77b91-263a-46a4-b3bc-3195113acf08","name":"Get Routes - NO MATCH","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"skipRecords\": 0,\n \"maxRecords\": 10,\n \"filter\": {\n \"source\": {\n \"type\": \"source\",\n \"data\": {\n \"id\": \"SOURCE01\",\n \"name\": \"Source\",\n \"alias\": \"sourceAlias\"\n }\n },\n \"target\": {\n \"type\": \"location\",\n \"data\": {\n \"criteria0\": \"Colombia\",\n \"criteria1\": \"Atlantico\",\n \"criteria2\": \"Barranquilla\"\n }\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://{{subdomain}}-olm.omnixsystem.com/v3/routes/all"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"11f4d47b-9fca-4152-8435-e44b078e1a1d\",\n \"code\": 200,\n \"message\": {\n \"numRecordsReturned\": 0,\n \"skippedRecords\": 0,\n \"maxPages\": 0,\n \"totalRecordsMatched\": 0,\n \"records\": []\n }\n}"}],"_postman_id":"cb5b4b07-4c51-410c-99c4-2030892a1b6f"},{"name":"Remove routes","id":"94797fc4-9ed4-49ce-8d77-01f20dc20fb3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"ids\": [\"route01\"],\n \"comment\": \"remove from monitor\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{subdomain}}-olm.omnixsystem.com/v3/routes","description":"Si no se especifica project entonces se entregarán todas las propiedades públicas del modelo Route
\n
Servicio para eliminar Routes y todas sus coberturas.
\nMock Server
\nhttps://c6ec6c36-0750-406b-a4b0-52de03a0674e.mock.pstmn.io/v3/routes
Request
\n","urlObject":{"protocol":"https","path":["v3","routes"],"host":["{{subdomain}}-olm","omnixsystem","com"],"query":[],"variable":[]}},"response":[{"id":"3afcaab6-7741-4dc8-816b-ccfc9e3d8de0","name":"Remove routes","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"ids\": [\"route01\"],\n \"comment\": \"remove from monitor\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{subdomain}}-olm.omnixsystem.com/v3/routes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"326f89d0-5862-11e8-92a0-fb2a57096715\",\n \"code\": 200,\n \"message\": \"OK\"\n}"}],"_postman_id":"94797fc4-9ed4-49ce-8d77-01f20dc20fb3"}],"id":"b173cd9b-1001-4c3a-a26d-2d71b533cca8","_postman_id":"b173cd9b-1001-4c3a-a26d-2d71b533cca8","description":""}],"id":"6e272fb2-8067-45af-8b6a-50f560125a03","description":"A continuación se describen los servicios de administración para rutas coberturas
\n","_postman_id":"6e272fb2-8067-45af-8b6a-50f560125a03"},{"name":"Logistic Sources","item":[{"name":"Create/update Source","id":"432ddc6a-b26b-4c80-93e1-4f2193509881","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"STORE01\",\n \"name\": \"STORE01\",\n \"alias\": [\n \"STORE01\"\n ],\n \"dispatchCapacity\": [\n {\n \"daysOfWeek\": [\n 1,\n 2,\n 3,\n 4,\n 5\n ],\n \"productType\": [\n \"productType1\",\n \"productType2\"\n ],\n \"capacity\": 10,\n \"overCapacity\": 10,\n \"deliveryType\": \"normal\"\n },\n {\n \"daysOfWeek\": [\n 1,\n 2,\n 3,\n 4,\n 5\n ],\n \"productType\": [\n \"productType1\",\n \"productType2\"\n ],\n \"overCapacity\": 10,\n \"capacity\": 10,\n \"deliveryType\": \"express\"\n }\n ],\n \"volumeCapacity\": [\n {\n \"daysOfWeek\": [\n 1,\n 2,\n 3,\n 4,\n 5\n ],\n \"capacity\": 10\n }\n ],\n \"schedule\": [\n {\n \"deliveryType\": \"estandar\",\n \"shippingType\": [\n \"HD\",\n \"SP\"\n ],\n \"productType\": [\n \"productType1\",\n \"productType2\"\n ],\n \"leadtime\": {\n \"value\": 1,\n \"unit\": \"h\"\n },\n \"slots\": [\n {\n \"from\": \"08:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"17:00\",\n \"label\": \"PM\"\n }\n ]\n }\n ],\n \"crossdock\": [\n {\n \"productType\": [\n \"productType1\",\n \"productType2\"\n ],\n \"value\": 1,\n \"unit\": \"h\"\n }\n ],\n \"workingSessions\": [\n {\n \"daysOfWeek\": [\n 1,\n 2,\n 3,\n 4,\n 5,\n 6\n ],\n \"productType\": [\n \"productType1\",\n \"productType2\"\n ],\n \"from\": \"08:00\",\n \"to\": \"17:00\",\n \"lockTime\": {\n \"from\": \"12:00\",\n \"to\": \"13:00\"\n }\n }\n ],\n \"workingTime\": [\n {\n \"daysOfWeek\": [\n 1,\n 2,\n 3,\n 4,\n 5,\n 6\n ],\n \"from\": \"08:00\",\n \"to\": \"17:00\"\n }\n ],\n \"calendarSettings\": {\n \"timezone\": \"America/Santiago\",\n \"nonWorkingDates\": [\n \"08/21\"\n ],\n \"nonWorkingDays\": [\n 7\n ]\n }\n}"},"url":"https://{{subdomain}}-olm.omnixsystem.com/v3/sources","description":"Servicio para crear/actualizar Source (configuración logística), si este existe la información entonces es actualizada, si no, este será creado.
\nMock Server
\nhttps://c6ec6c36-0750-406b-a4b0-52de03a0674e.mock.pstmn.io/v3/sources
Request
\nCustom error message
\n","urlObject":{"protocol":"https","path":["v3","sources"],"host":["{{subdomain}}-olm","omnixsystem","com"],"query":[],"variable":[]}},"response":[{"id":"2125be53-7354-4b8e-8f38-2a22552d3dd3","name":"Create Single Source","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"STORE01\",\n \"name\": \"STORE01\",\n \"alias\": [\n \"STORE01\"\n ],\n \"dispatchCapacity\": [\n {\n \"daysOfWeek\": [\n 1,\n 2,\n 3,\n 4,\n 5\n ],\n \"productType\": [\n \"productType1\",\n \"productType2\"\n ],,\n \"overCapacity\": 10,\n \"deliveryType\": \"normal\",\n \"capacity\": 10\n }\n ],\n \"volumeCapacity\": [\n {\n \"daysOfWeek\": [\n 1,\n 2,\n 3,\n 4,\n 5\n ],\n \"capacity\": 10,\n \"overCapacity\": 10,\n }\n ],\n \"schedule\": [\n {\n \"deliveryType\": \"estandar\",\n \"shippingType\": [\n \"HD\",\n \"SP\"\n ],\n \"productType\": [\n \"productType1\",\n \"productType2\"\n ],\n \"leadtime\": {\n \"value\": 1,\n \"unit\": \"h\"\n },\n \"slots\": [\n {\n \"from\": \"08:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"17:00\",\n \"label\": \"PM\"\n }\n ]\n }\n ],\n \"crossdock\": [\n {\n \"productType\": [\n \"productType1\",\n \"productType2\"\n ],\n \"value\": 1,\n \"unit\": \"h\"\n }\n ],\n \"workingSessions\": [\n {\n \"daysOfWeek\": [\n 1,\n 2,\n 3,\n 4,\n 5,\n 6\n ],\n \"productType\": [\n \"productType1\",\n \"productType2\"\n ],\n \"from\": \"08:00\",\n \"to\": \"17:00\",\n \"lockTime\": {\n \"from\": \"12:00\",\n \"to\": \"13:00\"\n }\n }\n ],\n \"workingTime\": [\n {\n \"daysOfWeek\": [\n 1,\n 2,\n 3,\n 4,\n 5,\n 6\n ],\n \"from\": \"08:00\",\n \"to\": \"17:00\"\n }\n ],\n \"calendarSettings\": {\n \"timezone\": \"America/Santiago\",\n \"nonWorkingDates\": [\n \"08/21\"\n ],\n \"nonWorkingDays\": [\n 7\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://subdomain-olm.omnixsystem.com/v3/sources"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"326f89d0-5862-11e8-92a0-fb2a57096715\",\n \"code\": 200,\n \"message\": \"OK\"\n}"},{"id":"5296bd4a-4883-4679-9a0e-edd24828e9c9","name":"Create Multiple Sources","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"id\": \"STORE01\",\n \"name\": \"STORE01\",\n \"alias\": [\n \"STORE01\"\n ],\n \"dispatchCapacity\": [\n {\n \"daysOfWeek\": [\n 1,\n 2,\n 3,\n 4,\n 5\n ],\n \"productType\": [\n \"productType1\",\n \"productType2\"\n ],\n \"overCapacity\": 10,\n \"capacity\": 10,\n \"deliveryType\": \"normal\"\n }\n ],\n \"volumeCapacity\": [\n {\n \"daysOfWeek\": [\n 1,\n 2,\n 3,\n 4,\n 5\n ],\n \"capacity\": 10,\n \"overCapacity\": 10\n }\n ],\n \"schedule\": [\n {\n \"deliveryType\": \"estandar\",\n \"shippingType\": [\n \"HD\",\n \"SP\"\n ],\n \"productType\": [\n \"productType1\",\n \"productType2\"\n ],\n \"leadtime\": {\n \"value\": 1,\n \"unit\": \"h\"\n },\n \"slots\": [\n {\n \"from\": \"08:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"17:00\",\n \"label\": \"PM\"\n }\n ]\n }\n ],\n \"crossdock\": [\n {\n \"productType\": [\n \"productType1\",\n \"productType2\"\n ],\n \"value\": 1,\n \"unit\": \"h\"\n }\n ],\n \"workingSessions\": [\n {\n \"daysOfWeek\": [\n 1,\n 2,\n 3,\n 4,\n 5,\n 6\n ],\n \"productType\": [\n \"productType1\",\n \"productType2\"\n ],\n \"from\": \"08:00\",\n \"to\": \"17:00\",\n \"lockTime\": {\n \"from\": \"12:00\",\n \"to\": \"13:00\"\n }\n }\n ],\n \"workingTime\": [\n {\n \"daysOfWeek\": [\n 1,\n 2,\n 3,\n 4,\n 5,\n 6\n ],\n \"from\": \"08:00\",\n \"to\": \"17:00\"\n }\n ],\n \"calendarSettings\": {\n \"timezone\": \"America/Santiago\",\n \"nonWorkingDates\": [\n \"08/21\"\n ],\n \"nonWorkingDays\": [\n 7\n ]\n }\n }\n]","options":{"raw":{"language":"json"}}},"url":"https://subdomain-olm.omnixsystem.com/v3/sources"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"326f89d0-5862-11e8-92a0-fb2a57096715\",\n \"code\": 200,\n \"message\": \"OK\"\n}"},{"id":"73905a37-0d8d-4afc-8382-6fe373d7d4f1","name":"Create/update Source with dispatch capacity by productType","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"STORE01\",\n \"name\": \"STORE01\",\n \"alias\": [\n \"STORE01\"\n ],\n \"dispatchCapacity\": [\n {\n \"daysOfWeek\": [\n 1,\n 2,\n 3,\n 4,\n 5\n ],\n \"productType\": [\n \"productType1\"\n ],\n \"capacity\": 10,\n \"overCapacity\": 10,\n \"deliveryType\": \"normal\"\n },\n {\n \"daysOfWeek\": [\n 1,\n 2,\n 3,\n 4,\n 5\n ],\n \"productType\": [\n \"productType2\"\n ],\n \"overCapacity\": 10,\n \"capacity\": 10,\n \"deliveryType\": \"normal\"\n }\n ],\n \"volumeCapacity\": [\n {\n \"daysOfWeek\": [\n 1,\n 2,\n 3,\n 4,\n 5\n ],\n \"capacity\": 10\n }\n ],\n \"schedule\": [\n {\n \"deliveryType\": \"estandar\",\n \"shippingType\": [\n \"HD\",\n \"SP\"\n ],\n \"productType\": [\n \"productType1\",\n \"productType2\"\n ],\n \"leadtime\": {\n \"value\": 1,\n \"unit\": \"h\"\n },\n \"slots\": [\n {\n \"from\": \"08:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"17:00\",\n \"label\": \"PM\"\n }\n ]\n }\n ],\n \"crossdock\": [\n {\n \"productType\": [\n \"productType1\",\n \"productType2\"\n ],\n \"value\": 1,\n \"unit\": \"h\"\n }\n ],\n \"workingSessions\": [\n {\n \"daysOfWeek\": [\n 1,\n 2,\n 3,\n 4,\n 5,\n 6\n ],\n \"productType\": [\n \"productType1\",\n \"productType2\"\n ],\n \"from\": \"08:00\",\n \"to\": \"17:00\",\n \"lockTime\": {\n \"from\": \"12:00\",\n \"to\": \"13:00\"\n }\n }\n ],\n \"workingTime\": [\n {\n \"daysOfWeek\": [\n 1,\n 2,\n 3,\n 4,\n 5,\n 6\n ],\n \"from\": \"08:00\",\n \"to\": \"17:00\"\n }\n ],\n \"calendarSettings\": {\n \"timezone\": \"America/Santiago\",\n \"nonWorkingDates\": [\n \"08/21\"\n ],\n \"nonWorkingDays\": [\n 7\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://{{subdomain}}-olm.omnixsystem.com/v3/sources"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"326f89d0-5862-11e8-92a0-fb2a57096715\",\n \"code\": 200,\n \"message\": \"OK\"\n}"}],"_postman_id":"432ddc6a-b26b-4c80-93e1-4f2193509881"},{"name":"Query Sources","id":"376e2b02-d516-4fbb-a2e7-9c57bf31ae57","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Bearer {{token}}"}],"body":{"mode":"raw","raw":"{\n\t\"idsOrAliases\":[\"SOURCE01\"],\n\t\"project\": [\"id\", \"name\"]\n}"},"url":"https://{{subdomain}}-olm.omnixsystem.com/v3/sources","description":"Servicio para consultar multiples Sources por ids o aliases, además es posible especificar que propiedades específicas se requieren para la respuesta.
\nMock Server
\nhttps://c6ec6c36-0750-406b-a4b0-52de03a0674e.mock.pstmn.io/v3/sources
Request
\n","urlObject":{"protocol":"https","path":["v3","sources"],"host":["{{subdomain}}-olm","omnixsystem","com"],"query":[],"variable":[]}},"response":[{"id":"bab2dfeb-ad85-40c8-b67e-5bf0352c27ae","name":"Search Source","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"idsOrAliases\":[\"SOURCE01\"],\n\t\"project\": [\"id\", \"name\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://{{subdomain}}-olm.omnixsystem.com/v3/sources"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"326f89d0-5862-11e8-92a0-fb2a57096715\",\n \"code\": 200,\n \"message\": [\n {\n \"id\": \"SOURCE01\",\n \"name\": \"SOURCE01\"\n }\n ]\n}"}],"_postman_id":"376e2b02-d516-4fbb-a2e7-9c57bf31ae57"},{"name":"Get Source","id":"0d536413-0ae4-403d-a748-5f3912da231c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"https://{{subdomain}}-olm.omnixsystem.com/v3/sources/:sourceId","description":"Servicio para obtener Source por id
\nMock Server
\nhttps://c6ec6c36-0750-406b-a4b0-52de03a0674e.mock.pstmn.io/v3/sources/:sourceId
Path Parameters
\n- \n
- sourceId: Identificador del source. \n
Identificador del Source.
\n","type":"text/plain"},"type":"any","value":"STORE01","key":"sourceId"}]}},"response":[{"id":"c0120085-305e-43c9-b874-4a4b1ae6c6fe","name":"Get Source","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":{"raw":"https://{{subdomain}}-olm.omnixsystem.com/v3/sources/:sourceId","protocol":"https","host":["{{subdomain}}-olm","omnixsystem","com"],"path":["v3","sources",":sourceId"],"variable":[{"key":"sourceId","value":"STORE01","description":"Identificador del Source."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"326f89d0-5862-11e8-92a0-fb2a57096715\",\n \"code\": 200,\n \"message\": {\n \"id\": \"STORE01\",\n \"name\": \"STORE01\",\n \"alias\": \"STORE01\",\n \"dispatchCapacity\": [\n {\n \"daysOfWeek\": [\n 1,\n 2,\n 3,\n 4,\n 5\n ],\n \"productType\": [\n \"productType1\",\n \"productType2\"\n ],\n \"capacity\": 10\n }\n ],\n \"volumeCapacity\": [\n {\n \"daysOfWeek\": [\n 1,\n 2,\n 3,\n 4,\n 5\n ],\n \"capacity\": 10\n }\n ],\n \"schedule\": [\n {\n \"deliveryType\": \"estandar\",\n \"shippingType\": [\n \"HD\",\n \"SP\"\n ],\n \"productType\": [\n \"productType1\",\n \"productType2\"\n ],\n \"leadtime\": {\n \"value\": 1,\n \"unit\": \"h\"\n },\n \"slots\": [\n {\n \"from\": \"08:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"17:00\",\n \"label\": \"PM\"\n }\n ]\n }\n ],\n \"crossdock\": [\n {\n \"productType\": [\n \"productType1\",\n \"productType2\"\n ],\n \"value\": 1,\n \"unit\": \"h\"\n }\n ],\n \"workingSessions\": [\n {\n \"daysOfWeek\": [\n 1,\n 2,\n 3,\n 4,\n 5,\n 6\n ],\n \"productType\": [\n \"productType1\",\n \"productType2\"\n ],\n \"from\": \"08:00\",\n \"to\": \"17:00\",\n \"lockTime\": {\n \"from\": \"12:00\",\n \"to\": \"13:00\"\n }\n }\n ],\n \"workingTime\": [\n {\n \"daysOfWeek\": [\n 1,\n 2,\n 3,\n 4,\n 5,\n 6\n ],\n \"from\": \"08:00\",\n \"to\": \"17:00\"\n }\n ],\n \"calendarSettings\": {\n \"timezone\": \"America/Santiago\",\n \"nonWorkingDates\": [\n \"08/21\"\n ],\n \"nonWorkingDays\": [\n 7\n ]\n }\n }\n}"},{"id":"5e1ea611-206c-4a36-880b-f6c53a28b3fa","name":"Get Source - 404","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":{"raw":"https://{{subdomain}}-olm.omnixsystem.com/v3/sources/:sourceId","protocol":"https","host":["{{subdomain}}-olm","omnixsystem","com"],"path":["v3","sources",":sourceId"],"variable":[{"key":"sourceId","value":"STORE01","description":"Identificador del Source."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"326f89d0-5862-11e8-92a0-fb2a57096715\",\n \"code\": 404,\n \"message\": \"NOT FOUND\"\n}"}],"_postman_id":"0d536413-0ae4-403d-a748-5f3912da231c"},{"name":"Get Sources","id":"dbc5af67-1f4b-4e76-a894-dde5eb0067f4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"skipRecords\": 0,\n \"maxRecords\": 10,\n \"project\": [\n \"id\",\n \"name\",\n \"schedule\",\n \"crossdock\"\n ],\n \"filter\": {\n \"id\": \"STORE01\",\n \"name\": \"STORE01\",\n \"alias\": [\n \"STORE01\"\n ]\n }\n}"},"url":"https://{{subdomain}}-olm.omnixsystem.com/v3/sources/all","description":"Servicio para consultar todos los Sources de forma paginada y es posible filtrar por propiedades del modelo.
\nMock Server
\nhttps://c6ec6c36-0750-406b-a4b0-52de03a0674e.mock.pstmn.io/v3/sources/all
Request:
\n- \n
- skipRecords (Requerida): (Int) Cantidad de registros a saltarse en la consulta. \n
- maxRecords (Requerida): (Int) Cantidad de registros a devolver en la consulta. \n
- project (Opcional): (Array[String]) Nombre de las propiedades que queremos ver en la respuesta. \n
- filter (Opcional): (Object) Permite especificar la consulta por propiedades especificas. ej:
{\"id\": \"source01\"}(traerá solo sources que cumplan con esta condición). \n
\n\n","urlObject":{"protocol":"https","path":["v3","sources","all"],"host":["{{subdomain}}-olm","omnixsystem","com"],"query":[],"variable":[]}},"response":[{"id":"62de07d2-2f4e-4bab-9f35-f9ab46e82749","name":"Get Sources","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"skipRecords\": 0,\n \"maxRecords\": 10,\n \"project\": [\n \"id\",\n \"name\",\n \"schedule\",\n \"crossdock\"\n ],\n \"filter\": {\n \"id\": \"STORE01\",\n \"name\": \"STORE01\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://{{subdomain}}-olm.omnixsystem.com/v3/sources/all"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"e587f6ac-ed06-406b-97ce-0ec41a719b4a\",\n \"code\": 200,\n \"message\": {\n \"numRecordsReturned\": 1,\n \"skippedRecords\": 0,\n \"maxPages\": 1,\n \"totalRecordsMatched\": 1,\n \"records\": [\n {\n \"id\": \"STORE01\",\n \"name\": \"STORE01\",\n \"schedule\": [\n {\n \"deliveryType\": \"estandar\",\n \"shippingType\": [\n \"HD\",\n \"SP\"\n ],\n \"productType\": [\n \"productType1\",\n \"productType2\"\n ],\n \"leadtime\": {\n \"value\": 1,\n \"unit\": \"h\"\n },\n \"slots\": [\n {\n \"from\": \"08:00\",\n \"to\": \"11:59\",\n \"label\": \"AM\"\n },\n {\n \"from\": \"12:00\",\n \"to\": \"17:00\",\n \"label\": \"PM\"\n }\n ]\n }\n ],\n \"crossdock\": [\n {\n \"productType\": [\n \"productType1\",\n \"productType2\"\n ],\n \"value\": 1,\n \"unit\": \"h\"\n }\n ]\n }\n ]\n }\n}"},{"id":"97f2c7c0-ec2b-4480-8c6b-ebb6c5e718a3","name":"Get Sources - NO MATCH","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"skipRecords\": 0,\n \"maxRecords\": 10,\n \"project\": [\n \"id\",\n \"name\",\n \"schedule\",\n \"crossdock\"\n ],\n \"filter\": {\n \"id\": \"STORE01\",\n \"name\": \"STORE01\",\n \"alias\": [\n \"STORE01\"\n ]\n }\n}"},"url":"https://{{subdomain}}-olm.omnixsystem.com/v3/sources/all"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"11f4d47b-9fca-4152-8435-e44b078e1a1d\",\n \"code\": 200,\n \"message\": {\n \"numRecordsReturned\": 0,\n \"skippedRecords\": 0,\n \"maxPages\": 0,\n \"totalRecordsMatched\": 0,\n \"records\": []\n }\n}"}],"_postman_id":"dbc5af67-1f4b-4e76-a894-dde5eb0067f4"},{"name":"Remove Sources","id":"de0531da-f5e5-425d-ac2b-51a226e4d581","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"ids\": [\n \"source01\"\n ],\n \"comment\": \"remove from monitor\"\n}"},"url":"https://{{subdomain}}-olm.omnixsystem.com/v3/sources","description":"Si no se especifica project entonces se entregarán todas las propiedades públicas del modelo Courier
\n
Servicio para eliminar sources y todas sus coberturas.
\n\n\nAl eliminar uno o más Sources se borraran todas sus rutas entrantes o salientes y las coberturas de estas.
\n
Mock Server
\nhttps://c6ec6c36-0750-406b-a4b0-52de03a0674e.mock.pstmn.io/v3/sources
Request
\n","urlObject":{"protocol":"https","path":["v3","sources"],"host":["{{subdomain}}-olm","omnixsystem","com"],"query":[],"variable":[]}},"response":[{"id":"f50d9a14-2490-4397-aa91-e69a0b5ec1b0","name":"Remove Sources","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"ids\": [\n \"source01\"\n ],\n \"comment\": \"remove from monitor\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{subdomain}}-olm.omnixsystem.com/v3/sources"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"326f89d0-5862-11e8-92a0-fb2a57096715\",\n \"code\": 200,\n \"message\": \"OK\"\n}"}],"_postman_id":"de0531da-f5e5-425d-ac2b-51a226e4d581"}],"id":"6608163b-7a5e-4b74-a3ce-c6917c572555","description":"A continuación se describen los servicios de administración para sources
\n","_postman_id":"6608163b-7a5e-4b74-a3ce-c6917c572555"},{"name":"Calendar","item":[{"name":"Create/update Calendar settings","id":"887960e9-6085-479d-aafc-465e42185453","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"timezone\": \"America/Bogota\",\n\t\"nonWorkingDates\": [\n\t\t\"12/25\",\n\t\t\"01/01\"\n\t],\n\t\"nonWorkingDays\": [7]\n}","options":{"raw":{"language":"json"}}},"url":"https://{{subdomain}}-olm.omnixsystem.com/v3/calendar","description":"Servicio para crear o actualizar información del calendario del cliente. En caso de existir algún registro de calendario este solo será modificado. Cada cliente puede tener solo un calendario.
\nMock Server
\nhttps://c6ec6c36-0750-406b-a4b0-52de03a0674e.mock.pstmn.io/v3/calendar
Request
\n","urlObject":{"protocol":"https","path":["v3","calendar"],"host":["{{subdomain}}-olm","omnixsystem","com"],"query":[],"variable":[]}},"response":[{"id":"86c173fc-51b8-40c7-9d73-8aeb5f76dcb2","name":"Create/update Calendar settings","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"timezone\": \"America/Bogota\",\n\t\"nonWorkingDates\": [\n\t\t\"12/25\",\n\t\t\"01/01\"\n\t],\n\t\"nonWorkingDays\": [7]\n}","options":{"raw":{"language":"json"}}},"url":"https://{{subdomain}}-olm.omnixsystem.com/v3/calendar"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"326f89d0-5862-11e8-92a0-fb2a57096715\",\n \"code\": 200,\n \"message\": \"OK\"\n}"}],"_postman_id":"887960e9-6085-479d-aafc-465e42185453"},{"name":"Get Calendar settings","id":"885f82af-bb08-476c-8069-f91a99fff086","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"https://{{subdomain}}-olm.omnixsystem.com/v3/calendar","description":"Servicio para consultar configuración del calendario.
\n","urlObject":{"protocol":"https","path":["v3","calendar"],"host":["{{subdomain}}-olm","omnixsystem","com"],"query":[],"variable":[]}},"response":[{"id":"f2b75897-491a-45c9-9e16-468de619c0c3","name":"Get Calendar settings","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"https://{{subdomain}}-olm.omnixsystem.com/v3/calendar"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"326f89d0-5862-11e8-92a0-fb2a57096715\",\n \"code\": 200,\n \"message\": {\n \"id\":\"calendar01\",\n \"timezone\": \"America/Bogota\",\n \"nonWorkingDates\": [\n \"12/25\",\n \"01/01\"\n ],\n \"nonWorkingDays\": [\n 7\n ]\n }\n}"}],"_postman_id":"885f82af-bb08-476c-8069-f91a99fff086"}],"id":"8acdd142-9f18-46e6-98cd-11f6d20a4344","description":"A continuación se describen los servicios de administración de configuraciones generales de calendario
\n","_postman_id":"8acdd142-9f18-46e6-98cd-11f6d20a4344"},{"name":"Locations","item":[{"name":"Create/update Location","id":"63c33afa-562b-43ba-92c1-0302547fdbc2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"criteria0\": \"Colombia\",\n \"criteria1\": \"Atlántico\",\n \"criteria2\": \"Barranquilla\"\n}"},"url":"https://{{subdomain}}-olm.omnixsystem.com/v3/locations","description":"Servicio de creación o actualización de Locations
\nMock Server
\nhttps://c6ec6c36-0750-406b-a4b0-52de03a0674e.mock.pstmn.io/v3/locations
Request
\n","urlObject":{"protocol":"https","path":["v3","locations"],"host":["{{subdomain}}-olm","omnixsystem","com"],"query":[],"variable":[]}},"response":[{"id":"fb80f1d4-5d39-4152-9539-217ae595cd35","name":"Create single Location","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"criteria0\": \"Colombia\",\n \"criteria1\": \"Atlántico\",\n \"criteria2\": \"Barranquilla\",\n \"custom\": {\n \"type\": \"distrito\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://{{subdomain}}-olm.omnixsystem.com/v3/locations"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"326f89d0-5862-11e8-92a0-fb2a57096715\",\n \"code\": 200,\n \"message\": \"OK\"\n}"},{"id":"6b9ce5ce-4b7f-4dcc-87b4-5b8f3db8961d","name":"Create multiple Location","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"criteria0\": \"Colombia\",\n \"criteria1\": \"Atlántico\",\n \"criteria2\": \"Barranquilla\"\n }\n]","options":{"raw":{"language":"json"}}},"url":"https://{{subdomain}}-olm.omnixsystem.com/v3/locations"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"326f89d0-5862-11e8-92a0-fb2a57096715\",\n \"code\": 200,\n \"message\": \"OK\"\n}"}],"_postman_id":"63c33afa-562b-43ba-92c1-0302547fdbc2"},{"name":"Get Locations","id":"b193e749-213b-4694-88d6-a872b110e9c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"https://{{subdomain}}-olm.omnixsystem.com/v3/locations","description":"Servicio para consultar Locations por criterias.
\nExamples
\n1. Obtener criteria0 de todos los locations
\nhttps://subdomain-olm.omnixsystem.com/v3/locations
2. Obtener criteria1 de todos los locations con un criteria0 especifico
\nhttps://subdomain-olm.omnixsystem.com/v3/locations?criteria0=CHILE
3. Obtener toda la información de un locations especifico a partir de criteria0 y criteria1
\nhttps://subdomain-olm.omnixsystem.com/v3/locations?criteria0=CHILE&criteria1=Santiago
\n\n","urlObject":{"protocol":"https","path":["v3","locations"],"host":["{{subdomain}}-olm","omnixsystem","com"],"query":[{"disabled":true,"description":{"content":"Para entender el contexto de cada criteria revisar las estrategias de logistica
\n
String
\n","type":"text/plain"},"key":"Criteria0","value":""},{"disabled":true,"description":{"content":"String
\n","type":"text/plain"},"key":"Criteria1","value":""},{"disabled":true,"description":{"content":"String
\n","type":"text/plain"},"key":"Criteria2","value":""},{"disabled":true,"description":{"content":"String
\n","type":"text/plain"},"key":"Criteria3","value":""}],"variable":[]}},"response":[{"id":"dd66d17a-98b5-4fe2-9363-075d2e0000f4","name":"Get criteria 0 from all Locations","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://{{subdomain}}-olm.omnixsystem.com/v3/locations","protocol":"https","host":["{{subdomain}}-olm","omnixsystem","com"],"path":["v3","locations"],"query":[{"key":"Criteria0","value":null,"description":"String","disabled":true},{"key":"Criteria1","value":null,"description":"String","disabled":true},{"key":"Criteria2","value":null,"description":"String","disabled":true},{"key":"Criteria3","value":null,"description":"String","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"326f89d0-5862-11e8-92a0-fb2a57096715\",\n \"code\": 200,\n \"message\": [\n {\n \"id\":\"location001\",\n \"criteria0\": \"CHILE\"\n }\n ]\n}"},{"id":"8c6a119c-539e-4317-85e1-c311a5ccafa7","name":"Get Criteria1 from all Locations with specific Criteria0","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":{"raw":"https://{{subdomain}}-olm.omnixsystem.com/v3/locations?Criteria0=CHILE","protocol":"https","host":["{{subdomain}}-olm","omnixsystem","com"],"path":["v3","locations"],"query":[{"key":"Criteria0","value":"CHILE","description":"String"},{"key":"Criteria1","value":"","description":"String","disabled":true},{"key":"Criteria2","value":"","description":"String","disabled":true},{"key":"Criteria3","value":"","description":"String","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"326f89d0-5862-11e8-92a0-fb2a57096715\",\n \"code\": 200,\n \"message\": [\n {\n \"id\":\"location001\",\n \"criteria0\": \"CHILE\",\n \"criteria1\": \"Region Metropolitana de Santiago\"\n },\n {\n \"id\":\"location002\",\n \"criteria0\": \"CHILE\",\n \"criteria1\": \"Region de Valparaíso\"\n },\n {\n \"id\":\"location003\",\n \"criteria0\": \"CHILE\",\n \"criteria1\": \"Region de O'Higgins\"\n }\n ]\n}"},{"id":"d8e76a0a-76e1-4865-9dd9-ad4f5a075ffe","name":"Get Criteria2 from all Locations with specific Criteria0 and Criteria 1","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":{"raw":"https://{{subdomain}}-olm.omnixsystem.com/v3/locations?Criteria0=CHILE&Criteria1=Region Metropolitana de Santiago","protocol":"https","host":["{{subdomain}}-olm","omnixsystem","com"],"path":["v3","locations"],"query":[{"key":"Criteria0","value":"CHILE","description":"String"},{"key":"Criteria1","value":"Region Metropolitana de Santiago","description":"String"},{"key":"Criteria2","value":null,"description":"String","disabled":true},{"key":"Criteria3","value":null,"description":"String","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"","value":"","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"326f89d0-5862-11e8-92a0-fb2a57096715\",\n \"code\": 200,\n \"message\": [\n {\n \"id\":\"location001\",\n \"criteria0\": \"CHILE\",\n \"criteria1\": \"Region Metropolitana de Santiago\",\n \"criteria2\": \"Santiago\",\n \"criteria3\": [],\n \"criteria4\": []\n },\n {\n \"id\":\"location002\",\n \"criteria0\": \"CHILE\",\n \"criteria1\": \"Region Metropolitana de Santiago\",\n \"criteria2\": \"Las Condes\",\n \"criteria3\": [],\n \"criteria4\": []\n }\n ]\n}"}],"_postman_id":"b193e749-213b-4694-88d6-a872b110e9c5"},{"name":"Filter locations","id":"0c0e7b13-148c-4d43-872e-0359e11f7328","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"skipRecords\": 0,\n \"maxRecords\": 10,\n \"project\": [\n \"id\",\n \"criteria0\",\n \"criteria1\"\n ],\n \"filter\": {\n \"id\": \"\",\n \"criteria0\": \"Colombia\",\n \"criteria1\": \"Atlantico\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://{{subdomain}}-olm.omnixsystem.com/v3/locations/all","description":"Servicio para consultar todos los locations de forma paginada y es posible filtrar por propiedades del modelo.
\nMock Server
\nhttps://c6ec6c36-0750-406b-a4b0-52de03a0674e.mock.pstmn.io/v3/locations/all
Request:
\n- \n
- skipRecords (Requerida): (Int) Cantidad de registros a saltarse en la consulta. \n
- maxRecords (Requerida): (Int) Cantidad de registros a devolver en la consulta. \n
- project (Opcional): (Array[String]) Nombre de las propiedades que queremos ver en la respuesta. \n
- filter (Opcional): (Object) Permite especificar la consulta por propiedades especificas. ej:
{\"criteria0\": \"Colombia\"}(traerá solo los locations cuyo criteria0 sea Colombia). \n
\n\n","urlObject":{"protocol":"https","path":["v3","locations","all"],"host":["{{subdomain}}-olm","omnixsystem","com"],"query":[],"variable":[]}},"response":[{"id":"35fa3978-ae9e-4561-a74d-64ed02c0eb16","name":"Get Locations","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"skipRecords\": 0,\n \"maxRecords\": 10,\n \"project\": [\n \"id\",\n \"criteria0\",\n \"criteria1\"\n ],\n \"filter\": {\n \"id\": \"\",\n \"criteria0\": \"Colombia\",\n \"criteria1\": \"Atlantico\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://subdomain-olm.omnixsystem.com/v3/locations/all"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"e587f6ac-ed06-406b-97ce-0ec41a719b4a\",\n \"code\": 200,\n \"message\": {\n \"numRecordsReturned\": 1,\n \"skippedRecords\": 0,\n \"maxPages\": 1,\n \"totalRecordsMatched\": 1,\n \"records\": [\n {\n \"id\": \"ARAUCANIATEMUCOCAJON AL CAMPO\",\n \"criteria0\": \"Colombia\",\n \"criteria1\": \"Atlantico\"\n }\n ]\n }\n}"}],"_postman_id":"0c0e7b13-148c-4d43-872e-0359e11f7328"},{"name":"Get Location by id","id":"3c228516-d2a3-4fe9-acc7-d4502e2927b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Bearer {{token}}"}],"url":"https://{{subdomain}}-olm.omnixsystem.com/v3/locations/:locationId","description":"Si no se especifica project entonces se entregarán todas las propiedades públicas del modelo Locations
\n
Servicio para obtener Location por id
\nMock Server
\nhttps://c6ec6c36-0750-406b-a4b0-52de03a0674e.mock.pstmn.io/v3/locations/:locationId
Path parameters
\n- \n
- locationId: Identificador del location. \n
Servicio para eliminar locations y todas sus coberturas.
\n\n\nAl eliminar uno o más Locations se borraran todas sus rutas entrantes o salientes y las coberturas de estas.
\n
Mock Server
\nhttps://c6ec6c36-0750-406b-a4b0-52de03a0674e.mock.pstmn.io/v3/locations
Request
\n","urlObject":{"protocol":"https","path":["v3","locations"],"host":["{{subdomain}}-olm","omnixsystem","com"],"query":[],"variable":[]}},"response":[{"id":"b15885ea-1f0e-4bf8-8ff2-47b39ba26995","name":"Remove Sources","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"ids\": [\n \"location001\"\n ],\n \"comment\": \"remove from monitor\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{subdomain}}-olm.omnixsystem.com/v3/locations"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"326f89d0-5862-11e8-92a0-fb2a57096715\",\n \"code\": 200,\n \"message\": \"OK\"\n}"}],"_postman_id":"07439873-1b6f-44de-aa38-7bb0cabe5ac3"}],"id":"1ecc1c3f-a546-4a70-a525-15bd0b0153fc","_postman_id":"1ecc1c3f-a546-4a70-a525-15bd0b0153fc","description":""},{"name":"Capacity","item":[{"name":"Reserve Capacity","id":"a7dda7cb-5d59-420f-be89-b0fbd8405514","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"entity\": {\n \"id\": \"STORE01\",\n \"type\": \"source\"\n },\n \"type\": \"dispatch\",\n \"productType\": [\n \"productType01\",\n \"productType02\"\n ],\n \"key\": \"key01\",\n \"quantity\": 1,\n \"dates\": {\n \"from\": \"2020-10-27\",\n \"to\": \"2020-10-27\"\n }\n}"},"url":"https://{{subdomain}}-olm.omnixsystem.com/v3/capacity","description":"Servicio para crear reservas de capacidades por entidad.
\nMock Server
\nhttps://c6ec6c36-0750-406b-a4b0-52de03a0674e.mock.pstmn.io/v3/capacity
Request
\nCustom error message
\n","urlObject":{"protocol":"https","path":["v3","capacity"],"host":["{{subdomain}}-olm","omnixsystem","com"],"query":[],"variable":[]}},"response":[{"id":"7fd37cbd-088e-485a-99ba-0dd914f1c1fa","name":"Reserve Capacity 200","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"entity\": {\n \"id\": \"STORE01\",\n \"type\": \"source\"\n },\n \"type\": \"dispatch\",\n \"productType\": [\n \"productType01\",\n \"productType02\"\n ],\n \"deliveryType\": \"normal\",\n \"key\": \"key01\",\n \"quantity\": 1,\n \"dates\": {\n \"from\": \"2020-10-27\",\n \"to\": \"2020-10-27\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://subdomain-olm.omnixsystem.com/v3/capacity"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"326f89d0-5862-11e8-92a0-fb2a57096715\",\n \"code\": 200,\n \"message\": \"OK\"\n}"},{"id":"b198ab5d-d517-41e6-9808-dedcaeaad1da","name":"Reserve Capacity 500","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"entity\": {\n \"id\": \"STORE01\",\n \"type\": \"source\"\n },\n \"type\": \"volume\",\n \"productType\": [\n \"productType01\",\n \"productType02\"\n ],\n \"key\": \"key01\",\n \"quantity\": 1,\n \"dates\": {\n \"from\": \"2020-10-27\",\n \"to\": \"2020-10-27\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://subdomain-olm.omnixsystem.com/v3/capacity"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"4ec7bcd7-9a62-4a9f-92b0-a36d8947ff9f\",\n \"code\": 500,\n \"message\": \"NotAvailableCapacityException: 2020-10-27\"\n}"}],"_postman_id":"a7dda7cb-5d59-420f-be89-b0fbd8405514"},{"name":"Get capacity by period","id":"d970b7ac-ee82-474c-a1f6-71c03b746adb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Bearer {{token}}"}],"url":"https://{{subdomain}}-olm.omnixsystem.com/v3/capacity?dateFrom=2020-10-17&dateTo=2020-10-17","description":"Servicio para consultar capacidades.
\nMock Server
\nhttps://c6ec6c36-0750-406b-a4b0-52de03a0674e.mock.pstmn.io/v3/capacity
Query Params
\n","urlObject":{"protocol":"https","path":["v3","capacity"],"host":["{{subdomain}}-olm","omnixsystem","com"],"query":[{"disabled":true,"key":"entityType","value":"source"},{"disabled":true,"key":"entityId","value":"STORE01"},{"disabled":true,"key":"productType","value":"productType1,productType2"},{"key":"dateFrom","value":"2020-10-17"},{"key":"dateTo","value":"2020-10-17"},{"disabled":true,"key":"skipRecords","value":""},{"disabled":true,"key":"maxRecords","value":""}],"variable":[]}},"response":[{"id":"be42c21f-57ab-45ad-9fb4-1c60374a48ca","name":"Get Capacity by period | empty","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":{"raw":"https://subdomain-olm.omnixsystem.com/v3/capacity?entityId=STORE01&productType=productType1,productType2&dateFrom=2020-10-17&dateTo=2020-10-17","protocol":"https","host":["subdomain-olm","omnixsystem","com"],"path":["v3","capacity"],"query":[{"key":"entityId","value":"STORE01"},{"key":"productType","value":"productType1,productType2"},{"key":"dateFrom","value":"2020-10-17"},{"key":"dateTo","value":"2020-10-17"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"326f89d0-5862-11e8-92a0-fb2a57096715\",\n \"code\": 404,\n \"message\": \"NOT_FOUND\"\n}"},{"id":"d63c40c1-307f-42bf-8153-f9e30dd25357","name":"Get Capacity by period","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":{"raw":"https://subdomain-olm.omnixsystem.com/v3/capacity?entityId=STORE01&productType=productType1,productType2&dateFrom=2020-10-17&dateTo=2020-10-17","protocol":"https","host":["subdomain-olm","omnixsystem","com"],"path":["v3","capacity"],"query":[{"key":"entityId","value":"STORE01"},{"key":"productType","value":"productType1,productType2"},{"key":"dateFrom","value":"2020-10-17"},{"key":"dateTo","value":"2020-10-17"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"af3889c6-4ce6-41cc-ba1f-001232f0fea9\",\n \"code\": 200,\n \"message\": {\n \"numRecordsReturned\": 10,\n \"skippedRecords\": 0,\n \"maxPages\": 13,\n \"totalRecordsMatched\": 121,\n \"records\": [\n {\n \"id\": \"FWQTYQ9WKT1XGIEV\",\n \"entity\": {\n \"id\": \"C230-H001\",\n \"type\": \"source\"\n },\n \"type\": \"dispatch\",\n \"deliveryType\": \"SD\",\n \"productType\": [\n \"ACCESORIOS\",\n \"COMPUTADOR ESCRITORIO\",\n \"CONSOLAS\",\n \"HANDSETS (TELÉFONOS)\",\n \"PARLANTES DE SONIDO\",\n \"PATINETAS\",\n \"PEQUEÑO\",\n \"PORTATILES\",\n \"SIM CARDS\",\n \"Smartphone\",\n \"TARJETAS PREPAGO\",\n \"TELEVISORES\"\n ],\n \"date\": \"2021-09-02T00:00:00.000Z\",\n \"maxCapacity\": 3,\n \"usedCapacity\": 3,\n \"details\": [\n {\n \"key\": \"FWQTYQ9WKT1XGICS\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n },\n {\n \"key\": \"FWQTYQ9WKT1XH43X\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n },\n {\n \"key\": \"FWQTYQ9WKT1XM8YZ\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n }\n ]\n },\n {\n \"id\": \"FWQTYQ9WKT1XM97Y\",\n \"entity\": {\n \"id\": \"TCC\",\n \"type\": \"courier\"\n },\n \"type\": \"volume\",\n \"productType\": [\n \"ACCESORIOS\",\n \"COMPUTADOR ESCRITORIO\",\n \"CONSOLAS\",\n \"HANDSETS (TELÉFONOS)\",\n \"PARLANTES DE SONIDO\",\n \"PATINETAS\",\n \"PEQUEÑO\",\n \"PORTATILES\",\n \"SIM CARDS\",\n \"Smartphone\",\n \"TARJETAS PREPAGO\",\n \"TELEVISORES\"\n ],\n \"date\": \"2021-09-02T00:00:00.000Z\",\n \"maxCapacity\": 10000,\n \"usedCapacity\": 1,\n \"details\": [\n {\n \"key\": \"FWQTYQ9WKT1XM8YZ\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n },\n {\n \"key\": \"3YHX8F88KT2XK7WQ\",\n \"status\": \"reserved\",\n \"usedCapacity\": 0\n },\n {\n \"key\": \"5KE9T8KT30YEM4\",\n \"status\": \"reserved\",\n \"usedCapacity\": 0\n },\n {\n \"key\": \"B5LVLY9KT3BV4SY\",\n \"status\": \"reserved\",\n \"usedCapacity\": 0\n }\n ]\n },\n {\n \"id\": \"3YHX8F88KT2XK7XL\",\n \"entity\": {\n \"id\": \"C431-H001\",\n \"type\": \"source\"\n },\n \"type\": \"dispatch\",\n \"deliveryType\": \"SD\",\n \"productType\": [\n \"ACCESORIOS\",\n \"COMPUTADOR ESCRITORIO\",\n \"CONSOLAS\",\n \"HANDSETS (TELÉFONOS)\",\n \"PARLANTES DE SONIDO\",\n \"PATINETAS\",\n \"PEQUEÑO\",\n \"PORTATILES\",\n \"SIM CARDS\",\n \"Smartphone\",\n \"TARJETAS PREPAGO\",\n \"TELEVISORES\"\n ],\n \"date\": \"2021-09-02T00:00:00.000Z\",\n \"maxCapacity\": 10000,\n \"usedCapacity\": 3,\n \"details\": [\n {\n \"key\": \"3YHX8F88KT2XK7WQ\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n },\n {\n \"key\": \"5KE9T8KT30YEM4\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n },\n {\n \"key\": \"B5LVLY9KT3BV4SY\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n }\n ]\n },\n {\n \"id\": \"FWQTYQ9WKT1XM97Z\",\n \"entity\": {\n \"id\": \"TCC\",\n \"type\": \"courier\"\n },\n \"type\": \"volume\",\n \"productType\": [\n \"ACCESORIOS\",\n \"COMPUTADOR ESCRITORIO\",\n \"CONSOLAS\",\n \"HANDSETS (TELÉFONOS)\",\n \"PARLANTES DE SONIDO\",\n \"PATINETAS\",\n \"PEQUEÑO\",\n \"PORTATILES\",\n \"SIM CARDS\",\n \"Smartphone\",\n \"TARJETAS PREPAGO\",\n \"TELEVISORES\"\n ],\n \"date\": \"2021-09-03T00:00:00.000Z\",\n \"maxCapacity\": 10000,\n \"usedCapacity\": 3,\n \"details\": [\n {\n \"key\": \"FWQTYQ9WKT1XM8YZ\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n },\n {\n \"key\": \"FWQTYQ9WKT1XOHJJ\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n },\n {\n \"key\": \"FWQTYQ9WKT1YCUQR\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n },\n {\n \"key\": \"3YHX8F88KT2XK7WQ\",\n \"status\": \"reserved\",\n \"usedCapacity\": 0\n },\n {\n \"key\": \"5KE9T8KT30YEM4\",\n \"status\": \"reserved\",\n \"usedCapacity\": 0\n },\n {\n \"key\": \"B5LVLY9KT3BV4SY\",\n \"status\": \"reserved\",\n \"usedCapacity\": 0\n }\n ]\n },\n {\n \"id\": \"FWQTYQ9WKT1XOHLM\",\n \"entity\": {\n \"id\": \"C230-H001\",\n \"type\": \"source\"\n },\n \"type\": \"dispatch\",\n \"deliveryType\": \"SD\",\n \"productType\": [\n \"ACCESORIOS\",\n \"COMPUTADOR ESCRITORIO\",\n \"CONSOLAS\",\n \"HANDSETS (TELÉFONOS)\",\n \"PARLANTES DE SONIDO\",\n \"PATINETAS\",\n \"PEQUEÑO\",\n \"PORTATILES\",\n \"SIM CARDS\",\n \"Smartphone\",\n \"TARJETAS PREPAGO\",\n \"TELEVISORES\"\n ],\n \"date\": \"2021-09-03T00:00:00.000Z\",\n \"maxCapacity\": 2,\n \"usedCapacity\": 2,\n \"details\": [\n {\n \"key\": \"FWQTYQ9WKT1XOHJJ\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n },\n {\n \"key\": \"FWQTYQ9WKT1YCUQR\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n }\n ]\n },\n {\n \"id\": \"FWQTYQ9WKT1XOHSC\",\n \"entity\": {\n \"id\": \"TCC\",\n \"type\": \"courier\"\n },\n \"type\": \"volume\",\n \"productType\": [\n \"ACCESORIOS\",\n \"COMPUTADOR ESCRITORIO\",\n \"CONSOLAS\",\n \"HANDSETS (TELÉFONOS)\",\n \"PARLANTES DE SONIDO\",\n \"PATINETAS\",\n \"PEQUEÑO\",\n \"PORTATILES\",\n \"SIM CARDS\",\n \"Smartphone\",\n \"TARJETAS PREPAGO\",\n \"TELEVISORES\"\n ],\n \"date\": \"2021-09-04T00:00:00.000Z\",\n \"maxCapacity\": 10000,\n \"usedCapacity\": 4,\n \"details\": [\n {\n \"key\": \"FWQTYQ9WKT1XOHJJ\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n },\n {\n \"key\": \"FWQTYQ9WKT1YCUQR\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n },\n {\n \"key\": \"FWQTYV0NKT1Z81LJ\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n },\n {\n \"key\": \"FWQTYVAYKT1Z9Q7C\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n },\n {\n \"key\": \"C8ITM8KT21BAVW\",\n \"status\": \"reserved\",\n \"usedCapacity\": 0\n },\n {\n \"key\": \"MAXG8KT21QRE9\",\n \"status\": \"reserved\",\n \"usedCapacity\": 0\n },\n {\n \"key\": \"MAXG8KT21VPMY\",\n \"status\": \"reserved\",\n \"usedCapacity\": 0\n },\n {\n \"key\": \"MAXG8KT21ZVEP\",\n \"status\": \"reserved\",\n \"usedCapacity\": 0\n },\n {\n \"key\": \"3YHX8F88KT2XK7WQ\",\n \"status\": \"reserved\",\n \"usedCapacity\": 0\n },\n {\n \"key\": \"5KE9T8KT30YEM4\",\n \"status\": \"reserved\",\n \"usedCapacity\": 0\n },\n {\n \"key\": \"B5LVLY9KT3BV4SY\",\n \"status\": \"reserved\",\n \"usedCapacity\": 0\n }\n ]\n },\n {\n \"id\": \"FWQTYV0NKT1Z81NE\",\n \"entity\": {\n \"id\": \"C230-H001\",\n \"type\": \"source\"\n },\n \"type\": \"dispatch\",\n \"deliveryType\": \"SD\",\n \"productType\": [\n \"ACCESORIOS\",\n \"COMPUTADOR ESCRITORIO\",\n \"CONSOLAS\",\n \"HANDSETS (TELÉFONOS)\",\n \"PARLANTES DE SONIDO\",\n \"PATINETAS\",\n \"PEQUEÑO\",\n \"PORTATILES\",\n \"SIM CARDS\",\n \"Smartphone\",\n \"TARJETAS PREPAGO\",\n \"TELEVISORES\"\n ],\n \"date\": \"2021-09-04T00:00:00.000Z\",\n \"maxCapacity\": 10000,\n \"usedCapacity\": 6,\n \"details\": [\n {\n \"key\": \"FWQTYV0NKT1Z81LJ\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n },\n {\n \"key\": \"FWQTYVAYKT1Z9Q7C\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n },\n {\n \"key\": \"C8ITM8KT21BAVW\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n },\n {\n \"key\": \"MAXG8KT21QRE9\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n },\n {\n \"key\": \"MAXG8KT21VPMY\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n },\n {\n \"key\": \"MAXG8KT21ZVEP\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n }\n ]\n },\n {\n \"id\": \"FWQTYV0NKT1Z81TE\",\n \"entity\": {\n \"id\": \"TCC\",\n \"type\": \"courier\"\n },\n \"type\": \"volume\",\n \"productType\": [\n \"ACCESORIOS\",\n \"COMPUTADOR ESCRITORIO\",\n \"CONSOLAS\",\n \"HANDSETS (TELÉFONOS)\",\n \"PARLANTES DE SONIDO\",\n \"PATINETAS\",\n \"PEQUEÑO\",\n \"PORTATILES\",\n \"SIM CARDS\",\n \"Smartphone\",\n \"TARJETAS PREPAGO\",\n \"TELEVISORES\"\n ],\n \"date\": \"2021-09-06T00:00:00.000Z\",\n \"maxCapacity\": 10000,\n \"usedCapacity\": 2,\n \"details\": [\n {\n \"key\": \"FWQTYV0NKT1Z81LJ\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n },\n {\n \"key\": \"FWQTYVAYKT1Z9Q7C\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n },\n {\n \"key\": \"C8ITM8KT21BAVW\",\n \"status\": \"reserved\",\n \"usedCapacity\": 0\n },\n {\n \"key\": \"MAXG8KT21QRE9\",\n \"status\": \"reserved\",\n \"usedCapacity\": 0\n },\n {\n \"key\": \"MAXG8KT21VPMY\",\n \"status\": \"reserved\",\n \"usedCapacity\": 0\n },\n {\n \"key\": \"MAXG8KT21ZVEP\",\n \"status\": \"reserved\",\n \"usedCapacity\": 0\n },\n {\n \"key\": \"3YHX8F88KT2XK7WQ\",\n \"status\": \"reserved\",\n \"usedCapacity\": 0\n },\n {\n \"key\": \"5KE9T8KT30YEM4\",\n \"status\": \"reserved\",\n \"usedCapacity\": 0\n },\n {\n \"key\": \"B5LVLY9KT3BV4SY\",\n \"status\": \"reserved\",\n \"usedCapacity\": 0\n }\n ]\n },\n {\n \"id\": \"T83PYV8KT96OPKC\",\n \"entity\": {\n \"id\": \"C230-H001\",\n \"type\": \"source\"\n },\n \"type\": \"dispatch\",\n \"deliveryType\": \"SD\",\n \"productType\": [\n \"ACCESORIOS\",\n \"COMPUTADOR ESCRITORIO\",\n \"CONSOLAS\",\n \"HANDSETS (TELÉFONOS)\",\n \"PARLANTES DE SONIDO\",\n \"PATINETAS\",\n \"PEQUEÑO\",\n \"PORTATILES\",\n \"SIM CARDS\",\n \"Smartphone\",\n \"TARJETAS PREPAGO\",\n \"TELEVISORES\"\n ],\n \"date\": \"2021-09-06T00:00:00.000Z\",\n \"maxCapacity\": 10000,\n \"usedCapacity\": 15,\n \"details\": [\n {\n \"key\": \"T83PYV8KT96OPJY\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n },\n {\n \"key\": \"T83PYV8KT96RI7D\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n },\n {\n \"key\": \"T83PYV8KT96TNMB\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n },\n {\n \"key\": \"T83PYV8KT96Z1P7\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n },\n {\n \"key\": \"T83PYV8KT974QFO\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n },\n {\n \"key\": \"T83PYV8KT975FJN\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n },\n {\n \"key\": \"T83PYV8KT975TQD\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n },\n {\n \"key\": \"T83PYV8KT9766O9\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n },\n {\n \"key\": \"T83PYV8KT976I2C\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n },\n {\n \"key\": \"T83PYV8KT976UVB\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n },\n {\n \"key\": \"T83PYV8KT977P5V\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n },\n {\n \"key\": \"NJ8YU9KT9A3KUB\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n },\n {\n \"key\": \"NJ8YU9KT9A4LGG\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n },\n {\n \"key\": \"7GF8KT9B09W9\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n },\n {\n \"key\": \"7GF8KT9B1J0T\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n }\n ]\n },\n {\n \"id\": \"T83PYV8KT96OPKD\",\n \"entity\": {\n \"id\": \"C230-H001\",\n \"type\": \"source\"\n },\n \"type\": \"dispatch\",\n \"deliveryType\": \"SD\",\n \"productType\": [\n \"ACCESORIOS\",\n \"COMPUTADOR ESCRITORIO\",\n \"CONSOLAS\",\n \"HANDSETS (TELÉFONOS)\",\n \"PARLANTES DE SONIDO\",\n \"PATINETAS\",\n \"PEQUEÑO\",\n \"PORTATILES\",\n \"SIM CARDS\",\n \"Smartphone\",\n \"TARJETAS PREPAGO\",\n \"TELEVISORES\"\n ],\n \"date\": \"2021-09-07T00:00:00.000Z\",\n \"maxCapacity\": 10000,\n \"usedCapacity\": 26,\n \"details\": [\n {\n \"key\": \"T83PYV8KT96OPJY\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n },\n {\n \"key\": \"T83PYV8KT96RI7D\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n },\n {\n \"key\": \"T83PYV8KT96TNMB\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n },\n {\n \"key\": \"T83PYV8KT96Z1P7\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n },\n {\n \"key\": \"T83PYV8KT974QFO\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n },\n {\n \"key\": \"T83PYV8KT975FJN\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n },\n {\n \"key\": \"T83PYV8KT975TQD\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n },\n {\n \"key\": \"T83PYV8KT9766O9\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n },\n {\n \"key\": \"T83PYV8KT976I2C\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n },\n {\n \"key\": \"T83PYV8KT976UVB\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n },\n {\n \"key\": \"T83PYV8KT977P5V\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n },\n {\n \"key\": \"NJ8YU9KT9A3KUB\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n },\n {\n \"key\": \"NJ8YU9KT9A4LGG\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n },\n {\n \"key\": \"7GF8KT9B09W9\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n },\n {\n \"key\": \"7GF8KT9B1J0T\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n },\n {\n \"key\": \"EAD58KT9DHW0R\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n },\n {\n \"key\": \"EAD58KT9DIBVM\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n },\n {\n \"key\": \"EAD58KT9DJ8UA\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n },\n {\n \"key\": \"EAD58KT9DJMEZ\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n },\n {\n \"key\": \"FYZ9EJ9KTA53Z53\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n },\n {\n \"key\": \"FYZ9EJ9KTA57NMF\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n },\n {\n \"key\": \"DFHR8KTA7OOV7\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n },\n {\n \"key\": \"DFHR8KTA7Q696\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n },\n {\n \"key\": \"BE498KTA90RD2\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n },\n {\n \"key\": \"FWB98KTAC6KV3\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n },\n {\n \"key\": \"FWB98KTACGH4K\",\n \"status\": \"reserved\",\n \"usedCapacity\": 1\n }\n ]\n }\n ]\n }\n}"}],"_postman_id":"d970b7ac-ee82-474c-a1f6-71c03b746adb"},{"name":"Update reserve","id":"2477c9bc-11bb-4508-aee3-781f56764137","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"action\": \"completed\",\n \"dateFrom\": \"2020-10-27\",\n \"dateTo\": \"2020-10-27\",\n \"entity\": {\n \"id\": \"STORE01\",\n \"type\": \"source\"\n },\n \"keys\": [\"key01\"]\n}"},"url":"https://{{subdomain}}-olm.omnixsystem.com/v3/capacity","description":"Servicio para modificar estados de reservas de capacidad.
\nMock Server
\nhttps://c6ec6c36-0750-406b-a4b0-52de03a0674e.mock.pstmn.io/v3/capacity
Request
\n\n\nSi no se especifica el rango de fechas la acción se aplicara sobre todos las reservas encontradas con los identificadores apartir de la fecha al momento de la consulta.
\n
Custom error message
\n","urlObject":{"protocol":"https","path":["v3","capacity"],"host":["{{subdomain}}-olm","omnixsystem","com"],"query":[],"variable":[]}},"response":[{"id":"920b8314-537e-4176-bfd5-bf72e7286942","name":"Change Reserved Capacity to Completed 404","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"action\": \"completed\",\n \"dateFrom\": \"2020-10-27\",\n \"dateTo\": \"2020-10-27\",\n \"keys\": [\"key01\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://subdomain-olm.omnixsystem.com/v3/capacity"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"326f89d0-5862-11e8-92a0-fb2a57096715\",\n \"code\": 404,\n \"message\": \"NOT FOUND RESERVE\"\n}"},{"id":"cf86a3af-d789-432c-a397-eac707fe6d4b","name":"Change Reserved Capacity to Canceled 200 ok","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"action\": \"canceled\",\n \"keys\": [\"key01\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://subdomain-olm.omnixsystem.com/v3/capacity"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"326f89d0-5862-11e8-92a0-fb2a57096715\",\n \"code\": 200,\n \"message\": \"OK\"\n}"},{"id":"9eb30239-0821-4ded-aff5-7ba98caeca61","name":"Change Reserved Capacity to Completed 200","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"action\": \"completed\",\n \"dateFrom\": \"2020-10-27\",\n \"dateTo\": \"2020-10-27\",\n \"keys\": [\"key01\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://subdomain-olm.omnixsystem.com/v3/capacity"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"326f89d0-5862-11e8-92a0-fb2a57096715\",\n \"code\": 200,\n \"message\": \"OK\"\n}"}],"_postman_id":"2477c9bc-11bb-4508-aee3-781f56764137"},{"name":"Update Max Capacity on specific reserved days","id":"6f2de7fb-d138-4c4f-93ec-56cbc9e7866a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"dateFrom\": \"2020-10-27\",\n \"dateTo\": \"2020-10-27\",\n \"entityIds\": [\"STORE01\"],\n \"entityType\": \"source\",\n \"type\": \"volume\",\n \"maxCapacity\": 200\n}","options":{"raw":{"language":"json"}}},"url":"https://{{subdomain}}-olm.omnixsystem.com/v3/capacity/modify","description":"Servicio para modificar capacidad máxima a registros de reserva específicos (existentes).\nSe modificaran los las reservas cuya capacidad utilizada sea inferior o igual a la nueva capacidad máxima.
\nMock Server
\nhttps://c6ec6c36-0750-406b-a4b0-52de03a0674e.mock.pstmn.io/v3/capacity/modify
Request
\nResponse
\n- \n
- Para el caso en que se modifiquen todas las reservas encontradas se responderá con el siguiente mensaje \n
{\n \"transactionId\": \"326f89d0-5862-11e8-92a0-fb2a57096715\",\n \"code\": 200,\n \"message\": \"OK\"\n}\n- \n
- Para el caso en que una o mas reservas de capacidad no cumplan con la condición de cambio, la respuesta contendrá la información de la entidad y la fechas de las reservas que no fueron modificadas. \n
{\n \"transactionId\": \"326f89d0-5862-11e8-92a0-fb2a57096715\",\n \"code\": 201,\n \"message\": [\n {\n \"entity\": {\n \"type\": \"source\",\n \"id\": \"STORE01\"\n },\n \"dates\": [\n \"2020-10-28\"\n ]\n }\n ]\n}\n- \n
- Para el caso en el que no existan reservas que modificar la respuesta será \n
{\n \"transactionId\": \"326f89d0-5862-11e8-92a0-fb2a57096715\",\n \"code\": 200,\n \"message\": \"NOT_FOUND_RESERVES\"\n}\nServicios para crear o modificar reservas de capacidades.
\n","_postman_id":"1a9aa98e-8ede-4807-b459-ad3cc8904e1f"},{"name":"Planned Capacity","item":[{"name":"Create/Update Planned Capacity","id":"3a5b6eb6-b978-441a-b437-b4a6c9834aa9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"cyber1\",\n \"type\": \"dispatch\",\n \"entity\": {\n \"type\": \"source\",\n \"ids\": [\"source1\", \"source2\"]\n },\n \"productTypes\": [\n \"productType1\",\n \"productType2\"\n ],\n \"capacity\": 100,\n \"dates\": [\n \"2021-04-10\",\n \"2021-04-11\",\n \"2021-04-12\"\n ]\n}"},"url":"https://subdomain-olm.omnixsystem.com/v3/planned_capacity","description":"Servicio para crear o actualizar configuraciones de capacidad programada para fechas especificas.
\nImportante!
\n\n\nEste servicio solo aplica para definir configuraciones de capacidad máxima de reservas futuras en fechas especificas. Si lo que se quiere es cambiar la capacidad máxima a fechas que ya cuentan con reservas de capacidad entonces utilizar el servicio Update Max Capacity on specific reserved days
\n
De acuerdo a lo anterior al momento de crear un nuevo registro de reserva de capacidad se validará si existe una configuración de capacidad programada para fecha requerida que cumpla con todas las condiciones y de esta manera se aplicara o no.
\nMock Server
\nhttps://c6ec6c36-0750-406b-a4b0-52de03a0674e.mock.pstmn.io/v3/planned_capacity
Request
\nCustom error message
\n","urlObject":{"protocol":"https","path":["v3","planned_capacity"],"host":["subdomain-olm","omnixsystem","com"],"query":[],"variable":[]}},"response":[{"id":"1d5d49a2-fc74-4d07-afb8-293f46039075","name":"Create Source dispatch Planned Capacity","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type\": \"dispatch\",\n \"entity\": {\n \"type\": \"source\",\n \"ids\": [\"source1\", \"source2\"]\n },\n \"productType\": [\n \"productType1\",\n \"productType2\"\n ],\n \"capacity\": 100,\n \"dates\": [\n \"2021-04-10\",\n \"2021-04-11\",\n \"2021-04-12\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://subdomain-olm.omnixsystem.com/v3/planned_capacity"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"326f89d0-5862-11e8-92a0-fb2a57096715\",\n \"code\": 200,\n \"message\": \"OK\"\n}"},{"id":"8038501b-8cba-4b18-b791-38b295e9d647","name":"Create/Update Planned Capacity with non exist source","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"cyber1\",\n \"type\": \"dispatch\",\n \"entity\": {\n \"type\": \"source\",\n \"ids\": [\"source1\", \"source3\"]\n },\n \"productType\": [\n \"productType1\",\n \"productType2\"\n ],\n \"capacity\": 100,\n \"dates\": [\n \"2021-04-10\",\n \"2021-04-11\",\n \"2021-04-12\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://subdomain-olm.omnixsystem.com/v3/planned_capacity"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"8f7fdd28-4284-4644-9de7-727db83d4506\",\n \"code\": 500,\n \"message\": \"EntityNotFoundException\"\n}"},{"id":"1b09bafa-a8f2-4e74-ab42-2ecf11c10b8a","name":"Create Source volume Planned Capacity","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"cyber1\",\n \"type\": \"volume\",\n \"entity\": {\n \"type\": \"source\",\n \"ids\": [\"source1\", \"source2\"]\n },\n \"capacity\": 5000,\n \"dates\": [\n \"2021-04-10\",\n \"2021-04-11\",\n \"2021-04-12\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://subdomain-olm.omnixsystem.com/v3/planned_capacity"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"326f89d0-5862-11e8-92a0-fb2a57096715\",\n \"code\": 200,\n \"message\": \"OK\"\n}"},{"id":"9cd4c7a5-b62c-445b-b089-35297c2393dd","name":"Create Courier volume Planned Capacity","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"cyber1\",\n \"type\": \"volume\",\n \"entity\": {\n \"type\": \"courier\",\n \"ids\": [\"courier1\", \"courier2\"]\n },\n \"capacity\": 5000,\n \"dates\": [\n \"2021-04-10\",\n \"2021-04-11\",\n \"2021-04-12\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://subdomain-olm.omnixsystem.com/v3/planned_capacity"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"326f89d0-5862-11e8-92a0-fb2a57096715\",\n \"code\": 200,\n \"message\": \"OK\"\n}"},{"id":"7c7b5ac1-88ee-4ec2-8a96-8bb81e0a3509","name":"Create Courier dispatch Planned Capacity","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type\": \"dispatch\",\n \"entity\": {\n \"type\": \"courier\",\n \"ids\": [\"courier1\", \"courier2\"]\n },\n \"capacity\": 100,\n \"dates\": [\n \"2021-04-10\",\n \"2021-04-11\",\n \"2021-04-12\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://subdomain-olm.omnixsystem.com/v3/planned_capacity"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"326f89d0-5862-11e8-92a0-fb2a57096715\",\n \"code\": 200,\n \"message\": \"OK\"\n}"}],"_postman_id":"3a5b6eb6-b978-441a-b437-b4a6c9834aa9"},{"name":"Get Planned Capacity by Id","id":"5e77e16f-23f5-4933-9ca3-56f2ebba0964","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Bearer {{token}}"}],"url":"https://subdomain-olm.omnixsystem.com/v3/planned_capacity/:plannedCapacityId","description":"Servicio para obtener configuración de planned capacity por id
\nMock Server
\nhttps://c6ec6c36-0750-406b-a4b0-52de03a0674e.mock.pstmn.io/v3/planned_capacity/:plannedCapacityId
Path parameters
\n- \n
- plannedCapacityId: Identificador de la configuración. \n
Servicio para consultar todas las configuraciones de planner capacity de forma paginada y es posible filtrar por propiedades del modelo.
\nMock Server
\nhttps://c6ec6c36-0750-406b-a4b0-52de03a0674e.mock.pstmn.io/v3/planned_capacity/all
Request:
\n- \n
- skipRecords (Requerida): (Int) Cantidad de registros a saltarse en la consulta. \n
- maxRecords (Requerida): (Int) Cantidad de registros a devolver en la consulta. \n
- project (Opcional): (Array[String]) Nombre de las propiedades que queremos ver en la respuesta. \n
- filter (Opcional): (Object) Permite especificar la consulta por propiedades especificas. ej:
{type: \"dispatch\"}(traerá solo los registros que cumplan con esta condición). \n
\n\n","urlObject":{"protocol":"https","path":["v3","planned_capacity","all"],"host":["subdomain-olm","omnixsystem","com"],"query":[],"variable":[]}},"response":[{"id":"eba7e2ce-d48f-452e-a4e0-3314b4d5ead4","name":"Get Planned Capacity","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"skipRecords\": 0,\n \"maxRecords\": 10,\n \"project\": [\n \"id\",\n \"entity\",\n \"capacity\",\n \"dates\"\n ],\n \"filter\": {\n \"id\": \"cyber1\",\n \"type\": \"dispatch\",\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://subdomain-olm.omnixsystem.com/v3/planned_capacity/all"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"e587f6ac-ed06-406b-97ce-0ec41a719b4a\",\n \"code\": 200,\n \"message\": {\n \"numRecordsReturned\": 2,\n \"skippedRecords\": 0,\n \"maxPages\": 1,\n \"totalRecordsMatched\": 2,\n \"records\": [\n {\n \"id\": \"cyber1\",\n \"entity\": {\n \"type\": \"source\",\n \"ids\": [\n \"source1\",\n \"source2\"\n ]\n },\n \"capacity\": 100,\n \"dates\": [\n \"2021-04-10\",\n \"2021-04-11\",\n \"2021-04-12\"\n ]\n }\n ]\n }\n}"}],"_postman_id":"ec829a17-5edf-4e94-b65a-1825b3e18b48"},{"name":"Remove Planned Capacity","id":"fa427935-646e-4306-b7de-a4b4346d8e43","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Bearer {{token}}"}],"body":{"mode":"raw","raw":"{\n \"ids\": [\"cyber1\"],\n \"comment\": \"remove from monitor\"\n}","options":{"raw":{"language":"json"}}},"url":"https://subdomain-olm.omnixsystem.com/v3/planned_capacity","description":"Si no se especifica project entonces se entregarán todas las propiedades públicas del modelo PlannedCapacity
\n
Servicio para eliminar Couriers y todas sus coberturas.
\nMock Server
\nhttps://c6ec6c36-0750-406b-a4b0-52de03a0674e.mock.pstmn.io/v3/planned_capacity
Request
\n","urlObject":{"protocol":"https","path":["v3","planned_capacity"],"host":["subdomain-olm","omnixsystem","com"],"query":[],"variable":[]}},"response":[{"id":"2ea88886-e010-4988-af36-17339452ced8","name":"Remove Planned Capacity","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"ids\": [\"cyber1\"],\n \"comment\": \"remove from monitor\"\n}","options":{"raw":{"language":"json"}}},"url":"https://subdomain-olm.omnixsystem.com/v3/planned_capacity"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"326f89d0-5862-11e8-92a0-fb2a57096715\",\n \"code\": 200,\n \"message\": \"OK\"\n}"}],"_postman_id":"fa427935-646e-4306-b7de-a4b4346d8e43"}],"id":"feb43ce5-9b50-4b0b-9612-61d6c85a8a45","_postman_id":"feb43ce5-9b50-4b0b-9612-61d6c85a8a45","description":""},{"name":"Massive Loads","item":[{"name":"Load file","id":"9f4317db-25d9-4668-aa15-07dc7257ead7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","value":null}]},"url":"https://subdomain-olm.omnixsystem.com/v3/massive_load?type","description":"Servicio para subir archivo de carga masiva de rutas o coberturas.
\nMock Server
\nhttps://c6ec6c36-0750-406b-a4b0-52de03a0674e.mock.pstmn.io/v3/massive_load
Files:
\n\nRequest:
\n- \n
- file (Requerido): archivo de extensión .xlsx que contiene la información de rutas o coberturas \n
Query Params
\n","urlObject":{"protocol":"https","path":["v3","massive_load"],"host":["subdomain-olm","omnixsystem","com"],"query":[{"description":{"content":"routes or coverages
\n","type":"text/plain"},"key":"type","value":null}],"variable":[]}},"response":[{"id":"e49333f9-100a-47aa-bf6b-b5c49a58ad01","name":"Load File succeeded","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":["/home/brandonslp/routes.xlsx"]}],"options":{"raw":{"language":"json"}}},"url":{"raw":"https://subdomain-olm.omnixsystem.com/v3/massive_load?type=routes","protocol":"https","host":["subdomain-olm","omnixsystem","com"],"path":["v3","massive_load"],"query":[{"key":"type","value":"routes","description":"routes or coverages"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"8f7fdd28-4284-4644-9de7-727db83d4506\",\n \"code\": 200,\n \"message\": {\n \"id\": \"PL2KPG26U1BNKK0MWIVHA\"\n }\n}"},{"id":"a558e957-9be2-4a3d-ad34-6d4dac376022","name":"Load Fail failed","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":["/home/brandonslp/routes.xlsx"]}],"options":{"raw":{"language":"json"}}},"url":{"raw":"https://subdomain-olm.omnixsystem.com/v3/massive_load?type=fail","protocol":"https","host":["subdomain-olm","omnixsystem","com"],"path":["v3","massive_load"],"query":[{"key":"type","value":"fail","description":"routes or coverages"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"37416ff3-c006-4333-9640-6a3dd0f31b69\",\n \"code\": 400,\n \"message\": \"instance.type is not one of enum values: routes, coverages\"\n}"}],"_postman_id":"9f4317db-25d9-4668-aa15-07dc7257ead7"},{"name":"Get Load Process by id","id":"0587d6d0-af75-4543-a462-fa72cb4838ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"BearerServicio para obtener detalle de proceso de carga por id
\nMock Server
\nhttps://c6ec6c36-0750-406b-a4b0-52de03a0674e.mock.pstmn.io/v3/massive_load/:processId
Path Parameters
\n- \n
- processId: Identificador del proceso. \n
Servicio para consultar todos los procesos de carga de forma paginada y es posible filtrar por propiedades del modelo.
\nMock Server
\nhttps://c6ec6c36-0750-406b-a4b0-52de03a0674e.mock.pstmn.io/v3/sources/all
Request:
\n- \n
- skipRecords (Requerida): (Int) Cantidad de registros a saltarse en la consulta. \n
- maxRecords (Requerida): (Int) Cantidad de registros a devolver en la consulta. \n
- project (Opcional): (Array[String]) Nombre de las propiedades que queremos ver en la respuesta. \n
- filter (Opcional): (Object) Permite especificar la consulta por propiedades especificas. ej:
{\"id\": \"LPFWQTY3VOSKRO4JMV8\"}(traerá solo procesos que cumplan con esta condición). \n
\n\n","urlObject":{"protocol":"https","path":["v3","massive_load","all"],"host":["subdomain-olm","omnixsystem","com"],"query":[],"variable":[]}},"response":[{"id":"2a54e9db-98a7-45f2-b014-43664a97f2e2","name":"Get Load Process","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"BearerSi no se especifica project entonces se entregarán todas las propiedades públicas del modelo de procesos
\n
Introducción
\n\n
OLM es el módulo o sistema de Omnix que se encarga de la logística de cada pedido teniendo en cuenta capacidades de despacho y transporte, y tiempos de preparación de sources, productos, coberturas de rutas.
\nLos actores principales son los siguientes:
\n- \n
- Source: Representa locaciones físicas ó virtuales que contienen y venden productos, como por ejemplo bodegas, tiendas, etc... \n
- Locations: Corresponde a las ubicaciones o zonas geograficas hacia las que se puede dar cobertura. \n
- Routes: Las rutas son las conexiones (direccionadas) entre
sourcesolocations. \n - Couriers: Los transportistas que dan cobertura a las rutas para cada uno de los tipos de despacho y entrega. \n
- Coverages: Representa las reglas de cobertura de rutas dada por un courier. \n
- CapacityReserves: Representa las reserva de capacidades, define el limite de operaciones o asignaciones diarias o por rango de días de sources y couriers. \n
- Calendar: Define la configuración a nivel general de la zona horaria, días y fechas no laborales que se deben tener en cuenta al momento de estimar tiempos de entregas. Cada cliente puede tener solo un calendario. \n
- Schedule: Describe los tipos de entrega por cada tipo de despacho y tipo de productos soportados por el cliente. \n
Shared Models
\nLa información a continuación describe los modelos y sus atributos públicos disponibles para consulta, modificación e inserción.
\nSource
\nLocation
\nSchedule
\nRoute
\nCourier
\nCoverage
\nCapacityReserves
\nCalendar
\nLogistic Cost Strategies
\nCada Courier en el atributo costStrategy debe tener definida la estrategia de costos de cobertura con la cual se calcularan los costos de envio. OLM ofrece las siguientes:
Costos por tipo de producto
\n\n\n\n
productType
En esta estrategia el Courier debe tener definido un costo por unidad para cada tipo de producto a los que da cobertura.
\nEn el modelo de Coverages (detallado más adelante) la estructura del atributo es cost para soportar esta estrategia debe ser la siguiente:
{\n \"type1\": 25,\n \"type2\": 3.8,\n \"typeN\": 10,\n}\nCostos por rango de volumen
\n\n\n\n
volumeRange
En esta estrategia el Courier debe tener definido un costo por rango de volumen a transportar. El volumen de referencia (a transportar) se calcula multiplicando la cantidad total de un sku por el volumen de su unidad.
\nEn el modelo de Coverages (detallado más adelante) la estructura del atributo es cost para soportar esta estrategia debe ser la siguiente:
[\n {\n \"min\": 0,\n \"max\": 10,\n \"value\": 50\n },\n {\n \"min\": 10.1,\n \"max\": 50,\n \"value\": 60\n },\n]\nCostos por rango de volumen y tipo de producto
\n\n\n\n
productTypeAndVolumeRange
En esta estrategia el Courier debe tener definido un costo por rango de volumen y tipo de producto a transportar. El volumen de referencia (a transportar) se calcula multiplicando la cantidad total de productos (de cada tipo) por el volumen de una unidad del tipo correspondiente.
\nEn el modelo de Coverages (detallado más adelante) la estructura del atributo es cost para soportar esta estrategia debe ser la siguiente:
[\n {\n \"productType\": [\"type1\", \"type2\"]\n \"min\": 0,\n \"max\": 10,\n \"value\": 50\n },\n {\n \"productType\": [\"typeN\"]\n \"min\": 0,\n \"max\": 10,\n \"value\": 60\n },\n]\nLogistic Location Strategies
\nCada Courier en el atributo locationStrategy debe tener definida la estrategia de localización para definir sus coberturas hacia zonas geográficas. OLM ofrece las siguientes:
Estrategia de nivel 1
\n\n\n\n
level1
En esta estrategia cada registro de Location debe tener definido los siguientes atributos.
\nEn el modelo de Routes (detallado más adelante) la estructura del atributo es source o target para los casos en que se haga referencia a un Location, debe ser la siguiente:
{\n \"criteria0\": \"Colombia\",\n \"criteria1\": \"Atlántico\",\n \"criteria2\": \"Barranquilla\",\n}\nCasos de uso
\n- \n
- Cuando la cobertura está dada a nivel de ciudad \n
- Cuando la cobertura está dada a nivel de comuna \n
Estrategia de nivel 2
\n\n\n\n
level2
En esta estrategia cada registro de Location debe tener definido los siguientes atributos.
\nEn el modelo de Routes (detallado más adelante) la estructura del atributo es source o target para los casos en que se haga referencia a un Location, debe ser la siguiente:
{\n \"criteria0\": \"Chile\",\n \"criteria1\": \"Region Metropolitana de Santiago\",\n \"criteria2\": \"Santiago\",\n \"criteria3\": \"Localidad 1\",\n}\nCasos de uso
\n- \n
- Cuando la cobertura está dada a nivel de localidad \n
- Cuando la cobertura está dada a nivel de distrito \n
- Cuando la cobertura está dada a nivel de ubigeo \n
Estrategia de nivel 3
\n\n\n\n
level3
En esta estrategia cada registro de Location debe tener definido los siguientes atributos.
\nEn el modelo de Routes (detallado más adelante) la estructura del atributo es source o target para los casos en que se haga referencia a un Location, debe ser la siguiente:
{\n \"criteria0\": \"Chile\",\n \"criteria1\": \"Región Metropolitana de Santiago\",\n \"criteria2\": \"Santiago\"\n}\ny en Coverage su atributo custom debe ser
- \n
- zones: Representa todas las zonas de cobertura dentro del Location y se compone de:
- \n
- type:
inclusionoexlusionde la cobertura \n - area: Polygon \n
\n - type:
{\n \"zones\": [\n {\n \"type\": \"inclusion\"\n \"area\": {\n \"type\":\"Polygon\",\n coordinates: [\n [\n logitude,\n latitude\n ],\n [\n logitude,\n latitude\n ],\n [\n logitude,\n latitude\n ]\n ]\n }\n }\n ]\n}\nCasos de uso
\n- \n
- Cuando la cobertura está dada a nivel de zonas o áreas de cobertura dentro de una ciudad o comuna \n
General Error Responses
\nLos errores comunes entregados en la respuesta por Omnix son los siguientes:
\nMovimiento de inventario
\nDentro del contexto de movimiento de inventario: los flujos de consulta y reserva de agendamiento, y cobertura de rutas. Tenemos los siguientes actores:
\n- \n
- Source: Representa el origen de un movimiento/traslado, donde se recogen los productos para ser llevados al target. Puede ser una bodega, tienda o una ubicación geográfica. \n
\n\n{\n \"type\": \"Source\",\n \"data\": JSON[data]\n}\n
\n\ntype puede ser tener como valor source o location
\n
- \n
- Target: Representa el destino de un movimiento/traslado, donde se entregan los productos. Puede ser una bodega, tienda o ubicación geográfica \n
\n\n{\n \"type\": \"Location\",\n \"data\": JSON[data]\n}\n
\n\ntype puede ser tener como valor source o location
\n
Descripción de atributos
\nLa estructura base del atributo data tanto en source como en location se define de acuerdo al valor del atributo type: source o location
Source
\n{\n \"type\": \"Source\",\n \"data\": {\n \"id\": \"CT15\",\n \"alias\": \"ES15\",\n \"name\": \"Bodega\"\n },\n \"items\": [\n {\n \"sku\": \"ABC1\",\n \"quantity\": 2,\n \"type\": \"pequeño\",\n \"volume\": 20,\n \"leadtime\": 8,\n \"criterias\": [\"pequeño\", \"sensible\"],\n \"availabilityDate\": \"YYYY-MM-DD\"\n },\n {\n \"sku\": \"ABC2\",\n \"quantity\": 1,\n \"type\": \"sensible\",\n \"volume\": 20,\n \"leadtime\": 8,\n \"criterias\": [\"pequeño\", \"sensible\"],\n \"availabilityDate\": \"YYYY-MM-DD\"\n }\n ]\n}\nLocation
\n{\n \"type\": \"Location\",\n \"data\": {\n \"criteria0\": \"Barranquilla\",\n \"criteria1\": \"Atlantico\",\n \"criteria2\": \"Betania\",\n \"criteria3\": \"\",\n \"criteria4\": \"\",\n \"custom\": {\n \"key\": \"value\"\n }\n }\n}\n\n\n","event":[{"listen":"prerequest","script":{"id":"651d3a4c-dba3-4573-9d00-dcd9a9aad465","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"96f26daf-cd91-4b54-830c-7f33c504da2e","type":"text/javascript","exec":[""]}}],"_postman_id":"8dadabb4-8e26-49b5-bd7d-5113722ac8f7"},{"name":"Omnix Security Management API (OSM)","item":[{"name":"PasswordPolicy","item":[{"name":"Get Password Policy","id":"a4017cd7-3540-4da4-a123-fa21e387f02d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{rootToken}}","type":"text"}],"url":"https://subdomain-osm.omnixsystem.com/v3/security/password-policy","description":"Para definir una ubicación se deben usar mínimo criteria0, criteria1 y criteria2 los demas son opcionales.
\n
Este servicio obtiene la configuración del Password Policy.
\n","urlObject":{"protocol":"https","path":["v3","security","password-policy"],"host":["subdomain-osm","omnixsystem","com"],"query":[{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[{"id":"7ae3fccd-5547-4964-a7e7-521a757bc310","name":"Get Password Policy","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{rootToken}}","type":"text"}],"url":{"raw":"https://subdomain-osm.omnixsystem.com/v3/security/password-policy","protocol":"https","host":["subdomain-osm","omnixsystem","com"],"path":["v3","security","password-policy"],"query":[{"key":"","value":"","disabled":true}]}},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"Password Policy
\nOmnix OSM permite crear una política de contraseñas las cuales contienen las siguientes características:
\n- \n
- minLength: Define el tamaño mínimo que debe tener una contraseña. \n
- maxLength: Define el tamaño máximo que debe tener una contraseña. \n
- maxAttempts: Define el máximo de intentos fallidos de login antes de bloquear un usuario. \n
- expireInDays: Define en días la validez de la contraseña, después de pasados estos días el usuario es bloqueado y obligado a cambiar su contraseña. \n
- maxPasswordHistoryToCompare: Por cada cambio de contraseña se guarda un histórico, en este campo se define hasta qué índice de ese histórico Omnix debe bloquear el intento de crear contraseñas usadas reciéntemente, es decir, si tengo un histórico de 50 contraseñas guardadas y este atributo se envía con un valor de 10, entonces Omnix no va a dejar crear contraseñas que estén en las 10 primeras posiciones de ese historial. \n
- checkPasswordStrength: Chequea la contraseña enviada en el momento de la creación de un usuario, si la contraseña es de una fortaleza media en adelante entonces se permite la creación del usuario. \n
Omnix permite configurar una política para el manejo de las claves en el sistema, para esto provee dos endpoints para consulta y configuración del mismo.
\n","_postman_id":"92ba84ca-d22c-4900-8f85-ad062cbcc828"},{"name":"OAuth - Client credentials grant","id":"6a154631-fb84-488e-8465-47b31a82a119","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"},{"key":"Authorization","type":"text","value":"Basic {{authBase64}}"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"client_credentials","type":"text"}]},"url":"https://{{subdomain}}-osm.omnixsystem.com/v3/security/oauth2/token","description":"Servicio para obtener un token autorizado a omnix, este servicio implementa el Client Credentials Grant de oauth. rfc6749.
\nRequest:
\n- \n
- grant_type (Requerido): (String) Esta propiedad debe ir con el valor client_credentials. \n
- scope (Opcional): (String) No es necesario para este servicio. \n
Header:
\n- \n
- Content-Type: (Requerido) (String) Este header tomará el valor de application/x-www-form-urlencoded \n
- Authorization: (Requerido) (String) Este header debe llevar una cadena formada por usuario:password en base 64. Ejemplo: Basic dXNlcjpwYXNzd29yZA== \n
Body
\n- \n
- grant_type: (Requerido) (String) Esta propiedad debe tomar el valor client_credentials. \n