The Rest API is deprecated and will be removed in the future. We recommend using the GraphQL API instead. Some endpoints may not be available anymore.
- Get list of integrationsGET
- Create integrationPOST
- Get integration by idGET
- Update integrationPUT
- Delete integrationDELETE
- Get integration actions by idGET
- Execute integration actionPOST
- Sync integration orders (async)POST
- Sync integration products (async)POST
- Get settings for integrationGET
- Sync integration shipping services (async)POST
- Sync integration product stocks (async)POST
- Get list of rule typesGET
- Get rule typeGET
- Get list of rulesGET
- Create rulePOST
- Get rule by idGET
- Update rulePUT
- Delete ruleDELETE
- Get rule actionsGET
- Create rule actionPOST
- Get rule action by idGET
- Update rule actionPUT
- Delete rule actionDELETE
- Get rule conditionsGET
- Create rule conditionPOST
- Get rule condition by idGET
- Update rule conditionPUT
- Delete rule conditionDELETE
Get rule type
GET
https://api.pack.cloud/v1/organizations/{organizationId}/rule-types/{ruleType}
Request
Path parameters
organizationIdstring
ruleTypestring
Response
OK
Body
code
Code of the rule type
Example:return_gatekeeper
name
Name of the rule type
Example:Return gatekeeper
code
Code of the action
Example:update_return_request_status
name
Name of the action
Example:Accept return request
Fields of the action
keystring
Key of the field
Example:subject
titlestring
Title of the field
Example:Subject
data_typestringnull
Data type of the field
Example:brand
typestring
Type of the field
Allowed values:booleanbrandmoneyselecttexttextareawysiwyg
Example:text
defaultstringnull
Default value of the field
Example:Subject
Options of the field (when type is select)
title
Title of the option
Example:Subject
value
Value of the option
Example:Example
code
Code of the condition
Example:total_quantity_returned
name
Name of the condition
Example:Total quantity returned
Allowed operators of the condition
type
Type of the condition value
Allowed values:booleanbrandmoneyselecttexttextareawysiwyg
Example:text
data_typestringnull
Data type of the condition value
Example:brand
OK
Body
code
Code of the rule type
Example:return_gatekeeper
name
Name of the rule type
Example:Return gatekeeper
code
Code of the action
Example:update_return_request_status
name
Name of the action
Example:Accept return request
Fields of the action
keystring
Key of the field
Example:subject
titlestring
Title of the field
Example:Subject
data_typestringnull
Data type of the field
Example:brand
typestring
Type of the field
Allowed values:booleanbrandmoneyselecttexttextareawysiwyg
Example:text
defaultstringnull
Default value of the field
Example:Subject
Options of the field (when type is select)
title
Title of the option
Example:Subject
value
Value of the option
Example:Example
code
Code of the condition
Example:total_quantity_returned
name
Name of the condition
Example:Total quantity returned
Allowed operators of the condition
type
Type of the condition value
Allowed values:booleanbrandmoneyselecttexttextareawysiwyg
Example:text
data_typestringnull
Data type of the condition value
Example:brand
OK
Body
code
Code of the rule type
Example:return_gatekeeper
name
Name of the rule type
Example:Return gatekeeper
code
Code of the action
Example:update_return_request_status
name
Name of the action
Example:Accept return request
Fields of the action
keystring
Key of the field
Example:subject
titlestring
Title of the field
Example:Subject
data_typestringnull
Data type of the field
Example:brand
typestring
Type of the field
Allowed values:booleanbrandmoneyselecttexttextareawysiwyg
Example:text
defaultstringnull
Default value of the field
Example:Subject
Options of the field (when type is select)
title
Title of the option
Example:Subject
value
Value of the option
Example:Example
code
Code of the condition
Example:total_quantity_returned
name
Name of the condition
Example:Total quantity returned
Allowed operators of the condition
type
Type of the condition value
Allowed values:booleanbrandmoneyselecttexttextareawysiwyg
Example:text
data_typestringnull
Data type of the condition value
Example:brand
OK
Body
code
Code of the rule type
Example:return_gatekeeper
name
Name of the rule type
Example:Return gatekeeper
code
Code of the action
Example:update_return_request_status
name
Name of the action
Example:Accept return request
Fields of the action
keystring
Key of the field
Example:subject
titlestring
Title of the field
Example:Subject
data_typestringnull
Data type of the field
Example:brand
typestring
Type of the field
Allowed values:booleanbrandmoneyselecttexttextareawysiwyg
Example:text
defaultstringnull
Default value of the field
Example:Subject
Options of the field (when type is select)
title
Title of the option
Example:Subject
value
Value of the option
Example:Example
code
Code of the condition
Example:total_quantity_returned
name
Name of the condition
Example:Total quantity returned
Allowed operators of the condition
type
Type of the condition value
Allowed values:booleanbrandmoneyselecttexttextareawysiwyg
Example:text
data_typestringnull
Data type of the condition value
Example:brand
OK
Body
code
Code of the rule type
Example:return_gatekeeper
name
Name of the rule type
Example:Return gatekeeper
code
Code of the action
Example:update_return_request_status
name
Name of the action
Example:Accept return request
Fields of the action
keystring
Key of the field
Example:subject
titlestring
Title of the field
Example:Subject
data_typestringnull
Data type of the field
Example:brand
typestring
Type of the field
Allowed values:booleanbrandmoneyselecttexttextareawysiwyg
Example:text
defaultstringnull
Default value of the field
Example:Subject
Options of the field (when type is select)
title
Title of the option
Example:Subject
value
Value of the option
Example:Example
code
Code of the condition
Example:total_quantity_returned
name
Name of the condition
Example:Total quantity returned
Allowed operators of the condition
type
Type of the condition value
Allowed values:booleanbrandmoneyselecttexttextareawysiwyg
Example:text
data_typestringnull
Data type of the condition value
Example:brand