Get a product collection relationship

Requires read_products access scope.

For more info, refer to:

GET https://{handle}.myshopline.com/admin/openapi/v20260301/products/collects/:collect_id.json

handle : The store's unique identifier, which is the prefix of the store's domain name. For example, if a store's domain name is open001.myshopline.com , the store handle is open001 .

Get a product collection relationship.

Path Parameters

collect_id string required

The unique identifier for the product collection relationship.

Example: 5392284410644534000

Query Parameters

fields string

Specify the fields to be returned, with multiple fields separated by commas. For available fields, refer to the top-level child parameters under the collect object in the response.

Example: collection_id,product_id

Request Headers

Content-Type string required

The field must be set to the fixed value application/json; charset=utf-8.
Authorization string required

The access token for the API resource. Refer to App authorization to obtain the access token, and then pass the obtained token in the Bearer format.
Example:

Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

Status Codes

For the complete list of codes and messages, see Http status code.

Response Headers

traceId

A globally unique identifier for the request. It is used to track the request flow throughout the system, allowing for easy location and debugging when issues arise.

Response Body

collectobject

Information on the product collection relationship.
collection_id string

The unique identifier for the collection.
Example: 12248721639068681442230282
created_at string

The date and time when the product collection relationship was created. Format: ISO 8601.
Example: 2021-09-03T14:11:54+00:00
id long

The unique identifier for the product collection relationship.
Example: 5332942101495347000
product_id string

The unique identifier for the product.
Example: 16053328646530847836660114
product_priority long

The priority of a product within a collection. A smaller value indicates a higher priority. The priority values are non-continuous and are not arranged in sequential integers.
Example: 10000000000000
sort_value string

Product sorting value within a collection. Constructed by left-padding the product_priority value with zeros to reach a total length of 20 characters.
Example: 00000010000000000000
updated_at string

The date and time when the product collection relationship was last updated. Format: ISO 8601.
Example: 2021-09-03T14:11:54+00:00

API Explorer

Debugger

Examples

Base URL

https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301

ParamOptions

collect_id — path required

Authorization — header required

fields — query

Language

curl --request GET \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301/products/collects/collect_id.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'

Was this article helpful to you?

SHOPLINE

Legal