Skip to main content

Staff Email Payloads

This article details the email payloads Nautical sends to SendGrid for emails delivered to sellers and marketplace operators. Use this data to customize your SendGrid email templates with dynamic content from each payload.

Staff member accounts​

Password set​

The following payload is available for the account set staff password (set_staff_password_template) email:

{
  "user": {
    "id": 156,
    "email": "seller@example.com",
    "is_staff": true,
    "metadata": {},
    "is_active": true,
    "last_name": "Alex",
    "first_name": "Durand",
    "private_metadata": {}
  },
  "token": "c34n9r-c8115102dc3e4a05470719359cc8d448",
  "domain": "https://ssm.fly.dev/",
  "logo_url": "https://mediacdn.nauticalcommerce.app/ssm/marketplace-email-logo.png",
  "site_name": "Safety Supply Market",
  "recipient_email": "seller@example.com",
  "password_set_url": "https://dashboard-ssm.mpconsole.com/new-password/?email=sellerr%40example.com&token=c34n9r-c8115102dc3e4a05470719359cc8d448"
}

Password reset​

The following payload is available for the account staff reset password (staff_password_reset_template) email:

{
  "user": {
    "id": 156,
    "email": "seller@example.com",
    "is_staff": true,
    "metadata": {},
    "is_active": true,
    "last_name": "Alex",
    "first_name": "Durand",
    "private_metadata": {}
  },
  "token": "c34a7g-1da07d29aff812bf85f510415631208d",
  "domain": "https://ssm.fly.dev/",
  "logo_url": "https://mediacdn.nauticalcommerce.app/ssm/marketplace-email-logo.png",
  "reset_url": "https://dashboard-ssm.mpconsole.com/new-password/?email=sellerr%40example.com&token=c34a7g-1da07d29aff812bf85f510415631208d",
  "site_name": "Safety Supply Market",
  "recipient_email": "seller@example.com",
}

Seller accounts​

Account activation request​

The following payload is available for the account activation request (request_activation_template) email:

{
  "user": {
    "id": 156,
    "email": "seller@example.com",
    "is_staff": true,
    "metadata": {},
    "is_active": true,
    "last_name": "Durand",
    "first_name": "Alex",
    "private_metadata": {}
  },
  "token": "c34nho-f2921254a8c0e4d8c60e7daad9ecec76",
  "domain": "https://ssm.fly.dev/",
  "logo_url": "https://mediacdn.nauticalcommerce.app/ssm/marketplace-email-logo.png",
  "last_name": "Hydro",
  "site_name": "Safety Supply Market",
  "first_name": "Alex",
  "recipient_email": "seller@example.com"
}
Show more ↓

Seller pending​

The following payload is available for the pending seller (pending_seller_template) email:

{
  "token": "bz3yab-240d379f7115d5f067ef34ae8b251127",
  "domain": "https://ssm.fly.dev/",
  "logo_url": "https://mediacdn.nauticalcommerce.app/ssm/marketplace-email-logo.png",
  "site_name": "Nautical Commerce",
  "recipient_email": "admin@nauticalcommerce.com"
}

Seller status updated​

The following payload is available for the updated status (updated_status_template) email:

{
  "domain": "https://ssm.fly.dev/",
  "status": "APPROVED",
  "logo_url": "https://mediacdn.nauticalcommerce.app/ssm/marketplace-email-logo.png",
  "site_name": "Nautical Commerce",
  "recipient_email": "seller@example.com"
}

Payouts​

Vendor payout confirmation​

The following payload is available for the vendor payout (vendor_payout_template) email:

{
  "domain": "https://ssm.fly.dev/",
  "logo_url": "https://mediacdn.nauticalcommerce.app/ssm/marketplace-email-logo.png",
  "site_name": "Safety Supply Market",
  "payout_name": "2024-02-15",
  "payout_amount": 248.1,
  "payout_end_date": "2024-02-15",
  "recipient_email": "seller@example.com"
}

Orders​

Pending order​

The following payload is available for the order pending (pending_order_template) email:

