Add a batch of transactions from offline sources.

Request

POST https://api.taxcloud.net/1.0/TaxCloud/AddTransactions

Request body

The request body takes a complete AddTransactions resource, containing the following writable properties:

{
    "apiKey": "string",
    "apiLoginID": "string",
    "transactions": [
        {
            "cartID": "uuid",
            "cartItems": [
                {
                    "Index": "int32",
                    "ItemID": "string",
                    "Price": "float",
                    "Qty": "int32",
                    "Rate": "float",
                    "TIC": "int32",
                    "Tax": "float"
                }
            ],
            "customerID": "string",
            "dateAuthorized": "date-time",
            "dateCaptured": "date-time",
            "dateTransaction": "date-time",
            "deliveredBySeller": "boolean",
            "destination": {
                "Address1": "string",
                "Address2": "string",
                "City": "string",
                "State": "string",
                "Zip4": "number",
                "Zip5": "number"
            },
            "exemptCert": "uuid",
            "orderID": "string",
            "origin": {
                "Address1": "string",
                "Address2": "string",
                "City": "string",
                "State": "string",
                "Zip4": "number",
                "Zip5": "number"
            }
        }
    ]
}

Properties

Name Type Description Additional
apiKey string

Find your API KEY via https://taxcloud.com/go/stores/

apiLoginID string

Find your API ID via https://taxcloud.com/go/stores/

transactions[] array
transactions[].cartID uuid

CartID is very similar to an Order ID, except most systems do not issue immutable (permanent) identifiers for orders until customers actually place their order (clicking the BUY button).

IMPORTANT: You must be able to persist the CartID across all Lookup requests for a particular customer (including situations where a customer puts an item in her cart before logging in, then proceeds ordering after logging in).

If your system does not provide a mechanism to create unique identifiers, you can omit this parameter (or submit as null) and TaxCloud will provide a unique identifier in the response (which you should persist for subsequent Lookup calls and the ultimate Authorized or AuthorizedWithCapture calls).

Optional
transactions[].cartItems[] array Optional
transactions[].cartItems[].Index int32
transactions[].cartItems[].ItemID string
transactions[].cartItems[].Price float
transactions[].cartItems[].Qty int32
transactions[].cartItems[].Rate float
transactions[].cartItems[].TIC int32
transactions[].cartItems[].Tax float Optional
transactions[].customerID string

This should be the abstract identifier used by your system to uniquely identify customers. Note: This should not be your customer's email address or any other form of Personally Identifiable Information (PII).

Optional
transactions[].dateAuthorized date-time

The Date/Time of record for Authorization. If omitted, this value is inferred from the time the API call is received.

Optional
transactions[].dateCaptured date-time

The Date/Time of record for Capture (or shipping date). If omitted, this value is inferred from the time the API call is received.

Optional
transactions[].dateTransaction date-time

The Date/Time of order/invoice creation

Optional
transactions[].deliveredBySeller boolean

If you ship orders to customers via common carrier (USPS, UPS, FedEx, etc) should always be false.

Optional
transactions[].destination object Address Optional
transactions[].destination.Address1 string Address1
transactions[].destination.Address2 string Address2 Optional
transactions[].destination.City string City
transactions[].destination.State string State

Possible values are:

  • AL
  • AK
  • AZ
  • AR
  • CA
  • CO
  • CT
  • DE
  • DC
  • FL
  • GA
  • HI
  • ID
  • IL
  • IN
  • IA
  • KS
  • KY
  • LA
  • ME
  • MD
  • MA
  • MI
  • MN
  • MS
  • MO
  • MT
  • NE
  • NV
  • NH
  • NJ
  • NM
  • NY
  • NC
  • ND
  • OH
  • OK
  • OR
  • PA
  • RI
  • SC
  • SD
  • TN
  • TX
  • UT
  • VT
  • VA
  • WA
  • WV
  • WI
  • WY
transactions[].destination.Zip4 number Zip4
transactions[].destination.Zip5 number Zip5
transactions[].exemptCert uuid CertificateID Optional
transactions[].orderID string

This is the immutable Order identifier used by your system to identify unique orders.

Optional
transactions[].origin object Address Optional
transactions[].origin.Address1 string Address1
transactions[].origin.Address2 string Address2 Optional
transactions[].origin.City string City
transactions[].origin.State string State

Possible values are:

  • AL
  • AK
  • AZ
  • AR
  • CA
  • CO
  • CT
  • DE
  • DC
  • FL
  • GA
  • HI
  • ID
  • IL
  • IN
  • IA
  • KS
  • KY
  • LA
  • ME
  • MD
  • MA
  • MI
  • MN
  • MS
  • MO
  • MT
  • NE
  • NV
  • NH
  • NJ
  • NM
  • NY
  • NC
  • ND
  • OH
  • OK
  • OR
  • PA
  • RI
  • SC
  • SD
  • TN
  • TX
  • UT
  • VT
  • VA
  • WA
  • WV
  • WI
  • WY
transactions[].origin.Zip4 number Zip4
transactions[].origin.Zip5 number Zip5

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

OK

AddTransactionsResponse

Explore this API

AddTransactions
Request Content-Type
Response Content-Type
Try it out!