API Overview Resources Schemas

Schemas

ProductBaseDto

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21


{
  "productBaseId": 1,
  "name": "Smartphone",
  "commercialBrand": 53,
  "category": 5,
  "vatTax": 2.5,
  "digitalCanon": 1.3,
  "unitsInPalet": 1500,
  "unitsInBox": 5,
  "eolDate": "2021-09-24",
  "substitute": "mobile2",
  "swapsRate": 1.5,
  "billingCategory": "sim",
  "organization": "MM",
  "characteristics": [
    {
      "name": "Color",
      "value": "Black"
    }
  ]
}

Name	Type	Required	Description
productBaseId	integer	false	none
name	string	true	none
commercialBrand	integer	true	none
category	integer	true	none
vatTax	number	false	none
digitalCanon	number	false	none
unitsInPalet	integer	false	none
unitsInBox	integer	false	none
eolDate	string(date)	false	none
substitute	string	false	none
swapsRate	number	false	none
billingCategory	string	false	none
organization	string	false	none
characteristics	CharacteristicValuesProductDto	false	none

CreateProductBaseDto

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14


{
  "name": "Smartphone",
  "commercialBrand": 53,
  "category": 5,
  "vatTax": 2.5,
  "digitalCanon": 1.3,
  "unitsInPalet": 1500,
  "unitsInBox": 5,
  "eolDate": "2021-09-24",
  "substitute": "mobile2",
  "swapsRate": 1.5,
  "billingCategory": "sim",
  "organization": "MM"
}

Name	Type	Required	Description
name	string	true	none
commercialBrand	integer	true	none
category	integer	true	none
vatTax	number	false	none
digitalCanon	number	false	none
unitsInPalet	integer	false	none
unitsInBox	integer	false	none
eolDate	string(date)	false	none
substitute	string	false	none
swapsRate	number	false	none
billingCategory	string	false	none
organization	string	false	none

SearchProductBaseDto

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14


{
  "name": "Smartphone",
  "commercialBrand": 53,
  "category": 5,
  "vatTax": 2.5,
  "digitalCanon": 1.3,
  "unitsInPalet": 1500,
  "unitsInBox": 5,
  "eolDate": "2021-09-24",
  "substitute": "mobile2",
  "swapsRate": 1.5,
  "billingCategory": "sim",
  "organization": "MM"
}

Name	Type	Required	Description
name	string	false	none
commercialBrand	integer	false	none
category	integer	false	none
vatTax	number	false	none
digitalCanon	number	false	none
unitsInPalet	integer	false	none
unitsInBox	integer	false	none
eolDate	string(date)	false	none
substitute	string	false	none
swapsRate	number	false	none
billingCategory	string	false	none
organization	string	false	none

ProductDto

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76


{
  "productId": 1,
  "productBase": {
    "productBaseId": 1,
    "name": "Smartphone",
    "commercialBrand": {
      "commercialBrandId": 1,
      "name": "Alcatel",
      "contactInfoId": 1
    },
    "category": {
      "categoryId": 1,
      "family": {
        "familyId": 1,
        "name": "family"
      },
      "subfamily": "subfamily"
    },
    "vatTax": 2.5,
    "digitalCanon": 1.3,
    "unitsInPalet": 1500,
    "unitsInBox": 5,
    "eolDate": "2021-09-24",
    "substitute": "mobile2",
    "swapsRate": 1.5,
    "organization": "MM",
    "billingCategory": "MM",
    "characteristics": [
      {
        "name": "Color",
        "value": "Black"
      }
    ]
  },
  "status": {
    "statusId": 1,
    "name": "status"
  },
  "isbundle": false,
  "phReference": 2,
  "upcEan": 2,
  "partnumber": 1,
  "releaseDate": "2021-09-24",
  "retireDate": "2021-09-24",
  "sapOrderingAux": {
    "sapOrderingAuxId": 1,
    "companyInvoice": "company",
    "productSapCode": 1,
    "productSapDescription": "description",
    "productSapMaterial": "material",
    "productSapFamilyCode": 1,
    "providerId": 1,
    "supplierToProviderId": 1
  },
  "retrievable": true,
  "name": "Smartphone",
  "purpose": {
    "purposeId": 1,
    "name": "purpose"
  },
  "inwarehousePrice": 0,
  "reference": "REF223",
  "currency": "EUR",
  "phPrice": 123.9,
  "purchasePrice": 12.9,
  "createdDate": "2021-09-24",
  "updatedDate": "2021-09-24",
  "bundle": [
    {
      "bundleId": 1,
      "productId": 1,
      "quantity": 1
    }
  ],
  "stockProperty": "Propiedad"
}

Name	Type	Required	Description
productId	integer	false	none
productBase	ProductBaseDtoWithReferences	false	none
status	StatusDto	false	none
isbundle	boolean	false	none
phReference	string	false	none
upcEan	string	false	none
partnumber	string	false	none
releaseDate	string(date)	false	none
retireDate	string(date)	false	none
sapOrderingAux	SapOrderingDto	false	none
retrievable	boolean	false	none
name	string	false	none
purpose	PurposeDto	false	none
inwarehousePrice	number	false	none
reference	string	false	none
currency	string	false	none
phPrice	number	false	none
purchasePrice	number	false	none
createdDate	string(date)	false	none
updatedDate	string(date)	false	none
bundle	[BundleDto]	false	none
stockProperty	string	false	none

