Versions Compared

Key

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

1. Download Latest Product

  • Supplier can use this API to download file related one or more products for update.

  • It is used when downloading zip file related product that compose of depth combination xlsx, contents xlsx, images.

  • If you enter validate access key and common code list, you can download files that you will use for update your product. - Product - Update

2. API Spec

1) Request

Endpoint

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

Method

POST

Description

Download xlsx file about existing products.

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]

  • Existing product version list

3) Request Example

(1) Validate

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

(2) invalidate

Code Block
{
    "supplier_access_key": "86e8b65a-d008-4e23-90d3-99b0f639c0e5",
    "supplier_unit_common_codes": ["not_existing_common_code"]
}

4) Response

Name

Type

Description

resultwholeness.zip

File

Files

  • Near real-time inventory reflected depth Depth combination file

  • Contents xlsx file

  • Image files

5) Error Spec

Status Code

Message

Solution

403

Need valid supplier access key.

The valid supplier access key must be entered

400

Need validate supplier unit common code, not not_existing_common_code.

The valid supplier unit common code list must be entered

6) Response Example

Code Block
languagepy
{
  "status_code": 403,
  "message": "자격Need 인증데이터(authentication credentials)가 제공되지 않았습니다valid supplier access key."
}

3. Request Example

1) CURL

Code Block
curl -X 'GETPOST' \
  'https://prod.ax-cloud.com/v1/wholeness-download' \
  -H 'accept: */*' \
  -H 'Content-Type: application/json' \
  -H 'X-CSRFTOKEN: nG8FlrJivkOlWRLqWfQTbZnK6tYcknSrL5PhxhFaZgJpJuUmc5bcWdekVbOHybpa' \
  -d '{

 "download_type": "API",
  "supplier_access_key": "86e8b65a-d008-4e23-90d3-99b0f639c0e5",
  "supplier_unit_common_codes": ["c1e973a5", "795c20fe", "c1e973a5"]

}

...

  • supplier_unit_common_codes

    • Common code must be exist in DB by your upload.

  • versions

    • Version must be exist in DB by your upload. Version is mixture that compose of major_version and minor_version.

...