Thinkific.Api.ExternalOrders (Thinkific API SDK v0.1.3)
API calls for all endpoints tagged ExternalOrders.
Link to this section Summary
Functions
createExternalOrder Please note that any External Orders created through the API do not appear on the orders report or dashboard in your Thinkific site. Using the External Orders endpoints will simply store the information in our database.
purchase transaction This endpoint will create a new transaction purchase for the External Order.
refund transaction This endpoint will create a new transaction refund for the External Order.
Link to this section Functions
create_external_order(connection, opts \\ [])
Specs
create_external_order(Tesla.Env.client(), keyword()) :: {:ok, Thinkific.Model.ExternalOrdersResponse.t()} | {:error, Tesla.Env.t()}
createExternalOrder Please note that any External Orders created through the API do not appear on the orders report or dashboard in your Thinkific site. Using the External Orders endpoints will simply store the information in our database.
Parameters
- connection (Thinkific.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
- :body (ExternalOrderRequest): External Order request
Returns
} on success {:error, info} on failure
purchasetransaction(connection, id, opts \\ [])
Specs
purchasetransaction(Tesla.Env.client(), String.t(), keyword()) :: {:ok, nil} | {:error, Tesla.Env.t()}
purchase transaction This endpoint will create a new transaction purchase for the External Order.
Parameters
- connection (Thinkific.Connection): Connection to server
- id (String.t): External Order ID
- opts (KeywordList): [optional] Optional parameters
- :body (ExternalOrderTransaction): Transaction
Returns
} on success {:error, info} on failure
refundtransaction(connection, id, opts \\ [])
Specs
refundtransaction(Tesla.Env.client(), float(), keyword()) :: {:ok, nil} | {:error, Tesla.Env.t()}
refund transaction This endpoint will create a new transaction refund for the External Order.
Parameters
- connection (Thinkific.Connection): Connection to server
- id (float()): External Order ID as integer
- opts (KeywordList): [optional] Optional parameters
- :body (ExternalOrderTransaction): Transaction
Returns
} on success {:error, info} on failure