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

MethodEndpointWhat it does
POST/api/commerce/OrderAdd new order
PUT/api/commerce/Order/{orderId}Modify existing order
GET/api/commerce/Order/{orderId}Get order by its id
POST/api/commerce/CartAdd new cart
GET/api/commerce/schemaGet order fields information
GET/api/commerce/saleslifecycle/lead/schemaGet lead fields information
GET/api/commerce/saleslifecycle/opportunity/schemaGet opportunity fields information

Endpoint details

Add new order

POST https://webapi.mymarketing.co.il/api/commerce/Order
ParameterInTypeDescription
orderIdbodystringThe Order ID.
orderNamebodystringThe name of the order.
externalIdbodystringThe external user ID.
externalNamebodystringThe external name.
firstNamebodystringThe first name of the customer.
lastNamebodystringThe last name of the customer.
emailbodystringThe email address of the customer.
mobilebodystringThe mobile number of the customer.
netAmountbodydecimal numberThe net amount of the order.
taxbodydecimal numberThe tax applied to the order.
couponbodystringThe coupon code used for the order.
quantitybodydecimal numberThe quantity of items in the order.
totalAmountbodydecimal numberThe total amount of the order.
addressbodystringThe shipping address of the order.
citybodystringThe city.
productsbodyCollection of ProductThe list of products in the order.
urlbodystringThe URL associated with the order.
purchaseDatebodydateThe date of purchase.
lastUpdatebodydateThe last update date of the order.
purchaseTypebodystringThe type of purchase.
statusbodystringThe status of purchase.
storeIdbodyintegerThe store ID associated with the order.
locationTypebodyOrderLocationTypeThe location type associated with the order.
ext1 … date3bodystring / date / numberCustom contact fields (18 fields). Same meaning as the contact fields in ActiveTrail.
subscriptionStatusbodybooleanThe subscription status of a new contact. false: the contact is created as Unsubscribed. Default true.
createContactbodybooleanWhether 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}
ParameterInTypeDescription
orderIdpathstringThe Order ID. Required.
orderNamebodystringThe name of the order.
externalidbodystringThe external user ID.
externalnamebodystringThe external name.
firstnamebodystringThe first name of the customer.
lastnamebodystringThe last name of the customer.
emailbodystringThe email address of the customer.
mobilebodystringThe mobile number of the customer.
netamountbodydecimal numberThe net amount of the order.
taxbodydecimal numberThe tax applied to the order.
couponbodystringThe coupon code used for the order.
quantitybodydecimal numberThe quantity of items in the order.
totalamountbodydecimal numberThe total amount of the order.
addressbodystringThe shipping address of the order.
citybodystringThe city.
productsbodyCollection of ProductThe list of products in the order.
urlbodystringThe URL associated with the order.
purchasedatebodydateThe date of purchase.
lastupdatebodydateThe last update date of the order.
purchasetypebodystringThe type of purchase.
statusbodystringThe status of purchase.
storeidbodyintegerThe store ID associated with the order.
locationtypebodyOrderLocationTypeThe location type associated with the order.
ext1 … date3bodystring / date / numberCustom contact fields (18 fields). Same meaning as the contact fields in ActiveTrail.
subscriptionStatusbodybooleanThe subscription status of a new contact. false: the contact is created as Unsubscribed. Default true.
createContactbodybooleanWhether 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}
ParameterInTypeDescription
orderIdpathstring Required.

Full reference, request and response samples

Add new cart

POST https://webapi.mymarketing.co.il/api/commerce/Cart
ParameterInTypeDescription
externalIdbodystringThe external user ID.
externalNamebodystringThe external name.
namebodystringThe name associated with the cart.
firstNamebodystringThe first name of the person associated with the cart.
lastNamebodystringThe last name of the person associated with the cart.
emailbodystringThe email address of the person associated with the cart.
mobilebodystringThe mobile phone number of the person associated with the cart.
netAmountbodydecimal numberThe net amount for the cart (before tax).
taxbodydecimal numberThe tax amount applied to the cart.
couponbodystringThe coupon code applied to the cart, if any.
quantitybodydecimal numberThe quantity of items in the cart.
totalAmountbodydecimal numberThe total amount for the cart (including tax).
addressbodystringThe address associated with the cart.
citybodystringThe city associated with the cart.
productsbodyCollection of ApiOrderProductThe list of products in the cart.
urlbodystringThe URL associated with the cart, if any.
lastUpdatebodydateThe date when the cart was last updated, if available.
purchaseTypebodystringThe purchase type (e.g., online, in-store).
storeIdbodyintegerThe store ID where the cart was created or purchased.
locationTypebodyOrderLocationTypeThe location type for the cart (e.g., delivery, pick-up).
ext1 … date3bodystring / date / numberCustom contact fields (18 fields). Same meaning as the contact fields in ActiveTrail.
subscriptionStatusbodybooleanThe subscription status of a new contact. false: the contact is created as Unsubscribed. Default true.
createContactbodybooleanWhether 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.