Versions Compared

Version Old Version 9 New Version Current
Changes made by

김전도Flip (Unlicensed)

김전도Flip (Unlicensed)

Saved on

Key

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

1. Update Product

  • Supplier can use this API to Update one or more products by version up.

  • It is used when updating a existing product.

  • Before doing update, xlsx including exist products information download must be preceded in other endpoint. - Product - Download Latest.

  • This endpoint only generates task id. So you can check progress status in other endpoint. - Product - Check Task Status

2. API Spec

1) Request

Endpoint

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

Method

POST

Description

Update existing product.

Content-Type

multipart/form-data

2) Body Parameter

Name

Required

Type

Description

supplier_access_key

O

String

  • Access right key issued by AX

depth_combination

O

File

  • An xlsx file no larger than 2MB to create purchase option units for products

contents

O

File

  • An xlsx file no larger than 2MB to create detail information of products

images

O

List[File]

  • The name of each file, including the extension, is specified in the contents file

  • A list of jpg(jpeg) or png, each no larger than 1MB

3) Response

Name

Type

Description

status

task_

code

id

Number

Server response code

message

String

Server response message

data

Object

not_processed_company_code

Array

Among the company codes in the depth combination file, company codes that could not be processed because of that company code not matching the supplier access key you entered

UUID

This task takes quite a bit of time. So this endpoint return only task id. You can use this task id for checking task status to other endpoint - https://axchange.atlassian.net/wiki/spaces/AC/pages/edit-v2/378109983

4) Error Spec

Status Code

Message

Solution

403

Need valid supplier access key.

The valid supplier access key must be entered

400

Need 2 excel and at least 1 image.

The valid files composed of depth combination, contents, images must be entered

400

Need valid depth combination file and contents file.

Check the guide sheet of the depth combination and enter a valid value for each column

5) Response Example

Code Block
languagepy
{
  "messagetask_id": "Success",915c1218-f41c-492b-bb0b-96177ff4d2ee"
}
Code Block
languagepy
{
  "status_code": 201403,
  "datamessage": {"Need valid supplier access  "not_processed_company_code": []
  }
key."
}
Code Block
languagepy
{
  "status_code": 403400,
  "message": "Need valid supplier access key2 excel and at least 1 image."
}

3. Request Example

1) CURL

Code Block
curl -X 'POST' \
  'https://prod.ax-cloud.com/v1/wholeness-upload' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -H 'X-CSRFTOKEN: cGWHP4rWn2tZ2ZBJMB2G36eSphzLwYOo8rK2wbaQuG8MHFTiqRq0KZ7thAPE8yFE' \
  -F 'supplier_access_key=098b34d1-5764-48e1-b062-94b287f9049c' \
  -F 'depth_combination=@Depth Combination.xlsx;type=application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' \
  -F 'contents=@contents.xlsx;type=application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' \
  -F 'images=@5172422803_A.jpg;type=image/jpeg' \
  -F 'images=@5172422803_B.jpg;type=image/jpeg' \
  -F 'images=@5172422803_C.jpg;type=image/jpeg'

...