memberships > Memberships

Create Membership

Changed on

Use this endpoint to create a new membership.

post/{tenant}/{environment}/{company}/membership

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.

Headers

x-api-versionstring date

Used for API versioning. More details.

Request body

itemNumberstring required

Unique identifier for an item.

activationDatestring date

The date from which the membership should be active. Setup can dictate and override this date.

companyNamestring

The name of the company associated with the membership.

preassignedCustomerNumberstring

A preassigned customer number for the membership. When there is no customer number, the system will generate one.

documentNostring

External identifier for the sales document.

Response

Response with status 201

Changes

    • breaking

      added the new required request property

    • breaking

      the request's body type changed from no type to object

    • 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

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the required property to the response with the status

    • info

      api operation id create-membership removed and replaced with memberships_serviceMembership_createMembership