Schemas

GET Get a list of known SCAPI schema definitions.

GET /organizations/{organizationId}/schemas

Operation ID: getSchemaList. Security: AmOAuth2 (sfcc.scapi-schemas).

Parameters

• organizationId (path, OrganizationId, required) An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character realm identifier and a 3-character instance type identifier.

  Example

  f_ecom_zzxy_prd

• apiFamily (query, ApiFamily) The API family
• apiName (query, ApiName) The API name
• apiVersion (query, ApiVersion) The API version
• cartridgeName (query, CartridgeName) The cartridge name
• status (query, string) The schema status
  Allowed values: current, deprecated. Example: current.

Responses

• 200 List of known SCAPI schema definitions successfully retrieved.

  Media type: application/json. Schema: SchemaListResult.

  Example: SchemaListSuccess

  {
    "limit": 1,
    "total": 3,
    "filter": {
      "apiFamily": "product",
      "apiName": "shopper-products",
      "apiVersion": "v1",
      "status": "current"
    },
    "data": [
      {
        "schemaVersion": "1.0.25",
        "apiFamily": "product",
        "apiName": "shopper-products",
        "apiVersion": "v1",
        "status": "current",
        "link": "https://api.example.com/scapi/schemas/product/shopper-products/v1"
      }
    ]
  }

  Example: SchemaListSuccessNoFilter

  {
    "limit": 3,
    "total": 3,
    "data": [
      {
        "schemaVersion": "1.0.25",
        "apiFamily": "product",
        "apiName": "shopper-products",
        "apiVersion": "v1",
        "status": "current",
        "link": "https://api.example.com/scapi/schemas/product/shopper-products/v1"
      },
      {
        "schemaVersion": "2.1.0",
        "apiFamily": "checkout",
        "apiName": "shopper-baskets",
        "apiVersion": "v2",
        "status": "current",
        "link": "https://api.example.com/scapi/schemas/checkout/shopper-baskets/v2"
      },
      {
        "schemaVersion": "1.5.12",
        "apiFamily": "customer",
        "apiName": "customers",
        "apiVersion": "v1",
        "status": "deprecated",
        "link": "https://api.example.com/scapi/schemas/customer/customers/v1"
      }
    ]
  }

• 400 Value constraint violation

  Media type: application/problem+json. Schema: ErrorResponse.

  Example: BadRequest

  {
    "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/value-constraint-violation",
    "title": "Bad Request",
    "detail": "Value for parameter 'apiFamily' violates API constraint '^[a-z0-9-]+$'"
  }

• 401 Unauthorized

  Media type: application/problem+json. Schema: ErrorResponse.

  Example: Unauthorized

  {
    "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/unauthorized",
    "title": "Unauthorized",
    "detail": "Unauthorized request"
  }

• 403 Forbidden

  Media type: application/problem+json. Schema: ErrorResponse.

  Example: Forbidden

  {
    "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/forbidden",
    "title": "Forbidden",
    "detail": "Access to requested resource forbidden"
  }