API docs by Redocly

Bright Market API Docs (d128399f)

Download OpenAPI specification:Download

Documentación de los servicios de Bright Market

Grupos de artículos

Servicios referidos a grupos de artículos

Obtener grupo de artículo

Obtener grupo de artículo

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Editar grupo de artículo

Editar un grupo de artículo

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
query Parameters
name
string
description
string
state
boolean
analysis
string
origin
string
Enum: "MANUAL" "SUGGESTED"
brandId
integer <int64>
categoryId
integer <int64>
branchOfficeId
integer <int64>
articleId
integer <int64>
skuId
integer <int64>

Responses

Borrar grupo de artículo

Borrar un grupo de artículo

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Crear grupo de artículo

Crear un nuevo grupo de artículo

Authorizations:
Bearer Authentication
Request Body schema: application/json
id
integer <int64>
name
required
string
description
required
string
state
required
boolean
origin
required
string (GroupOrigin)
Enum: "MANUAL" "SUGGESTED"
analysis
string
createdAt
string
categoryId
integer <int64>

Filter by category ID

brandId
integer <int64>

Filter by brand ID

branchOfficeId
integer <int64>

Filter by branch office ID

articleId
integer <int64>

Filter by article ID

skuId
integer <int64>

Filter by SKU ID

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "state": true,
  • "origin": "MANUAL",
  • "analysis": "string",
  • "createdAt": "string",
  • "categoryId": 0,
  • "brandId": 0,
  • "branchOfficeId": 0,
  • "articleId": 0,
  • "skuId": 0
}

Contar cantidad de artículos en grupo

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Categorías

Servicios referidos a las categorías

Obtener categoría

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Editar categoría

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
query Parameters
externalId
string
name
required
string
description
string
fatherId
integer <int64>
enable
required
boolean
roundingTypeId
integer <int64>
businessUnitsIds
Array of integers <int64> [ items <int64 > ]

Responses

Eliminar categoría

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Carga de articulos por archivo excel

Authorizations:
Bearer Authentication
Request Body schema: application/json
file
required
string <binary>

Responses

Request samples

Content type
application/json
{
  • "file": "string"
}

Crear categoría

Authorizations:
Bearer Authentication
query Parameters
externalId
string
name
required
string
description
string
fatherId
integer <int64>
enable
required
boolean
roundingTypeId
integer <int64>
businessUnitsIds
Array of integers <int64> [ items <int64 > ]

Responses

Consultar categorías paginado

Authorizations:
Bearer Authentication
query Parameters
name
string
page
required
integer <int32>
size
required
integer <int32>
Array of objects (SortProperty)

Responses

Obtener posibles padres de una categoría

Authorizations:
Bearer Authentication
path Parameters
categoryId
required
integer <int64>

Responses

Obtener todas las categorías por organización

Authorizations:
Bearer Authentication

Responses

Obtener plantilla de carga en excel

Authorizations:
Bearer Authentication

Responses

Curvas

Servicios referidos a las curvas

Obtener curva

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Editar curva

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
query Parameters
name
string
sizeStart
integer <int64>
sizeEnd
integer <int64>
distribution
Array of integers <int32> [ items <int32 > ]

Responses

Eliminar curva

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Crear curva

Authorizations:
Bearer Authentication
Request Body schema: application/json
name
string
sizeStart
integer <int64>
sizeEnd
integer <int64>
distribution
Array of integers <int32> [ items <int32 > ]

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "sizeStart": 0,
  • "sizeEnd": 0,
  • "distribution": [
    ]
}

Depósito

Servicios referidos a los depósitos

Obtener depósito

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Editar depósito

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
Request Body schema: application/json
externalId
string
name
required
string
capacity
number <double>
capacityInUnits
integer <int32>
capacityDispatchUnits
integer <int32>
dispatchFrequency
integer <int32>
capacityReception
integer <int32>
storageCostPerUnit
number <double>
address
string
Array of objects (BranchOfficeWithDistance)
businessUnitsIds
Array of integers <int64> [ items <int64 > ]
categoriesIds
Array of integers <int64> [ items <int64 > ]
minimumStock
integer <int64>
maximumStock
integer <int64>
longitude
number <double>
latitude
number <double>

Responses

Request samples

Content type
application/json
{
  • "externalId": "string",
  • "name": "string",
  • "capacity": 0,
  • "capacityInUnits": 0,
  • "capacityDispatchUnits": 0,
  • "dispatchFrequency": 0,
  • "capacityReception": 0,
  • "storageCostPerUnit": 0,
  • "address": "string",
  • "branchOffices": [
    ],
  • "businessUnitsIds": [
    ],
  • "categoriesIds": [
    ],
  • "minimumStock": 0,
  • "maximumStock": 0,
  • "longitude": 0,
  • "latitude": 0
}

Eliminar depósito

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Editar stocks de varios SKUs en varios depósito

Authorizations:
Bearer Authentication
Request Body schema: application/json
Array
skuBranchOfficeOrDepositId
integer <int64>
stock
integer <int32>

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Editar stock de sku en depósito

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
query Parameters
stock
required
integer <int32>

Responses

Agregar sku a depósito

Authorizations:
Bearer Authentication
path Parameters
depositId
required
integer <int64>
skuId
required
integer <int64>
query Parameters
stock
required
integer <int32>

Responses

Carga de depósitos por archivo excel

Authorizations:
Bearer Authentication
Request Body schema: application/json
file
required
string <binary>

Responses

Request samples

Content type
application/json
{
  • "file": "string"
}

Carga de depósitos por archivo excel

Authorizations:
Bearer Authentication
Request Body schema: application/json
file
required
string <binary>

Responses

Request samples

Content type
application/json
{
  • "file": "string"
}

Crear depósito

Authorizations:
Bearer Authentication
Request Body schema: application/json
externalId
string
name
required
string
capacity
number <double>
capacityInUnits
integer <int32>
capacityDispatchUnits
integer <int32>
dispatchFrequency
integer <int32>
capacityReception
integer <int32>
storageCostPerUnit
number <double>
address
string
Array of objects (BranchOfficeWithDistance)
businessUnitsIds
Array of integers <int64> [ items <int64 > ]
categoriesIds
Array of integers <int64> [ items <int64 > ]
minimumStock
integer <int64>
maximumStock
integer <int64>
longitude
number <double>
latitude
number <double>

Responses

Request samples

Content type
application/json
{
  • "externalId": "string",
  • "name": "string",
  • "capacity": 0,
  • "capacityInUnits": 0,
  • "capacityDispatchUnits": 0,
  • "dispatchFrequency": 0,
  • "capacityReception": 0,
  • "storageCostPerUnit": 0,
  • "address": "string",
  • "branchOffices": [
    ],
  • "businessUnitsIds": [
    ],
  • "categoriesIds": [
    ],
  • "minimumStock": 0,
  • "maximumStock": 0,
  • "longitude": 0,
  • "latitude": 0
}

Obtener depósito con costo de artículos

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Obtener plantilla de carga en excel

Authorizations:
Bearer Authentication

Responses

Obtener los ajustes de stock de un sku en un depósito

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
query Parameters
page
required
integer <int32>
size
required
integer <int32>

Responses

Consultar depositos paginado

Authorizations:
Bearer Authentication
query Parameters
id
integer <int64>
name
string
externalId
string
page
required
integer <int32>
size
required
integer <int32>
Array of objects (SortProperty)

Responses

Obtener todos los depósitos de la organización

Authorizations:
Bearer Authentication

Responses

Obtener plantilla de carga en excel

Authorizations:
Bearer Authentication

Responses

Eliminar sku de depósito

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Promociones

Servicios referidos a las promociones

Editar promoción regular a partir de external ids

Authorizations:
Bearer Authentication
path Parameters
externalId
required
string
Request Body schema: application/json
required
object (Promotion)
regularPromotionType
required
string
Enum: "NOMINAL" "NOMINAL_SENT" "PERCENTAGE" "MAX_PRICE_PER_ARTICLE" "PERCENTAGE_SENT" "FREE_SHIPPING" "GIFT" "NOMINAL_DISCOUNT" "PRICE_TABLE"
skuExternalIds
required
Array of strings
discountValue
number <double>
discountPercent
number <double>
giftExternalId
string

Responses

Request samples

Content type
application/json
{
  • "promotion": {
    },
  • "regularPromotionType": "NOMINAL",
  • "skuExternalIds": [
    ],
  • "discountValue": 0,
  • "discountPercent": 0,
  • "giftExternalId": "string"
}

Editar promoción regular

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
Request Body schema: application/json
required
object (Promotion)
regularPromotionType
required
string
Enum: "NOMINAL" "NOMINAL_SENT" "PERCENTAGE" "MAX_PRICE_PER_ARTICLE" "PERCENTAGE_SENT" "FREE_SHIPPING" "GIFT" "NOMINAL_DISCOUNT" "PRICE_TABLE"
skuExternalIds
required
Array of strings
discountValue
number <double>
discountPercent
number <double>
giftExternalId
string

Responses

Request samples

Content type
application/json
{
  • "promotion": {
    },
  • "regularPromotionType": "NOMINAL",
  • "skuExternalIds": [
    ],
  • "discountValue": 0,
  • "discountPercent": 0,
  • "giftExternalId": "string"
}

Editar promoción 'Descuento progresivo'

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
Request Body schema: application/json
required
object (Promotion)
skuIds
required
Array of integers <int64> [ items <int64 > ]
required
Array of objects (ProgressiveDiscountPromotionLine)

Responses

Request samples

Content type
application/json
{
  • "promotion": {
    },
  • "skuIds": [
    ],
  • "lines": [
    ]
}

Editar promoción MxN

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
Request Body schema: application/json
required
object (Promotion)
quantityForPromotion
required
integer <int32>
quantityWithDiscount
required
integer <int32>
discountPercent
required
number <double>
allProducts
required
boolean
highPrice
required
boolean
forTotalArticles
required
boolean
skuIds
required
Array of integers <int64> [ items <int64 > ]

Responses

Request samples

Content type
application/json
{
  • "promotion": {
    },
  • "quantityForPromotion": 0,
  • "quantityWithDiscount": 0,
  • "discountPercent": 0,
  • "allProducts": true,
  • "highPrice": true,
  • "forTotalArticles": true,
  • "skuIds": [
    ]
}

Editar promoción 'Comprar juntos'

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
Request Body schema: application/json
required
object (Promotion)
discountFirstList
required
number <double>
discountSecondList
required
number <double>
skuIdFirstList
required
Array of integers <int64> [ items <int64 > ]
skuIdSecondList
required
Array of integers <int64> [ items <int64 > ]

Responses

Request samples

Content type
application/json
{
  • "promotion": {
    },
  • "discountFirstList": 0,
  • "discountSecondList": 0,
  • "skuIdFirstList": [
    ],
  • "skuIdSecondList": [
    ]
}

Editar promoción 'Comprar uno, obtener uno'

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
Request Body schema: application/json
required
object (Promotion)
type
required
string
Enum: "GIFT" "FREE_SHIPPING" "MAX_PRICE_PER_ARTICLE"
giftId
required
integer <int64>
skuIds
Array of integers <int64> [ items <int64 > ]

Responses

Request samples

Content type
application/json
{
  • "promotion": {
    },
  • "type": "GIFT",
  • "giftId": 0,
  • "skuIds": [
    ]
}

Check which SKUs are already added to a promotion

Authorizations:
Bearer Authentication
path Parameters
externalId
required
string
Request Body schema: application/json
skuExternalIds
Array of strings

Responses

Request samples

Content type
application/json
{
  • "skuExternalIds": [
    ]
}

Agregar SKUs a una promoción usando external IDs

Authorizations:
Bearer Authentication
path Parameters
externalId
required
string
Request Body schema: application/json
skuExternalIds
Array of strings

Responses

Request samples

Content type
application/json
{
  • "skuExternalIds": [
    ]
}

Agendar promoción

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
query Parameters
startDate
required
string <date-time>
endDate
string <date-time>

Responses

Crear promoción regular

Authorizations:
Bearer Authentication
Request Body schema: application/json
required
object (Promotion)
regularPromotionType
required
string
Enum: "NOMINAL" "NOMINAL_SENT" "PERCENTAGE" "MAX_PRICE_PER_ARTICLE" "PERCENTAGE_SENT" "FREE_SHIPPING" "GIFT" "NOMINAL_DISCOUNT" "PRICE_TABLE"
skuExternalIds
required
Array of strings
discountValue
number <double>
discountPercent
number <double>
giftExternalId
string

Responses

Request samples

