REST Order OrderReferrer

Create or list order referrers.

List referrers

Lists referrers with the desired columns/attributes.

/rest/orders/referrers

Parameters

Field	Type	Description
columns	`String[]`	The desired columns/attributes of the order referrer to be loaded.

Success 200

Response is a List

Field	Type	Description
`id`	`Float`	The ID of the order referrer
`isEditable`	`Bool`	Flag that indicates if this referrer can be updated as well as deleted or not True = the referrer can be edited and deleted False = the referrer can neither be edited nor deleted
`backendName`	`String`	The backend name of the referrer
`name`	`String`	The public name of the referrer as it is displayed e.g. on documents
`orderOwnerId`	`Int`	The user ID of whoever owns new orders from this referrer
`isFilterable`	`Bool`	Flag that indicates if this referrer can be used as a filter or not True = Can be used as a filter False = Cannot be used as a filter
`origin`	`String`	The origin of this referrer

Response (example)

[{"id":5.06,"isEditable":false,"backendName":"Oswald Estates","name":"Oswald Estates","orderOwnerId":2,"isFilterable":false},{"id":3.68,"isEditable":false,"backendName":"Buckridge Divide","name":"Buckridge Divide","orderOwnerId":5,"isFilterable":true}]

Errors 4xx

Code	Exception	Description
401	`League\OAuth2\Server\Exception\AccessDeniedException`	The resource owner or authorization server denied the request.
401	`League\OAuth2\Server\Exception\InvalidRequestException`	The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Create an order referrer

Create an order referrer. The ID can be specified, a parent ID can be specified to create a sub referrer or if no ID is specified, a referrer ID will be assigned automatically. If an ID is specified, the ID may not be used already. If the ID is used already, the referrer will only be created. If the ID is automatically assigned, the first ID that has not been used before will be set. If the ID is not specified, but a parent referrer ID is given, then the new referrer ID will be a sub referrer of the given parent.

/rest/orders/referrers/{parentReferrerId?}

Parameters

Field	Type	Description
data	`String[]`	The attributes of the order referrer to be created.

Success 200

Field	Type	Description
`id`	`Float`	The ID of the order referrer
`isEditable`	`Bool`	Flag that indicates if this referrer can be updated as well as deleted or not True = the referrer can be edited and deleted False = the referrer can neither be edited nor deleted
`backendName`	`String`	The backend name of the referrer
`name`	`String`	The public name of the referrer as it is displayed e.g. on documents
`orderOwnerId`	`Int`	The user ID of whoever owns new orders from this referrer
`isFilterable`	`Bool`	Flag that indicates if this referrer can be used as a filter or not True = Can be used as a filter False = Cannot be used as a filter
`origin`	`String`	The origin of this referrer

Errors 4xx

Code	Exception	Description
401	`League\OAuth2\Server\Exception\AccessDeniedException`	The resource owner or authorization server denied the request.
401	`League\OAuth2\Server\Exception\InvalidRequestException`	The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.