Order Purchase/Return/Refund/Cancellation

1 min

POST

https://api.us1.odp.optimizely.com/v3/events

Upload an order purchase/return/refund/cancellation event to Optimizely Data Platform (ODP).

Body Parameters

bodyEvent[]required
Examples
Order Purchase Example Payload:
[ { "type": "order", "action": "purchase", "identifiers": { "email": "[email protected]" }, "data": { "ts": 123456789, "order": { "order_id": "OR345", "total": 109.65, "discount": 5, "subtotal": 103, "tax": 5.15, "shipping": 6.5, "coupon_code": "5OFF", "items": [ { "product_id": "2045", "price": 19, "quantity": 5, "discount": 0, "subtotal": 95 }, { "product_id": "2091", "price": 10, "quantity": 1, "discount": 2, "subtotal": 8 } ] } } } ]
Order Cancellation Example Payload:
[ { "type": "order", "action": "cancel", "identifiers": { "email": "[email protected]" }, "data": { "ts": 123456789, "order": { "order_id": "OR345", "total": -100, "items": [ { "product_id": "2045", "price": -10, "quantity": 10, "subtotal": -100 } ] } } } ]
Partial Refund Example Payload:
[ { "identifiers": { "email": "[email protected]" }, "type": "order", "action": "refund", "data": { "order": { "order_id": "ABC", "total": 10, "subtotal": 10 } } } ]
- typestringrequired
  Example
  order
  Description
  the event type
  Default
  order
- actionstringrequired
  Example
  purchase
  Description
  the event action associated with the type. Acceptable actions include: purchase, return, refund, and cancel
- identifiersmap<string, string>required
  Description
  any known identifiers associated with the customer that performed the event
- datamap<string, string>
  Description
  the data with the order and any additional fields
  - tsnumber
    Description
    specify the time of the order action
  - orderOrder
    - order_idstringrequired
      Description
      the unique identifier related to this order
    - totalnumber
      Description
      total should include the final amount charged to the customer after all goods, discounts, tax, and shipping are calculated. See below for more information
    - subtotalnumber
      Description
      subtotal may be taken either before or after discounting, but generally should be before shipping or tax
    - taxnumber
    - shippingnumber
    - itemsLineItem[]
      - product_idstringrequired
        Description
        the unique identifier for the order line item
      - pricenumber
        Description
        the price for an order line item
      - quantitynumber
        Description
        the number of items purchased
      - discountnumber
        Description
        the discount (if any) for the given line item
      - subtotalnumber
        Description
        the calculated subtotal for the given product and quantity, typically calculated after any discounts

Responses

202Accepted

GenericUpdateResponse
- titlestring
- statusinteger<int32>
  Format
  int32
- timestampstring

400Bad Request

undefined

Example

{
  "title": "Bad Request",
  "status": 400,
  "timestamp": "2018-09-10T21:07:10-05:00",
  "detail": {
    "invalids": [
      {
        "field": "delimiter",
        "reason": "Unrecognized delimiter, valid options are comma, tab or pipe"
      }
    ]
  }
}

403Forbidden

undefined
Example
```
{
  "message": "Forbidden"
}
```

404Not Found

undefined

Example

{
  "title": "Bad Request",
  "status": 404,
  "timestamp": "2018-09-10T21:07:10-05:00",
  "detail": {
    "message": "Not found description"
  }
}

curl

curl --request POST \
     --url https://api.us1.odp.optimizely.com/v3/events \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '[
     {
     "type": "order",
     "action": "purchase",
     "identifiers": "",
     "data": ""
     }
     ]'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var raw = JSON.stringify([
   {
      "type": "order",
      "action": "purchase",
      "identifiers": "",
      "data": ""
   }
]);

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://api.us1.odp.optimizely.com/v3/events", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.us1.odp.optimizely.com/v3/events")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump([
   {
      "type": "order",
      "action": "purchase",
      "identifiers": "",
      "data": ""
   }
])

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.us1.odp.optimizely.com/v3/events"

payload = json.dumps([
   {
      "type": "order",
      "action": "purchase",
      "identifiers": "",
      "data": ""
   }
])
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

202

// Accepted
{
  "title": "",
  "status": "",
  "timestamp": ""
}

400

// Bad Request
"{\"title\":\"Bad Request\",\"status\":400,\"timestamp\":\"2018-09-10T21:07:10-05:00\",\"detail\":{\"invalids\":[{\"field\":\"delimiter\",\"reason\":\"Unrecognized delimiter, valid options are comma, tab or pipe\"}]}}"

403

// Forbidden
"{  \"message\": \"Forbidden\"}"

404

// Not Found
"{\"title\":\"Bad Request\",\"status\":404,\"timestamp\":\"2018-09-10T21:07:10-05:00\",\"detail\":{\"message\":\"Not found description\"}}"