Content type
application/json
{
  • "promotion": {
    },
  • "regularPromotionType": "NOMINAL",
  • "skuExternalIds": [
    ],
  • "discountValue": 0,
  • "discountPercent": 0,
  • "giftExternalId": "string"
}

Crear promoción regular a partir de external ids

Authorizations:
Bearer Authentication
Request Body schema: application/json
required
object (Promotion)
regularPromotionType
required
string
Enum: "NOMINAL" "NOMINAL_SENT" "PERCENTAGE" "MAX_PRICE_PER_ARTICLE" "PERCENTAGE_SENT" "FREE_SHIPPING" "GIFT" "NOMINAL_DISCOUNT" "PRICE_TABLE"
skuExternalIds
required
Array of strings
discountValue
number <double>
discountPercent
number <double>
giftExternalId
string

Responses

Request samples

Content type
application/json
{
  • "promotion": {
    },
  • "regularPromotionType": "NOMINAL",
  • "skuExternalIds": [
    ],
  • "discountValue": 0,
  • "discountPercent": 0,
  • "giftExternalId": "string"
}

Crear promoción 'Descuento progresivo'

Authorizations:
Bearer Authentication
Request Body schema: application/json
required
object (Promotion)
skuIds
required
Array of integers <int64> [ items <int64 > ]
required
Array of objects (ProgressiveDiscountPromotionLine)

Responses

Request samples

Content type
application/json
{
  • "promotion": {
    },
  • "skuIds": [
    ],
  • "lines": [
    ]
}

Crear promoción MxN

Authorizations:
Bearer Authentication
Request Body schema: application/json
required
object (Promotion)
quantityForPromotion
required
integer <int32>
quantityWithDiscount
required
integer <int32>
discountPercent
required
number <double>
allProducts
required
boolean
highPrice
required
boolean
forTotalArticles
required
boolean
skuIds
required
Array of integers <int64> [ items <int64 > ]

Responses

Request samples

Content type
application/json
{
  • "promotion": {
    },
  • "quantityForPromotion": 0,
  • "quantityWithDiscount": 0,
  • "discountPercent": 0,
  • "allProducts": true,
  • "highPrice": true,
  • "forTotalArticles": true,
  • "skuIds": [
    ]
}

Cancelar promoción

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Crear promoción 'Comprar juntos'

Authorizations:
Bearer Authentication
Request Body schema: application/json
required
object (Promotion)
discountFirstList
required
number <double>
discountSecondList
required
number <double>
skuIdFirstList
required
Array of integers <int64> [ items <int64 > ]
skuIdSecondList
required
Array of integers <int64> [ items <int64 > ]

Responses

Request samples

Content type
application/json
{
  • "promotion": {
    },
  • "discountFirstList": 0,
  • "discountSecondList": 0,
  • "skuIdFirstList": [
    ],
  • "skuIdSecondList": [
    ]
}

Crear promoción 'Comprar uno, obtener uno'

Authorizations:
Bearer Authentication
Request Body schema: application/json
required
object (Promotion)
type
required
string
Enum: "GIFT" "FREE_SHIPPING" "MAX_PRICE_PER_ARTICLE"
giftId
required
integer <int64>
skuIds
Array of integers <int64> [ items <int64 > ]

Responses

Request samples

Content type
application/json
{
  • "promotion": {
    },
  • "type": "GIFT",
  • "giftId": 0,
  • "skuIds": [
    ]
}

Obtener promoción

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Eliminar promoción

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Obtener promociónes del mes

Authorizations:
Bearer Authentication
path Parameters
date
required
string <date>

Responses

Obtener promociónes del mes por dia

Authorizations:
Bearer Authentication
path Parameters
date
required
string <date>

Responses

Roles

Servicios referidos a los roles

Editar rol

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
query Parameters
name
required
string
privilegesId
required
Array of integers <int64> [ items <int64 > ]
description
required
string

Responses

Elimnar rol

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Modificar roles de usuario

Authorizations:
Bearer Authentication
path Parameters
idUser
required
integer <int64>
query Parameters
roleIds
required
Array of integers <int64> [ items <int64 > ]

Responses

Eliminar rol a usuario

Authorizations:
Bearer Authentication
path Parameters
idRole
required
integer <int64>
idUser
required
integer <int64>

Responses

Asignar rol a usuario

Authorizations:
Bearer Authentication
path Parameters
idRole
required
integer <int64>
idUser
required
integer <int64>

Responses

Crear rol

Authorizations:
Bearer Authentication
query Parameters
name
required
string
privilegesId
required
Array of integers <int64> [ items <int64 > ]
description
required
string

Responses

Tickets

Servicios referidos a los tickets

Obtener ticket

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Editar ticket

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
Request Body schema: application/json
code
required
integer <int32>
clientRut
integer <int32>
date
required
string <date>
subtotal
required
number <double>
iva
required
number <double>
total
required
number <double>
documentType
required
string (TicketDocumentType)
Enum: "CASH_TICKET" "CREDIT_INVOICE" "CREDIT_NOTE"
accumulatePoints
required
number <double>
consumedPoints
required
number <double>
currencyId
required
integer <int32>
channelId
required
integer <int32>
salePointId
required
integer <int32>
required
Array of objects (TicketSku)
acceptedPaymentMethodIds
required
Array of integers <int64> [ items <int64 > ]
fidelity
string
promotionIds
required
Array of integers <int64> [ items <int64 > ]
controlStock
boolean

True or null for stock control

Responses

Request samples

Content type
application/json
{
  • "code": 0,
  • "clientRut": 0,
  • "date": "2019-08-24",
  • "subtotal": 0,
  • "iva": 0,
  • "total": 0,
  • "documentType": "CASH_TICKET",
  • "accumulatePoints": 0,
  • "consumedPoints": 0,
  • "currencyId": 0,
  • "channelId": 0,
  • "salePointId": 0,
  • "skusWithPrice": [
    ],
  • "acceptedPaymentMethodIds": [
    ],
  • "fidelity": "string",
  • "promotionIds": [
    ],
  • "controlStock": true
}

Eliminar ticket

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Crear ticket usando external IDs

Authorizations:
Bearer Authentication
Request Body schema: application/json
code
required
integer <int32>
clientRut
integer <int32>
date
required
string <date>
subtotal
required
number <double>
iva
required
number <double>
total
required
number <double>
documentType
required
string (TicketDocumentType)
Enum: "CASH_TICKET" "CREDIT_INVOICE" "CREDIT_NOTE"
accumulatePoints
required
number <double>
consumedPoints
required
number <double>
currencyId
required
integer <int32>
channelId
required
integer <int32>
salePointExternalId
required
string
required
Array of objects (TicketSkuExternalId)
acceptedPaymentMethodExternalIds
required
Array of strings
fidelity
string
promotionExternalIds
Array of strings
controlStock
boolean

True or null for stock control

Responses

Request samples

Content type
application/json
{
  • "code": 0,
  • "clientRut": 0,
  • "date": "2019-08-24",
  • "subtotal": 0,
  • "iva": 0,
  • "total": 0,
  • "documentType": "CASH_TICKET",
  • "accumulatePoints": 0,
  • "consumedPoints": 0,
  • "currencyId": 0,
  • "channelId": 0,
  • "salePointExternalId": "string",
  • "skusWithPrice": [
    ],
  • "acceptedPaymentMethodExternalIds": "['EXT1','EXT2','EXT3']",
  • "fidelity": "string",
  • "promotionExternalIds": "['EXT1','EXT2','EXT3']",
  • "controlStock": true
}

Crear desde listado de ticket

Authorizations:
Bearer Authentication
Request Body schema: application/json
Array
code
required
integer <int32>
clientRut
integer <int32>
date
required
string <date>
subtotal
required
number <double>
iva
required
number <double>
total
required
number <double>
documentType
required
string (TicketDocumentType)
Enum: "CASH_TICKET" "CREDIT_INVOICE" "CREDIT_NOTE"
accumulatePoints
required
number <double>
consumedPoints
required
number <double>
currencyId
required
integer <int32>
channelId
required
integer <int32>
salePointId
required
integer <int32>
required
Array of objects (TicketSku)
acceptedPaymentMethodIds
required
Array of integers <int64> [ items <int64 > ]
fidelity
string
promotionIds
required
Array of integers <int64> [ items <int64 > ]
controlStock
boolean

True or null for stock control

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Crear ticket

Authorizations:
Bearer Authentication
Request Body schema: application/json
code
required
integer <int32>
clientRut
integer <int32>
date
required
string <date>
subtotal
required
number <double>
iva
required
number <double>
total
required
number <double>
documentType
required
string (TicketDocumentType)
Enum: "CASH_TICKET" "CREDIT_INVOICE" "CREDIT_NOTE"
accumulatePoints
required
number <double>
consumedPoints
required
number <double>
currencyId
required
integer <int32>
channelId
required
integer <int32>
salePointId
required
integer <int32>
required
Array of objects (TicketSku)
acceptedPaymentMethodIds
required
Array of integers <int64> [ items <int64 > ]
fidelity
string
promotionIds
required
Array of integers <int64> [ items <int64 > ]
controlStock
boolean

True or null for stock control

Responses

Request samples

Content type
application/json
{
  • "code": 0,
  • "clientRut": 0,
  • "date": "2019-08-24",
  • "subtotal": 0,
  • "iva": 0,
  • "total": 0,
  • "documentType": "CASH_TICKET",
  • "accumulatePoints": 0,
  • "consumedPoints": 0,
  • "currencyId": 0,
  • "channelId": 0,
  • "salePointId": 0,
  • "skusWithPrice": [
    ],
  • "acceptedPaymentMethodIds": [
    ],
  • "fidelity": "string",
  • "promotionIds": [
    ],
  • "controlStock": true
}

getProgress

Authorizations:
Bearer Authentication
path Parameters
id
required
string

Responses

Data Science

Proxy genérico para servicios de Data Science

Proxy genérico

Redirige cualquier solicitud al servicio de Data Science

query Parameters
requestBody
required
object

Responses

Proxy genérico

Redirige cualquier solicitud al servicio de Data Science

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Proxy genérico

Redirige cualquier solicitud al servicio de Data Science

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Proxy genérico

Redirige cualquier solicitud al servicio de Data Science

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Proxy genérico

Redirige cualquier solicitud al servicio de Data Science

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Sucursales

Servicios referidos a las sucursales

Obtener sucural

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Editar sucural

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
Request Body schema: application/json
externalId
string
name
required
string
type
required
string (BranchOfficeType)
Enum: "PHISIC" "ECOMMERCE"
location
string
url
string
roomCapacity
integer <int64>
priceVariation
number <double>
marketplace
string
belongsShoppingCenter
required
boolean
shoppingCenter
string
priceRestriction
string
storageCostPerUnit
number <double>
businessUnitsIds
Array of integers <int64> [ items <int64 > ]
restrictedCategoriesIds
Array of integers <int64> [ items <int64 > ]
restrictedArticlesIds
Array of integers <int64> [ items <int64 > ]
restrictedAcceptedPaymentMethodsIds
Array of integers <int64> [ items <int64 > ]
channelId
integer <int64>
minimumStock
integer <int64>
maximumStock
integer <int64>
priority
integer <int64>
address
string
longitude
number <double>
latitude
number <double>
ownInventory
boolean
depositId
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "externalId": "string",
  • "name": "string",
  • "type": "PHISIC",
  • "location": "string",
  • "url": "string",
  • "roomCapacity": 0,
  • "priceVariation": 0,
  • "marketplace": "string",
  • "belongsShoppingCenter": true,
  • "shoppingCenter": "string",
  • "priceRestriction": "string",
  • "storageCostPerUnit": 0,
  • "businessUnitsIds": [
    ],
  • "restrictedCategoriesIds": [
    ],
  • "restrictedArticlesIds": [
    ],
  • "restrictedAcceptedPaymentMethodsIds": [
    ],
  • "channelId": 0,
  • "minimumStock": 0,
  • "maximumStock": 0,
  • "priority": 0,
  • "address": "string",
  • "longitude": 0,
  • "latitude": 0,
  • "ownInventory": true,
  • "depositId": 0
}

Eliminar sucural

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Altenrar el estado de discontinuado de un sku en una sucursal

Authorizations:
Bearer Authentication
path Parameters
branchOfficeId
required
integer <int64>
skuId
required
integer <int64>

Responses

Editar punto de venta

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
Request Body schema: application/json
name
string
externalId
string
acceptedPaymentMethodsIds
Array of integers <int64> [ items <int64 > ]

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "externalId": "string",
  • "acceptedPaymentMethodsIds": [
    ]
}