Property	Values
stockProperty	one of [Propiedad, Cesión, Consigna]

CreateProductDto

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34


{
  "name": "Smartphone",
  "status": 1,
  "isbundle": false,
  "phReference": 2,
  "upcEan": 2,
  "partnumber": 1,
  "releaseDate": "2021-09-24",
  "retireDate": "2021-09-24",
  "sapOrderingAux": {
    "sapOrderingAuxId": 1,
    "companyInvoice": "company",
    "productSapCode": 1,
    "productSapDescription": "description",
    "productSapMaterial": "material",
    "productSapFamilyCode": 1,
    "providerId": 1,
    "supplierToProviderId": 1
  },
  "retrievable": true,
  "purchasePrice": 180.5,
  "phPrice": 24.99,
  "reference": "reference",
  "inwarehousePrice": 50.5,
  "currency": "EUR",
  "purpose": 1,
  "productsInBundle": [
    {
      "productId": 1,
      "quantity": 1
    }
  ],
  "stockProperty": "Propiedad"
}

Name	Type	Required	Description
name	string	true	none
status	integer	true	none
isbundle	boolean	true	none
phReference	string	false	none
upcEan	string	false	none
partnumber	string	false	none
releaseDate	string(date)	false	none
retireDate	string(date)	false	none
sapOrderingAux	SapOrderingDto	true	none
retrievable	boolean	false	none
purchasePrice	number	false	none
phPrice	number	false	none
reference	string	false	none
inwarehousePrice	number	false	none
currency	string	false	none
purpose	integer	false	none
productsInBundle	[CreateBundleDto]	false	none
stockProperty	string	false	none

Property	Values
stockProperty	one of [Propiedad, Cesión, Consigna]

SearchProductDto

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21


{
  "productId": 1,
  "productBaseId": 1,
  "name": "Smartphone",
  "status": 1,
  "isbundle": false,
  "phReference": 2,
  "upcEan": 2,
  "partNumber": 1,
  "releaseDate": "2021-09-24",
  "retireDate": "2021-09-24",
  "sapOrderingAuxId": 10,
  "retrievable": true,
  "purchasePrice": 180.5,
  "phPrice": 24.99,
  "reference": "reference",
  "inwarehousePrice": 50.5,
  "currency": "EUR",
  "purpose": 1,
  "stockProperty": "Propiedad"
}

Name	Type	Required	Description
productId	integer	false	none
productBaseId	integer	false	none
name	string	false	none
status	integer	false	none
isbundle	boolean	false	none
phReference	string	false	none
upcEan	string	false	none
partNumber	string	false	none
releaseDate	string(date)	false	none
retireDate	string(date)	false	none
sapOrderingAuxId	integer	false	none
retrievable	boolean	false	none
purchasePrice	number	false	none
phPrice	number	false	none
reference	string	false	none
inwarehousePrice	number	false	none
currency	string	false	none
purpose	integer	false	none
stockProperty	string	false	none

Property	Values
stockProperty	one of [Propiedad, Cesión, Consigna]

UpdateProductDto

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35


{
  "name": "Smartphone",
  "status": 1,
  "isbundle": false,
  "phReference": 2,
  "upcEan": 2,
  "partnumber": 1,
  "releaseDate": "2021-09-24",
  "retireDate": "2021-09-24",
  "sapOrderingAux": {
    "sapOrderingAuxId": 1,
    "companyInvoice": "company",
    "productSapCode": 1,
    "productSapDescription": "description",
    "productSapMaterial": "material",
    "productSapFamilyCode": 1,
    "providerId": 1,
    "supplierToProviderId": 1
  },
  "retrievable": true,
  "purchasePrice": 180.5,
  "phPrice": 24.99,
  "reference": "reference",
  "inwarehousePrice": 50.5,
  "currency": "EUR",
  "purpose": 1,
  "productsInBundle": [
    {
      "bundleId": 1,
      "productId": 1,
      "quantity": 1
    }
  ],
  "stockProperty": "Propiedad"
}

Name	Type	Required	Description
name	string	true	none
status	integer	true	none
isbundle	boolean	true	none
phReference	string	false	none
upcEan	string	false	none
partnumber	string	false	none
releaseDate	string(date)	false	none
retireDate	string(date)	false	none
sapOrderingAux	SapOrderingDto	true	none
retrievable	boolean	false	none
purchasePrice	number	false	none
phPrice	number	false	none
reference	string	false	none
inwarehousePrice	number	false	none
currency	string	false	none
purpose	integer	false	none
productsInBundle	[BundleDto]	false	none
stockProperty	string	false	none

Property	Values
stockProperty	one of [Propiedad, Cesión, Consigna]

PaginatedProductDto

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84


