memberships > Catalog

Get the list of membership items and their descriptions for a specific store.

get/{tenant}/{environment}/{company}/membership/catalog/{storeCode}

Request

  • Base URL
    https://api.npretail.app
  • Auth
    API key in header x-np-api-key

Path parameters

tenantstring required

Your Entra Tenant ID. More details.

environmentstring required

Your Business Central Environment. More details.

companystring required

Your Business Central Company. More details.

storeCodestring

A unique identifier for a store - a logical grouping defining a subset of membership items. This is used to filter the list of membership related items returned by the API.

Query parameters

itemNumberstring

Unique identifier for an item.

Headers

x-api-versionstring date

Used for API versioning. More details.

Response

Response with status 200

storeCodestring required

A unique identifier for a store - a logical grouping defining a subset of membership items. This is used to filter the list of membership related items returned by the API.

Changes

    • breaking

      the response's body type changed from no type to object for status

    • warning

      deleted the header request parameter x-np-api-key

    • info

      the endpoint scheme security NPApiKeyAuthScheme was added to the API

    • info

      for the path request parameter storeCode, the type was generalized from no type to string

    • info

      for the query request parameter itemNumber, the type was generalized from no type to string

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      api operation id get-catalog removed and replaced with memberships_serviceCatalog_getCatalog