Eliminar punto de venta

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Editar stocks de varios SKUs en varias sucursales

Authorizations:
Bearer Authentication
Request Body schema: application/json
Array
skuBranchOfficeOrDepositId
integer <int64>
stock
integer <int32>

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Editar stock de un SKU en una sucursal

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
query Parameters
stock
required
integer <int32>

Responses

Editar minimo stock de un SKU en una sucursal

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
query Parameters
minimumStock
required
integer <int32>

Responses

Editar plazo de entrega de un SKU en una sucursal

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
query Parameters
leadTime
required
integer <int32>

Responses

Agregar stock de SKU a la sucursal

Authorizations:
Bearer Authentication
path Parameters
branchOfficeId
required
integer <int64>
skuId
required
integer <int64>
query Parameters
stock
required
integer <int32>
minimumStock
required
integer <int32>
leadTime
integer <int32>

Responses

Validar existencia de externalIds de sucursales

Authorizations:
Bearer Authentication
query Parameters
externalIds
required
Array of strings

Responses

Carga de sucursales por archivo excel

Authorizations:
Bearer Authentication
Request Body schema: application/json
file
required
string <binary>

Responses

Request samples

Content type
application/json
{
  • "file": "string"
}

Crear punto de venta en sucursal

Authorizations:
Bearer Authentication
Request Body schema: application/json
name
string
branchOfficeId
integer <int64>
acceptedPaymentMethodsIds
Array of integers <int64> [ items <int64 > ]
externalId
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "branchOfficeId": 0,
  • "acceptedPaymentMethodsIds": [
    ],
  • "externalId": "string"
}

Carga de sucursales por archivo excel

Authorizations:
Bearer Authentication
Request Body schema: application/json
file
required
string <binary>

Responses

Request samples

Content type
application/json
{
  • "file": "string"
}

Crear sucural.

Authorizations:
Bearer Authentication
Request Body schema: application/json
externalId
string
name
required
string
type
required
string (BranchOfficeType)
Enum: "PHISIC" "ECOMMERCE"
location
string
url
string
roomCapacity
integer <int64>
priceVariation
number <double>
marketplace
string
belongsShoppingCenter
required
boolean
shoppingCenter
string
priceRestriction
string
storageCostPerUnit
number <double>
businessUnitsIds
Array of integers <int64> [ items <int64 > ]
restrictedCategoriesIds
Array of integers <int64> [ items <int64 > ]
restrictedArticlesIds
Array of integers <int64> [ items <int64 > ]
restrictedAcceptedPaymentMethodsIds
Array of integers <int64> [ items <int64 > ]
channelId
integer <int64>
minimumStock
integer <int64>
maximumStock
integer <int64>
priority
integer <int64>
address
string
longitude
number <double>
latitude
number <double>
ownInventory
boolean
depositId
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "externalId": "string",
  • "name": "string",
  • "type": "PHISIC",
  • "location": "string",
  • "url": "string",
  • "roomCapacity": 0,
  • "priceVariation": 0,
  • "marketplace": "string",
  • "belongsShoppingCenter": true,
  • "shoppingCenter": "string",
  • "priceRestriction": "string",
  • "storageCostPerUnit": 0,
  • "businessUnitsIds": [
    ],
  • "restrictedCategoriesIds": [
    ],
  • "restrictedArticlesIds": [
    ],
  • "restrictedAcceptedPaymentMethodsIds": [
    ],
  • "channelId": 0,
  • "minimumStock": 0,
  • "maximumStock": 0,
  • "priority": 0,
  • "address": "string",
  • "longitude": 0,
  • "latitude": 0,
  • "ownInventory": true,
  • "depositId": 0
}

Obtener sucural con costo de artículos

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Obtener plantilla de carga en excel

Authorizations:
Bearer Authentication

Responses

Obtener los ajustes de stock de un sku en una sucursal

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
query Parameters
page
required
integer <int32>
size
required
integer <int32>

Responses

Consultar sucursales paginado

Authorizations:
Bearer Authentication
query Parameters
id
integer <int64>
name
string
externalId
string
businessUnitId
integer <int64>
ownInventory
boolean
page
required
integer <int32>
size
required
integer <int32>
Array of objects (SortProperty)

Responses

Obtener sucursales por unidades de negocio

Authorizations:
Bearer Authentication
query Parameters
businessUnitIds
required
Array of integers <int64> [ items <int64 > ]

Responses

Obtener sucural por externalId

Authorizations:
Bearer Authentication
path Parameters
externalId
required
string

Responses

Obtener plantilla de carga en excel

Authorizations:
Bearer Authentication

Responses

Obtener tipo de sucursales

Authorizations:
Bearer Authentication

Responses

Eliminar SKU de una sucursal

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Atributos

Servicios referidos a los atributos

Editar atributo

Authorizations:
Bearer Authentication
path Parameters
attributeId
required
integer <int64>
query Parameters
attribute
required
string
businessUnitsIds
Array of integers <int64> [ items <int64 > ]
isEnum
required
boolean
enums
Array of strings

Responses

Eliminar atributo

Authorizations:
Bearer Authentication
path Parameters
attributeId
required
integer <int64>

Responses

Crear atributo

Authorizations:
Bearer Authentication
query Parameters
attribute
required
string
businessUnitsIds
Array of integers <int64> [ items <int64 > ]
isEnum
required
boolean
enums
Array of strings

Responses

Consultar atributos paginado

Authorizations:
Bearer Authentication
query Parameters
attribute
string
page
required
integer <int32>
size
required
integer <int32>
Array of objects (SortProperty)

Responses

Obtener todos los atributos de la organización

Authorizations:
Bearer Authentication

Responses

Tipos de promoción

Servicios referidos a los tipos de promoción

Editar tipo de promoción

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
query Parameters
name
string
code
required
string

Responses

Eliminar tipo de promoción

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Crear tipo de promoción

Authorizations:
Bearer Authentication
query Parameters
name
string
code
required
string

Responses

Marcas

Servicios referidos a las marcas

Obtener marca

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Editar marca

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
query Parameters
externalId
string
name
required
string
description
required
string

Responses

Eliminar marca

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Validar existencia de externalIds de sucursales

Authorizations:
Bearer Authentication
query Parameters
externalIds
required
Array of strings

Responses

Carga de marcas por archivo excel

Authorizations:
Bearer Authentication
Request Body schema: application/json
file
required
string <binary>

Responses

Request samples

Content type
application/json
{
  • "file": "string"
}

Crear marca

Authorizations:
Bearer Authentication
query Parameters
externalId
string
name
required
string
description
required
string

Responses

Consultar marcas paginado

Authorizations:
Bearer Authentication
query Parameters
id
integer <int64>
name
string
externalId
string
page
required
integer <int32>
size
required
integer <int32>
Array of objects (SortProperty)

Responses

Obtener todas las marcas de la organización

Authorizations:
Bearer Authentication

Responses

Obtener plantilla de carga en excel

Authorizations:
Bearer Authentication

Responses

Proveedores

Servicios referidos a los proveedores

Obtener proveedor

Authorizations:
Bearer Authentication
path Parameters
supplierId
required
integer <int64>

Responses

Editar proveedor

Authorizations:
Bearer Authentication
path Parameters
supplierId
required
integer <int64>
query Parameters
externalId
string
name
required
string
website
string
catalogueLink
string
businessUnitsIds
Array of integers <int64> [ items <int64 > ]
supplierPaymentMethodIds
Array of integers <int64> [ items <int64 > ]

Responses

Eliminar proveedor

Authorizations:
Bearer Authentication
path Parameters
supplierId
required
integer <int64>

Responses

Editar contacto de proveedor

Authorizations:
Bearer Authentication
path Parameters
supplierContactId
required
integer <int64>
query Parameters
name
required
string
phoneNumber
string
email
string
role
string

Responses

Eliminar contacto de proveedor

Authorizations:
Bearer Authentication
path Parameters
supplierContactId
required
integer <int64>

Responses

Editar artículo de proveedor

Authorizations:
Bearer Authentication
path Parameters
articleSupplierId
required
integer <int64>
Request Body schema: application/json
articleId
integer <int64>
principal
boolean
object (CommercialTerm)
purchaseUnitId
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "articleId": 0,
  • "principal": true,
  • "commercialTerm": {
    },
  • "purchaseUnitId": 0
}

Eliminar artículo de proveedor

Authorizations:
Bearer Authentication
path Parameters
articleSupplierId
required
integer <int64>

Responses

Agregar contacto a proveedor

Authorizations:
Bearer Authentication
path Parameters
supplierId
required
integer <int64>
query Parameters
name
required
string
phoneNumber
string
email
string
role
string

Responses

Agregar artículo a proveedor

Authorizations:
Bearer Authentication
path Parameters
supplierId
required
integer <int64>
Request Body schema: application/json
articleId
integer <int64>
principal
boolean
object (CommercialTerm)
purchaseUnitId
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "articleId": 0,
  • "principal": true,
  • "commercialTerm": {
    },
  • "purchaseUnitId": 0
}

Carga de proveedores por archivo excel

Authorizations:
Bearer Authentication
Request Body schema: application/json
file
required
string <binary>

Responses

Request samples

Content type
application/json
{
  • "file": "string"
}

Crear proveedor

Authorizations:
Bearer Authentication
Request Body schema: application/json
externalId
string
name
required
string
website
string
catalogueLink
string
businessUnitsIds
Array of integers <int64> [ items <int64 > ]
supplierPaymentMethodsIds
Array of integers <int64> [ items <int64 > ]
Array of objects (ArticleSuppliers)
Array of objects (SupplierContact)

Responses

Request samples

Content type
application/json
{
  • "externalId": "string",
  • "name": "string",
  • "website": "string",
  • "catalogueLink": "string",
  • "businessUnitsIds": [
    ],
  • "supplierPaymentMethodsIds": [
    ],
  • "articles": [
    ],
  • "contacts": [
    ]
}

Consultar proveedores paginado

Authorizations:
Bearer Authentication
query Parameters
id
integer <int64>
name
string
externalId
string
businessUnitId
integer <int64>
articleId
integer <int64>
page
required
integer <int32>
size
required
integer <int32>
Array of objects (SortProperty)

Responses

Obtener todos los proveedores de la organización

Authorizations:
Bearer Authentication

Responses

Obtener plantilla de carga en excel

Authorizations:
Bearer Authentication

Responses

Temporadas

Servicios referidos a las temporadas

Obtener temporada

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Editar temporada

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
query Parameters
name
required
string
startingDate
required
string <date>
endingDate
required
string <date>

Responses

Eliminar temporada

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Crear tempodad

Authorizations:
Bearer Authentication
query Parameters
name
required
string
startingDate
required
string <date>
endingDate
required
string <date>

Responses

Consultar temporadas paginado

Authorizations:
Bearer Authentication
query Parameters
name
string
page
required
integer <int32>
size
required
integer <int32>
Array of objects (SortProperty)

Responses

Stock histórico

Servicios referidos al histórico de stock

Salvar histórico de stock

Authorizations:
Bearer Authentication

Responses

Métodos de pago de proveedores

Servicios referidos a los métodos de pago de proveedores

Editar método de pago de proveedor

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
Request Body schema: application/json
name
required
string
paymentDeadlineDays
required
integer <int32>
typeId
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "paymentDeadlineDays": 0,
  • "typeId": 0
}

Eliminar método de pago de proveedor

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Crear método de pago de proveedor

Authorizations:
Bearer Authentication
Request Body schema: application/json
name
required
string
paymentDeadlineDays
required
integer <int32>
typeId
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "paymentDeadlineDays": 0,
  • "typeId": 0
}

Obtener todos los métodos de pago de proveedores de la organización

Authorizations:
Bearer Authentication

Responses

Unidades de compra

Servicios referidos a las unidades de compra

Obtener unidad de compra

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Editar unidad de compra

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
Request Body schema: application/json
purchaseUnit
string
conversionFactor
number <double>

Responses

Request samples

Content type
application/json
{
  • "purchaseUnit": "string",
  • "conversionFactor": 0
}

Eliminar uniadd de compra

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Crear unidades de compra

Authorizations:
Bearer Authentication
Request Body schema: application/json
purchaseUnit
string
conversionFactor
number <double>

Responses

Request samples

Content type
application/json
{
  • "purchaseUnit": "string",
  • "conversionFactor": 0
}

Consultar unidades de negocio paginado

Authorizations:
Bearer Authentication
query Parameters
name
string
page
required
integer <int32>
size
required
integer <int32>
Array of objects (SortProperty)

Responses

