Send orders and carts to ActiveTrail from your server, and read the order, lead and opportunity field schemas.
All endpoints use the base URL https://webapi.mymarketing.co.il and an API key in the Authorization header. New to the API? Start with Get started with the ActiveTrail API.
Endpoints
| Method | Endpoint | What it does |
|---|---|---|
POST | /api/ | Add new order |
PUT | /api/ | Modify existing order |
GET | /api/ | Get order by its id |
POST | /api/ | Add new cart |
GET | /api/ | Get order fields information |
GET | /api/ | Get lead fields information |
GET | /api/ | Get opportunity fields information |
Endpoint details
Add new order
POST https://webapi.mymarketing.co.il/api/commerce/Order
| Parameter | In | Type | Description |
|---|---|---|---|
orderId | body | string | The Order ID. |
orderName | body | string | The name of the order. |
externalId | body | string | The external user ID. |
externalName | body | string | The external name. |
firstName | body | string | The first name of the customer. |
lastName | body | string | The last name of the customer. |
email | body | string | The email address of the customer. |
mobile | body | string | The mobile number of the customer. |
netAmount | body | decimal number | The net amount of the order. |
tax | body | decimal number | The tax applied to the order. |
coupon | body | string | The coupon code used for the order. |
quantity | body | decimal number | The quantity of items in the order. |
totalAmount | body | decimal number | The total amount of the order. |
address | body | string | The shipping address of the order. |
city | body | string | The city. |
products | body | Collection of Product | The list of products in the order. |
url | body | string | The URL associated with the order. |
purchaseDate | body | date | The date of purchase. |
lastUpdate | body | date | The last update date of the order. |
purchaseType | body | string | The type of purchase. |
status | body | string | The status of purchase. |
storeId | body | integer | The store ID associated with the order. |
locationType | body | OrderLocationType | The location type associated with the order. |
ext1 … date3 | body | string / date / number | Custom contact fields (18 fields). Same meaning as the contact fields in ActiveTrail. |
subscriptionStatus | body | boolean | The subscription status of a new contact. false: the contact is created as Unsubscribed. Default true. |
createContact | body | boolean | Whether the request can create a new contact. false: no new contact is created. Default true. |
The request body is a JSON object (ApiPostOrder).
Full reference, request and response samples
Modify existing order
PUT https://webapi.mymarketing.co.il/api/commerce/Order/{orderId}
| Parameter | In | Type | Description |
|---|---|---|---|
orderId | path | string | The Order ID. Required. |
orderName | body | string | The name of the order. |
externalid | body | string | The external user ID. |
externalname | body | string | The external name. |
firstname | body | string | The first name of the customer. |
lastname | body | string | The last name of the customer. |
email | body | string | The email address of the customer. |
mobile | body | string | The mobile number of the customer. |
netamount | body | decimal number | The net amount of the order. |
tax | body | decimal number | The tax applied to the order. |
coupon | body | string | The coupon code used for the order. |
quantity | body | decimal number | The quantity of items in the order. |
totalamount | body | decimal number | The total amount of the order. |
address | body | string | The shipping address of the order. |
city | body | string | The city. |
products | body | Collection of Product | The list of products in the order. |
url | body | string | The URL associated with the order. |
purchasedate | body | date | The date of purchase. |
lastupdate | body | date | The last update date of the order. |
purchasetype | body | string | The type of purchase. |
status | body | string | The status of purchase. |
storeid | body | integer | The store ID associated with the order. |
locationtype | body | OrderLocationType | The location type associated with the order. |
ext1 … date3 | body | string / date / number | Custom contact fields (18 fields). Same meaning as the contact fields in ActiveTrail. |
subscriptionStatus | body | boolean | The subscription status of a new contact. false: the contact is created as Unsubscribed. Default true. |
createContact | body | boolean | Whether the request can create a new contact. false: no new contact is created. Default true. |
The request body is a JSON object (ApiUpdateOrder).
Full reference, request and response samples
Get order by its id
GET https://webapi.mymarketing.co.il/api/commerce/Order/{orderId}
| Parameter | In | Type | Description |
|---|---|---|---|
orderId | path | string | Required. |
Full reference, request and response samples
Add new cart
POST https://webapi.mymarketing.co.il/api/commerce/Cart
| Parameter | In | Type | Description |
|---|---|---|---|
externalId | body | string | The external user ID. |
externalName | body | string | The external name. |
name | body | string | The name associated with the cart. |
firstName | body | string | The first name of the person associated with the cart. |
lastName | body | string | The last name of the person associated with the cart. |
email | body | string | The email address of the person associated with the cart. |
mobile | body | string | The mobile phone number of the person associated with the cart. |
netAmount | body | decimal number | The net amount for the cart (before tax). |
tax | body | decimal number | The tax amount applied to the cart. |
coupon | body | string | The coupon code applied to the cart, if any. |
quantity | body | decimal number | The quantity of items in the cart. |
totalAmount | body | decimal number | The total amount for the cart (including tax). |
address | body | string | The address associated with the cart. |
city | body | string | The city associated with the cart. |
products | body | Collection of ApiOrderProduct | The list of products in the cart. |
url | body | string | The URL associated with the cart, if any. |
lastUpdate | body | date | The date when the cart was last updated, if available. |
purchaseType | body | string | The purchase type (e.g., online, in-store). |
storeId | body | integer | The store ID where the cart was created or purchased. |
locationType | body | OrderLocationType | The location type for the cart (e.g., delivery, pick-up). |
ext1 … date3 | body | string / date / number | Custom contact fields (18 fields). Same meaning as the contact fields in ActiveTrail. |
subscriptionStatus | body | boolean | The subscription status of a new contact. false: the contact is created as Unsubscribed. Default true. |
createContact | body | boolean | Whether the request can create a new contact. false: no new contact is created. Default true. |
The request body is a JSON object (ApiCart).
Full reference, request and response samples
Get order fields information
GET https://webapi.mymarketing.co.il/api/commerce/schema
No parameters.
Full reference, request and response samples
Get lead fields information
GET https://webapi.mymarketing.co.il/api/commerce/saleslifecycle/lead/schema
No parameters.
Full reference, request and response samples
Get opportunity fields information
GET https://webapi.mymarketing.co.il/api/commerce/saleslifecycle/opportunity/schema
No parameters.
Full reference, request and response samples
This reference is based on the ActiveTrail API documentation, where you can also test each endpoint with your own API key.