Product Operations - JSON API

Table of Contents

1. GET Product Operations
2. Object Definitions

Introduction

Products are sellable items within eFiling, a product can have an operation assigned, these are additional charges.

An example of this would be an Address product. For each item of post processed a charge can be made against the customer's account. eFiling allows brands to configure their own charges via 'product operations'

An operation will have a name, description and price.

1.0 GET /products/[product-id]/operations

This end point will allow you to retrieve all possible operations associated with a product.

Response

Value	Type	Description
request	object	Request details
response	object	Response object that contains an array of 'product operation'
pagination	object	Pagination details
errors	array	Contains an array of strings

2.0 Object Definitions

Below is a list object definitions.

2.1 Request

An object that returns details about API request, it's only returned when 'debug' filter set to '1'

Property	Value	Description
type	string	HTTP method
url	string	Endpoint requested.
filters	object	An object containing any applied filters.

2.2 Response

An object that contains the data requested.

Property	Value	Description
product_operations	array	Array of product operation objects

2.3 Pagination

An object that contains details about pagination

Property	Value	Description
result_count	int	The number of results returned.
result_total	int	The total number of results available.
current_page	int	The page you are viewing based on the result_limit being displayed. Passed in through the URL
total_pages	int	The total number of pages you can view.

2.4 Product Operation

Property	Value	Description
id	int	The id of the operation
product_id	int	The id of the product.
name	string	The name of the operation.|product_operations.description | string | A description of the operation.
price	int	The price of the operation.