Obtener todas las unidades de compra de la organización

Authorizations:
Bearer Authentication

Responses

Chequeo de salud

Servicios para chequear el servidor

Chequeo

Responses

Autorización

Servicios para autenticación, registro de usuarios y organizaciones

Resetear contraseña

query Parameters
token
required
string
newPassword
required
string

Responses

Re enviar correo de validación

query Parameters
userEmail
required
string
organizationName
required
string

Responses

Hacer login en la aplicación

Luego de loguearse, se obtiene un token el cual se utilizará en todos los llamados del sistema.

Request Body schema: application/json
email
string
password
string
organizationName
string

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "password": "string",
  • "organizationName": "string"
}

Hacer login en la aplicación

Luego de loguearse, se obtiene un token el cual se utilizará en todos los llamados del sistema.

Request Body schema: application/json
organizationName
string

Responses

Request samples

Content type
application/json
{
  • "organizationName": "string"
}

Confirmar usuario

Confirmar usuario con un token.

query Parameters
token
required
string

Responses

Confirmar usuario y setear contraseña

Confirmar usuario con un token y setear contraseña.

query Parameters
token
required
string
password
required
string

Responses

Confirmar si el token existe

Para validar el usuario, se confirma que el mismo sea valido y si necesita setear password.

query Parameters
token
required
string

Responses

Movimientos de stock

Servicios referidos a los movimientos de stock

Establecer valor de stock usando IDs externos

Authorizations:
Bearer Authentication
Request Body schema: application/json
branchOfficeExternalId
string
skuExternalId
string
depositExternalId
string
stock
required
integer <int32>
reason
string
date
required
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "branchOfficeExternalId": "string",
  • "skuExternalId": "string",
  • "depositExternalId": "string",
  • "stock": 0,
  • "reason": "string",
  • "date": "2019-08-24T14:15:22Z"
}

Añadir movimiento de stock usando IDs externos

Authorizations:
Bearer Authentication
Request Body schema: application/json
branchOfficeExternalId
string
skuExternalId
string
depositExternalId
string
stock
required
integer <int32>
reason
string
date
required
string <date-time>
updateStock
boolean
type
required
string (StockMovementType)
Enum: "ADJUSTMENT" "REPOSITION_ORDER" "PURCHASE_ORDER"

Responses

Request samples

Content type
application/json
{
  • "branchOfficeExternalId": "string",
  • "skuExternalId": "string",
  • "depositExternalId": "string",
  • "stock": 0,
  • "reason": "string",
  • "date": "2019-08-24T14:15:22Z",
  • "updateStock": true,
  • "type": "ADJUSTMENT"
}

Añadir movimiento de stock

Authorizations:
Bearer Authentication
Request Body schema: application/json
skuBranchOfficeId
integer <int64>
skuDepositId
integer <int64>
stock
required
integer <int32>
reason
string
date
required
string <date-time>
updateStock
boolean
type
required
string (StockMovementType)
Enum: "ADJUSTMENT" "REPOSITION_ORDER" "PURCHASE_ORDER"

Responses

Request samples

Content type
application/json
{
  • "skuBranchOfficeId": 0,
  • "skuDepositId": 0,
  • "stock": 0,
  • "reason": "string",
  • "date": "2019-08-24T14:15:22Z",
  • "updateStock": true,
  • "type": "ADJUSTMENT"
}

Obtener tipo de movimientos de stock

Authorizations:
Bearer Authentication

Responses

Fechas comerciales

Servicios referidos a las fechas comerciales

Obtener fecha comercial

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Editar fecha comercial

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
query Parameters
name
required
string
startingDate
required
string <date>
endingDate
required
string <date>

Responses

Eliminar fecha comercial

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Crear fecha comercial

Authorizations:
Bearer Authentication
query Parameters
name
required
string
startingDate
required
string <date>
endingDate
required
string <date>

Responses

Órdenes de compra

Servicios referidos a las órdenes de compra

Obtener orden de compra

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Editar orden de compra

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
Request Body schema: application/json
branchOfficeOrDeposit
string
Enum: "BRANCH_OFFICE" "DEPOSIT"
branchOfficeOrDepositId
integer <int64>
estimatedDeliveryDate
string <date>
Array of objects (CreatePurchaseOrderSku)

Responses

Request samples

Content type
application/json
{
  • "branchOfficeOrDeposit": "BRANCH_OFFICE",
  • "branchOfficeOrDepositId": 0,
  • "estimatedDeliveryDate": "2019-08-24",
  • "skus": [
    ]
}

Cambiar estado de orden de compra

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
query Parameters
status
required
string
Enum: "SUGGESTED" "GENERATED" "SENT" "IN_PROGRESS" "PARTIAL" "NOT_COMPLETED" "COMPLETED" "CANCEL"
notCompletedReason
string

Responses

Crear orden de compra

Authorizations:
Bearer Authentication
path Parameters
businessUnitId
required
integer <int64>
Request Body schema: application/json
Array
supplierId
required
integer <int64>
branchOfficeOrDeposit
required
string
Enum: "BRANCH_OFFICE" "DEPOSIT"
branchOfficeOrDepositId
required
integer <int64>
required
Array of objects (CreatePurchaseOrderSku)
estimatedDeliveryDate
string <date>

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Vista previa de orden de compra

Authorizations:
Bearer Authentication
Request Body schema: application/json
Array
skuId
integer <int64>
supplierId
integer <int64>
quantity
integer <int32>
branchOfficeOrDepositId
integer <int64>
branchOfficeOrDeposit
string
Enum: "BRANCH_OFFICE" "DEPOSIT"

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Marcar órdenes de compras como recibida

Authorizations:
Bearer Authentication
Request Body schema: application/json
Array
id
integer <int64>
quantity
integer <int32>
date
string <date>
whoReceived
string
observations
string
updateStock
boolean

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Crear orden de compra

Authorizations:
Bearer Authentication
path Parameters
businessUnitId
required
integer <int64>
Request Body schema: application/json
Array
supplierExternalId
required
string
branchOfficeOrDeposit
required
string
Enum: "BRANCH_OFFICE" "DEPOSIT"
branchOfficeOrDepositIdExternalId
required
string
required
Array of objects (CreatePurchaseOrderSkuExternalId)
estimatedDeliveryDate
string <date>

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Obtener borrador de órdenes de compra para unidad de negocio

Authorizations:
Bearer Authentication
path Parameters
businessUnitId
required
integer <int64>

Responses

Crear borrador de órdenes de compra para unidad de negocio

Authorizations:
Bearer Authentication
path Parameters
businessUnitId
required
integer <int64>
Request Body schema: application/json
Array
skuId
integer <int64>
supplierId
integer <int64>
quantity
integer <int32>
branchOfficeOrDepositId
integer <int64>
branchOfficeOrDeposit
string
Enum: "BRANCH_OFFICE" "DEPOSIT"

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Obtener estadísticas de órdenes de compra

Authorizations:
Bearer Authentication

Responses

Consultar órdenes de compra paginado

Authorizations:
Bearer Authentication
query Parameters
businessUnitId
integer <int64>
supplierId
integer <int64>
startCreatedDate
string <date>
endCreatedDate
string <date>
startEstimatedDeliveryDate
string <date>
endEstimatedDeliveryDate
string <date>
status
string
Enum: "SUGGESTED" "GENERATED" "SENT" "IN_PROGRESS" "PARTIAL" "NOT_COMPLETED" "COMPLETED" "CANCEL"
articlesIds
Array of integers <int64> [ items <int64 > ]
categoriesIds
Array of integers <int64> [ items <int64 > ]
minStock
integer <int32>
maxStock
integer <int32>
page
required
integer <int32>
size
required
integer <int32>
Array of objects (SortProperty)

Responses

Eliminar orden de compra

Authorizations:
Bearer Authentication
path Parameters
purchaseOrderId
required
integer <int64>

Responses

Vehiculos

Servicios referidos a los vehiculos

Obtener vehiculo

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Editar vehiculo

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
query Parameters
name
string
code
string
brand
string
model
string
licensePlate
string
type
string
Enum: "TRUCK" "VAN" "CAR" "MOTORCYCLE"
maxCapacity
integer <int64>
fuelConsumption
number <double>

Responses

Eliminar vehiculo

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Editar cronograma de vehiculo

Authorizations:
Bearer Authentication
path Parameters
vehicleId
required
integer <int64>
scheduleId
required
integer <int64>
Request Body schema: application/json
code
integer <int64>
description
string
required
object (Recurrence)
branchOfficeIdFrom
integer <int64>
branchOfficeIdTo
integer <int64>
object (BranchOffice)
object (BranchOffice)
depositIdFrom
integer <int64>
depositIdTo
integer <int64>
object (Deposit)
object (Deposit)
object (Vehicle)
vehicleId
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "code": 0,
  • "description": "string",
  • "recurrence": {
    },
  • "branchOfficeIdFrom": 0,
  • "branchOfficeIdTo": 0,
  • "branchOfficeFrom": {
    },
  • "branchOfficeTo": {
    },
  • "depositIdFrom": 0,
  • "depositIdTo": 0,
  • "depositTo": {
    },
  • "depositFrom": {
    },
  • "vehicle": {
    },
  • "vehicleId": 0
}

Agregar deposito a vehiculo

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
query Parameters
depositId
required
integer <int64>

Responses

Agregar sucursal a vehiculo

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
query Parameters
branchOfficeId
required
integer <int64>

Responses

Agregar cronograma a vehiculo

Authorizations:
Bearer Authentication
Request Body schema: application/json
code
integer <int64>
description
string
required
object (Recurrence)
branchOfficeIdFrom
integer <int64>
branchOfficeIdTo
integer <int64>
object (BranchOffice)
object (BranchOffice)
depositIdFrom
integer <int64>
depositIdTo
integer <int64>
object (Deposit)
object (Deposit)
object (Vehicle)
vehicleId
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "code": 0,
  • "description": "string",
  • "recurrence": {
    },
  • "branchOfficeIdFrom": 0,
  • "branchOfficeIdTo": 0,
  • "branchOfficeFrom": {
    },
  • "branchOfficeTo": {
    },
  • "depositIdFrom": 0,
  • "depositIdTo": 0,
  • "depositTo": {
    },
  • "depositFrom": {
    },
  • "vehicle": {
    },
  • "vehicleId": 0
}

Crear vehiculo

Authorizations:
Bearer Authentication
Request Body schema: application/json
name
string
code
string
brand
string
model
string
licensePlate
string
maxCapacity
integer <int64>
fuelConsumption
number <double>
type
string (VehicleType)
Enum: "TRUCK" "VAN" "CAR" "MOTORCYCLE"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "code": "string",
  • "brand": "string",
  • "model": "string",
  • "licensePlate": "string",
  • "maxCapacity": 0,
  • "fuelConsumption": 0,
  • "type": "TRUCK"
}

Obtener tipo de vehículos

Authorizations:
Bearer Authentication

Responses

Remover cronograma de vehiculo

Authorizations:
Bearer Authentication
path Parameters
vehicleId
required
integer <int64>
scheduleId
required
integer <int64>

Responses

Eliminar deposito de vehiculo

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Eliminar surucsal de vehiculo

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Niveles de clientes

Servicios referidos a niveles de clientes

Obtener nivel de cliente

Obtener nivel

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Editar nivel

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
query Parameters
level
integer <int32>
name
string
active
boolean
accumulationFactor
number <double>
ruleType
string
ruleQuantity
integer <int32>
originType
string
description
string

Responses

Borrar nivel

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Crear nivel de cliente

Authorizations:
Bearer Authentication
Request Body schema: application/json
id
integer <int64>
level
required
integer <int32>

The level number for the client level

name
required
string

The name of the client level

description
string

A description of the client level

active
required
boolean

Indicates if the client level is active

accumulationFactor
required
number <double>

The accumulation factor for the client level

ruleType
required
string (RuleTypeLevel)
Enum: "AMOUNT_SPENT" "TOTAL_SPENT" "MONTHS_IN_PROGRAM" "ACCOUNT_POINTS"
ruleQuantity
integer <int32>

The quantity associated with the rule type

totalClients
integer <int32>

The total number of clients in this level

origin
required
string (LevelOrigin)
Enum: "MANUAL" "SUGGESTED"
createdAt
string

The creation timestamp of the client level

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "level": 0,
  • "name": "string",
  • "description": "string",
  • "active": true,
  • "accumulationFactor": 0,
  • "ruleType": "AMOUNT_SPENT",
  • "ruleQuantity": 0,
  • "totalClients": 0,
  • "origin": "MANUAL",
  • "createdAt": "string"
}

