API Endpoints #

Product #

GET v1/products #

https://tw.supplier.yahoo.com/api/spa/v1/products

Query products owned by the log-in supplier.

Parameters

Parameter Name	Type	Required	Note
id	String	N	Comma-separated product ID
partNo	String	N	Part number, all the products with the part number contains the input value will be returned
sort	String	N	Comma-separated sort condition: [+\|-]id Default: -id
offset	Int32	N	Pagination offset. Default: 0
limit	Int32	N	Pagination limit. Default: 20 Max: 50
fields	String	N	Comma-separated additional fields +listingIdList

At least one of parameter id or partNo is required.

Output

HTTP Status Code: 200 (OK)
Object: Products

Error

HTTP Status Code	Error Code	Description
400		Invalid input
400	40000005	Contains illegal character(s)
401	40100001	Missing or bad authentication
401	40100002	Invalid cookie
401	40100003	Missing or bad authentication
401	40100004	Check wssid failed
401	40100006	Cookie has expired
500	50000006	Internal server error
500	50000026	Internal server error
500	50000030	Internal server error
500	50000034	Internal server error
500	50000035	Internal server error

Example

Query product by ID and part number, and return the listings the product belongs to.

Request

GET /api/spa/v1/products?id=6497217&partNo=partNo1&fields=+listingIdList

Response

HTTP/1.1 200 OK

{
  "products": [
    {
      "id": 6497217,
      "sku": 6497217,
      "name": "-abc 測ㄅㄇ12!#➠ ∜あなたPM仿供應商，ｓｕb28",
      "cost": "1.00",
      "images": [
        {
          "url": "https://s.yimg.com/zo/MerchandiseImages/0985562A21-SP-178305.jpg",
          "width": 1000,
          "height": 1000,
          "order": 1
        },
        {
          "url": "https://s.yimg.com/zo/MerchandiseImages/0D74056666-SP-178305.jpg",
          "width": 400,
          "height": 400,
          "order": 1
        },
        {
          "url": "https://s.yimg.com/zo/MerchandiseImages/307DC71837-SP-178305.jpg",
          "width": 250,
          "height": 250,
          "order": 1
        },
        {
          "url": "https://s.yimg.com/zo/MerchandiseImages/56E6ABE9EA-SP-178305.jpg",
          "width": 135,
          "height": 135,
          "order": 1
        },
        {
          "url": "https://s.yimg.com/zo/MerchandiseImages/62239DB238-SP-178305.jpg",
          "width": 80,
          "height": 80,
          "order": 1
        },
        {
          "url": "https://s.yimg.com/zo/MerchandiseImages/0985562A21-SP-178305.jpg",
          "width": 1000,
          "height": 1000,
          "order": 2
        },
        {
          "url": "https://s.yimg.com/zo/MerchandiseImages/0D74056666-SP-178305.jpg",
          "width": 400,
          "height": 400,
          "order": 2
        }
      ],
      "listingIdList": [
        3369651
      ],
      "isExpiringItem": false,
      "isInstallRequired": false,
      "isNeedRecycle": false,
      "minPackingCount": 1,
      "taxable": true,
      "msrp": "9999999.00",
      "brand": "商品品牌",
      "catId": "cat915",
      "catItemId": "catItem13950",
      "isSoftGame": true,
      "gameContents": [
        "棋牌益知及娛樂"
      ],
      "shipType": {
        "id": 1,
        "type": "Home"
      }
    }
  ],
  "pagination": {
    "resultsTotal": 1
  }
}