Products

Get product

Looks up a product in Anrok by its external ID. Returns the product's external ID, tax category, name, and description.

post/v1/seller/products/externalId:{externalId}/get

Request

  • Base URL: https://api.anrok.com
  • URL: https://api.anrok.com/v1/seller/products/externalId:{externalId}/get
  • Auth: HTTP bearer

Request body

object required

Response

OK

externalIdstring required

The product's external ID.

namestring required

The product's display name.

descriptionstring required

The product's description. Empty string if no description has been set.

Example response

{
  "externalId": "sku-1001",
  "taxCategoryId": {
    "id": "saasBusiness"
  },
  "name": "Pro plan",
  "description": "Monthly subscription to the Pro plan."
}

Changes

No recorded changes to this operation across all 1 revision of this API.