AI

Proxy genérico para servicios de AI

Proxy genérico

Redirige cualquier solicitud al servicio de AI

query Parameters
requestBody
required
object

Responses

Proxy genérico

Redirige cualquier solicitud al servicio de AI

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Proxy genérico

Redirige cualquier solicitud al servicio de AI

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Proxy genérico

Redirige cualquier solicitud al servicio de AI

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Proxy genérico

Redirige cualquier solicitud al servicio de AI

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Pricings

Servicios referidos a los pricings

Obtener pricing

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Editar pricing

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
Request Body schema: application/json
name
required
string
Array of objects (PricingDate)
endPrice
required
string
Enum: "BACK_TO_DEFAULT" "KEEP_THIS_PRICE" "NEW_PRICE"
newPrice
number <double>
value
number <double>
pricingTypeId
integer <int64>
Array of objects (PricingArticle)
branchOfficeIds
Array of integers <int64> [ items <int64 > ]
categoryIds
Array of integers <int64> [ items <int64 > ]
Array of objects (PricingArticleGroup)
brandId
integer <int64>
promotionId
integer <int64>
appliedStrategy
string
currencyId
integer <int64>
description
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "dates": [
    ],
  • "endPrice": "BACK_TO_DEFAULT",
  • "newPrice": 0,
  • "value": 0,
  • "pricingTypeId": 0,
  • "articlesIds": [
    ],
  • "branchOfficeIds": [
    ],
  • "categoryIds": [
    ],
  • "articleGroups": [
    ],
  • "brandId": 0,
  • "promotionId": 0,
  • "appliedStrategy": "string",
  • "currencyId": 0,
  • "description": "string"
}

Eliminar pricing

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Agendar pricing

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
query Parameters
startDate
required
string <date-time>
endDate
string <date-time>

Responses

Cancelar pricing

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Crear pricing

Authorizations:
Bearer Authentication
Request Body schema: application/json
name
required
string
Array of objects (PricingDate)
endPrice
required
string
Enum: "BACK_TO_DEFAULT" "KEEP_THIS_PRICE" "NEW_PRICE"
newPrice
number <double>
value
number <double>
pricingTypeId
integer <int64>
Array of objects (PricingArticle)
branchOfficeIds
Array of integers <int64> [ items <int64 > ]
categoryIds
Array of integers <int64> [ items <int64 > ]
Array of objects (PricingArticleGroup)
brandId
integer <int64>
promotionId
integer <int64>
appliedStrategy
string
currencyId
integer <int64>
description
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "dates": [
    ],
  • "endPrice": "BACK_TO_DEFAULT",
  • "newPrice": 0,
  • "value": 0,
  • "pricingTypeId": 0,
  • "articlesIds": [
    ],
  • "branchOfficeIds": [
    ],
  • "categoryIds": [
    ],
  • "articleGroups": [
    ],
  • "brandId": 0,
  • "promotionId": 0,
  • "appliedStrategy": "string",
  • "currencyId": 0,
  • "description": "string"
}

Obtener artículos de grupo de artículos de pricing

Authorizations:
Bearer Authentication
path Parameters
pricingId
required
integer <int64>
groupId
required
integer <int64>
query Parameters
page
required
integer <int32>
size
required
integer <int32>

Responses

Consultar pricing de articulo

Authorizations:
Bearer Authentication
query Parameters
articleId
integer <int64>
categoryId
integer <int64>
brandId
integer <int64>
page
required
integer <int32>
size
required
integer <int32>

Responses

Obtener pricing por mes

Authorizations:
Bearer Authentication
path Parameters
date
required
string <date>

Responses

Usuarios

Servicios referidos a los usuarios

Editar usuario

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
query Parameters
roleIds
required
Array of integers <int64> [ items <int64 > ]
businessUnitsIds
Array of integers <int64> [ items <int64 > ]
name
string
lastname
string
branchOfficesIds
Array of integers <int64> [ items <int64 > ]

Responses

Cambiar contraseña

Authorizations:
Bearer Authentication
query Parameters
oldPassword
required
string
newPassword
required
string

Responses

Editar mi usuario

Authorizations:
Bearer Authentication
query Parameters
name
string
lastname
string

Responses

Crear usuario

Authorizations:
Bearer Authentication
query Parameters
userEmail
required
string
roleIds
required
Array of integers <int64> [ items <int64 > ]
businessUnitsIds
Array of integers <int64> [ items <int64 > ]
branchOfficesIds
Array of integers <int64> [ items <int64 > ]

Responses

Obtener mi usuario

Authorizations:
Bearer Authentication

Responses

Eliminar usuario

Authorizations:
Bearer Authentication
path Parameters
userId
required
integer <int64>

Responses

Clusters

Servicios referidos a los grupos

Obtener grupo

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Editar grupo

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
query Parameters
name
required
string
depositsIds
Array of integers <int64> [ items <int64 > ]
branchOfficesIds
Array of integers <int64> [ items <int64 > ]

Responses

Eliminar grupo

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Agregar deposito a grupo

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
query Parameters
depositId
required
integer <int64>

Responses

Agregar sucursal a grupo

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
query Parameters
branchOfficeId
required
integer <int64>

Responses

Crear grupo

Authorizations:
Bearer Authentication
query Parameters
name
required
string
depositsIds
Array of integers <int64> [ items <int64 > ]
branchOfficesIds
Array of integers <int64> [ items <int64 > ]

Responses

Eliminar sucursal o deposito de grupo

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Órdenes de reposición

Servicios referidos a las órdenes de reposición

Obtener órden de reposición

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Editar órden de reposición

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
Request Body schema: application/json
branchOfficeOrDepositFromId
integer <int64>
branchOfficeOrDepositFrom
string
Enum: "BRANCH_OFFICE" "DEPOSIT"
branchOfficeOrDepositToId
integer <int64>
branchOfficeOrDepositTo
string
Enum: "BRANCH_OFFICE" "DEPOSIT"
estimatedDeliveryDate
string <date>
Array of objects (CreateRepositionOrderSku)

Responses

Request samples

Content type
application/json
{
  • "branchOfficeOrDepositFromId": 0,
  • "branchOfficeOrDepositFrom": "BRANCH_OFFICE",
  • "branchOfficeOrDepositToId": 0,
  • "branchOfficeOrDepositTo": "BRANCH_OFFICE",
  • "estimatedDeliveryDate": "2019-08-24",
  • "skus": [
    ]
}

Cambiar estado de órden de reposición

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
query Parameters
status
required
string
Enum: "SUGGESTED" "GENERATED" "SENT" "IN_PROGRESS" "PARTIAL" "NOT_COMPLETED" "COMPLETED" "CANCEL"

Responses

Crear órden de reposición

Authorizations:
Bearer Authentication
path Parameters
businessUnitId
required
integer <int64>
Request Body schema: application/json
Array
branchOfficeOrDepositFromId
integer <int64>
branchOfficeOrDepositFrom
string
Enum: "BRANCH_OFFICE" "DEPOSIT"
branchOfficeOrDepositToId
integer <int64>
branchOfficeOrDepositTo
string
Enum: "BRANCH_OFFICE" "DEPOSIT"
Array of objects (CreateRepositionOrderSku)
estimatedDeliveryDate
string <date>
purchaseOrderStatus
string
Enum: "SUGGESTED" "GENERATED" "SENT" "IN_PROGRESS" "PARTIAL" "NOT_COMPLETED" "COMPLETED" "CANCEL"

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Vista de previa órdenes de reposición

Authorizations:
Bearer Authentication
Request Body schema: application/json
Array
skuId
integer <int64>
branchOfficeOrDepositFromId
integer <int64>
branchOfficeOrDepositFrom
string
Enum: "BRANCH_OFFICE" "DEPOSIT"
branchOfficeOrDepositToId
integer <int64>
branchOfficeOrDepositTo
string
Enum: "BRANCH_OFFICE" "DEPOSIT"
quantity
integer <int32>
purchaseOrderStatus
string
Enum: "SUGGESTED" "GENERATED" "SENT" "IN_PROGRESS" "PARTIAL" "NOT_COMPLETED" "COMPLETED" "CANCEL"

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Marcar órdenes de reposición como recibidas

Authorizations:
Bearer Authentication
Request Body schema: application/json
Array
id
integer <int64>
quantity
integer <int32>
date
string <date>
whoReceived
string
observations
string
updateStock
boolean

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Marcar artículo de orden como enviado

Authorizations:
Bearer Authentication
query Parameters
estimatedDate
required
string <date>
repositionOrderSkuId
required
Array of integers <int64> [ items <int64 > ]

Responses

Crear órden de reposició por external id

Authorizations:
Bearer Authentication
path Parameters
businessUnitId
required
integer <int64>
Request Body schema: application/json
Array
branchOfficeOrDepositFromExternalId
string
branchOfficeOrDepositFrom
string
Enum: "BRANCH_OFFICE" "DEPOSIT"
branchOfficeOrDepositToExternalId
string
branchOfficeOrDepositTo
string
Enum: "BRANCH_OFFICE" "DEPOSIT"
Array of objects (CreateRepositionOrderSkuExternalId)
estimatedDeliveryDate
string <date>
purchaseOrderStatus
string
Enum: "SUGGESTED" "GENERATED" "SENT" "IN_PROGRESS" "PARTIAL" "NOT_COMPLETED" "COMPLETED" "CANCEL"

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Crear borrador de órdenes de reposición para unidad de negocio

Authorizations:
Bearer Authentication
path Parameters
businessUnitId
required
integer <int64>
branchOfficeToId
required
integer <int64>
Request Body schema: application/json
Array
skuId
integer <int64>
branchOfficeOrDepositFromId
integer <int64>
branchOfficeOrDepositFrom
string
Enum: "BRANCH_OFFICE" "DEPOSIT"
branchOfficeOrDepositToId
integer <int64>
branchOfficeOrDepositTo
string
Enum: "BRANCH_OFFICE" "DEPOSIT"
quantity
integer <int32>
purchaseOrderStatus
string
Enum: "SUGGESTED" "GENERATED" "SENT" "IN_PROGRESS" "PARTIAL" "NOT_COMPLETED" "COMPLETED" "CANCEL"

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Obtener estadísticas de órdenes de reposición

Authorizations:
Bearer Authentication

Responses

Consultar órdenes de reposición paginado

Authorizations:
Bearer Authentication
query Parameters
branchOfficeFromId
integer <int64>
depositFromId
integer <int64>
branchOfficeToId
integer <int64>
depositToId
integer <int64>
businessUnitId
integer <int64>
status
string
Enum: "SUGGESTED" "GENERATED" "SENT" "IN_PROGRESS" "PARTIAL" "NOT_COMPLETED" "COMPLETED" "CANCEL"
skuId
integer <int64>
articlesIds
Array of integers <int64> [ items <int64 > ]
startCreatedDate
string <date>
endCreatedDate
string <date>
startEstimatedDeliveryDate
string <date>
endEstimatedDeliveryDate
string <date>
page
required
integer <int32>
size
required
integer <int32>
Array of objects (SortProperty)

Responses

Consultar por quiebre de stock

Authorizations:
Bearer Authentication
query Parameters
skuId
integer <int64>
articleId
integer <int64>
minStock
integer <int32>
maxStock
integer <int32>
branchOfficeId
integer <int64>
businessUnitId
integer <int64>
page
required
integer <int32>
size
required
integer <int32>
Array of objects (SortProperty)

Responses

Obtener estadísticas de órdenes de reposición

Authorizations:
Bearer Authentication
query Parameters
filterDateFrom
string <date>
filterDateTo
string <date>
categoriesIds
Array of integers <int64> [ items <int64 > ]
brandsIds
Array of integers <int64> [ items <int64 > ]
branchOfficeIdFrom
integer <int64>
branchOfficeIdTo
integer <int64>
depositFrom
integer <int64>
depositTo
integer <int64>

Responses

Consultar órdenes de reposición paginado

Authorizations:
Bearer Authentication
query Parameters
branchOfficeFromId
integer <int64>
businessUnitId
integer <int64>
depositFromId
integer <int64>
branchOfficeToId
integer <int64>
depositToId
integer <int64>
status
string
Enum: "SUGGESTED" "GENERATED" "SENT" "IN_PROGRESS" "PARTIAL" "NOT_COMPLETED" "COMPLETED" "CANCEL"
skuId
integer <int64>
articlesIds
Array of integers <int64> [ items <int64 > ]
startCreatedDate
string <date>
endCreatedDate
string <date>
startEstimatedDeliveryDate
string <date>
endEstimatedDeliveryDate
string <date>
page
required
integer <int32>
size
required
integer <int32>
Array of objects (SortProperty)