{
  "pageSize": 123,
  "totalPages": 10,
  "currentPage": 1,
  "totalElements": 3000,
  "products": [
    {
      "productId": 1,
      "productBase": {
        "productBaseId": 1,
        "name": "Smartphone",
        "commercialBrand": {
          "commercialBrandId": 1,
          "name": "Alcatel",
          "contactInfoId": 1
        },
        "category": {
          "categoryId": 1,
          "family": {
            "familyId": 1,
            "name": "family"
          },
          "subfamily": "subfamily"
        },
        "vatTax": 2.5,
        "digitalCanon": 1.3,
        "unitsInPalet": 1500,
        "unitsInBox": 5,
        "eolDate": "2021-09-24",
        "substitute": "mobile2",
        "swapsRate": 1.5,
        "organization": "MM",
        "billingCategory": "MM",
        "characteristics": [
          {
            "name": "Color",
            "value": "Black"
          }
        ]
      },
      "status": {
        "statusId": 1,
        "name": "status"
      },
      "isbundle": false,
      "phReference": 2,
      "upcEan": 2,
      "partnumber": 1,
      "releaseDate": "2021-09-24",
      "retireDate": "2021-09-24",
      "sapOrderingAux": {
        "sapOrderingAuxId": 1,
        "companyInvoice": "company",
        "productSapCode": 1,
        "productSapDescription": "description",
        "productSapMaterial": "material",
        "productSapFamilyCode": 1,
        "providerId": 1,
        "supplierToProviderId": 1
      },
      "retrievable": true,
      "name": "Smartphone",
      "purpose": {
        "purposeId": 1,
        "name": "purpose"
      },
      "inwarehousePrice": 0,
      "reference": "REF223",
      "currency": "EUR",
      "phPrice": 123.9,
      "purchasePrice": 12.9,
      "createdDate": "2021-09-24",
      "updatedDate": "2021-09-24",
      "bundle": [
        {
          "bundleId": 1,
          "productId": 1,
          "quantity": 1
        }
      ],
      "stockProperty": "Propiedad"
    }
  ]
}

Name	Type	Required	Description
anonymous	PaginationResponse	false	none

Name	Type	Required	Description
anonymous	object	false	none
» products	[ProductDto]	false	none

DeliveryCommitmentDto

1
2
3
4
5
6
7


{
  "productId": 1,
  "providerId": 1,
  "minWeeks": 10,
  "maxWeeks": 1,
  "deliveryWeeks": 2
}

Name	Type	Required	Description
productId	integer	false	none
providerId	integer	false	none
minWeeks	integer	false	none
maxWeeks	integer	false	none
deliveryWeeks	integer	false	none

BundleDto

1
2
3
4
5


{
  "bundleId": 1,
  "productId": 1,
  "quantity": 1
}

Name	Type	Required	Description
bundleId	integer	false	none
productId	integer	false	none
quantity	integer	false	none

CreateBundleDto

1
2
3
4


{
  "productId": 1,
  "quantity": 1
}

Name	Type	Required	Description
productId	integer	false	none
quantity	integer	false	none

Characteristic

1
2
3
4


{
  "name": "Color",
  "value": "Blue"
}

Name	Type	Required	Description
name	string	true	none
value	string	true	none

CommercialBrandsDto

1
2
3
4
5


{
  "commercialBrandId": 1,
  "name": "Alcatel",
  "contactInfoId": 1
}

Name	Type	Required	Description
commercialBrandId	integer	false	none
name	string	false	none
contactInfoId	integer	false	none

CommercialDistributionDto

1
2
3
4
5
6
7
8
9


{
  "commDistributionId": 1,
  "salesChannel": 1,
  "salesType": 1,
  "salesGroup": 1,
  "warehouse": 1,
  "name": "masmovil",
  "tenant": "masmovil"
}

Name	Type	Required	Description
commDistributionId	integer	false	none
salesChannel	integer	false	none
salesType	integer	false	none
salesGroup	integer	false	none
warehouse	integer	false	none
name	string	false	none
tenant	string	false	none

StatusDto

1
2
3
4


{
  "statusId": 1,
  "name": "status"
}

Name	Type	Required	Description
statusId	integer	false	none
name	string	false	none

PurposeDto

1
2
3
4


{
  "purposeId": 1,
  "name": "purpose"
}

Name	Type	Required	Description
purposeId	integer	false	none
name	string	false	none

InputTypesDto

1
2
3
4


{
  "typeId": 1,
  "description": "description"
}

Name	Type	Required	Description
typeId	integer	false	none
description	string	false	none

RegionDto

1
2
3
4


{
  "regionId": 1,
  "name": "region"
}

Name	Type	Required	Description
regionId	integer	false	none
name	string	false	none

CountryDto

1
2
3


{
  "countryIso": "ES"
}

Name	Type	Required	Description
countryIso	string	false	none

ReceptorsDto

1
2
3
4


{
  "receptorId": 1,
  "name": "receptor"
}

Name	Type	Required	Description
receptorId	integer	false	none
name	string	false	none

OutputTypesDto

1
2
3
4


{
  "typeId": 1,
  "description": "type"
}

Name	Type	Required	Description
typeId	integer	false	none
description	string	false	none

CategoryDto

