Store Transaction
Use this request to create a transaction that will be saved.
To store a transaction, use a POST method and the following URL:
{service_URL}/api/v3/seller/transactions
where {servic_URL} is the URL of the sandbox or production environment.
For example:
curl --request POST \
--url https://seller-transaction-api.sandbox.marketplace.taxamo.com/api/v3/seller/transactions \
Details
| Type | Value |
|---|---|
| Endpoint | /api/v3/seller/transactions |
| Method | POST |
| Seller API Reference Documentation | Store the transaction. |
Fields
A full list of the available fields is in the Fields Reference section.
Request example
The following example shows some information that you may want to add in the JSON of this request:
{
"transaction": {
"tax_timestamp": "2025-03-01T12:00:00Z",
"description": "Transaction description",
"currency_code": "EUR",
"buyer_name": "Test buyer",
"ship_to_address": {
"country_code": "GB",
"city": "Big city",
"street_name": "Street name",
"building_number": "100a",
"address_detail": "2nd fl",
"postal_code": "00000"
},
"billing_address": {
"country_code": "GB",
"city": "The big city",
"street_name": "The street name",
"building_number": "100a",
"postal_code": "00000"
},
"transaction_lines": [
{
"amount": 100,
"custom_id": "",
"ship_from_address": {
"country_code": "GB"
},
"description": "Product 1",
"product_class": "P",
"product_tax_code": {
"class": "TPP/Goods"
}
},
{
"amount": 100,
"custom_id": "",
"ship_from_address": {
"country_code": "GB"
},
"description": "Shipping",
"product_class": "S"
}
]
}
}
Response example
Here is an example of some of the information that might be returned by the API. Note the Transaction Key that is returned in the transaction_key field. You need this for the Confirm Transaction request.
{
"transaction": {
"ship_to_address": {
"city": "Big city",
"country_code": "GB",
"postal_code": "00000",
"street_name": "Street name",
"address_detail": "2nd fl",
"building_number": "100a",
"tax_region": "GB"
},
"description": "Transaction description",
"amount": 200.00,
"required_fields": {
"tax_required_fields": [],
"storage_required_fields": []
},
"marketplace_code": "V4EDemo",
"tax_country_codes": "GB",
"key": "PSqiwAQAAPJFqz_jLCgzo6VMqW1xn5klQ9goY6w",
"tax_amount": 40.00,
"update_date": "2025-03-28",
"invoice_timestamp": "2025-03-01T12:00:00Z",
"tax_liability_owner_codes": "",
"create_timestamp": "2025-03-28T07:01:36Z",
"transaction_lines": [
{
"description": "Product 1",
"reverse_charge": false,
"amount": 100.00,
"tax_rule_applied": "physical-tax",
"unit_price": 100.00,
"taxes": [
{
"tax_type": "VAT",
"imposition_type": "VAT",
"tax_jurisdiction_code": "78295",
"tax_amount": 20.0,
"tax_calculation_rule_id": "v301086121",
"exempt_amount": 0.0,
"tax_base_amount": 100,
"tax_jurisdiction_type": "COUNTRY",
"rate": 20,
"taxable_amount": 100.0,
"tax_authority_name": "UNITED KINGDOM",
"rate_type": "Standard",
"tax_authority_id": "78295",
"tax_name": "VAT physical",
"non_taxable_amount": 0.0,
"imposition": "VAT",
"amount_fraction_taxable": 1
}
],
"tax_amount": 20.00,
"seller_tax_number": "GB123456789",
"tax_region": "GB",
"invoice_place": "Postal address line 1, Postal address line 2, Postal address line 3",
"tax_exempt": false,
"additional_currencies": {
"invoice": {
"amount": 82.59,
"currency_code": "GBP",
"fx_date": "2025-02-28T12:00:00Z",
"fx_rate": 0.825900231252,
"fx_source": "source_bankofengland",
"total_amount": 99.11,
"tax_amount": 16.52
}
},
"tax_country_code": "GB",
"line_key": "UwJ85ua2PYVf48bX",
"custom_id": "",
"tax_address_kind": "ship_to_address",
"ship_from_address": {
"country_code": "GB",
"tax_region": "GB"
},
"tax_engine": "oseries",
"invoice_status": "R",
"kind": "b2c",
"product_tax_code": {
"class": "TPP/Goods"
},
"tax_number_service": "tax.service.gov.uk",
"product_class": "P",
"custom_rules_applied": [],
"line_num": 1,
"is_seller_permanent": true,
"quantity": 1.000000000000,
"invoice_capable": false,
"total_amount": 120.00,
"seller_code": "V4EDemo_Seller3",
"tax_entity_name": "United Kingdom",
"tax_supported": true
},
{
"description": "Shipping",
"reverse_charge": false,
"amount": 100.00,
"tax_rule_applied": "physical-tax",
"unit_price": 100.00,
"taxes": [
{
"tax_type": "VAT",
"imposition_type": "VAT",
"tax_jurisdiction_code": "78295",
"tax_amount": 20.00,
"tax_calculation_rule_id": "v301086121",
"exempt_amount": 0.0,
"tax_base_amount": 100.00,
"tax_jurisdiction_type": "COUNTRY",
"rate": 20,
"taxable_amount": 100.0,
"tax_authority_name": "UNITED KINGDOM",
"rate_type": "Standard",
"tax_authority_id": "78295",
"tax_name": "VAT physical",
"non_taxable_amount": 0.0,
"imposition": "VAT",
"amount_fraction_taxable": 1
}
],
"tax_amount": 20.00,
"seller_tax_number": "GB123456789",
"tax_region": "GB",
"invoice_place": "Postal address line 1, Postal address line 2, Postal address line 3",
"additional_currencies": {
"invoice": {
"amount": 82.59,
"currency_code": "GBP",
"fx_date": "2025-02-28T12:00:00Z",
"fx_rate": 0.825900231252,
"fx_source": "source_bankofengland",
"total_amount": 99.11,
"tax_amount": 16.52
}
},
"tax_country_code": "GB",
"line_key": "bjjMpRAXWINsH9uZ",
"custom_id": "",
"tax_address_kind": "ship_to_address",
"ship_from_address": {
"country_code": "GB",
"tax_region": "GB"
},
"tax_engine": "oseries",
"invoice_status": "R",
"kind": "b2c",
"tax_number_service": "tax.service.gov.uk",
"product_class": "S",
"custom_rules_applied": [],
"line_num": 2,
"is_seller_permanent": true,
"quantity": 1.000000000000,
"invoice_capable": false,
"total_amount": 120.00,
"seller_code": "V4EDemo_Seller3",
"tax_entity_name": "United Kingdom",
"tax_supported": true
}
],
"discounts": [],
"refunded_tax_amount": 0,
"product_classes": "SP",
"billing_address": {
"city": "The big city",
"country_code": "GB",
"postal_code": "00000",
"street_name": "The street name",
"building_number": "100a",
"tax_region": "GB"
},
"status": "N",
"refunded_total_amount": 0,
"update_timestamp": "2025-03-28T07:01:36Z",
"buyer_name": "Test buyer",
"tax_timestamp": "2025-03-01T12:00:00Z",
"total_amount": 240.00,
"currency_code": "EUR"
}
}
Updated about 1 month ago