Order Desk
Learn how to integrate Anedot with Order Desk to automate order management. This guide walks you through setup, syncing Action Pages, entering API credentials, and customizing metadata fields.
Order Desk enables you to automate and streamline your order management workflow by integrating directly with Anedot.
Table of Contents
Connecting Anedot to Order Desk
To begin the integration:
-
Navigate to Settings > Integrations > Directory in your Anedot dashboard.
-
Select Order Desk from the list of available integrations.
-
Action Page Selection
-
By default, all Action Pages will sync with Order Desk.
-
To exclude specific pages, enter a comma-separated list of the corresponding Action Page IDs.
-
You can also limit the integration to a specific Team’s Action Pages. If no team is selected, all applicable pages (as defined above) will sync.
-
-
Enter your Order Desk API Key. If you need help locating it, please reach out to Order Desk Support.
-
Enter your Order Desk Store ID.
-
Optionally, you may also enter a comma-separated list of hidden fields to send additional order-item metadata to Order Desk.
- Click Save to complete the connection.
You can modify Action Pages, Team filters, and credentials at any time.
Data Relays
-
Financial Pages Only:
Anedot sends relays exclusively for financial Action Pages. -
Manual Pushes:
You can resend failed or unsent relays using the Push Unsent feature, which supports all Action Pages and allows for custom date range selection. -
Relay Failure Handling:
If there are five consecutive failed relay attempts, the integration will be marked as inactive, and no further relay attempts will be made until reactivated.
Field Mapping
Anedot Field | Order Desk Field |
---|---|
“paymentMethod {cardMonth} / paymentMethod {cardYear}” |
cc_exp |
- address {city} phone address {region} "" address {country} address {line1} address {line2} lastName firstName address {postalCode} |
customer / shipping {city} {phone} {state} {company} {country} {address1} {address2} {last_name} {first_name} {postal_code} |
(Donation) id | source_id |
“0” | tax_total |
created_at | date_added |
- totalAmount (x100) "true" (Donation) frequency "GOAA" (if submission has associated products, otherwise: "") "1" "noship" |
order_items {price} {is_donation} {donation_frequency} donation_subaccount {quantity} {delivery_type} |
totalAmount (x100) | order_total |
One of: VISA MASTERCARD DISCOVER AMEX EFT ( if bank account ) PAYPAL |
payment_type |
- actionPagesFund identifier "ANEDOT" (Donation) id email source_code "CHECKING" or "SAVINGS" account id "xxxxx + cardLastFour" (eg: "xxxxx1234") (Commitment) id totalAmount (x100, if commitment is present) |
order_metadata {fund} {source order_id} {SSO_Ping_id} {source_code} {eft_account_type} {anedot_account_uid} {eft_account_number} {anedot_commitment_uid} {anedot_commitment_amount} |
“0” | shipping_total |
“FREE” | shipping_method |
“xxxxxxxxxxxx + cardLastFour” (eg: “xxxxxxxxxxxx1234” ) |
cc_number_masked |
totalAmount (x100) | processor_balance |
Payload Data
Request Headers
{ }
Request Body
{
"email": "admin@anedot.com",
"cc_exp": "12/2034",
"customer": {
"city": "New Orleans",
"phone": "2252501301",
"state": "LA",
"company": "",
"country": "US",
"address1": "1340 Poydras Street",
"address2": null,
"last_name": "Dot",
"first_name": "Annie",
"postal_code": "70113"
},
"shipping": {
"city": "New Orleans",
"phone": "2252501301",
"state": "LA",
"company": "",
"country": "US",
"address1": "1340 Poydras Street",
"address2": null,
"address3": "",
"address4": "",
"last_name": "Dot",
"first_name": "Annie",
"postal_code": "70113"
},
"source_id": "dddc78757b4fffb4ba67d",
"tax_total": 0,
"date_added": "2023-02-17 15:18:02",
"order_items": [{
"price": 50.0,
"metadata": {
"is_donation": "true",
"donation_frequency": "once",
"donation_subaccount": null
},
"quantity": 1,
"delivery_type": "noship"
}],
"order_total": 50.0,
"payment_type": "MASTERCARD",
"order_metadata": {
"fund": "1001",
"source": "ANEDOT",
"order_id": "dddc78757b4fffb4ba67d",
"SSO_Ping_id": "admin@anedot.com",
"source_code": "stub",
"eft_account_type": "",
"anedot_account_uid": "aa3480c1cb0b039147824",
"eft_account_number": "",
"anedot_commitment_uid": null,
"anedot_commitment_amount": null
},
"shipping_total": 0,
"shipping_method": "FREE",
"cc_number_masked": "xxxxxxxxxxxx5454",
"processor_balance": 50.0
}
Response Body (Success)
{
"order": {
"id": "3866382274",
"email": "admin@anedot.com",
"cc_exp": "12/2034",
"customer": {
"city": "New Orleans",
"phone": "2252501301",
"state": "LA",
"company": "",
"country": "US",
"address1": "1340 Poydras Street",
"address2": "",
"last_name": "Dot",
"first_name": "Annie",
"postal_code": "70113"
},
"shipping": {
"city": "New Orleans",
"phone": "2252501301",
"state": "LA",
"company": "",
"country": "US",
"address1": "1340 Poydras Street",
"address2": "",
"address3": "",
"address4": "",
"last_name": "Dot",
"first_name": "Annie",
"postal_code": "70113"
},
"tag_name": "",
"folder_id": 268383,
"source_id": "dddc78757b4fffb4ba67d",
"tag_color": "",
"tax_total": 0,
"date_added": "2023-02-17 15:18:02",
"ip_address": "",
"customer_id": "",
"email_count": "46",
"order_items": [{
"id": "260562913",
"code": "",
"name": "",
"price": 50,
"weight": 0,
"metadata": {
"ship": "no ship",
"is_donation": "true",
"donation_frequency": "once",
"donation_subaccount": ""
},
"quantity": 1,
"category_code": "",
"delivery_type": "noship",
"variation_list": [],
"fulfillment_method": ""
}],
"order_notes": [],
"order_total": 50,
"source_name": "Order Desk",
"date_updated": "2023-02-17 15:18:19",
"payment_type": "MASTERCARD",
"refund_total": 0,
"weight_total": 0,
"checkout_data": {
"back_order_cancel_date": "240217"
},
"discount_list": [],
"product_total": 50,
"discount_total": 0,
"fulfillment_id": "",
"handling_total": 0,
"order_metadata": {
"fund": "1001",
"source": "ANEDOT",
"order_id": "dddc78757b4fffb4ba67d",
"SSO_Ping_id": "admin@anedot.com",
"source_code": "stub",
"eft_account_type": "",
"json_post_in_body": "1",
"anedot_account_uid": "aa3480c1cb0b039147824",
"eft_account_number": "",
"anedot_commitment_uid": "",
"anedot_commitment_amount": ""
},
"payment_status": "Approved",
"quantity_total": 1,
"return_address": {
"city": "",
"name": "",
"phone": "",
"state": "",
"title": "",
"company": "",
"country": "",
"address1": "",
"address2": "",
"postal_code": ""
},
"shipping_total": 0,
"order_shipments": [],
"shipping_method": "FREE",
"cc_number_masked": "xxxxxxxxxxxx5454",
"fulfillment_name": "",
"processor_balance": 50,
"previous_folder_id": "119169",
"processor_response": ""
},
"status": "success",
"execution_time": "5.4832 seconds"
}
Response Body (Failure)
{
"status": "error",
"message": "Order dddc78757b4fffb4ba67d already imported.",
"execution_time": "0.0168 seconds",
"existing_order_id": 400504278
}
Response Body (Error)
{ }
Response Status (Success)
201
Response Status (Failure)
400
Response Status (Error)
null