1
2
3
4
5
6
7
8


{
  "categoryId": 1,
  "family": {
    "familyId": 1,
    "name": "family"
  },
  "subfamily": "subfamily"
}

Name	Type	Required	Description
categoryId	integer	false	none
family	FamilyDto	false	none
subfamily	string	false	none

FamilyDto

1
2
3
4


{
  "familyId": 1,
  "name": "family"
}

Name	Type	Required	Description
familyId	integer	false	none
name	string	false	none

InputDto

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22


{
  "inputId": 1,
  "reference": 1,
  "productId": 1,
  "amount": 10,
  "orderId": "1234ABCD",
  "orderPositionId": 1,
  "inputDate": "2021-09-24",
  "orderOlId": 1,
  "inWarehousePrice": 50.5,
  "courierBill": 10,
  "billId": "12ABC",
  "receptionDate": "2021-09-24",
  "incident": true,
  "facturable": false,
  "inWareHousePriceCurrency": "eu",
  "type": 1,
  "ean": 1,
  "billableCompany": 1,
  "pWarehouseId": 1,
  "comments": "comments"
}

Name	Type	Required	Description
inputId	integer	false	none
reference	string	false	none
productId	integer	false	none
amount	integer	false	none
orderId	string	false	none
orderPositionId	integer	false	none
inputDate	string(date)	false	none
orderOlId	string	false	none
inWarehousePrice	number	false	none
courierBill	string	false	none
billId	string	false	none
receptionDate	string(date)	false	none
incident	boolean	false	none
facturable	boolean	false	none
inWareHousePriceCurrency	string	false	none
type	string	false	none
ean	string	false	none
billableCompany	string	false	none
pWarehouseId	integer	false	none
comments	string	false	none

UpdateInputDto

1

{}

Name	Type	Required	Description
anonymous	InputDto	false	none

Name	Type	Required	Description
anonymous	object	false	none

CreateInputDto

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20


{
  "reference": 1,
  "pWarehouseId": 1,
  "amount": 10,
  "orderId": "1234ABCD",
  "orderPositionId": 1,
  "inputDate": "2021-09-24",
  "orderOlId": 1,
  "inWarehousePrice": 50,
  "courierBill": 10,
  "billId": "12ABC",
  "receptionDate": "2021-09-24",
  "incident": true,
  "facturable": false,
  "inWareHousePriceCurrency": "EUR",
  "type": 1,
  "ean": 112312,
  "billableCompany": "XFERA",
  "comments": "comments"
}

Name	Type	Required	Description
reference	string	false	none
pWarehouseId	integer	true	none
amount	integer	true	none
orderId	string	false	none
orderPositionId	integer	false	none
inputDate	string(date)	true	none
orderOlId	string	true	none
inWarehousePrice	number	true	none
courierBill	string	false	none
billId	string	false	none
receptionDate	string(date)	false	none
incident	boolean	false	none
facturable	boolean	false	none
inWareHousePriceCurrency	string	false	none
type	string	false	none
ean	string	false	none
billableCompany	string	false	none
comments	string	false	none

OutputsByProductAndWarehouseResponseDto

1
2
3
4
5
6
7


{
  "reference": "ABCD123",
  "productId": 1,
  "vwarehouseId": 10,
  "amount": 50,
  "outputDate": "2021-09-24"
}

Name	Type	Required	Description
reference	string	false	none
productId	integer	false	none
vwarehouseId	integer	false	none
amount	integer	false	none
outputDate	string(date)	false	none

OutputDto

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20


{
  "outputId": 1,
  "reference": "reference",
  "productId": 1,
  "vwarehouseId": 10,
  "pWarehouseId": 10,
  "amount": 50,
  "salesChannel": 2,
  "outputDate": "2021-09-24",
  "regularization": true,
  "type": 2,
  "salesType": "salesType",
  "tenantGroupBrand": {
    "id": 10,
    "name": "masmovil"
  },
  "orderId": "1234ABCD",
  "inWarehousePrice": 50,
  "inWarehousePriceCurrency": "EUR"
}

Name	Type	Required	Description
outputId	integer	false	none
reference	string	false	none
productId	integer	false	none
vwarehouseId	integer	false	none
pWarehouseId	integer	false	none
amount	integer	false	none
salesChannel	integer	false	none
outputDate	string(date)	false	none
regularization	boolean	false	none
type	integer	false	none
salesType	string	false	none
tenantGroupBrand	TenantGroupBrandDto	false	none
orderId	string	false	none
inWarehousePrice	number	false	none
inWarehousePriceCurrency	string	false	none

CreateOutputDto

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15


{
  "reference": "reference",
  "vwarehouseId": 10,
  "pWarehouseId": 10,
  "amount": 50,
  "salesChannel": 2,
  "tenantGroupBrand": "tenant",
  "outputDate": "2021-09-24",
  "regularization": true,
  "type": 2,
  "salesType": "salesType",
  "orderId": "1234ABCD",
  "inWarehousePrice": 50,
  "inWarehousePriceCurrency": "EUR"
}