Responses

Obtener lead time

Authorizations:
Bearer Authentication
query Parameters
filterDateFrom
string <date>
filterDateTo
string <date>
categoriesIds
Array of integers <int64> [ items <int64 > ]
brandsIds
Array of integers <int64> [ items <int64 > ]
branchOfficeIdFrom
integer <int64>
branchOfficeIdTo
integer <int64>

Responses

Consultar solicitudes

Authorizations:
Bearer Authentication
query Parameters
branchOfficeToId
integer <int64>
depositToId
integer <int64>
page
required
integer <int32>
size
required
integer <int32>
Array of objects (SortProperty)

Responses

Obtener borrador de órdenes de reposición para unidad de negocio

Authorizations:
Bearer Authentication
path Parameters
businessUnitId
required
integer <int64>

Responses

Obtener compliance

Authorizations:
Bearer Authentication
query Parameters
filterDateFrom
string <date>
filterDateTo
string <date>
categoriesIds
Array of integers <int64> [ items <int64 > ]
brandsIds
Array of integers <int64> [ items <int64 > ]
branchOfficeIdFrom
integer <int64>
branchOfficeIdTo
integer <int64>
depositFrom
integer <int64>
depositTo
integer <int64>

Responses

Eliminar órden de reposición

Authorizations:
Bearer Authentication
path Parameters
repositionOrderId
required
integer <int64>

Responses

Tipos de pricing

Servicios referidos a los tipos de pricing

Editar tipo de pricing

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
query Parameters
description
string
code
required
string

Responses

Eliminar tipo de pricing

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Crear tipo de pricing

Authorizations:
Bearer Authentication
query Parameters
description
string
code
required
string

Responses

Obtener todos los tipo de pricing de la organización

Authorizations:
Bearer Authentication

Responses

Recompensas

Servicios referidos a las recompensas

Obtener recompensa

Obtener recompensa

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Editar recompensa

Editar recompensa

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
query Parameters
name
required
string
description
string
instructionsForUse
string
availability
string
value
integer <int32>
typeId
integer <int64>
pointsValue
integer <int32>
globalLimit
integer <int32>
memberLimit
integer <int32>
memberUseLimit
integer <int32>
validityStart
string <date>
validityEnd
string <date>
expirationDate
string <date>
codeLength
integer <int32>
codeType
string
Enum: "ALPHANUMERIC" "CHARACTERS" "NUMBERS"
prefix
string
status
required
boolean
brandIds
Array of integers <int64> [ items <int64 > ]
categoryIds
Array of integers <int64> [ items <int64 > ]
clientSegmentIds
Array of integers <int64> [ items <int64 > ]
levelIds
Array of integers <int64> [ items <int64 > ]
articleIds
Array of integers <int64> [ items <int64 > ]
articleGroupIds
Array of integers <int64> [ items <int64 > ]

Responses

Borrar Recompensa

Borrar una recompensa

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Obtener tipo de recompensa

Obtener tipo de recompensa

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Editar tipo de recompensa

Editar un tipo de recompensa

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
query Parameters
name
string
status
boolean

Responses

Borrar tipo de recompensa

Borrar un tipo de recompensa

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Crear tipo de recompensa

Crear un nuevo tipo de recompensa

Authorizations:
Bearer Authentication
Request Body schema: application/json
name
required
string
status
required
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "status": true
}

Crear recompensa

Crear una nueva recompensa

Authorizations:
Bearer Authentication
Request Body schema: application/json
id
required
integer <int64>
name
required
string
rewardType
required
integer <int64>
createdAt
required
string <date-time>
availability
string
description
string <= 255 characters
instructionsForUse
string <= 255 characters
value
integer <int32>
pointsValue
integer <int32>
globalLimit
integer <int32>
memberLimit
integer <int32>
memberUseLimit
integer <int32>
validityStart
string <date>
status
required
boolean
validityEnd
string <date>
expirationDate
string <date>
codeLength
integer <int32>
codeType
string (CodeType)
Enum: "ALPHANUMERIC" "CHARACTERS" "NUMBERS"
prefix
string
organizationId
required
integer <int64>
brandIds
Array of integers <int64> [ items <int64 > ]
categoryIds
Array of integers <int64> [ items <int64 > ]
clientSegmentIds
Array of integers <int64> [ items <int64 > ]
levelIds
Array of integers <int64> [ items <int64 > ]
articleIds
Array of integers <int64> [ items <int64 > ]
articleGroupIds
Array of integers <int64> [ items <int64 > ]

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "rewardType": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "availability": "string",
  • "description": "string",
  • "instructionsForUse": "string",
  • "value": 0,
  • "pointsValue": 0,
  • "globalLimit": 0,
  • "memberLimit": 0,
  • "memberUseLimit": 0,
  • "validityStart": "2019-08-24",
  • "status": true,
  • "validityEnd": "2019-08-24",
  • "expirationDate": "2019-08-24",
  • "codeLength": 0,
  • "codeType": "ALPHANUMERIC",
  • "prefix": "string",
  • "organizationId": 0,
  • "brandIds": [
    ],
  • "categoryIds": [
    ],
  • "clientSegmentIds": [
    ],
  • "levelIds": [
    ],
  • "articleIds": [
    ],
  • "articleGroupIds": [
    ]
}

Organización

Servicios referidos a las organizaciones

Obtener organización por id

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Modificar organización

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
Request Body schema: application/json
realName
string
businessName
string
rut
string
address
string

Responses

Request samples

Content type
application/json
{
  • "realName": "string",
  • "businessName": "string",
  • "rut": "string",
  • "address": "string"
}

Crear organización con usuario administrador

Crea una nueva organización, con el usuario administrador (y contraseña que se elija). Se envía un correo para verificar la cuenta y así activar tanto el usuario como la organización.

query Parameters
organizationName
required
string
userEmail
required
string
password
required
string

Responses

Notificaciones

Servicios referidos a los notificaciones

Marcar como leída

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Marcar como leída

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Obtener notificaciones del usuario

Authorizations:
Bearer Authentication
query Parameters
page
required
integer <int32>
size
required
integer <int32>

Responses

Métodos de pago aceptados

Servicios referidos a los métodos de pago aceptados

Obtener método de pago aceptado

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Editar método de pago aceptado

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
Request Body schema: application/json
externalId
string
name
required
string
typeId
integer <int64>
feeRangeMin
integer <int32>
feeRangeMax
integer <int32>
businessUnitsIds
Array of integers <int64> [ items <int64 > ]

Responses

Request samples

Content type
application/json
{
  • "externalId": "string",
  • "name": "string",
  • "typeId": 0,
  • "feeRangeMin": 0,
  • "feeRangeMax": 0,
  • "businessUnitsIds": [
    ]
}

Eliminar método de pago aceptado

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Validar existencia de externalIds de sucursales

Authorizations:
Bearer Authentication
query Parameters
externalIds
required
Array of strings

Responses

Carga de métodos de pago aceptado por archivo excel

Authorizations:
Bearer Authentication
Request Body schema: application/json
file
required
string <binary>

Responses

Request samples

Content type
application/json
{
  • "file": "string"
}

Crear método de pago aceptado

Authorizations:
Bearer Authentication
Request Body schema: application/json
externalId
string
name
required
string
typeId
integer <int64>
feeRangeMin
integer <int32>
feeRangeMax
integer <int32>
businessUnitsIds
Array of integers <int64> [ items <int64 > ]

Responses

Request samples

Content type
application/json
{
  • "externalId": "string",
  • "name": "string",
  • "typeId": 0,
  • "feeRangeMin": 0,
  • "feeRangeMax": 0,
  • "businessUnitsIds": [
    ]
}

Obtener tipos de método de pago aceptado

Authorizations:
Bearer Authentication

Responses

Consultar métodos de pago paginado

Authorizations:
Bearer Authentication
query Parameters
id
integer <int64>
name
string
externalId
string
page
required
integer <int32>
size
required
integer <int32>
Array of objects (SortProperty)

Responses

Obtener método de pago aceptado por unidad de negocio

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Obtener todos los métodos de pago aceptado de la organización

Authorizations:
Bearer Authentication

Responses

Obtener plantilla de carga en excel

Authorizations:
Bearer Authentication

Responses

Artículos

Servicios referidos a los artículos

Obtener artículo

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Editar artículo

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
query Parameters
name
required
string
externalId
string
description
string
categoryId
integer <int64>
brandId
integer <int64>
cost
number <double>
defaultPrice
number <double>
currencyId
integer <int64>
costCurrency
integer <int64>
roundingTypeId
integer <int64>
enable
required
boolean
discontinued
required
boolean
minimumPrice
number <double>
maximumPrice
number <double>
minimumMargin
number <double>
originType
string
Enum: "IMPORTED_ARTICLE" "BUY_IN_SQUARE"
businessUnitsIds
required
Array of integers <int64> [ items <int64 > ]
seasonsIds
Array of integers <int64> [ items <int64 > ]
curvesIds
Array of integers <int64> [ items <int64 > ]
webDescription
string
photo1
string
photo2
string
photo3
string

Responses

Eliminar artículo

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Alternar discontinuidad

Cambia el estado de discontinuidad del artículo

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Editar proveedor de artículo

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
Request Body schema: application/json
supplierId
required
integer <int64>
principal
required
boolean
required
object (CommercialTerm)
purchaseUnitId
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "supplierId": 0,
  • "principal": true,
  • "commercialTerm": {
    },
  • "purchaseUnitId": 0
}

Editar SKU a artículo

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
query Parameters
externalId
string
name
required
string
enable
boolean
heightWithPackaging
number <double>
lengthWithPackaging
number <double>
widthWithPackaging
number <double>
weightWithPackaging
number <double>
height
number <double>
length
number <double>
width
number <double>
weight
number <double>
volumen
number <double>
kit
boolean
salesUnit
string
storageUnit
string
minimumStock
integer <int32>
shoeSize
number <double>
clothSizeOp1
integer <int32>
clothSizeOp2
string
colourId
integer <int64>
brand
string
cost
number <double>
replenish
boolean
currencyId
integer <int64>

Responses

Eliminar SKU de artículo

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Editar SKU a artículo con id externo

Authorizations:
Bearer Authentication
path Parameters
externalId
required
string
query Parameters
newExternalId
string
name
required
string
enable
boolean
heightWithPackaging
number <double>
lengthWithPackaging
number <double>
widthWithPackaging
number <double>
weightWithPackaging
number <double>
height
number <double>
length
number <double>
width
number <double>
weight
number <double>
volumen
number <double>
kit
boolean
salesUnit
string
storageUnit
string
minimumStock
integer <int32>
shoeSize
number <double>
clothSizeOp1
integer <int32>
clothSizeOp2
string
colourId
integer <int64>
brand
string
cost
number <double>
replenish
boolean
currencyId
integer <int64>

Responses

Eliminar SKU de artículo por id externo

Authorizations:
Bearer Authentication
path Parameters
externalId
required
string

Responses

Editar atributo de sku

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
query Parameters
value
string
idEnum
integer <int64>

Responses

Eliminar atributo de sku

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Editar artículo por External ID

Authorizations:
Bearer Authentication
path Parameters
externalId
required
string
query Parameters
name
required
string
description
string
categoryId
integer <int64>
brandId
integer <int64>
cost
number <double>
defaultPrice
number <double>
currencyId
integer <int64>
roundingTypeId
integer <int64>
enable
required
boolean
discontinued
required
boolean
minimumPrice
number <double>
maximumPrice
number <double>
minimumMargin
number <double>
originType
string
Enum: "IMPORTED_ARTICLE" "BUY_IN_SQUARE"
businessUnitsIds
required
Array of integers <int64> [ items <int64 > ]
seasonsIds
Array of integers <int64> [ items <int64 > ]
curvesIds
Array of integers <int64> [ items <int64 > ]
webDescription
string
photo1
string
photo2
string
photo3
string

Responses

Eliminar artículo por id externo

Authorizations:
Bearer Authentication
path Parameters
externalId
required
string

Responses

Editar atributo de artículo

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
query Parameters
value
string
idEnum
integer <int64>

Responses

