Sdílet prostřednictvím


Product - List

Získá všechny produkty.

GET https://prod.core.sphere.azure.net/v2/tenants/{tenantId}/products
GET https://prod.core.sphere.azure.net/v2/tenants/{tenantId}/products?maxPageSize={maxPageSize}

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
tenantId
path True

string

uuid

ID tenanta Azure Sphere

maxPageSize
query

integer

int32

Maximální počet výsledků, které by měly být zahrnuty do odpovědi.

Hlavička požadavku

Name Vyžadováno Typ Description
Sphere-Continuation

string

Pokračovací token použitý k pokračování z předchozí stránky výsledků.

Odpovědi

Name Typ Description
200 OK

ProductItemCollectionResponse

Úspěch.

Příklady

List the products

Sample Request

GET https://prod.core.sphere.azure.net/v2/tenants/768c2cd6-1bf0-4521-9f53-084a331d81cb/products

Sample Response

{
  "Items": [
    {
      "Id": "b0ba65bc-648f-4213-a910-cbeb6024c744",
      "TenantId": "768c2cd6-1bf0-4521-9f53-084a331d81cb",
      "Name": "Dishwasher",
      "Description": "Contoso dishwashers"
    },
    {
      "Id": "258e9e1d-a16d-4459-be5d-38420a8c43ad",
      "TenantId": "768c2cd6-1bf0-4521-9f53-084a331d81cb",
      "Name": "Refrigerator",
      "Description": "Contoso refrigerators"
    }
  ],
  "ContinuationToken": null
}

Definice

Name Description
Product
ProductItemCollectionResponse

Product

Name Typ Description
Description

string

Popis produktu.

Id

string

Jedinečné ID produktu.

Name

string

Název produktu.

TenantId

string

Jedinečné ID tenanta, který je vlastníkem produktu.

ProductItemCollectionResponse

Name Typ Description
ContinuationToken

string

Token pro pokračování, který lze použít k získání další sady položek.

Items

Product[]

Seznam položek.