Name	Type	Required	Description
reference	string	false	none
vwarehouseId	integer	true	none
pWarehouseId	integer	false	none
amount	integer	true	none
salesChannel	integer	false	none
tenantGroupBrand	string	true	tenant or group band
outputDate	string(date)	true	none
regularization	boolean	false	none
type	integer	false	none
salesType	string	false	none
orderId	string	false	none
inWarehousePrice	number	false	none
inWarehousePriceCurrency	string	false	none

UpdateOutputDto

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16


{
  "reference": "reference",
  "vwarehouseId": 10,
  "pWarehouseId": 10,
  "amount": 50,
  "salesChannel": 2,
  "tenantGroupBrand": "tenant",
  "outputDate": "2021-09-24",
  "regularization": true,
  "type": 2,
  "salesType": "salesType",
  "orderId": "1234ABCD",
  "inWarehousePrice": 50,
  "inWarehousePriceCurrency": "EUR",
  "productId": 1
}

Name	Type	Required	Description
anonymous	CreateOutputDto	false	none

Name	Type	Required	Description
anonymous	object	false	none
» productId	integer	true	none

AllOutputs

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22


[
  {
    "outputId": 1,
    "reference": "reference",
    "productId": 1,
    "vwarehouseId": 10,
    "pWarehouseId": 10,
    "amount": 50,
    "salesChannel": 2,
    "outputDate": "2021-09-24",
    "regularization": true,
    "type": 2,
    "salesType": "salesType",
    "tenantGroupBrand": {
      "id": 10,
      "name": "masmovil"
    },
    "orderId": "1234ABCD",
    "inWarehousePrice": 50,
    "inWarehousePriceCurrency": "EUR"
  }
]

Name	Type	Required	Description
anonymous	[OutputDto]	false	none

OutputsByProductAndWarehouseResponseDtoList

1
2
3
4
5
6
7
8
9


[
  {
    "reference": "ABCD123",
    "productId": 1,
    "vwarehouseId": 10,
    "amount": 50,
    "outputDate": "2021-09-24"
  }
]

Name	Type	Required	Description
anonymous	[OutputsByProductAndWarehouseResponseDto]	false	none

StockDto

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


{
  "stockId": 1,
  "productId": 10,
  "vwarehouseId": 56,
  "totalAmount": 25,
  "availableAmount": 100,
  "reservedAmount": 45,
  "stockDate": "2022-02-20",
  "reference": "reference1",
  "prepickingOrders": 10
}

Name	Type	Required	Description
stockId	integer	false	none
productId	integer	false	none
vwarehouseId	integer	false	none
totalAmount	integer	false	none
availableAmount	integer	false	none
reservedAmount	integer	false	none
stockDate	string	false	none
reference	string	false	none
prepickingOrders	integer	false	none

CreateStockDto

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


{
  "stockId": 1,
  "productId": 10,
  "vwarehouseId": 56,
  "totalAmount": 25,
  "availableAmount": 100,
  "reservedAmount": 45,
  "stockDate": "2022-02-20",
  "reference": "reference1",
  "prepickingOrders": 10
}

Name	Type	Required	Description
stockId	integer	false	none
productId	integer	false	none
vwarehouseId	integer	false	none
totalAmount	integer	false	none
availableAmount	integer	false	none
reservedAmount	integer	false	none
stockDate	string	false	none
reference	string	false	none
prepickingOrders	integer	false	none

PhysicalWarehouseDto

1
2
3
4
5
6
7
8
9


{
  "pwarehouseId": 1,
  "name": "name",
  "logisticOperator": 1,
  "regionId": 1,
  "country": "ES",
  "address": "address",
  "contactInfoId": 20
}

Name	Type	Required	Description
pwarehouseId	integer	false	none
name	string	false	none
logisticOperator	integer	false	none
regionId	integer	false	none
country	string	false	none
address	string	false	none
contactInfoId	integer	false	none

CreatePhysicalWarehouseDto

1
2
3
4
5
6
7
8


{
  "name": "name",
  "logisticOperator": 1,
  "regionId": 1,
  "country": "ES",
  "address": "address",
  "contactInfoId": 20
}

Name	Type	Required	Description
name	string	false	none
logisticOperator	integer	false	none
regionId	integer	false	none
country	string	false	none
address	string	false	none
contactInfoId	integer	false	none

PhysicalWarehouseAndCharacteristicsDto

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20


{
  "pwarehouseId": 1,
  "name": "name",
  "country": "ES",
  "address": "address",
  "regionName": "Peninsula",
  "logisticOperators": {
    "logisticOperatorId": 1,
    "name": "name",
    "cif": "cif",
    "address": "address",
    "corporateName": "corporate",
    "contactInfo": {
      "contactInfoId": 1,
      "contactName": "name",
      "contactEmail": "email",
      "contactPhone": "phone"
    }
  }
}

Name	Type	Required	Description
pwarehouseId	integer	false	none
name	string	false	none
country	string	false	none
address	string	false	none
regionName	string	false	none
logisticOperators	LogisticsOperatorDto	false	none

LogisticsOperatorDto

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13


