xclade
Admin APIProducts

Get a Product's Option

Retrieve a product's option by its ID.

GET
/admin/products/{id}/options/{option_id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

The product's ID.

option_id*string

The product's option id.

Query Parameters

fields?string

Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.

Response Body

application/json

application/json

text/plain

application/json

application/json

application/json

application/json

curl -X GET "https://{tenant}.api.myxclade.com/admin/products/string/options/string"
{
  "product_option": {
    "id": "string",
    "title": "string",
    "product": {},
    "product_id": "string",
    "values": [
      {}
    ],
    "metadata": {},
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "deleted_at": "2019-08-24T14:15:22Z"
  }
}

{
  "message": "Discount must be set to dynamic",
  "type": "not_allowed"
}

"Unauthorized"
{
  "message": "Entity with id 1 was not found",
  "type": "not_found"
}
{
  "code": "unknown_error",
  "message": "The request conflicted with another request. You may retry the request with the provided Idempotency-Key.",
  "type": "QueryRunnerAlreadyReleasedError"
}
{
  "code": "invalid_request_error",
  "message": "Discount with code TEST already exists.",
  "type": "duplicate_error"
}

{
  "code": "api_error",
  "message": "An error occured while hashing password",
  "type": "database_error"
}

List a Product's Options

Retrieve a list of options of a product. The options can be filtered by fields like `id`. The options can also be paginated.

List Variants of a Product

Retrieve a list of variants in a product. The variants can be filtered by fields like FILTER FIELDS. The variants can also be paginated.