masstack

V1
API Overview Resources Schemas

Base products

Operations to get base products

Parameters

Name In Type Required Description
orgId path string true Organization name as it is registered in Mas-Stack
body body CreateProductBaseDto true Information needed to insert a base product

Request body - instance of 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

Request example

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


curl -X POST https://logistics-stock.sta.masstack.com/v1/orgs/yoigo/base_products \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
 --data-raw "{
  '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'
}"

Responses

Code Meaning Description Schema
200 OK Success ProductBaseDto
400 Bad Request Bad Request Error400
404 Not Found Not found Error404
500 Internal Server Error Internal Server Error Error500

Parameters

Name In Type Required Description
orgId path string true Organization name as it is registered in Mas-Stack
body body SearchProductBaseDto false Information needed to update a base product

Request body - JsonObject

 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

Request example

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


curl -X POST https://logistics-stock.sta.masstack.com/v1/orgs/yoigo/base_products/search \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
 --data-raw "{
  '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'
}"

Responses

Code Meaning Description Schema
200 OK Success [ProductBaseDto]
400 Bad Request Bad Request Error400
404 Not Found Not found Error404
500 Internal Server Error Internal Server Error Error500

200 - instance of ProductBaseDto

Custom schema example

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

[
  {
    "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

Parameters

Name In Type Required Description
orgId path string true Organization name as it is registered in Mas-Stack
baseId path integer true product base id

Request example

1
2
3
4
5


curl -X GET https://logistics-stock.sta.masstack.com/v1/orgs/yoigo/base_products/{baseId} \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

Code Meaning Description Schema
200 OK Success [ProductBaseDto]
400 Bad Request Bad Request Error400
404 Not Found Not found Error404
500 Internal Server Error Internal Server Error Error500

200 - instance of ProductBaseDto

Custom schema example

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

[
  {
    "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

Parameters

Name In Type Required Description
orgId path string true Organization name as it is registered in Mas-Stack
baseId path integer true Base product id to update
body body CreateProductBaseDto true Information needed to update a base product

Request body - instance of 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

Request example

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


curl -X PUT https://logistics-stock.sta.masstack.com/v1/orgs/yoigo/base_products/1 \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
 --data-raw "{
  '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'
}"

Responses

Code Meaning Description Schema
200 OK Success ProductBaseDto
400 Bad Request Bad Request Error400
404 Not Found Not found Error404
500 Internal Server Error Internal Server Error Error500

Endpoints

Base products

    Products

      Characteristics

        Delivery commitment

          Inputs

            Input Types

              Outputs

                Output Types

                  Stock

                    Physical Warehouse

                      Virtual Warehouse

                        Returns

                          Devices

                            Providers

                              Logistic Operators

                                Commercial Brands

                                  Commercial Distributions

                                    Status

                                      Categories

                                        Purposes

                                          Regions

                                            Countries

                                              Receptors

                                                Characteristics Values

                                                  Sales Channel

                                                    Tenant group brand

                                                      Organizations

                                                        Sap Ordering

                                                          Report importer