{
  "logisticOperatorId": 1,
  "name": "name",
  "cif": "cif",
  "address": "address",
  "corporateName": "corporate",
  "contactInfo": {
    "contactInfoId": 1,
    "contactName": "name",
    "contactEmail": "email",
    "contactPhone": "phone"
  }
}

Name	Type	Required	Description
logisticOperatorId	integer	false	none
name	string	false	none
cif	string	false	none
address	string	false	none
corporateName	string	false	none
contactInfo	ContactInfoDto	false	none

ContactInfoDto

1
2
3
4
5
6


{
  "contactInfoId": 1,
  "contactName": "name",
  "contactEmail": "email",
  "contactPhone": "phone"
}

Name	Type	Required	Description
contactInfoId	integer	false	none
contactName	string	false	none
contactEmail	string	false	none
contactPhone	string	false	none

AllPhysicalWarehouse

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


[
  {
    "pwarehouseId": 1,
    "name": "name",
    "logisticOperator": 1,
    "regionId": 1,
    "country": "ES",
    "address": "address",
    "contactInfoId": 20
  }
]

Name	Type	Required	Description
anonymous	[PhysicalWarehouseDto]	false	none

VirtualWarehouseReceptorDto

1
2
3
4
5
6
7
8


{
  "vwarehouseId": 1,
  "name": "name",
  "receptors": {
    "receptorId": 1,
    "name": "receptor"
  }
}

Name	Type	Required	Description
vwarehouseId	integer	false	none
name	string	false	none
receptors	ReceptorsDto	false	none

VirtualWarehouseReceptorsDto

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


[
  {
    "vwarehouseId": 1,
    "name": "name",
    "receptors": {
      "receptorId": 1,
      "name": "receptor"
    }
  }
]

Name	Type	Required	Description
anonymous	[VirtualWarehouseReceptorDto]	false	none

CreateVirtualWarehouseDto

1
2
3
4


{
  "name": "name",
  "receptorId": 10
}

Name	Type	Required	Description
name	string	false	none
receptorId	integer	false	none

VirtualWarehouseDto

1
2
3
4
5


{
  "vwarehouseId": 15,
  "name": "name",
  "receptorId": 1
}

Name	Type	Required	Description
vwarehouseId	integer	false	none
name	string	false	none
receptorId	integer	false	none

CharacteristicsValuesDto

1
2
3
4
5
6
7
8


[
  {
    "name": "Color",
    "values": [
      "Black, Green"
    ]
  }
]

Name	Type	Required	Description
anonymous	[CharacteristicsValueDto]	false	none

CharacteristicsValueDto

1
2
3
4
5
6


{
  "name": "Color",
  "values": [
    "Black, Green"
  ]
}

Name	Type	Required	Description
name	string	false	none
values	[string]	false	none

CharacteristicValuesProductDto

1
2
3
4
5
6


[
  {
    "name": "Color",
    "value": "Black"
  }
]

Name	Type	Required	Description
name	string	false	none
value	string	false	none

SapOrderingDto

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


{
  "sapOrderingAuxId": 1,
  "companyInvoice": "company",
  "productSapCode": 1,
  "productSapDescription": "description",
  "productSapMaterial": "material",
  "productSapFamilyCode": 1,
  "providerId": 1,
  "supplierToProviderId": 1
}

Name	Type	Required	Description
sapOrderingAuxId	integer	false	none
companyInvoice	string	false	none
productSapCode	string	false	none
productSapDescription	string	false	none
productSapMaterial	string	false	none
productSapFamilyCode	string	false	none
providerId	integer	false	none
supplierToProviderId	integer	false	none

PaginatedSapOrderingDtos

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18


{
  "pageSize": 123,
  "totalPages": 10,
  "currentPage": 1,
  "totalElements": 3000,
  "sapOrderingDtos": [
    {
      "sapOrderingAuxId": 1,
      "companyInvoice": "company",
      "productSapCode": 1,
      "productSapDescription": "description",
      "productSapMaterial": "material",
      "productSapFamilyCode": 1,
      "providerId": 1,
      "supplierToProviderId": 1
    }
  ]
}

Name	Type	Required	Description
anonymous	PaginationResponse	false	none

Name	Type	Required	Description
anonymous	object	false	none
» sapOrderingDtos	[SapOrderingDto]	false	none

SalesChannelDto

1
2
3
4
5
6
7
8
9


{
  "id": 10,
  "name": "txt",
  "masterChannel": {
    "id": 1,
    "name": "nombre",
    "direct": true
  }
}

Name	Type	Required	Description
id	integer	false	none
name	string	false	none
masterChannel	object	false	none
» id	integer	false	none
» name	string	false	none
» direct	boolean	false	none

TenantGroupBrandDto

1
2
3
4


{
  "id": 10,
  "name": "masmovil"
}

Name	Type	Required	Description
id	integer	false	none
name	string	false	none

ReturnsDto

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59