{
  "order": {
    "id": 38,
    "bids": [],
    "email": "buyer@example.com",
    "lines": [
      {
        "id": 43,
        "product": {
          "id": 125,
          "images": [
            {
              "original": null
            },
            {
              "original": null
            }
          ],
          "weight": "",
          "features": [],
          "metadata": {},
          "locations": [],
          "attributes": [
            {
              "values": [
                {
                  "name": "Kevlar",
                  "slug": "kevlar",
                  "value": ""
                }
              ],
              "assignment": {
                "attribute": {
                  "name": "",
                  "slug": "material-multiselect"
                }
              }
            }
          ],
          "first_image": {
            "original": null
          },
          "configuration": 0
        },
        "variant": {
          "id": 552,
          "images": null,
          "weight": "",
          "feature": [],
          "listing_id": 552,
          "first_image": null
        },
        "currency": "USD",
        "quantity": 1,
        "is_digital": false,
        "digital_url": null,
        "product_sku": "UHJvZHVjdFZhcmlhbnQ6MjI2",
        "product_name": "Fire-Resistant Gloves",
        "variant_name": "XL",
        "unit_tax_amount": "4.12",
        "total_tax_amount": "4.12",
        "quantity_declined": 0,
        "quantity_fulfilled": 0,
        "is_shipping_required": true,
        "unit_price_net_amount": "49.99",
        "total_price_net_amount": "49.99",
        "translated_product_name": "Fire-Resistant Gloves",
        "translated_variant_name": "XL",
        "unit_price_gross_amount": "54.11",
        "total_price_gross_amount": "54.11"
      }
    ],
    "token": "e6a75ede-97b8-4cc2-b772-22ac1b6b41a1",
    "number": 38,
    "seller": {
      "id": 11,
      "logo": "https://mediacdn.nauticalcommerce.app/ssm/seller-logos/7e4323c2-d47c-4995-ac74-ffc28e5bdd2e.png",
      "status": "APPROVED",
      "created": "2023-11-24 17:56:11.701995+00:00",
      "updated": "2023-11-30 18:30:31.602550+00:00",
      "owner_email": "seller@example.com",
      "company_name": "Fire Safe Supply"
    },
    "status": "unfulfilled",
    "created": "2023-12-05 20:50:56.524627+00:00",
    "currency": "USD",
    "metadata": {},
    "sub_status": null,
    "tax_amount": "6.18",
    "customer_note": "Please ensure all items are packaged securely, especially the Fire-Resistant Gloves and the Hard Hat. The items are needed for a safety training session next week, so timely delivery is crucial. If possible, use minimal plastic packaging for environmental reasons.",
    "language_code": "en",
    "nautical_order": {
      "id": 28
    },
    "billing_address": {
      "city": "HOUSTON",
      "phone": "+17133848263",
      "country": "US",
      "city_area": "",
      "last_name": "Buyer",
      "first_name": "Barbara",
      "postal_code": "77030",
      "company_name": "",
      "country_area": "TX",
      "street_address_1": "2888 Monroe Street",
      "street_address_2": ""
    },
    "private_metadata": {},
    "shipping_address": {
      "city": "HOUSTON",
      "phone": "+17133848263",
      "country": "US",
      "city_area": "",
      "last_name": "Buyer",
      "first_name": "Barbara",
      "postal_code": "77030",
      "company_name": "",
      "country_area": "TX",
      "street_address_1": "2888 Monroe Street",
      "street_address_2": ""
    },
    "total_net_amount": "74.99",
    "total_gross_amount": "81.17",
    "subtotal_net_amount": "49.99",
    "display_gross_prices": true,
    "shipping_method_name": "FedEx",
    "subtotal_gross_amount": "54.11",
    "shipping_price_net_amount": "25.00",
    "shipping_price_gross_amount": "27.06"
  },
  "domain": "https://ssm.fly.dev/",
  "logo_url": "https://mediacdn.nauticalcommerce.app/ssm/marketplace-email-logo.png",
  "site_name": "Safety Supply Market",
  "order_type": "seller",
  "recipient_name": "Frank FireSafe",
  "recipient_email": [
    "seller@example.com"
  ],
  "order_details_url": ""
}
Show more ↓

Quote requested​

The following payload is available for the quote requested (requested_quote_template) email:

{
  "order": {
    "id": 20,
    "bids": [],
    "email": "buyer@example.com",
    "lines": [
      {
        "id": 23,
        "product": {
          "id": 121,
          "images": [
            {
              "original": null
            }
          ],
          "weight": "29.483 kg",
          "features": [],
          "metadata": {},
          "locations": [],
          "attributes": [],
          "first_image": {
            "original": null
          },
          "configuration": 0
        },
        "variant": {
          "id": 496,
          "images": null,
          "weight": "29.483 kg",
          "feature": [],
          "listing_id": 496,
          "first_image": null
        },
        "currency": "USD",
        "quantity": 2,
        "is_digital": false,
        "digital_url": null,
        "product_sku": "CP-4D-01",
        "product_name": "4-Drum Spill Containment Pallet",
        "variant_name": "CP-4D-01",
        "unit_tax_amount": "89.52",
        "total_tax_amount": "179.03",
        "quantity_declined": 0,
        "quantity_fulfilled": 0,
        "is_shipping_required": true,
        "unit_price_net_amount": "1085.00",
        "total_price_net_amount": "2170.00",
        "translated_product_name": "4-Drum Spill Containment Pallet",
        "translated_variant_name": "CP-4D-01",
        "unit_price_gross_amount": "1174.52",
        "total_price_gross_amount": "2349.03"
      }
    ],
    "token": "47e005ba-7a64-4212-84a1-5f5ba956700c",
    "number": 20,
    "status": "quote",
    "created": "2023-11-30 17:12:48.673845+00:00",
    "currency": "USD",
    "metadata": {},
    "sub_status": "quote_requested",
    "tax_amount": "179.03",
    "customer_note": "",
    "language_code": "en",
    "billing_address": {
      "city": "Houston",
      "phone": "+17133848263",
      "country": "US",
      "city_area": "",
      "last_name": "Buyer",
      "first_name": "Barbara",
      "postal_code": "77030",
      "company_name": "",
      "country_area": "Texas",
      "street_address_1": "2888 Monroe Street",
      "street_address_2": ""
    },
    "private_metadata": {},
    "shipping_address": {
      "city": "HOUSTON",
      "phone": "+17133848263",
      "country": "US",
      "city_area": "",
      "last_name": "Buyer",
      "first_name": "Barbara",
      "postal_code": "77030",
      "company_name": "",
      "country_area": "TX",
      "street_address_1": "2888 Monroe Street",
      "street_address_2": ""
    },
    "total_net_amount": "2170.00",
    "total_gross_amount": "2349.03",
    "subtotal_net_amount": "2170.00",
    "display_gross_prices": true,
    "shipping_method_name": "Multiseller",
    "subtotal_gross_amount": "2349.03",
    "shipping_price_net_amount": "0.00",
    "shipping_price_gross_amount": "0.00"
  },
  "domain": "https://ssm.fly.dev/",
  "logo_url": "https://mediacdn.nauticalcommerce.app/ssm/marketplace-email-logo.png",
  "site_name": "Safety Supply Market",
  "order_type": "marketplace",
  "recipient_name": "Super User",
  "recipient_email": [
    "admin@example.com"
  ]
}
Show more ↓

Buyer bid action​

The following payload is available for the buyer bid action (buyer_bid_action) email:

{
  "order": {
    "order": {
      "id": 2616,
      "bids": [
        {
          "id": 130,
          "role": "buyer",
          "status": "submitted",
          "message": "Here is my best offer",
          "currency": "USD",
          "bid_amount": "1800.00",
          "created_at": "2024-02-23 16:11:13.683352+00:00",
          "updated_at": "2024-02-23 16:11:13.683383+00:00",
          "user_email": "buyer@example.com"
        }
      ],
      "email": "",
      "lines": [
        {
          "id": 5021,
          "product": {
            "id": 103,
            "images": [
              {
                "original": {
                  "url": "https://mediacdn.nauticalcommerce.app/ssm/products/d60b6858-22fd-4047-a0fb-898fb77b447e.png",
                  "60x60": "https://mediacdn.nauticalcommerce.app/ssm/__sized__/products/d60b6858-22fd-4047-a0fb-898fb77b447e-thumbnail-60x60.png",
                  "120x120": "https://mediacdn.nauticalcommerce.app/ssm/__sized__/products/d60b6858-22fd-4047-a0fb-898fb77b447e-thumbnail-120x120.png",
                  "255x255": "https://mediacdn.nauticalcommerce.app/ssm/__sized__/products/d60b6858-22fd-4047-a0fb-898fb77b447e-thumbnail-255x255.png",
                  "510x510": "https://mediacdn.nauticalcommerce.app/ssm/__sized__/products/d60b6858-22fd-4047-a0fb-898fb77b447e-thumbnail-510x510.png",
                  "540x540": "https://mediacdn.nauticalcommerce.app/ssm/__sized__/products/d60b6858-22fd-4047-a0fb-898fb77b447e-thumbnail-540x540.png",
                  "1080x1080": "https://mediacdn.nauticalcommerce.app/ssm/__sized__/products/d60b6858-22fd-4047-a0fb-898fb77b447e-thumbnail-1080x1080.png"
                }
              }
            ],
            "weight": "8.0 kg",
            "features": [],
            "metadata": {},
            "locations": [],
            "attributes": [],
            "first_image": {
              "original": {
                "url": "https://mediacdn.nauticalcommerce.app/ssm/products/d60b6858-22fd-4047-a0fb-898fb77b447e.png",
                "60x60": "https://mediacdn.nauticalcommerce.app/ssm/__sized__/products/d60b6858-22fd-4047-a0fb-898fb77b447e-thumbnail-60x60.png",
                "120x120": "https://mediacdn.nauticalcommerce.app/ssm/__sized__/products/d60b6858-22fd-4047-a0fb-898fb77b447e-thumbnail-120x120.png",
                "255x255": "https://mediacdn.nauticalcommerce.app/ssm/__sized__/products/d60b6858-22fd-4047-a0fb-898fb77b447e-thumbnail-255x255.png",
                "510x510": "https://mediacdn.nauticalcommerce.app/ssm/__sized__/products/d60b6858-22fd-4047-a0fb-898fb77b447e-thumbnail-510x510.png",
                "540x540": "https://mediacdn.nauticalcommerce.app/ssm/__sized__/products/d60b6858-22fd-4047-a0fb-898fb77b447e-thumbnail-540x540.png",
                "1080x1080": "https://mediacdn.nauticalcommerce.app/ssm/__sized__/products/d60b6858-22fd-4047-a0fb-898fb77b447e-thumbnail-1080x1080.png"
              }
            },
            "configuration": 0
          },
          "variant": {
            "id": 235,
            "images": null,
            "weight": "8.0 kg",
            "feature": [],
            "listing_id": 235,
            "first_image": null
          },
          "currency": "USD",
          "quantity": 5,
          "is_digital": false,
          "digital_url": null,
          "product_sku": "",
          "product_name": "Dive Cylinder 12.5L",
          "variant_name": "8cf8f69b-c336-45de-8240-19d97e8225a4",
          "unit_tax_amount": "0.00",
          "total_tax_amount": "0.00",
          "quantity_declined": 0,
          "quantity_fulfilled": 0,
          "is_shipping_required": true,
          "unit_price_net_amount": "400.00",
          "total_price_net_amount": "2000.00",
          "translated_product_name": "Dive Cylinder 12.5L",
          "translated_variant_name": "8cf8f69b-c336-45de-8240-19d97e8225a4",
          "unit_price_gross_amount": "400.00",
          "total_price_gross_amount": "2000.00"
        }
      ],
      "token": "71f7dacb-eefb-4055-b167-9e3c7c6a4aec",
      "number": 2616,
      "seller": {
        "id": 14,
        "logo": "https://mediacdn.nauticalcommerce.app/ssm/seller-logos/5f31ea00-97e8-4925-bb26-39c3d495d448.png",
        "status": "APPROVED",
        "created": "2023-10-11 20:40:30.400786+00:00",
        "updated": "2024-02-16 16:53:12.670521+00:00",
        "owner_email": "seller@example.com",
        "company_name": "Dave's Dive Pro Shop"
      },
      "status": "offer",
      "created": "2024-02-23 16:11:11.809019+00:00",
      "currency": "USD",
      "metadata": {},
      "sub_status": "offer_created",
      "tax_amount": "0",
      "customer_note": "",
      "language_code": "en",
      "nautical_order": {
        "id": 1486
      },
      "billing_address": null,
      "private_metadata": {},
      "shipping_address": null,
      "total_net_amount": "2000.00",
      "total_gross_amount": "2000.00",
      "subtotal_net_amount": "2000.00",
      "display_gross_prices": true,
      "shipping_method_name": null,
      "subtotal_gross_amount": "2000.00",
      "shipping_price_net_amount": "0.00",
      "shipping_price_gross_amount": "0.00"
    },
    "order_type": "seller"
  },
  "domain": "https://main.nautical.dev/",
  "logo_url": "https://mediacdn.nauticalcommerce.app/ssm/marketplace-email-logo.png",
  "site_name": "Nautical Commerce",
  "recipient_name": "Dave Diver",
  "recipient_email": [
    "seller@example.com"
  ],
  "marketplace_order": {}
}
Show more ↓