Eliminar atributo de artículo

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Agregar SKU a artículo

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
Request Body schema: application/json
name
string
externalId
string
enable
boolean
heightWithPackaging
number <double>
lengthWithPackaging
number <double>
widthWithPackaging
number <double>
weightWithPackaging
number <double>
height
number <double>
length
number <double>
width
number <double>
weight
number <double>
volumen
number <double>
kit
boolean
salesUnit
string
storageUnit
string
minimumStock
integer <int32>
shoeSize
number <double>
clothSizeOp1
integer <int32>
clothSizeOp2
string
cost
number <double>
colourId
integer <int64>
replenish
boolean
currencyId
integer <int64>
Array of objects (AttributeValue)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "externalId": "string",
  • "enable": true,
  • "heightWithPackaging": 0,
  • "lengthWithPackaging": 0,
  • "widthWithPackaging": 0,
  • "weightWithPackaging": 0,
  • "height": 0,
  • "length": 0,
  • "width": 0,
  • "weight": 0,
  • "volumen": 0,
  • "kit": true,
  • "salesUnit": "string",
  • "storageUnit": "string",
  • "minimumStock": 0,
  • "shoeSize": 0,
  • "clothSizeOp1": 0,
  • "clothSizeOp2": "string",
  • "cost": 0,
  • "colourId": 0,
  • "replenish": true,
  • "currencyId": 0,
  • "attributes": [
    ]
}

Agregar temporada a artículo

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
query Parameters
seasonId
required
integer <int64>

Responses

Agregar precio a artículo

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
query Parameters
branchOfficeId
required
integer <int64>
price
required
number <double>
date
string <date-time>

Responses

Agregar curva a artículo

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
query Parameters
curveId
required
integer <int64>

Responses

Agregar atributo a artículo

Authorizations:
Bearer Authentication
path Parameters
articleId
required
integer <int64>
query Parameters
attributeId
required
integer <int64>
value
string
idEnum
integer <int64>

Responses

Validar existencia de externalIds de artículos

Authorizations:
Bearer Authentication
Request Body schema: application/json
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Agregar atributo a sku

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
query Parameters
attributeId
required
integer <int64>
value
string
idEnum
integer <int64>

Responses

Validar existencia de externalIds de SKUs

Authorizations:
Bearer Authentication
query Parameters
externalIds
required
Array of strings

Responses

Carga de articulos por archivo excel

Authorizations:
Bearer Authentication
Request Body schema: application/json
file
required
string <binary>

Responses

Request samples

Content type
application/json
{
  • "file": "string"
}

Crear artículo con external ids

Authorizations:
Bearer Authentication
Request Body schema: application/json
externalId
string
name
required
string
description
string
categoryExternalId
required
string
brandExternalId
required
string
cost
number <double>
defaultPrice
number <double>
currencyName
string
costCurrency
integer <int64>
enable
boolean
Array of objects (SkuExternalId)
Array of objects (AttributeValue)
businessUnitsIds
required
Array of integers <int64> [ items <int64 > ]
discontinued
boolean
minimumPrice
number <double>
maximumPrice
number <double>
minimumMargin
number <double>
webDescription
string
photo1
string
photo2
string
photo3
string
originType
string (OriginType)
Enum: "IMPORTED_ARTICLE" "BUY_IN_SQUARE" "PURCHASE_ORDER"

Responses

Request samples

Content type
application/json
{
  • "externalId": "string",
  • "name": "string",
  • "description": "string",
  • "categoryExternalId": "string",
  • "brandExternalId": "string",
  • "cost": 0,
  • "defaultPrice": 0,
  • "currencyName": "string",
  • "costCurrency": 0,
  • "enable": true,
  • "skus": [
    ],
  • "attributes": [
    ],
  • "businessUnitsIds": [
    ],
  • "discontinued": true,
  • "minimumPrice": 0,
  • "maximumPrice": 0,
  • "minimumMargin": 0,
  • "webDescription": "string",
  • "photo1": "string",
  • "photo2": "string",
  • "photo3": "string",
  • "originType": "IMPORTED_ARTICLE"
}

Agregar SKU a artículo por external id

Authorizations:
Bearer Authentication
path Parameters
articleExternalId
required
string
Request Body schema: application/json
name
string
externalId
string
enable
boolean
heightWithPackaging
number <double>
lengthWithPackaging
number <double>
widthWithPackaging
number <double>
weightWithPackaging
number <double>
height
number <double>
length
number <double>
width
number <double>
weight
number <double>
volumen
number <double>
kit
boolean
salesUnit
string
storageUnit
string
minimumStock
integer <int32>
shoeSize
number <double>
clothSizeOp1
integer <int32>
clothSizeOp2
string
cost
number <double>
colourName
string
replenish
boolean
currencyName
string
Array of objects (AttributeValue)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "externalId": "string",
  • "enable": true,
  • "heightWithPackaging": 0,
  • "lengthWithPackaging": 0,
  • "widthWithPackaging": 0,
  • "weightWithPackaging": 0,
  • "height": 0,
  • "length": 0,
  • "width": 0,
  • "weight": 0,
  • "volumen": 0,
  • "kit": true,
  • "salesUnit": "string",
  • "storageUnit": "string",
  • "minimumStock": 0,
  • "shoeSize": 0,
  • "clothSizeOp1": 0,
  • "clothSizeOp2": "string",
  • "cost": 0,
  • "colourName": "string",
  • "replenish": true,
  • "currencyName": "string",
  • "attributes": [
    ]
}

Crear artículo

Authorizations:
Bearer Authentication
Request Body schema: application/json
externalId
string
name
required
string
description
string
categoryId
required
integer <int64>
brandId
required
integer <int64>
cost
number <double>
defaultPrice
number <double>
currencyId
integer <int64>
costCurrency
integer <int64>
roundingTypeId
integer <int64>
enable
boolean
Array of objects (Sku)
Array of objects (AttributeValue)
Array of objects (SupplierArticles)
businessUnitsIds
required
Array of integers <int64> [ items <int64 > ]
seasonsIds
Array of integers <int64> [ items <int64 > ]
curvesIds
Array of integers <int64> [ items <int64 > ]
discontinued
boolean
minimumPrice
number <double>
maximumPrice
number <double>
minimumMargin
number <double>
webDescription
string
photo1
string
photo2
string
photo3
string
originType
string (OriginType)
Enum: "IMPORTED_ARTICLE" "BUY_IN_SQUARE" "PURCHASE_ORDER"

Responses

Request samples

Content type
application/json
{
  • "externalId": "string",
  • "name": "string",
  • "description": "string",
  • "categoryId": 0,
  • "brandId": 0,
  • "cost": 0,
  • "defaultPrice": 0,
  • "currencyId": 0,
  • "costCurrency": 0,
  • "roundingTypeId": 0,
  • "enable": true,
  • "skus": [
    ],
  • "attributes": [
    ],
  • "suppliers": [
    ],
  • "businessUnitsIds": [
    ],
  • "seasonsIds": [
    ],
  • "curvesIds": [
    ],
  • "discontinued": true,
  • "minimumPrice": 0,
  • "maximumPrice": 0,
  • "minimumMargin": 0,
  • "webDescription": "string",
  • "photo1": "string",
  • "photo2": "string",
  • "photo3": "string",
  • "originType": "IMPORTED_ARTICLE"
}

Obtener los tipos de documento de los tickets

Authorizations:
Bearer Authentication

Responses

Obtener los tipos de sexo de la apliación

Authorizations:
Bearer Authentication

Responses

Obtener los tipos de recuerrencia de la aplicación

Authorizations:
Bearer Authentication

Responses

Obtener los tipos de fin de pricing de la aplicación

Authorizations:
Bearer Authentication

Responses

Consulta skus dado id de sucursal, id de marca e id de categoría e id de articulo e id de sku

Authorizations:
Bearer Authentication
query Parameters
brandId
integer <int64>
categoryId
required
integer <int64>
articleId
integer <int64>
skuId
integer <int64>
unsupply
boolean
page
required
integer <int32>
size
required
integer <int32>

Responses

Consulta skus dado id de sucursal o depósito, id de marca e id de categoría

Authorizations:
Bearer Authentication
query Parameters
branchOfficeId
integer <int64>
depositId
integer <int64>
brandId
required
integer <int64>
categoryId
required
integer <int64>
unsupply
boolean
page
required
integer <int32>
size
required
integer <int32>

Responses

Consulta categorias por marca, categoria, articulo , sku

Authorizations:
Bearer Authentication
query Parameters
brandId
required
integer <int64>
articleId
integer <int64>
categoryId
integer <int64>
skuId
integer <int64>
page
required
integer <int32>
size
required
integer <int32>

Responses

Consulta categorías por marca, categoría, artículo, SKU

Authorizations:
Bearer Authentication
query Parameters
brandId
required
integer <int64>
articleId
integer <int64>
categoryId
integer <int64>
skuId
integer <int64>
unsupply
boolean
page
required
integer <int32>
size
required
integer <int32>

Responses

Consulta categorias id de sucursal e id de marca

Authorizations:
Bearer Authentication
query Parameters
branchOfficeId
integer <int64>
depositId
integer <int64>
brandId
required
integer <int64>
unsupply
boolean
page
required
integer <int32>
size
required
integer <int32>

Responses

Consulta categorias id de sucursal e id de marca

Authorizations:
Bearer Authentication
query Parameters
branchOfficeId
required
integer <int64>
brandId
required
integer <int64>
unsupply
boolean
page
required
integer <int32>
size
required
integer <int32>

Responses

Consulta sku por id de sucursal

Authorizations:
Bearer Authentication
query Parameters
branchOfficeId
required
integer <int64>
unsupply
boolean
page
required
integer <int32>
size
required
integer <int32>

Responses

Consulta marcas por marca, categoria, articulo , sku

Authorizations:
Bearer Authentication
query Parameters
brandId
integer <int64>
articleId
integer <int64>
categoryId
integer <int64>
skuId
integer <int64>
page
required
integer <int32>
size
required
integer <int32>

Responses

Consulta marcas por marca, categoria, articulo, sku

Authorizations:
Bearer Authentication
query Parameters
brandId
integer <int64>
articleId
integer <int64>
categoryId
integer <int64>
skuId
integer <int64>
unsupply
boolean
page
required
integer <int32>
size
required
integer <int32>

Responses

Consulta marcas por id de sucursal

Authorizations:
Bearer Authentication
query Parameters
branchOfficeId
integer <int64>
depositId
integer <int64>
unsupply
boolean
page
required
integer <int32>
size
required
integer <int32>

Responses

Consulta marcas por id de sucursal y trae stock

Authorizations:
Bearer Authentication
query Parameters
branchOfficeId
required
integer <int64>
unsupply
boolean
page
required
integer <int32>
size
required
integer <int32>

Responses

Consultar artículos paginado

Authorizations:
Bearer Authentication
query Parameters
id
integer <int64>
externalId
string
name
string
categoryId
integer <int64>
brandId
integer <int64>
businessUnitId
integer <int64>
page
required
integer <int32>
size
required
integer <int32>
Array of objects (SortProperty)

Responses

Consultar por skus con stock 0

Authorizations:
Bearer Authentication
query Parameters
branchOfficeId
integer <int64>
categoriesIds
Array of integers <int64> [ items <int64 > ]
brandsIds
Array of integers <int64> [ items <int64 > ]
page
required
integer <int32>
size
required
integer <int32>
Array of objects (SortProperty)

Responses

Consultar skus paginado

Authorizations:
Bearer Authentication
query Parameters
articleId
integer <int64>
externalId
string
externalArticleId
string
articleName
string
name
string
id
integer <int64>
categoryId
integer <int64>
page
required
integer <int32>
size
required
integer <int32>
Array of objects (SortProperty)

Responses

Consulta sku con stock en sucursal

Authorizations:
Bearer Authentication
query Parameters
articleId
integer <int64>
branchOfficeId
required
integer <int64>
businessUnitId
required
integer <int64>
skuId
integer <int64>
page
required
integer <int32>
size
required
integer <int32>

Responses

Obtener artículos por proveedor

Se obtiene un JSONObject

Authorizations:
Bearer Authentication

Responses

Obtener todos los artículos de la organización

Authorizations:
Bearer Authentication

Responses

Obtener todos los artículos con sus stocks de la organización

Authorizations:
Bearer Authentication

Responses

Obtener todos los artículos con sus stocks ordenados de la organización

Authorizations:
Bearer Authentication
query Parameters
page
required
integer <int32>
size
required
integer <int32>
sortStock
string
articlesIds
Array of integers <int64> [ items <int64 > ]
categoriesIds
Array of integers <int64> [ items <int64 > ]

Responses

Obtener todos los artículos con sus skus y stocks de la organización

Authorizations:
Bearer Authentication
query Parameters
page
required
integer <int32>
size
required
integer <int32>
sortStock
string

Responses

Obtener todos los artículos y sus skus de la organización