{
  "returnId": 1,
  "reference": 123456,
  "product": {
    "productId": 1,
    "productBaseId": 1,
    "status": 1,
    "isbundle": false,
    "phReference": 2,
    "upcEan": 2,
    "partnumber": 1,
    "releaseDate": "2021-09-24",
    "retireDate": "2021-09-24",
    "sapOrderingAux": {
      "sapOrderingAuxId": 1,
      "companyInvoice": "company",
      "productSapCode": 1,
      "productSapDescription": "description",
      "productSapMaterial": "material",
      "productSapFamilyCode": 1,
      "providerId": 1,
      "supplierToProviderId": 1
    },
    "retrievable": true,
    "name": "Smartphone",
    "purpose": 1,
    "inwarehousePrice": 50,
    "reference": "reference",
    "currency": "EUR",
    "purchasePrice": 180.5,
    "phPrice": 24.99
  },
  "vwarehouse": {
    "vwarehouseId": 4,
    "name": "Canarias Yoigo Renove",
    "receptors": {
      "receptorId": 6,
      "name": "Renove"
    }
  },
  "amount": "3",
  "tenantGroupBrand": "de",
  "returnDate": "2021-02-03",
  "returnReason": {
    "name": "tienda",
    "description": "description"
  },
  "relatedOrderId": 123654,
  "salesChannel": {
    "id": 10,
    "name": "phone",
    "masterChannel": {
      "id": 1,
      "name": "aux",
      "direct": true
    }
  },
  "salesType": "tipo"
}

Name	Type	Required	Description
returnId	integer	false	none
reference	string	false	none
product	object	false	none
» productId	integer	false	none
» productBaseId	integer	false	none
» status	integer	false	none
» isbundle	boolean	false	none
» phReference	string	false	none
» upcEan	string	false	none
» partnumber	string	false	none
» releaseDate	string(date)	false	none
» retireDate	string(date)	false	none
» sapOrderingAux	SapOrderingDto	false	none
» retrievable	boolean	false	none
» name	string	false	none
» purpose	integer	false	none
» inwarehousePrice	number	false	none
» reference	string	false	none
» currency	string	false	none
» purchasePrice	number	false	none
» phPrice	number	false	none
vwarehouse	object	false	none
» vwarehouseId	number	false	none
» name	string	false	none
» receptors	object	false	none
»» receptorId	number	false	none
»» name	string	false	none
amount	string	false	none
tenantGroupBrand	string	false	none
returnDate	string	false	none
returnReason	object	false	none
» name	string	false	none
» description	string	false	none
relatedOrderId	string	false	none
salesChannel	object	false	none
» id	number	false	none
» name	string	false	none
» masterChannel	object	false	none
»» id	number	false	none
»» name	string	false	none
»» direct	boolean	false	none
salesType	string	false	none

CreateReturnDto

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12


{
  "reference": 123456,
  "productId": 4,
  "vwarehouse": 4,
  "amount": "3",
  "tenantGroupBrand": "de",
  "returnDate": "2021-02-03",
  "returnReason": "tienda",
  "relatedOrderId": "123654",
  "salesChannel": 10,
  "salesType": "tipo"
}

Name	Type	Required	Description
reference	string	false	none
productId	number	false	none
vwarehouse	string	false	none
amount	string	false	none
tenantGroupBrand	string	false	none
returnDate	string	false	none
returnReason	string	false	none
relatedOrderId	string	false	none
salesChannel	string	false	none
salesType	string	false	none

InputDeviceWithDetailsRequestDto

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22


{
  "order_number": "4000003264",
  "provider_delivery_id": "3",
  "input_date": "2009-01-13",
  "details": [
    {
      "reference": "G034W54G2",
      "model": "Samsung Galaxy Watch5 44mm BT Silver",
      "color": "Plata",
      "device_type": "SmartWatch",
      "brand": "Samsung",
      "quantity": 10,
      "devices": [
        {
          "imei": "864467060074057",
          "imei2": "864467060074057",
          "serial_number": "RFAT73D511Z"
        }
      ]
    }
  ]
}

Name	Type	Required	Description
order_number	string	false	none
provider_delivery_id	string	false	none
input_date	string(date)	false	none
details	[InputDetailsDto]	false	none

InputDetailsDto

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15


{
  "reference": "G034W54G2",
  "model": "Samsung Galaxy Watch5 44mm BT Silver",
  "color": "Plata",
  "device_type": "SmartWatch",
  "brand": "Samsung",
  "quantity": 10,
  "devices": [
    {
      "imei": "864467060074057",
      "imei2": "864467060074057",
      "serial_number": "RFAT73D511Z"
    }
  ]
}

Name	Type	Required	Description
reference	string	false	none
model	string	false	none
color	string	false	none
device_type	string	false	none
brand	string	false	none
quantity	integer	false	none
devices	[DevicesDetailDto]	false	none

DevicesDetailDto

1
2
3
4
5


{
  "imei": "864467060074057",
  "imei2": "864467060074057",
  "serial_number": "RFAT73D511Z"
}

Name	Type	Required	Description
imei	string	false	none
imei2	string	false	none
serial_number	string	false	none

DeviceDto

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17