Catalog import​

Catalog import failed​

The following payload is available for the catalog import failed (import_catalog_failed_template) email:

{
  "domain": "https://ssm.fly.dev/",
  "logo_url": "https://mediacdn.nauticalcommerce.app/ssm/marketplace-email-logo.png",
  "site_name": "Safety Supply Market",
  "recipient_email": "shopify.seller@example.com"
}

Catalog import success​

The following payload is available for the catalog import success (import_catalog_success_template) email:

{
  "domain": "https://ssm.fly.dev/",
  "logo_url": "https://mediacdn.nauticalcommerce.app/ssm/marketplace-email-logo.png",
  "site_name": "Safety Supply Market",
  "recipient_email": "shopify.seller@example.com"
}

Catalog export​

CSV export failed​

The following payload is available for the CSV export failed (csv_export_failed_template) email:

{
  "domain": "https://main.nautical.dev/",
  "export": {
    "id": 1,
    "app_id": null,
    "status": "failed",
    "message": null,
    "user_id": 21,
    "created_at": "2024-02-14T18:37:07.566Z",
    "updated_at": "2024-02-14T18:37:07.665Z",
    "user_email": "admin@example.com"
  },
  "logo_url": "https://mediacdn.nauticalcommerce.app/ssm/marketplace-email-logo.png",
  "site_name": "Nautical Commerce",
  "recipient_email": "admin@example.com"
}

CSV export success​

The following payload is available for the CSV export success (csv_product_export_success_template) email:

{
  "domain": "https://ssm.fly.dev/",
  "export": {
    "id": 1,
    "app_id": null,
    "status": "pending",
    "message": null,
    "user_id": 105,
    "created_at": "2024-02-26T21:32:36.482Z",
    "updated_at": "2024-02-26T21:32:37.062Z",
    "user_email": "marketplace.operator@example.com"
  },
  "csv_link": "https://storage.googleapis.com/nautical_ssm_storage/export_files/product_data_26_02_2024_21_32_36_cff529.csv?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=nautical-storage%40nautical-commerce.iam.gserviceaccount.com%2F20240226%2Fauto%2Fstorage%2Fgoog4_request&X-Goog-Date=20240226T213237Z&X-Goog-Expires=86400&X-Goog-SignedHeaders=host&X-Goog-Signature=4c2e379b67786b18129b4ba731107cd2ad773d214eae688ae73d1b6f487949017dc8843c4536953342d2f692b6f58ccc6e4d7be67cb60ba40338d2f43f69668b1d66cec5fc93c08a76f1051c933010415444e4fb9fb8f80c1629c937f673b1e8c39d5017c5240f75d819520d5531f7ae48d71714eaf7c1305d6b7180b823dcd997f29a09caa0fb6e498427e6a0d9524ca4f58322bfe6843ee2cfcda594ac88ad5c4fafa016c21dbb011531f51f3e5a859b6ba6d42d66118b2eb35bf54c80c54c2b5f0e1ca579c6c1a8dcc92be535fb113511891997370c60e21d7bae301a77497519cfc061b29b6a099e4f45c076865eab6d9fc09e2d35341e536b22d5e759f4",
  "logo_url": "https://mediacdn.nauticalcommerce.app/ssm/marketplace-email-logo.png",
  "site_name": "Safety Supply Market",
  "recipient_email": "marketplace.operator@example.com"
}

Was this page helpful?