Privacy

Privacy permissions exists on two levels: enterprise and ordertype. This API can be used to get the current privacy permissions the customer. It may also be used to update the data.

Field Type Description
enterprise Level Wrapper for enterprise level permission/shield.
orderType Level Wrapper for order type level permission/shield.
purpose String Purpose of permission.

List privacy enterprise

The user needs to be logged in to use this endpoint, click here to read more.

SecurityAuthorization_Code
Request
path Parameters
enterpriseCode
required
string <= 12 characters
Responses
200

OK

Response Schema: application/json
Array of objects

Wrapper for enterprise level permission/shield.

400

Bad Request

429

Too Many Requests

500

Internal Server Error

get/v1/customer/privacy/{enterpriseCode}
Request samples
Response samples
application/json
{
  • "permission": [
    ]
}

Change privacy enterprise

The user needs to be logged in to use this endpoint, click here to read more.

Privacy permissions exists on two levels: enterprise and ordertype. This API can be used to get the current privacy permissions the customer. It may also be used to update the data.

SecurityAuthorization_Code
Request
path Parameters
enterpriseCode
required
string <= 12 characters
Request Body schema: application/json
Array of objects

Wrapper for enterprise level permission/shield.

Responses
200

OK

Response Schema: application/json
Array of objects

Wrapper for enterprise level permission/shield.

400

Bad Request

429

Too Many Requests

500

Internal Server Error

post/v1/customer/privacy/{enterpriseCode}
Request samples
application/json
{
  • "permission": [
    ]
}
Response samples
application/json
{
  • "permission": [
    ]
}

List privacy ordertype

The user needs to be logged in to use this endpoint, click here to read more.

This API can be used to get the current privacy permissions the customer.

SecurityAuthorization_Code
Request
path Parameters
enterpriseCode
required
string <= 12 characters
orderType
required
string <= 12 characters
Responses
200

OK

Response Schema: application/json
Array of objects

Wrapper for order type level permission/shield.

400

Bad Request

429

Too Many Requests

500

Internal Server Error

get/v1/customer/privacy/{enterpriseCode}/{orderType}
Request samples
Response samples
application/json
{
  • "permission": [
    ]
}

Change privacy ordertype

The user needs to be logged in to use this endpoint, click here to read more.

This API can be used to update the current privacy permissions for the customer.

SecurityAuthorization_Code
Request
path Parameters
enterpriseCode
required
string <= 12 characters
orderType
required
string <= 12 characters
Request Body schema: application/json
Array of objects

Wrapper for order type level permission/shield.

Responses
200

OK

Response Schema: application/json
Array of objects

Wrapper for order type level permission/shield.

400

Bad Request

429

Too Many Requests

500

Internal Server Error

post/v1/customer/privacy/{enterpriseCode}/{orderType}
Request samples
application/json
{
  • "permission": [
    ]
}
Response samples
application/json
{
  • "permission": [
    ]
}