{
  "deviceId": 0,
  "imei": "864467060074057",
  "imei2": "864467060074057",
  "serialNumber": "RFAT73D511Z",
  "brand": "Samsung",
  "model": "Samsung Galaxy Watch5 44mm BT Silver",
  "reference": "G034W54G2",
  "color": "Plata",
  "deviceType": "SmartWatch",
  "orderNumber": "4000003264",
  "providerDeliveryId": "3",
  "loadDate": "2009-01-13",
  "inputDate": "2009-01-13",
  "createDate": "2009-01-13",
  "updateDate": "2009-01-13"
}

Name	Type	Required	Description
deviceId	integer(int64)	false	none
imei	string	false	none
imei2	string	false	none
serialNumber	string	false	none
brand	string	false	none
model	string	false	none
reference	string	false	none
color	string	false	none
deviceType	string	false	none
orderNumber	string	false	none
providerDeliveryId	string	false	none
loadDate	string(date)	false	none
inputDate	string(date)	false	none
createDate	string(date)	false	none
updateDate	string(date)	false	none

ProductBaseDtoWithReferences

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32


{
  "productBaseId": 1,
  "name": "Smartphone",
  "commercialBrand": {
    "commercialBrandId": 1,
    "name": "Alcatel",
    "contactInfoId": 1
  },
  "category": {
    "categoryId": 1,
    "family": {
      "familyId": 1,
      "name": "family"
    },
    "subfamily": "subfamily"
  },
  "vatTax": 2.5,
  "digitalCanon": 1.3,
  "unitsInPalet": 1500,
  "unitsInBox": 5,
  "eolDate": "2021-09-24",
  "substitute": "mobile2",
  "swapsRate": 1.5,
  "organization": "MM",
  "billingCategory": "MM",
  "characteristics": [
    {
      "name": "Color",
      "value": "Black"
    }
  ]
}

Name	Type	Required	Description
productBaseId	integer	false	none
name	string	false	none
commercialBrand	CommercialBrandsDto	false	none
category	CategoryDto	false	none
vatTax	number	false	none
digitalCanon	number	false	none
unitsInPalet	integer	false	none
unitsInBox	integer	false	none
eolDate	string(date)	false	none
substitute	string	false	none
swapsRate	number	false	none
organization	string	false	none
billingCategory	string	false	none
characteristics	CharacteristicValuesProductDto	false	none

OrganizationDto

1
2
3
4


{
  "organizationId": "MM",
  "description": "Mas Movil"
}

Name	Type	Required	Description
organizationId	string	false	none
description	string	false	none

ProviderDto

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17


{
  "providerId": 1,
  "name": "ADOC",
  "cif": "string",
  "address": "Direccion",
  "contactInfoId": 1,
  "corporateName": "string",
  "purchaseCentralCode": "2AD",
  "wholeSale": true,
  "providerSapCode": "string",
  "contactInfo": {
    "contactInfoId": 1,
    "contactName": "name",
    "contactEmail": "email",
    "contactPhone": "phone"
  }
}

Name	Type	Required	Description
providerId	integer	true	none
name	string	true	none
cif	string	true	none
address	string	true	none
contactInfoId	integer	true	none
corporateName	string	true	none
purchaseCentralCode	string	false	none
wholeSale	boolean	false	none
providerSapCode	string	false	none
contactInfo	ContactInfoDto	false	none

ReportImporterDto

1
2
3
4
5
6
7


{
  "reportId": 1,
  "reportName": "Report name",
  "tabName": "Excel tab name",
  "lastRead": 1,
  "lastExecution": "2021-09-24T00:00:00Z"
}

Name	Type	Required	Description
reportId	integer	false	none
reportName	string	false	none
tabName	string	false	none
lastRead	integer(int64)	false	none
lastExecution	string	false	none

PaginationResponse

1
2
3
4
5
6


{
  "pageSize": 123,
  "totalPages": 10,
  "currentPage": 1,
  "totalElements": 3000
}

Name	Type	Required	Description
pageSize	integer	false	Page size
totalPages	integer	false	Total pages for page size
currentPage	integer	false	Current page
totalElements	integer	false	Total element

ProductSortEnum

1

"PRODUCT_ID"

Name	Type	Required	Description
anonymous	string	false	Product sort values

Property	Values
anonymous	one of [PRODUCT_ID, PRODUCT_BASE, STATUS, BUNDLE, PH_REFERENCE, SAP_ORDERING, RETRIEVABLE, RETIRE_DATE, RELEASE_DATE, PURPOSE, REFERENCE, NAME]

SortEnum

1

"ASC"

Name	Type	Required	Description
anonymous	string	false	Sort values

Property	Values
anonymous	one of [ASC, DESC]

Error400

1
2
3
4
5


{
  "code": 2,
  "subcode": 2000,
  "message": "Bad request"
}

Name	Type	Required	Description
code	integer	false	none
subcode	integer	false	none
message	string	false	none

Error404

1
2
3
4
5


{
  "code": 4,
  "subcode": 4001,
  "message": "Resource not found"
}

Name	Type	Required	Description
code	integer	false	none
subcode	integer	false	none
message	string	false	none

Error500

1
2
3
4
5


{
  "code": 5,
  "subcode": 5001,
  "message": "Internal server error"
}

Name	Type	Required	Description
code	integer	false	none
subcode	integer	false	none
message	string	false	none