Create Membership

POST

Use this endpoint to create a new membership.

tenantstringRequired

Your Entra Tenant ID. More details.

environmentstringRequired

Your Business Central Environment. More details.

companystringRequired

Your Business Central Company. More details.

x-api-versiondateOptional

Used for API versioning. More details.

This endpoint expects an object.

itemNumberstringRequired

Unique identifier for an item.

cacheInstanceIdstringOptional

Identifier for the NST instance. Providing this value will increase the performance of the API when the NST is load-balanced.

activationDatedateOptional

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

companyNamestringOptional

The name of the company associated with the membership.

preassignedCustomerNumberstringOptional

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

This endpoint returns an object.

membershipobject

The MembershipEntity describes the basic attributes of a Membership.

cacheInstanceIdstringOptional

Identifier for the NST instance. Providing this value will increase the performance of the API when the NST is load-balanced.

1	curl -X POST https://api.npretail.app/01234567-89ab-cdef-0123-456789abcdef/production/CRONUS%20International%20Ltd./membership \
2	-H "Content-Type: application/json" \
3	-d '{
4	"itemNumber": "M12345"
5	}'

1	{
2	"membership": {
3	"membershipId": "cdef7890-abcd-0123-1234-567890abcdef",
4	"membershipNumber": "MS-DEMO-00152",
5	"communityCode": "RIVERLAND",
6	"membershipCode": "GOLD",
7	"issueDate": "2024-09-17",
8	"blocked": false,
9	"validFromDate": "2024-09-17",
10	"validUntilDate": "2025-09-16",
11	"customerNumber": "D000188"
12	}
13	}