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 15 Next »

1. Create New

  • Supplier can use this API to create one or more products.

  • It is used when registering a new product.

  • You can check progress status in Product - Check Task Status.

2. API Spec

1) Request

Endpoint

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

Method

POST

Description

Register new 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

task_id

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.

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

5) Response Example

{
  "task_id": "915c1218-f41c-492b-bb0b-96177ff4d2ee"
}
{
  "status_code": 403,
  "message": "Need valid supplier access key."
}
{
  "status_code": 400,
  "message": "Need 2 excel and at least 1 image."
}

3. Request Example

1) CURL

curl -X 'POST' \
  'http://localhost:8000/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'

4. Limitation

  • supplier_access_key

    • It must be the same as the company code of the depth combination file

  • File

    • The depth combination is xlsx file no larger than 2MB

    • The contents is an xlsx file no larger than 2MB

    • Each image must be a jpg(jpeg) or png file no larger than 1MB

  • Total size limit for all files

    • The total size limit is 100 MB

  • No labels