TIM SDK
TIM API C
|
|
Basket item.
Object type basket_item.
ta_e_result_code_t ta_basket_item_copy | ( | ta_object_t * | item, |
const ta_object_t * | source_item | ||
) |
Create deep copy of object instance of type basket_item.
[out] | item | Pointer to variable to write created object instance to. Created object instance is retained. |
[in] | source_item | Object of type basket_item to create copy of. |
ta_c_rc_ok | Object instance has been created and written to item. |
ta_c_rc_invalid_argument | item is null-pointer. |
ta_c_rc_invalid_argument | source_item is ta_invalid_object. |
ta_c_rc_invalid_argument | source_item is not of type basket_item. |
ta_c_rc_out_of_memory | Failed allocating memory. |
ta_e_result_code_t ta_basket_item_create | ( | ta_object_t * | item | ) |
Create object of type basket_item.
[out] | item | Pointer to variable to write created object instance to. Created object instance is retained. |
ta_c_rc_ok | Object instance has been created and written to item. |
ta_c_rc_invalid_argument | item is null-pointer. |
ta_c_rc_out_of_memory | Failed allocating memory. |
ta_e_result_code_t ta_basket_item_get_amount | ( | ta_object_t | item, |
ta_object_t * | amount | ||
) |
Amount.
[in] | item | Object instance of type basket_item. |
[out] | amount | Pointer to variable to write object instance to. Object instance is of type amount and is not retained. Object instance is ta_invalid_object if value is not set in item. |
ta_c_rc_ok | Object instance written to amount. |
ta_c_rc_invalid_argument | item is ta_invalid_object. |
ta_c_rc_invalid_argument | item is not of type basket_item. |
ta_c_rc_invalid_argument | amount is not null-pointer. |
ta_e_result_code_t ta_basket_item_get_amount_discount | ( | ta_object_t | item, |
ta_object_t * | amount_discount | ||
) |
Discount amount or 0 if discount amount is not used.
[in] | item | Object instance of type basket_item. |
[out] | amount_discount | Pointer to variable to write object instance to. Object instance is of type amount_discount and is not retained. Object instance is ta_invalid_object if value is not set in item. |
ta_c_rc_ok | Object instance written to amount_discount. |
ta_c_rc_invalid_argument | item is ta_invalid_object. |
ta_c_rc_invalid_argument | item is not of type basket_item. |
ta_c_rc_invalid_argument | amount_discount is not null-pointer. |
ta_e_result_code_t ta_basket_item_get_amount_gross | ( | ta_object_t | item, |
ta_object_t * | amount_gross | ||
) |
Gross amount.
[in] | item | Object instance of type basket_item. |
[out] | amount_gross | Pointer to variable to write object instance to. Object instance is of type amount and is not retained. Object instance is ta_invalid_object if value is not set in item. |
ta_c_rc_ok | Object instance written to amount_gross. |
ta_c_rc_invalid_argument | item is ta_invalid_object. |
ta_c_rc_invalid_argument | item is not of type basket_item. |
ta_c_rc_invalid_argument | amount_gross is not null-pointer. |
ta_e_result_code_t ta_basket_item_get_amount_tax | ( | ta_object_t | item, |
ta_object_t * | amount_tax | ||
) |
Tax amount.
[in] | item | Object instance of type basket_item. |
[out] | amount_tax | Pointer to variable to write object instance to. Object instance is of type amount and is not retained. Object instance is ta_invalid_object if value is not set in item. |
ta_c_rc_ok | Object instance written to amount_tax. |
ta_c_rc_invalid_argument | item is ta_invalid_object. |
ta_c_rc_invalid_argument | item is not of type basket_item. |
ta_c_rc_invalid_argument | amount_tax is not null-pointer. |
ta_e_result_code_t ta_basket_item_get_amount_total | ( | ta_object_t | item, |
ta_object_t * | amount_total | ||
) |
Total amount.
[in] | item | Object instance of type basket_item. |
[out] | amount_total | Pointer to variable to write object instance to. Object instance is of type amount and is not retained. Object instance is ta_invalid_object if value is not set in item. |
ta_c_rc_ok | Object instance written to amount_total. |
ta_c_rc_invalid_argument | item is ta_invalid_object. |
ta_c_rc_invalid_argument | item is not of type basket_item. |
ta_c_rc_invalid_argument | amount_total is not null-pointer. |
ta_e_result_code_t ta_basket_item_get_auth_result | ( | ta_object_t | item, |
ta_object_t * | auth_result | ||
) |
Acquirers result code, which indicates the result of a restriction request.
[in] | item | Object instance of type basket_item. |
[out] | auth_result | Pointer to variable to write object instance to. Object instance is of type integer and is not retained. Object instance is ta_invalid_object if value is not set in basket_item. |
ta_c_rc_ok | Object instance written to auth_result. |
ta_c_rc_invalid_argument | item is ta_invalid_object. |
ta_c_rc_invalid_argument | item is not of type basket_item. |
ta_c_rc_invalid_argument | auth_result is not null-pointer. |
ta_e_result_code_t ta_basket_item_get_item_id | ( | ta_object_t | item, |
ta_object_t * | id | ||
) |
Identifies the item.
[in] | item | Object instance of type basket_item. |
[out] | id | Pointer to variable to write object instance to. Object instance is of type string and is not retained. Object instance is ta_invalid_object if value is not set in item. |
ta_c_rc_ok | Object instance written to id. |
ta_c_rc_invalid_argument | item is ta_invalid_object. |
ta_c_rc_invalid_argument | item is not of type basket_item. |
ta_c_rc_invalid_argument | id is not null-pointer. |
ta_e_result_code_t ta_basket_item_get_item_quantity | ( | ta_object_t | item, |
ta_object_t * | item_quantity | ||
) |
Quantity of the product.
[in] | item | Object instance of type basket_item. |
[out] | item_quantity | Pointer to variable to write object instance to. Object instance is of type item_quantity and is not retained. Object instance is ta_invalid_object if value is not set in item. |
ta_c_rc_ok | Object instance written to item_quantity. |
ta_c_rc_invalid_argument | item is ta_invalid_object. |
ta_c_rc_invalid_argument | item is not of type basket_item. |
ta_c_rc_invalid_argument | item_quantity is not null-pointer. |
ta_e_result_code_t ta_basket_item_get_loyalty_id | ( | ta_object_t | item, |
ta_object_t * | loyalty_id | ||
) |
Identifies the loyalty type.
[in] | item | Object instance of type basket_item. |
[out] | loyalty_id | Pointer to variable to write object instance to. Object instance is of type string and is not retained. Object instance is ta_invalid_object if value is not set in item. |
ta_c_rc_ok | Object instance written to loyalty_id. |
ta_c_rc_invalid_argument | item is ta_invalid_object. |
ta_c_rc_invalid_argument | item is not of type basket_item. |
ta_c_rc_invalid_argument | loyalty_id is not null-pointer. |
ta_e_result_code_t ta_basket_item_get_prod_description | ( | ta_object_t | item, |
ta_object_t * | prod_description | ||
) |
Product description.
[in] | item | Object instance of type basket_item. |
[out] | prod_description | Pointer to variable to write object instance to. Object instance is of type string and is not retained. Object instance is ta_invalid_object if value is not set in item. |
ta_c_rc_ok | Object instance written to prod_description. |
ta_c_rc_invalid_argument | item is ta_invalid_object. |
ta_c_rc_invalid_argument | item is not of type basket_item. |
ta_c_rc_invalid_argument | prod_description is not null-pointer. |
ta_e_result_code_t ta_basket_item_get_unit_amount_discount | ( | ta_object_t | item, |
ta_object_t * | unit_amount_discount | ||
) |
Tax amount.
[in] | item | Object instance of type basket_item. |
[out] | unit_amount_discount | Pointer to variable to write object instance to. Object instance is of type amount and is not retained. Object instance is ta_invalid_object if value is not set in item. |
ta_c_rc_ok | Object instance written to unit_amount_discount. |
ta_c_rc_invalid_argument | item is ta_invalid_object. |
ta_c_rc_invalid_argument | item is not of type basket_item. |
ta_c_rc_invalid_argument | unit_amount_discount is not null-pointer. |
ta_e_result_code_t ta_basket_item_get_unit_amount_gross | ( | ta_object_t | item, |
ta_object_t * | unit_amount_gross | ||
) |
Tax amount.
[in] | item | Object instance of type basket_item. |
[out] | unit_amount_gross | Pointer to variable to write object instance to. Object instance is of type amount and is not retained. Object instance is ta_invalid_object if value is not set in item. |
ta_c_rc_ok | Object instance written to unit_amount_gross. |
ta_c_rc_invalid_argument | item is ta_invalid_object. |
ta_c_rc_invalid_argument | item is not of type basket_item. |
ta_c_rc_invalid_argument | unit_amount_gross is not null-pointer. |
ta_e_result_code_t ta_basket_item_set_amount | ( | ta_object_t | item, |
ta_object_t | amount | ||
) |
Set amount.
[in] | item | Object instance of type basket_item. |
[in] | amount | Object instance to set. Object instance can be ta_invalid_object to clear the value in item. If object instance is not ta_invalid_object is has to be of type amount. |
ta_c_rc_ok | Object instance assigned to item. |
ta_c_rc_invalid_argument | item is ta_invalid_object. |
ta_c_rc_invalid_argument | item is not of type basket_item. |
ta_c_rc_invalid_argument | amount is not ta_invalid_object and is not of type amount. |
ta_e_result_code_t ta_basket_item_set_amount_discount | ( | ta_object_t | item, |
ta_object_t | amount_discount | ||
) |
Set discount amount or 0 if discount amount is not used.
[in] | item | Object instance of type basket_item. |
[in] | amount_discount | Object instance to set. Object instance can be ta_invalid_object to clear the value in item. If object instance is not ta_invalid_object is has to be of type amount_discount. |
ta_c_rc_ok | Object instance assigned to item. |
ta_c_rc_invalid_argument | item is ta_invalid_object. |
ta_c_rc_invalid_argument | item is not of type basket_item. |
ta_c_rc_invalid_argument | amount_discount is not ta_invalid_object and is not of type amount_discount. |
ta_e_result_code_t ta_basket_item_set_amount_gross | ( | ta_object_t | item, |
ta_object_t | amount_gross | ||
) |
Set gross amount.
[in] | item | Object instance of type basket_item. |
[in] | amount_gross | Object instance to set. Object instance can be ta_invalid_object to clear the value in item. If object instance is not ta_invalid_object is has to be of type amount. |
ta_c_rc_ok | Object instance assigned to item. |
ta_c_rc_invalid_argument | item is ta_invalid_object. |
ta_c_rc_invalid_argument | item is not of type basket_item. |
ta_c_rc_invalid_argument | amount_gross is not ta_invalid_object and is not of type amount. |
ta_e_result_code_t ta_basket_item_set_amount_tax | ( | ta_object_t | item, |
ta_object_t | amount_tax | ||
) |
Set tax amount.
[in] | item | Object instance of type basket_item. |
[in] | amount_tax | Object instance to set. Object instance can be ta_invalid_object to clear the value in item. If object instance is not ta_invalid_object is has to be of type amount. |
ta_c_rc_ok | Object instance assigned to item. |
ta_c_rc_invalid_argument | item is ta_invalid_object. |
ta_c_rc_invalid_argument | item is not of type basket_item. |
ta_c_rc_invalid_argument | amount_tax is not ta_invalid_object and is not of type amount. |
ta_e_result_code_t ta_basket_item_set_amount_total | ( | ta_object_t | item, |
ta_object_t | amount_total | ||
) |
Set total amount.
[in] | item | Object instance of type basket_item. |
[in] | amount_total | Object instance to set. Object instance can be ta_invalid_object to clear the value in item. If object instance is not ta_invalid_object is has to be of type amount. |
ta_c_rc_ok | Object instance assigned to item. |
ta_c_rc_invalid_argument | item is ta_invalid_object. |
ta_c_rc_invalid_argument | item is not of type basket_item. |
ta_c_rc_invalid_argument | amount_total is not ta_invalid_object and is not of type amount. |
ta_e_result_code_t ta_basket_item_set_auth_result | ( | ta_object_t | item, |
ta_object_t | auth_result | ||
) |
Set acquirers result code, which indicates the result of a restriction request.
[in] | item | Object instance of type basket_item. |
[in] | auth_result | Object instance to set. Object instance can be ta_invalid_object to clear the value in item. If object instance is not ta_invalid_object is has to be of type integer. |
ta_c_rc_ok | Object instance assigned to item. |
ta_c_rc_invalid_argument | item is ta_invalid_object. |
ta_c_rc_invalid_argument | item is not of type basket_item. |
ta_c_rc_invalid_argument | auth_result is not ta_invalid_object and is not of type integer. |
ta_e_result_code_t ta_basket_item_set_item_id | ( | ta_object_t | item, |
ta_object_t | id | ||
) |
Set identifies the item.
[in] | item | Object instance of type basket_item. |
[in] | id | Object instance to set. Object instance can be ta_invalid_object to clear the value in item. If object instance is not ta_invalid_object is has to be of type string. |
ta_c_rc_ok | Object instance assigned to item. |
ta_c_rc_invalid_argument | item is ta_invalid_object. |
ta_c_rc_invalid_argument | item is not of type basket_item. |
ta_c_rc_invalid_argument | id is not ta_invalid_object and is not of type string. |
ta_e_result_code_t ta_basket_item_set_item_quantity | ( | ta_object_t | item, |
ta_object_t | item_quantity | ||
) |
Set quantity of the product.
[in] | item | Object instance of type basket_item. |
[in] | item_quantity | Object instance to set. Object instance can be ta_invalid_object to clear the value in item. If object instance is not ta_invalid_object is has to be of type item_quantity. |
ta_c_rc_ok | Object instance assigned to item. |
ta_c_rc_invalid_argument | item is ta_invalid_object. |
ta_c_rc_invalid_argument | item is not of type basket_item. |
ta_c_rc_invalid_argument | item_quantity is not ta_invalid_object and is not of type item_quantity. |
ta_e_result_code_t ta_basket_item_set_loyalty_id | ( | ta_object_t | item, |
ta_object_t | loyalty_id | ||
) |
Set identifies the loyalty type.
[in] | item | Object instance of type basket_item. |
[in] | loyalty_id | Object instance to set. Object instance can be ta_invalid_object to clear the value in item. If object instance is not ta_invalid_object is has to be of type string. |
ta_c_rc_ok | Object instance assigned to item. |
ta_c_rc_invalid_argument | item is ta_invalid_object. |
ta_c_rc_invalid_argument | item is not of type basket_item. |
ta_c_rc_invalid_argument | loyalty_id is not ta_invalid_object and is not of type string. |
ta_e_result_code_t ta_basket_item_set_prod_description | ( | ta_object_t | item, |
ta_object_t | prod_description | ||
) |
Set product description.
[in] | item | Object instance of type basket_item. |
[in] | prod_description | Object instance to set. Object instance can be ta_invalid_object to clear the value in item. If object instance is not ta_invalid_object is has to be of type string. |
ta_c_rc_ok | Object instance assigned to item. |
ta_c_rc_invalid_argument | item is ta_invalid_object. |
ta_c_rc_invalid_argument | item is not of type basket_item. |
ta_c_rc_invalid_argument | prod_description is not ta_invalid_object and is not of type string. |
ta_e_result_code_t ta_basket_item_set_unit_amount_discount | ( | ta_object_t | item, |
ta_object_t | unit_amount_discount | ||
) |
Set unit_amount_discount amount.
[in] | item | Object instance of type basket_item. |
[in] | unit_amount_discount | Object instance to set. Object instance can be ta_invalid_object to clear the value in item. If object instance is not ta_invalid_object is has to be of type amount. |
ta_c_rc_ok | Object instance assigned to item. |
ta_c_rc_invalid_argument | item is ta_invalid_object. |
ta_c_rc_invalid_argument | item is not of type basket_item. |
ta_c_rc_invalid_argument | unit_amount_discount is not ta_invalid_object and is not of type amount. |
ta_e_result_code_t ta_basket_item_set_unit_amount_gross | ( | ta_object_t | item, |
ta_object_t | unit_amount_gross | ||
) |
Set unit_amount_gross amount.
[in] | item | Object instance of type basket_item. |
[in] | unit_amount_gross | Object instance to set. Object instance can be ta_invalid_object to clear the value in item. If object instance is not ta_invalid_object is has to be of type amount. |
ta_c_rc_ok | Object instance assigned to item. |
ta_c_rc_invalid_argument | item is ta_invalid_object. |
ta_c_rc_invalid_argument | item is not of type basket_item. |
ta_c_rc_invalid_argument | unit_amount_gross is not ta_invalid_object and is not of type amount. |