Authorizations:
Bearer Authentication

Responses

Obtener plantilla de carga en excel

Authorizations:
Bearer Authentication

Responses

Remover curva de artículo

Authorizations:
Bearer Authentication
path Parameters
articleId
required
integer <int64>
curveId
required
integer <int64>

Responses

Eliminar temporada de artículo

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Eliminar precio de artículo

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Colores

Servicios referidos a los colores

Obtener color

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Editar color

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
query Parameters
name
required
string

Responses

Borrar color

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Crear color

Authorizations:
Bearer Authentication
Request Body schema: application/json
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Reglas

Servicios referidos a las reglas

Crear ordenes de reposición en sucursales con por debajo del mínimo.

Authorizations:
Bearer Authentication

Responses

Crear ordenes de reposición en sucursales con stock 0.

Authorizations:
Bearer Authentication

Responses

Competidores

Servicios referidos a los competidores

Obtener Competidor

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Editar competidor

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
query Parameters
externalId
string
name
required
string
website
string
articlesIds
required
Array of integers <int64> [ items <int64 > ]

Responses

Eliminar competidor

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Carga de marcas por archivo excel

Authorizations:
Bearer Authentication
Request Body schema: application/json
file
required
string <binary>

Responses

Request samples

Content type
application/json
{
  • "file": "string"
}

Crear competidor

Authorizations:
Bearer Authentication
query Parameters
externalId
string
name
required
string
website
string
articlesIds
required
Array of integers <int64> [ items <int64 > ]

Responses

Obtener plantilla de carga en excel

Authorizations:
Bearer Authentication

Responses

Unidades de negocio

Servicios referidos a las unidades de negocio

Editar unidad de negocio

Authorizations:
Bearer Authentication
path Parameters
businessUnitId
required
integer <int64>
query Parameters
name
required
string
languageId
integer <int64>
currencyId
integer <int64>
targetMargin
number <double>

Responses

Eliminar unidad de negocio

Authorizations:
Bearer Authentication
path Parameters
businessUnitId
required
integer <int64>

Responses

Editar canal

Authorizations:
Bearer Authentication
path Parameters
channelId
required
integer <int64>
query Parameters
channelTypeId
required
integer <int64>
currenciesIds
Array of integers <int64> [ items <int64 > ]

Responses

Crear canal en la unidad de negocio

Authorizations:
Bearer Authentication
path Parameters
businessUnitId
required
integer <int64>
query Parameters
channelTypeId
required
integer <int64>
currenciesIds
Array of integers <int64> [ items <int64 > ]

Responses

Crear unidad de negocio

Authorizations:
Bearer Authentication
query Parameters
name
required
string
languageId
integer <int64>
currencyId
integer <int64>

Responses

Obener unidad de negocio

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Obtener todas las unidades de negocio de la organización

Authorizations:
Bearer Authentication

Responses

Obtener todos los canales de la organización

Authorizations:
Bearer Authentication

Responses

Clientes

Servicios referidos a los clientes y segmentos de clientes

Obtener cliente

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Editar cliente

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
query Parameters
birthdate
string <date>
externalId
string
idTypeId
integer <int64>
idNumber
string
countryId
integer <int64>
stateId
integer <int64>
levelId
integer <int64>
sex
string
Enum: "MALE" "FEMALE" "OTHER"
active
boolean
fidelity
string

Responses

Eliminar cliente

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Obtener segmento de clientes

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
query Parameters
page
required
integer <int32>
size
required
integer <int32>
sortBy
required
string
direction
required
string

Responses

Editar segmento de cliente

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
query Parameters
name
required
string
description
string
type
required
string
Enum: "STATIC" "DYNAMIC"
sex
string
Enum: "MALE" "FEMALE" "OTHER"
averageTicket
number <double>
purchaseCountPeriod
integer <int32>
purchaseCountLastDays
integer <int32>
purchaseCountRange
integer <int32>
purchaseCountStartDate
string <date>
purchaseCountEndDate
string <date>
totalSpent
number <double>
origin
string
Enum: "MANUAL" "SUGGESTED"
birthdayStartDate
string <date>
birthdayEndDate
string <date>
programRegistrationStartDate
string <date>
programRegistrationEndDate
string <date>
minAge
integer <int32>
maxAge
integer <int32>
active
required
boolean
clientIds
Array of integers <int64> [ items <int64 > ]
stateId
integer <int64>
articleIds
Array of integers <int64> [ items <int64 > ]
skuIds
Array of integers <int64> [ items <int64 > ]
brandIds
Array of integers <int64> [ items <int64 > ]
purchaseChannelIds
Array of integers <int64> [ items <int64 > ]

Responses

Eliminar segmento de cliente

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>

Responses

Editar recomendacion de producto

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
query Parameters
articleId
required
integer <int64>
skuId
required
integer <int64>
buyProbability
number <double>

Responses

Editar cliente por id externo

Authorizations:
Bearer Authentication
path Parameters
externalId
required
string
query Parameters
birthdate
string <date>
idTypeId
integer <int64>
idNumber
string
countryId
integer <int64>
stateId
integer <int64>
sex
string
Enum: "MALE" "FEMALE" "OTHER"
levelId
integer <int64>
active
boolean
fidelity
string

Responses

Setear puntos a cliente

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
query Parameters
activePoints
required
integer <int32>
pendingPoints
required
integer <int32>

Responses

Agregar recomendacion de producto a cliente

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
Request Body schema: application/json
articleId
integer <int64>
skuId
integer <int64>
categoryId
integer <int64>
buyProbability
number <double>

Responses

Request samples

Content type
application/json
{
  • "articleId": 0,
  • "skuId": 0,
  • "categoryId": 0,
  • "buyProbability": 0
}

Agregar movimiento de puntos a cliente

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
Request Body schema: application/json
name
required
string
comments
string
type
required
string (MovementType)
Enum: "ACCUMULATION" "CONSUMPTION" "ADJUSTMENT"
clientId
required
integer <int64>
pointsMoved
required
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "comments": "string",
  • "type": "ACCUMULATION",
  • "clientId": 0,
  • "pointsMoved": 0
}

Agregar segmento a cliente

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
query Parameters
segmentId
required
integer <int64>

Responses

Agregar nivel a cliente

Authorizations:
Bearer Authentication
path Parameters
id
required
integer <int64>
query Parameters
levelId
required
integer <int64>

Responses

Previsualizar clientes dinámicos

Previsualiza los clientes dinámicos basados en el payload del segmento de cliente

Authorizations:
Bearer Authentication
query Parameters
page
required
integer <int32>
size
required
integer <int32>
sortBy
string
Default: "id"
direction
string
Default: "ASC"
Request Body schema: application/json
name
required
string
description
string
type
required
string (ClientSegmentType)
Enum: "STATIC" "DYNAMIC"
origin
string (GroupOrigin)
Enum: "MANUAL" "SUGGESTED"
sex
string (Sex)
Enum: "MALE" "FEMALE" "OTHER"
averageTicket
number <double>
purchaseCountPeriod
integer <int32>
purchaseCountLastDays
integer <int32>
purchaseCountRange
integer <int32>
purchaseCountStartDate
string <date>
purchaseCountEndDate
string <date>
totalSpent
number <double>
birthdayStartDate
string <date>
birthdayEndDate
string <date>
programRegistrationStartDate
string <date>
programRegistrationEndDate
string <date>
minAge
integer <int32>
maxAge
integer <int32>
active
required
boolean
levelId
integer <int64>
clientIds
Array of integers <int64> [ items <int64 > ]
articleIds
Array of integers <int64> [ items <int64 > ]
skuIds
Array of integers <int64> [ items <int64 > ]
brandIds
Array of integers <int64> [ items <int64 > ]
purchaseChannelIds
Array of integers <int64> [ items <int64 > ]
stateId
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "type": "STATIC",
  • "origin": "MANUAL",
  • "sex": "MALE",
  • "averageTicket": 0,
  • "purchaseCountPeriod": 0,
  • "purchaseCountLastDays": 0,
  • "purchaseCountRange": 0,
  • "purchaseCountStartDate": "2019-08-24",
  • "purchaseCountEndDate": "2019-08-24",
  • "totalSpent": 0,
  • "birthdayStartDate": "2019-08-24",
  • "birthdayEndDate": "2019-08-24",
  • "programRegistrationStartDate": "2019-08-24",
  • "programRegistrationEndDate": "2019-08-24",
  • "minAge": 0,
  • "maxAge": 0,
  • "active": true,
  • "levelId": 0,
  • "clientIds": [
    ],
  • "articleIds": [
    ],
  • "skuIds": [
    ],
  • "brandIds": [
    ],
  • "purchaseChannelIds": [
    ],
  • "stateId": 0
}

Crear segmento de cliente

Authorizations:
Bearer Authentication
Request Body schema: application/json
name
required
string
description
string
type
required
string (ClientSegmentType)
Enum: "STATIC" "DYNAMIC"
origin
string (GroupOrigin)
Enum: "MANUAL" "SUGGESTED"
sex
string (Sex)
Enum: "MALE" "FEMALE" "OTHER"
averageTicket
number <double>
purchaseCountPeriod
integer <int32>
purchaseCountLastDays
integer <int32>
purchaseCountRange
integer <int32>
purchaseCountStartDate
string <date>
purchaseCountEndDate
string <date>
totalSpent
number <double>
birthdayStartDate
string <date>
birthdayEndDate
string <date>
programRegistrationStartDate
string <date>
programRegistrationEndDate
string <date>
minAge
integer <int32>
maxAge
integer <int32>
active
required
boolean
levelId
integer <int64>
clientIds
Array of integers <int64> [ items <int64 > ]
articleIds
Array of integers <int64> [ items <int64 > ]
skuIds
Array of integers <int64> [ items <int64 > ]
brandIds
Array of integers <int64> [ items <int64 > ]
purchaseChannelIds
Array of integers <int64> [ items <int64 > ]
stateId
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "type": "STATIC",
  • "origin": "MANUAL",
  • "sex": "MALE",
  • "averageTicket": 0,
  • "purchaseCountPeriod": 0,
  • "purchaseCountLastDays": 0,
  • "purchaseCountRange": 0,
  • "purchaseCountStartDate": "2019-08-24",
  • "purchaseCountEndDate": "2019-08-24",
  • "totalSpent": 0,
  • "birthdayStartDate": "2019-08-24",
  • "birthdayEndDate": "2019-08-24",
  • "programRegistrationStartDate": "2019-08-24",
  • "programRegistrationEndDate": "2019-08-24",
  • "minAge": 0,
  • "maxAge": 0,
  • "active": true,
  • "levelId": 0,
  • "clientIds": [
    ],
  • "articleIds": [
    ],
  • "skuIds": [
    ],
  • "brandIds": [
    ],
  • "purchaseChannelIds": [
    ],
  • "stateId": 0
}

Crear cliente

Authorizations:
Bearer Authentication
query Parameters
birthdate
string <date>
idTypeId
integer <int64>
idNumber
string
countryId
integer <int64>
stateId
integer <int64>
sex
string
Enum: "MALE" "FEMALE" "OTHER"
active
boolean
fidelity
string
externalId
string

Responses

Consultar segmento de clientes paginado

Consulta segmentos de clientes con filtros y paginación

Authorizations:
Bearer Authentication
query Parameters
name
string
description
string
minMembers
integer <int64>
maxMembers
integer <int64>
status
boolean
minAverageTicket
number <double>
maxAverageTicket
number <double>
minTotalSpent
number <double>
maxTotalSpent
number <double>
minTransactions
integer <int64>
maxTransactions
integer <int64>
startDate
string <date-time>
endDate
string <date-time>
page
required
integer <int32>
size
required
integer <int32>
Array of objects (SortProperty)

Responses

Obtener todos los segmentos de clientes

Authorizations:
Bearer Authentication

Responses

Obtener cantidad de clientes de un listado de id de segmentos

Authorizations:
Bearer Authentication
query Parameters
segmentIds
required
Array of integers <int64> [ items <int64 > ]

Responses

Obtener todos los clientes de la organización

Authorizations:
Bearer Authentication

Responses

Remover segmento de cliente

Authorizations:
Bearer Authentication
path Parameters
clientId
required
integer <int64>
segmentId
required
integer <int64>

Responses

Remover nivel de cliente

Authorizations:
Bearer Authentication
path Parameters
clientId
required
integer <int64>
levelId
required
integer <int64>

Responses

Remover recomendacion de producto

Authorizations:
Bearer Authentication
path Parameters
clientId
required
integer <int64>
productRecommendationId
required
integer <int64>

Responses