Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 12 Next »

1. Download Inventory

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

2. API Spec

Request

Endpoint

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

Method

POST

Description

Download xlsx file about existing inventories.

Content-Type

application/json

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

Request Example

Validate

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

invalidate

# 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"]
}
# versions type error
{
    "supplier_access_key": "86e8b65a-d008-4e23-90d3-99b0f639c0e5",
    "supplier_unit_common_codes": ["c1e973a5", "795c20fe"],
    "versions": [1.1, 3.5]
}
# 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"]
}

Response

Name

Type

Description

inventory.xlsx

File

Inventory xlsx added columns related inventory to depth combination xlsx

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

Response Example

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

3. Request Example

CURL

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 - version pair must be exist in DB by your upload.

  • No labels