Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

1. Download Latest Inventory

  • You can obtain inventory information of the desired product, version, date, and time.

2. API Spec

1) Request

Endpoint

https://prod.ax-cloud.com/v1/inventory-download

Method

POST

Description

Download xlsx file about existing inventories.

Content-Type

application/json

2) Body Parameter

Name

Required

Type

Description

supplier_access_key

O

String

  • Access right key issued by AX

supplier_unit_common_codes

O

List[String]

  • Existing product ID list

versions

O

List[String]

  • Product’s specific version

3) Request Example

(1) Validate

Code Block
languagepy
{
    "supplier_access_key": "86e8b65a-d008-4e23-90d3-99b0f639c0e5",
    "supplier_unit_common_codes": ["c1e973a5", "795c20fe"],
    "versions": ["1.1", "3.5"]
}

(2) invalidate

Code Block
languagepy
# supplier_unit_common_codes error
{
    "supplier_access_key": "86e8b65a-d008-4e23-90d3-99b0f639c0e5",
    "supplier_unit_common_codes": ["not_exist_common_code"],
    "versions": ["1.1", "3.5"]
}

...

Code Block
languagepy
# common_code-version match error
{
    "supplier_access_key": "86e8b65a-d008-4e23-90d3-99b0f639c0e5",
    "supplier_unit_common_codes": ["c1e973a5", "795c20fe"],
    "versions": ["1.1", "3.5", "4.7"]
}

4) Response

Name

Type

Description

inventory.xlsx

File

Inventory xlsx added columns related inventory to depth combination xlsx

5) Error Spec

Status Code

Message

Solution

403

Need valid supplier access key.

The valid supplier access key must be entered

400

Need valid supplier unit common code, not {not_existing_common_code}-{1.0}.

The valid supplier unit common code list and version list must be entered

6) Response Example

Code Block
{
  "status_code": 403,
  "message": "Need valid supplier access key."
}
Code Block
{
    "status_code": 400,
    "message": "Need valid supplier unit common code, value, not 06311edcz-1.0"
}

3. Request Example

1) CURL

Code Block
curl -X 'POST' \
  'https://prod.ax-cloud.com/v1/inventory-download' \
  -H 'accept: */*' \
  -H 'Content-Type: application/json' \
  -H 'X-CSRFTOKEN: nG8FlrJivkOlWRLqWfQTbZnK6tYcknSrL5PhxhFaZgJpJuUmc5bcWdekVbOHybpa' \
  -d '{
    "supplier_access_key": "f38d4291-b253-4ca8-9b01-d9b8ffd3cd51",
    "supplier_unit_common_codes": [
        "06311edc",
        "fe9e2fda"
    ],
    "versions": [
        "1.0",
        "1.0"
    ]
}

4. Limitation

  • supplier_unit_common_codes, versions

    • Common code and versions - version pair must be exist in DB by your upload.

...