Webhook Events and Sample Payloads
Webhook payload headers
HTTP POST payloads delivered to your configured URL endpoint will contain the following Nautical-specific headers:
| Header | Description |
|---|---|
x-nautical-event | Name of the webhook event that triggered the payload. |
x-nautical-domain | The domain of the Nautical source instance where the webhook was triggered from. |
x-nautical-signature | This header is populated if the webhook is configured with a secretKey. This is an HMAC SHA-256 signature, generated based on the secret key and the payload body. |
For example, see the following header:
Header
{
"host": "eoa276juyloqj4y.m.pipedream.net",
"content-length": "404",
"user-agent": "python-requests/2.28.1",
"accept-encoding": "gzip, deflate",
"accept": "*/*",
"content-type": "application/json",
"x-nautical-event": "customer_created",
"x-nautical-domain": "https://ssm.nautical.dev/",
"x-nautical-signature": ""
}
Sample payloads
info
When updates happen in quick succession, webhook payload data may not be current. The most reliable way to get up-to-date data is to query the API directly.
Agreement created
The agreement_created webhook event is triggered by creating a new vendor agreement.
Sample payload body
{
"id": "QWdyZWVtZW50Ojg=",
"fees": [],
"slug": "marketplace-agreement",
"title": "Marketplace Agreement ",
"content": "By operating under this marketplace you agree to the commission rate of 12.75%\n",
"fixed_fee": "0",
"is_active": false,
"seo_title": "",
"created_at": "2023-12-07T16:30:51.135406+00:00",
"fee_format": "per sale",
"updated_at": "2023-12-07T16:30:51.135438+00:00",
"vendor_type": "seller",
"content_html": "By operating under this marketplace you agree to the commission rate of 12.75%<p></p>",
"is_published": false,
"jurisdiction": "Worldwide",
"agreement_type": 1,
"commission_type": "marketplace",
"seo_description": "",
"publication_date": null,
"commission_uniform": true,
"default_commission": "0.1275",
"granular_commissions": [],
"markup_commission_type": "percentage",
"markup_commission_value": "0.1275000",
"nautical_event_type": "agreement_created",
"nautical_event_timestamp": "2023-12-08T14:19:05.16.981378-04:00"
}
Show more ↓
Agreement deleted
The agreement_deleted webhook event is triggered by deleting an agreement.
Sample payload body
{
"id": "QWdyZWVtZW50Ojg=",
"fees": [],
"slug": "marketplace-agreement",
"title": "Marketplace Agreement ",
"content": "By operating under this marketplace you agree to the commission rate of 12.75%\n",
"fixed_fee": "0.00",
"is_active": false,
"seo_title": "",
"created_at": "2023-12-07T16:30:51.135406+00:00",
"fee_format": "per sale",
"updated_at": "2023-12-07T16:31:06.848439+00:00",
"vendor_type": "seller",
"content_html": "By operating under this marketplace you agree to the commission rate of 12.75%<p></p>",
"is_published": true,
"jurisdiction": "Worldwide",
"agreement_type": 1,
"commission_type": "marketplace",
"seo_description": "",
"publication_date": null,
"commission_uniform": true,
"default_commission": "0.12750",
"granular_commissions": [],
"markup_commission_type": "percentage",
"markup_commission_value": "0.1275000",
"nautical_event_type": "agreement_deleted",
"nautical_event_timestamp": "2023-12-08T14:19:05.16.981378-04:00"
}
Show more ↓
Agreement updated
The agreement_updated webhook event is triggered by editing an existing agreement. webhook event activates when you update an existing agreement. This includes adding fees, setting granular commissions, or publishing the agreement.
Sample payload body
{
"id": "QWdyZWVtZW50Ojg=",
"fees": [
{
"id": "QWdyZWVtZW50RmVlczoz",
"fee_name": "Percentage",
"fee_type": "percentage",
"fee_scope": "total",
"fee_value": "0.0100000"
}
],
"slug": "marketplace-agreement",
"title": "Marketplace Agreement ",
"content": "By operating under this marketplace you agree to the commission rate of 12.75%\n",
"fixed_fee": "0",
"is_active": false,
"seo_title": "",
"created_at": "2023-12-07T16:30:51.135406+00:00",
"fee_format": "per sale",
"updated_at": "2023-12-07T16:31:06.848439+00:00",
"vendor_type": "seller",
"content_html": "By operating under this marketplace you agree to the commission rate of 12.75%<p></p>",
"is_published": true,
"jurisdiction": "Worldwide",
"agreement_type": 1,
"commission_type": "marketplace",
"seo_description": "",
"publication_date": null,
"commission_uniform": true,
"default_commission": "0.1275",
"granular_commissions": [],
"markup_commission_type": "percentage",
"markup_commission_value": "0.1275",
"nautical_event_type": "agreement_updated",
"nautical_event_timestamp": "2023-12-08T14:19:05.16.981378-04:00"
}
Show more ↓
Category created
The category_created webhook event is triggered by creating a category.
Sample payload body
{
"id": "Q2F0ZWdvcnk6MjA=",
"name": "Juice Boxes",
"slug": "juice-boxes",
"background_image": "",
"background_image_alt": "",
"allow_product_assignment": true,
"nautical_event_type": "category_created",
"nautical_event_timestamp": "2023-12-08T14:19:05.16.981378-04:00"
}
Category deleted
The category_deleted webhook event is triggered by deleting a category.
Sample payload body
{
"id": "Q2F0ZWdvcnk6MjA=",
"name": "Juice Boxes",
"slug": "juice-boxes",
"background_image": "category-backgrounds/953b7bc9-b282-4fd5-b601-f43e56d11bd4.jpeg",
"background_image_alt": "",
"allow_product_assignment": true,
"nautical_event_type": "category_deleted",
"nautical_event_timestamp": "2023-12-08T14:19:05.16.981378-04:00"
}
Category updated
The category_updated webhook event is triggered by updating a category.
Sample payload body
{
"id": "Q2F0ZWdvcnk6MjA=",
"name": "Juice Boxes",
"slug": "juice-boxes",
"background_image": "category-backgrounds/953b7bc9-b282-4fd5-b601-f43e56d11bd4.jpeg",
"background_image_alt": "",
"allow_product_assignment": true,
"nautical_event_type": "category_updated",
"nautical_event_timestamp": "2023-12-08T14:19:05.16.981378-04:00"
}
Checkout created
The checkout_created webhook event is triggered when a user completes the payment step in the checkout process. This is triggered by the the checkoutCreate mutation.
This payload contains all relevant checkout information, irrespective of whether the payment is authorized or captured yet.
Sample payload body
{
"email": "barbara.buyer@example.com",
"token": "86d8c191-eb9d-4bd0-bf0e-9f7e299c0ae7",
"created": "2024-01-16T14:58:03.037363+00:00",
"currency": "USD",
"metadata": {},
"quantity": 0,
"last_change": "2024-01-16T14:58:03.063246+00:00",
"discount_name": null,
"discount_amount": "0",
"private_metadata": {},
"nautical_event_type": "checkout_created",
"nautical_event_timestamp": "2023-12-08T14:19:05.16.981378-04:00"
}
Checkout updated
The checkout_updated webhook event is triggered when a buyer updates their checkout instance. These changes can involve editing cart items, applying a promo code, adding an order note, updating billing or shipping details, or choosing a new shipping method.
Sample payload body
{
"email": "barbara.buyer@example.com",
"token": "84537b37-d8fa-4f45-80e5-b7f38e04bdad",
"created": "2023-12-08T14:19:05.167808+00:00",
"currency": "USD",
"metadata": {},
"quantity": 1,
"last_change": "2023-12-08T14:19:05.182277+00:00",
"discount_name": null,
"discount_amount": 0,
"private_metadata": {},
"nautical_event_type": "checkout_updated",
"nautical_event_timestamp": "2023-12-08T14:19:05.16.981378-04:00"
}
Collection created
The collection_created webhook event is triggered by creating a new collection.
Sample payload body
{
"id": "Q29sbGVjdGlvbjo0Mw==",
"slug": "spring-2024-lookbook",
"type": "product",
"products": [],
"variants": [],
"nautical_event_type": "collection_created",
"nautical_event_timestamp": "2024-04-16T10:14:13.806169-04:00"
}
Collection deleted
The collection_deleted webhook event is triggered by deleting a collection.
Sample payload body
{
"id": "Q29sbGVjdGlvbjo0Mg==",
"slug": "spring-2024-lookbook",
"type": "product",
"products": [],
"variants": [],
"nautical_event_type": "collection_deleted",
"nautical_event_timestamp": "2024-04-16T10:14:07.981378-04:00"
}
Collection updated
The collection_updated webhook event is triggered by updating a collection. This includes adding, removing, or reordering products or variants in the collection.
Sample payload body
{
"id": "Q29sbGVjdGlvbjo0Mw==",
"slug": "spring-2024-lookbook",
"type": "product",
"products": [
{
"id": "UHJvZHVjdDo0MTA=",
"name": "Short sleeve T-shirt",
"slug": "short-sleeve-t-shirt",
"seller": {
"id": "U2VsbGVyOjE=",
"company_name": "Acme",
"fulfilled_by_marketplace": false
},
"product_type": {
"id": "UHJvZHVjdFR5cGU6MzA=",
"name": "T-shirts",
"slug": "t-shirts",
"weight": "0.0 kg",
"metadata": {},
"is_digital": false,
"private_metadata": {},
"is_shipping_required": true,
"is_price_override_allowed": false
}
}
],
"variants": [],
"nautical_event_type": "collection_updated",
"nautical_event_timestamp": "2024-04-16T10:14:19.698497-04:00"
}
Show more ↓
Customer created
The customer_created webhook event is triggered when a new customer account is added.
Sample payload body
{
"type": "User",
"id": "VXNlcjozMjk=",
"default_shipping_address": null,
"default_billing_address": null,
"last_login": null,
"private_metadata": {},
"metadata": {},
"external_id": null,
"external_source": null,
"company_name": "",
"email": "maria.falla@example.com",
"first_name": "",
"last_name": "",
"is_active": false,
"note": null,
"date_joined": "2023-09-09T23:42:46.981Z",
"personal_phone": "",
"nautical_event_type": "customer_created",
"nautical_event_timestamp": "2023-09-09T23:42:46.698497-04:00"
}
Show more ↓
Customer deleted
The customer_deleted webhook event is triggered upon deleting a customer.
Sample payload body
{
"type": "User",
"id": "VXNlcjozMjk=",
"default_shipping_address": null,
"default_billing_address": null,
"last_login": null,
"private_metadata": {},
"metadata": {},
"external_id": null,
"external_source": null,
"company_name": "",
"email": "maria.falla@example.com",
"first_name": "",
"last_name": "",
"is_active": true,
"note": "",
"date_joined": "2023-09-09T23:42:46.981Z",
"personal_phone": "",
"nautical_event_type": "customer_deleted",
"nautical_event_timestamp": "2023-09-09T23:42:46.698497-04:00"
}
Show more ↓
Customer updated
The customer_updated webhook event is triggered when a customer's details are updated.
Sample payload body
{
"type": "User",
"id": "VXNlcjozMjk=",
"default_shipping_address": null,
"default_billing_address": null,
"last_login": null,
"private_metadata": {},
"metadata": {},
"external_id": null,
"external_source": null,
"company_name": "",
"email": "maria.falla@example.com",
"first_name": "",
"last_name": "",
"is_active": true,
"note": "",
"date_joined": "2023-09-09T23:42:46.981Z",
"personal_phone": "",
"nautical_event_type": "customer_updated",
"nautical_event_timestamp": "2023-09-09T23:42:46.698497-04:00"
}
Show more ↓
Fulfillment created
The fulfillment_created webhook event is triggered each time a seller or marketplace operator logs a fulfillment against an order.
This differs from order_fulfilled, which is sent only when all items from a seller are fulfilled. The fulfillment_created payload is generated whenever any part of an order is fulfilled.
note
Fulfilling an order also triggers the following webhooks:
Sample payload body
{
"id": "RnVsZmlsbG1lbnQ6Nw==",
"order": {
"id": "T3JkZXI6MTY="
},
"status": "fulfilled",
"tracking_number": "",
"nautical_event_type": "fulfillment_created",
"nautical_event_timestamp": "2023-09-09T23:42:46.698497-04:00"
}
Microsite created
The microsite_created webhook event is triggered upon creating a microsite.
Sample payload body
{
"id": "TWljcm9zaXRlOjE=",
"name": "Nemo's Diving Supplies",
"slug": "nemos-diving-supplies",
"seller": {
"id": "U2VsbGVyOjk=",
"status": "APPROVED",
"created": "2023-08-24T18:38:57.072799+00:00",
"updated": "2023-10-11T13:51:45.543716+00:00",
"company_name": "Nemo Dive Shop",
"identification": null,
"fulfilled_by_marketplace": true
},
"metadata": {},
"products": [
{
"id": "UHJvZHVjdDoxMjk=",
"name": "AquaPro DiveMate 3000",
"slug": "aquapro-divemate-3000",
"seller": {
"id": "U2VsbGVyOjk=",
"company_name": "Nemo Dive Shop"
},
"product_type": {
"id": "UHJvZHVjdFR5cGU6MTY=",
"name": "Diving Accessories ",
"slug": "diving-accessories",
"metadata": {},
"is_digital": false,
"has_variants": true,
"private_metadata": {},
"is_shipping_required": true
}
}
],
"affiliate": null,
"description": "Specializing in high-quality diving gear and expert guidance, we're dedicated to equipping both beginners and seasoned divers.\n",
"is_published": false,
"description_html": "<span style=\"color: rgb(55, 65, 81); font-family: Söhne, ui-sans-serif, system-ui, -apple-system, "Segoe UI", Roboto, Ubuntu, Cantarell, "Noto Sans", sans-serif, "Helvetica Neue", Arial, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol", "Noto Color Emoji"; white-space-collapse: preserve;\">Specializing in high-quality diving gear and expert guidance, we're dedicated to equipping both beginners and seasoned divers.</span><p></p>",
"private_metadata": {},
"publication_date": null,
"nautical_event_type": "microsite_created",
"nautical_event_timestamp": "2023-09-09T23:42:46.698497-04:00"
}
Show more ↓
Microsite updated
The microsite_updated webhook event is triggered upon updating a microsite.
Sample payload body
{
"id": "TWljcm9zaXRlOjE=",
"name": "Nemo's Diving Supplies",
"slug": "nemos-diving-supplies",
"seller": {
"id": "U2VsbGVyOjk=",
"status": "APPROVED",
"created": "2023-08-24T18:38:57.072799+00:00",
"updated": "2023-10-11T13:51:45.543716+00:00",
"company_name": "Nemo Dive Shop",
"identification": null,
"fulfilled_by_marketplace": true
},
"metadata": {},
"products": [
{
"id": "UHJvZHVjdDoxMjk=",
"name": "AquaPro DiveMate 3000",
"slug": "aquapro-divemate-3000",
"seller": {
"id": "U2VsbGVyOjk=",
"company_name": "Nemo Dive Shop"
},
"product_type": {
"id": "UHJvZHVjdFR5cGU6MTY=",
"name": "Diving Accessories ",
"slug": "diving-accessories",
"metadata": {},
"is_digital": false,
"has_variants": true,
"private_metadata": {},
"is_shipping_required": true
}
}
],
"affiliate": null,
"description": "Specializing in high-quality diving gear and expert guidance, we're dedicated to equipping both beginners and seasoned divers.\n",
"is_published": true,
"description_html": "<span style=\"color: rgb(55, 65, 81); font-family: Söhne, ui-sans-serif, system-ui, -apple-system, "Segoe UI", Roboto, Ubuntu, Cantarell, "Noto Sans", sans-serif, "Helvetica Neue", Arial, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol", "Noto Color Emoji"; white-space-collapse: preserve;\">Specializing in high-quality diving gear and expert guidance, we're dedicated to equipping both beginners and seasoned divers.</span><p></p>",
"private_metadata": {},
"publication_date": "2023-12-07",
"nautical_event_type": "microsite_updated",
"nautical_event_timestamp": "2023-09-09T23:42:46.698497-04:00"
}
Show more ↓
Nautical order cancelled
The nautical_order_cancelled webhook event is triggered by cancelling a marketplace order.
Sample payload body
{
"id": "TmF1dGljYWxPcmRlcjo5NDc=",
"user": {
"id": "VXNlcjoyMzQ=",
"note": "",
"email": "emily.smith@example.com",
"metadata": {},
"addresses": [
{
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
{
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
}
],
"is_active": true,
"last_name": "Buyer",
"first_name": "Emily",
"last_login": "2024-01-12T17:04:23.897288+00:00",
"date_joined": "2024-01-12T17:01:24.808178+00:00",
"external_id": null,
"company_name": "",
"is_anonymous": false,
"personal_phone": "",
"external_source": null,
"tax_exempt_code": null,
"private_metadata": {},
"default_billing_address": {
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
"default_shipping_address": {
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
"vat_identification_number": null
},
"lines": [
{
"id": "TmF1dGljYWxPcmRlckxpbmU6MzUxNg==",
"variant": {
"id": "UHJvZHVjdFZhcmlhbnQ6MjU5",
"sku": "",
"name": "",
"price": {
"amount": "499.00",
"currency": "USD"
},
"seller": {
"id": "U2VsbGVyOjE3",
"company_name": "Acme Dive Suits"
},
"status": "active",
"weight": "3.0 kg",
"product": {
"id": "UHJvZHVjdDoxMTA=",
"name": "White Diving Suit ",
"slug": "white-diving-suit",
"seller": {
"id": "U2VsbGVyOjE3",
"company_name": "Acme Dive Suits"
},
"status": "active",
"weight": "3.0 kg",
"category": {
"id": "Q2F0ZWdvcnk6MTg=",
"name": "Scuba Diving",
"slug": "scuba-diving"
},
"currency": "USD",
"metadata": {},
"created_at": "2023-10-13T17:22:57.509388+00:00",
"sub_status": "approved",
"updated_at": "2023-10-13T17:22:58.128887+00:00",
"collections": [
{
"id": "Q29sbGVjdGlvbjoyNA==",
"slug": "starrcollectiona",
"type": "product"
}
],
"description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.\n",
"charge_taxes": true,
"is_published": true,
"product_type": {
"id": "UHJvZHVjdFR5cGU6MTc=",
"name": "Diving Gear (Simple) ",
"slug": "diving-gear-simple",
"weight": "0.0 kg",
"metadata": {
"avatax.code": "O9999999",
"avatax.description": "Temporary Unmapped Other SKU - taxable default"
},
"is_digital": false,
"has_variants": false,
"private_metadata": {},
"is_shipping_required": true
},
"description_html": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.<p></p>",
"private_metadata": {},
"publication_date": "2023-10-13",
"minimal_variant_price_amount": "499.00"
},
"currency": "USD",
"metadata": {},
"is_master": false,
"seo_title": null,
"created_at": "2023-10-13T17:22:57.531123+00:00",
"sub_status": "approved",
"updated_at": "2023-10-13T17:22:57.531160+00:00",
"description": "",
"price_amount": "499.00",
"seo_description": null,
"track_inventory": true,
"description_html": "<div></div>",
"private_metadata": {},
"cost_price_amount": "0.00",
"override_currency": false,
"is_user_defined_name": false,
"nautical_stock_number": "f80d1b22-4b62-4e1b-b6ab-233ba9c1fb6c"
},
"quantity": 2,
"unit_price": {
"net": {
"amount": "499.00",
"currency": "USD"
},
"tax": {
"amount": "24.95",
"currency": "USD"
},
"gross": {
"amount": "523.95",
"currency": "USD"
}
},
"product_sku": "",
"total_price": {
"net": {
"amount": "998.00",
"currency": "USD"
},
"tax": {
"amount": "49.90",
"currency": "USD"
},
"gross": {
"amount": "1047.90",
"currency": "USD"
}
},
"product_name": "White Diving Suit ",
"variant_name": "f80d1b22-4b62-4e1b-b6ab-233ba9c1fb6c",
"seller_order_line": {
"id": "T3JkZXJMaW5lOjMzMzg=",
"variant": {
"id": "UHJvZHVjdFZhcmlhbnQ6MjU5",
"sku": "",
"name": "",
"price": {
"amount": "499.00",
"currency": "USD"
},
"seller": {
"id": "U2VsbGVyOjE3",
"company_name": "Acme Dive Suits"
},
"status": "active",
"weight": "3.0 kg",
"product": {
"id": "UHJvZHVjdDoxMTA=",
"name": "White Diving Suit ",
"slug": "white-diving-suit",
"seller": {
"id": "U2VsbGVyOjE3",
"company_name": "Acme Dive Suits"
},
"status": "active",
"weight": "3.0 kg",
"category": {
"id": "Q2F0ZWdvcnk6MTg=",
"name": "Scuba Diving",
"slug": "scuba-diving"
},
"currency": "USD",
"metadata": {},
"created_at": "2023-10-13T17:22:57.509388+00:00",
"sub_status": "approved",
"updated_at": "2023-10-13T17:22:58.128887+00:00",
"collections": [
{
"id": "Q29sbGVjdGlvbjoyNA==",
"slug": "starrcollectiona",
"type": "product"
}
],
"description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.\n",
"charge_taxes": true,
"is_published": true,
"product_type": {
"id": "UHJvZHVjdFR5cGU6MTc=",
"name": "Diving Gear (Simple) ",
"slug": "diving-gear-simple",
"weight": "0.0 kg",
"metadata": {
"avatax.code": "O9999999",
"avatax.description": "Temporary Unmapped Other SKU - taxable default"
},
"is_digital": false,
"has_variants": false,
"private_metadata": {},
"is_shipping_required": true
},
"description_html": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.<p></p>",
"private_metadata": {},
"publication_date": "2023-10-13",
"minimal_variant_price_amount": "499.00"
},
"currency": "USD",
"metadata": {},
"is_master": false,
"seo_title": null,
"created_at": "2023-10-13T17:22:57.531123+00:00",
"sub_status": "approved",
"updated_at": "2023-10-13T17:22:57.531160+00:00",
"description": "",
"price_amount": "499.00",
"seo_description": null,
"track_inventory": true,
"description_html": "<div></div>",
"private_metadata": {},
"cost_price_amount": "0.00",
"override_currency": false,
"is_user_defined_name": false,
"nautical_stock_number": "f80d1b22-4b62-4e1b-b6ab-233ba9c1fb6c"
},
"currency": "USD",
"quantity": 2,
"vat_code": "",
"unit_price": {
"net": {
"amount": "499.00",
"currency": "USD"
},
"tax": {
"amount": "24.95",
"currency": "USD"
},
"gross": {
"amount": "523.95",
"currency": "USD"
}
},
"product_sku": "",
"total_price": {
"net": {
"amount": "998.00",
"currency": "USD"
},
"tax": {
"amount": "49.90",
"currency": "USD"
},
"gross": {
"amount": "1047.90",
"currency": "USD"
}
},
"product_name": "White Diving Suit ",
"variant_name": "f80d1b22-4b62-4e1b-b6ab-233ba9c1fb6c",
"quantity_declined": 0,
"quantity_fulfilled": 0,
"is_shipping_required": true,
"translated_product_name": "",
"translated_variant_name": "",
"is_line_price_overridden": false
},
"quantity_fulfilled": 0,
"is_shipping_required": true,
"unit_price_net_amount": "499.00",
"unit_price_gross_amount": "523.95",
"is_line_price_overridden": false
}
],
"token": "687418a2-6dc7-4e03-98fe-4b7dc52d1e8c",
"total": {
"net": {
"amount": "1013.00",
"currency": "USD"
},
"tax": {
"amount": "49.90",
"currency": "USD"
},
"gross": {
"amount": "1062.90",
"currency": "USD"
}
},
"number": 947,
"status": "unfulfilled",
"created": "2024-01-17T17:12:41.178684+00:00",
"updated": "2024-01-17T17:12:41.189411+00:00",
"currency": "USD",
"discount": {
"amount": "0.00",
"currency": "USD"
},
"payments": [
{
"id": "UGF5bWVudDo3MjM=",
"total": "1062.90",
"created": "2024-01-17T17:12:39.408834+00:00",
"gateway": "nautical.payments.stripe",
"cc_brand": "visa",
"currency": "USD",
"modified": "2024-01-17T17:12:39.408901+00:00",
"is_active": true,
"to_confirm": false,
"billing_city": "TORONTO",
"billing_email": "emily.smith@example.com",
"charge_status": "not-charged",
"captured_amount": "0.00",
"billing_address_1": "123 Sesame Street",
"billing_address_2": "",
"billing_city_area": "",
"billing_last_name": "Smith",
"billing_first_name": "Emily",
"billing_postal_code": "M5V0G9",
"payment_method_type": "card",
"billing_company_name": "",
"billing_country_area": "ON",
"billing_country_code": "CA"
}
],
"sub_status": null,
"user_email": "emily.smith@example.com",
"discount_name": null,
"seller_orders": [
{
"id": "T3JkZXI6MTYwMw==",
"user": {
"id": "VXNlcjoyMzQ=",
"note": "",
"email": "emily.smith@example.com",
"metadata": {},
"addresses": [
{
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
{
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
}
],
"is_active": true,
"last_name": "Buyer",
"first_name": "Emily",
"last_login": "2024-01-12T17:04:23.897288+00:00",
"date_joined": "2024-01-12T17:01:24.808178+00:00",
"external_id": null,
"company_name": "",
"is_anonymous": false,
"personal_phone": "",
"external_source": null,
"tax_exempt_code": null,
"private_metadata": {},
"default_billing_address": {
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
"default_shipping_address": {
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
"vat_identification_number": null
},
"lines": [
{
"id": "T3JkZXJMaW5lOjMzMzg=",
"variant": {
"id": "UHJvZHVjdFZhcmlhbnQ6MjU5",
"sku": "",
"name": "",
"price": {
"amount": "499.00",
"currency": "USD"
},
"seller": {
"id": "U2VsbGVyOjE3",
"company_name": "Acme Dive Suits"
},
"status": "active",
"weight": "3.0 kg",
"product": {
"id": "UHJvZHVjdDoxMTA=",
"name": "White Diving Suit ",
"slug": "white-diving-suit",
"seller": {
"id": "U2VsbGVyOjE3",
"company_name": "Acme Dive Suits"
},
"status": "active",
"weight": "3.0 kg",
"category": {
"id": "Q2F0ZWdvcnk6MTg=",
"name": "Scuba Diving",
"slug": "scuba-diving"
},
"currency": "USD",
"metadata": {},
"created_at": "2023-10-13T17:22:57.509388+00:00",
"sub_status": "approved",
"updated_at": "2023-10-13T17:22:58.128887+00:00",
"collections": [
{
"id": "Q29sbGVjdGlvbjoyNA==",
"slug": "starrcollectiona",
"type": "product"
}
],
"description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.\n",
"charge_taxes": true,
"is_published": true,
"product_type": {
"id": "UHJvZHVjdFR5cGU6MTc=",
"name": "Diving Gear (Simple) ",
"slug": "diving-gear-simple",
"weight": "0.0 kg",
"metadata": {
"avatax.code": "O9999999",
"avatax.description": "Temporary Unmapped Other SKU - taxable default"
},
"is_digital": false,
"has_variants": false,
"private_metadata": {},
"is_shipping_required": true
},
"description_html": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.<p></p>",
"private_metadata": {},
"publication_date": "2023-10-13",
"minimal_variant_price_amount": "499.00"
},
"currency": "USD",
"metadata": {},
"is_master": false,
"seo_title": null,
"created_at": "2023-10-13T17:22:57.531123+00:00",
"sub_status": "approved",
"updated_at": "2023-10-13T17:22:57.531160+00:00",
"description": "",
"price_amount": "499.00",
"seo_description": null,
"track_inventory": true,
"description_html": "<div></div>",
"private_metadata": {},
"cost_price_amount": "0.00",
"override_currency": false,
"is_user_defined_name": false,
"nautical_stock_number": "f80d1b22-4b62-4e1b-b6ab-233ba9c1fb6c"
},
"currency": "USD",
"quantity": 2,
"vat_code": "",
"unit_price": {
"net": {
"amount": "499.00",
"currency": "USD"
},
"tax": {
"amount": "24.95",
"currency": "USD"
},
"gross": {
"amount": "523.95",
"currency": "USD"
}
},
"product_sku": "",
"total_price": {
"net": {
"amount": "998.00",
"currency": "USD"
},
"tax": {
"amount": "49.90",
"currency": "USD"
},
"gross": {
"amount": "1047.90",
"currency": "USD"
}
},
"product_name": "White Diving Suit ",
"variant_name": "f80d1b22-4b62-4e1b-b6ab-233ba9c1fb6c",
"quantity_declined": 0,
"quantity_fulfilled": 0,
"is_shipping_required": true,
"translated_product_name": "",
"translated_variant_name": "",
"is_line_price_overridden": false
}
],
"token": "3b6d6036-e153-44e2-a0ee-eaf289685332",
"total": {
"net": {
"amount": "1013.00",
"currency": "USD"
},
"tax": {
"amount": "49.90",
"currency": "USD"
},
"gross": {
"amount": "1062.90",
"currency": "USD"
}
},
"seller": {
"id": "U2VsbGVyOjE3",
"company_name": "Acme Dive Suits"
},
"status": "unfulfilled",
"weight": "6.0 kg",
"created": "2024-01-17T17:12:41.198318+00:00",
"currency": "USD",
"discount": {
"amount": "0.00",
"currency": "USD"
},
"metadata": {},
"sub_status": null,
"user_email": "emily.smith@example.com",
"external_id": null,
"fulfillments": [],
"discount_name": null,
"payout_status": "not_ready",
"nautical_order": {
"id": "TmF1dGljYWxPcmRlcjo5NDc="
},
"shipping_price": {
"net": {
"amount": "15.00",
"currency": "USD"
},
"tax": {
"amount": "0.00",
"currency": "USD"
},
"gross": {
"amount": "15.00",
"currency": "USD"
}
},
"billing_address": {
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
"external_source": null,
"shipping_method": {
"id": "U2hpcHBpbmdNZXRob2Q6MjA=",
"price": {
"amount": "15.00",
"currency": "USD"
}
},
"private_metadata": {},
"shipping_address": {
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
"total_gross_amount": "1062.90",
"shipping_price_net_amount": "15.00",
"is_shipping_price_overridden": false
}
],
"billing_address": {
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
"shipping_address": {
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
"nautical_event_type": "nautical_order_cancelled",
"nautical_event_timestamp": "2023-09-09T23:42:46.698497-04:00"
}
Show more ↓
Nautical order created
The nautical_order_created webhook event is triggered when a marketplace order is created, including draft, quote, and offer orders.
Sample payload body
{
"id": "TmF1dGljYWxPcmRlcjo5NDg=",
"user": {
"id": "VXNlcjoyMzQ=",
"note": "",
"email": "emily.smith@example.com",
"metadata": {},
"addresses": [
{
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
{
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
}
],
"is_active": true,
"last_name": "Buyer",
"first_name": "Emily",
"last_login": "2024-01-12T17:04:23.897288+00:00",
"date_joined": "2024-01-12T17:01:24.808178+00:00",
"external_id": null,
"company_name": "",
"is_anonymous": false,
"personal_phone": "",
"external_source": null,
"tax_exempt_code": null,
"private_metadata": {},
"default_billing_address": {
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
"default_shipping_address": {
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
"vat_identification_number": null
},
"lines": [
{
"id": "TmF1dGljYWxPcmRlckxpbmU6MzUxNw==",
"variant": {
"id": "UHJvZHVjdFZhcmlhbnQ6MjU5",
"sku": "",
"name": "",
"price": {
"amount": "499.00",
"currency": "USD"
},
"seller": {
"id": "U2VsbGVyOjE3",
"company_name": "Acme Dive Suits"
},
"status": "active",
"weight": "3.0 kg",
"product": {
"id": "UHJvZHVjdDoxMTA=",
"name": "White Diving Suit ",
"slug": "white-diving-suit",
"seller": {
"id": "U2VsbGVyOjE3",
"company_name": "Acme Dive Suits"
},
"status": "active",
"weight": "3.0 kg",
"category": {
"id": "Q2F0ZWdvcnk6MTg=",
"name": "Scuba Diving",
"slug": "scuba-diving"
},
"currency": "USD",
"metadata": {},
"created_at": "2023-10-13T17:22:57.509388+00:00",
"sub_status": "approved",
"updated_at": "2023-10-13T17:22:58.128887+00:00",
"collections": [
{
"id": "Q29sbGVjdGlvbjoyNA==",
"slug": "starrcollectiona",
"type": "product"
}
],
"description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.\n",
"charge_taxes": true,
"is_published": true,
"product_type": {
"id": "UHJvZHVjdFR5cGU6MTc=",
"name": "Diving Gear (Simple) ",
"slug": "diving-gear-simple",
"weight": "0.0 kg",
"metadata": {
"avatax.code": "O9999999",
"avatax.description": "Temporary Unmapped Other SKU - taxable default"
},
"is_digital": false,
"has_variants": false,
"private_metadata": {},
"is_shipping_required": true
},
"description_html": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.<p></p>",
"private_metadata": {},
"publication_date": "2023-10-13",
"minimal_variant_price_amount": "499.00"
},
"currency": "USD",
"metadata": {},
"is_master": false,
"seo_title": null,
"created_at": "2023-10-13T17:22:57.531123+00:00",
"sub_status": "approved",
"updated_at": "2023-10-13T17:22:57.531160+00:00",
"description": "",
"price_amount": "499.00",
"seo_description": null,
"track_inventory": true,
"description_html": "<div></div>",
"private_metadata": {},
"cost_price_amount": "0.00",
"override_currency": false,
"is_user_defined_name": false,
"nautical_stock_number": "f80d1b22-4b62-4e1b-b6ab-233ba9c1fb6c"
},
"quantity": 2,
"unit_price": {
"net": {
"amount": "499.00",
"currency": "USD"
},
"tax": {
"amount": "24.95",
"currency": "USD"
},
"gross": {
"amount": "523.95",
"currency": "USD"
}
},
"product_sku": "",
"total_price": {
"net": {
"amount": "998.00",
"currency": "USD"
},
"tax": {
"amount": "49.90",
"currency": "USD"
},
"gross": {
"amount": "1047.90",
"currency": "USD"
}
},
"product_name": "White Diving Suit ",
"variant_name": "f80d1b22-4b62-4e1b-b6ab-233ba9c1fb6c",
"seller_order_line": {
"id": "T3JkZXJMaW5lOjMzMzk=",
"variant": {
"id": "UHJvZHVjdFZhcmlhbnQ6MjU5",
"sku": "",
"name": "",
"price": {
"amount": "499.00",
"currency": "USD"
},
"seller": {
"id": "U2VsbGVyOjE3",
"company_name": "Acme Dive Suits"
},
"status": "active",
"weight": "3.0 kg",
"product": {
"id": "UHJvZHVjdDoxMTA=",
"name": "White Diving Suit ",
"slug": "white-diving-suit",
"seller": {
"id": "U2VsbGVyOjE3",
"company_name": "Acme Dive Suits"
},
"status": "active",
"weight": "3.0 kg",
"category": {
"id": "Q2F0ZWdvcnk6MTg=",
"name": "Scuba Diving",
"slug": "scuba-diving"
},
"currency": "USD",
"metadata": {},
"created_at": "2023-10-13T17:22:57.509388+00:00",
"sub_status": "approved",
"updated_at": "2023-10-13T17:22:58.128887+00:00",
"collections": [
{
"id": "Q29sbGVjdGlvbjoyNA==",
"slug": "starrcollectiona",
"type": "product"
}
],
"description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.\n",
"charge_taxes": true,
"is_published": true,
"product_type": {
"id": "UHJvZHVjdFR5cGU6MTc=",
"name": "Diving Gear (Simple) ",
"slug": "diving-gear-simple",
"weight": "0.0 kg",
"metadata": {
"avatax.code": "O9999999",
"avatax.description": "Temporary Unmapped Other SKU - taxable default"
},
"is_digital": false,
"has_variants": false,
"private_metadata": {},
"is_shipping_required": true
},
"description_html": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.<p></p>",
"private_metadata": {},
"publication_date": "2023-10-13",
"minimal_variant_price_amount": "499.00"
},
"currency": "USD",
"metadata": {},
"is_master": false,
"seo_title": null,
"created_at": "2023-10-13T17:22:57.531123+00:00",
"sub_status": "approved",
"updated_at": "2023-10-13T17:22:57.531160+00:00",
"description": "",
"price_amount": "499.00",
"seo_description": null,
"track_inventory": true,
"description_html": "<div></div>",
"private_metadata": {},
"cost_price_amount": "0.00",
"override_currency": false,
"is_user_defined_name": false,
"nautical_stock_number": "f80d1b22-4b62-4e1b-b6ab-233ba9c1fb6c"
},
"currency": "USD",
"quantity": 2,
"vat_code": "",
"unit_price": {
"net": {
"amount": "499.00",
"currency": "USD"
},
"tax": {
"amount": "24.95",
"currency": "USD"
},
"gross": {
"amount": "523.95",
"currency": "USD"
}
},
"product_sku": "",
"total_price": {
"net": {
"amount": "998.00",
"currency": "USD"
},
"tax": {
"amount": "49.90",
"currency": "USD"
},
"gross": {
"amount": "1047.90",
"currency": "USD"
}
},
"product_name": "White Diving Suit ",
"variant_name": "f80d1b22-4b62-4e1b-b6ab-233ba9c1fb6c",
"quantity_declined": 0,
"quantity_fulfilled": 0,
"is_shipping_required": true,
"translated_product_name": "",
"translated_variant_name": "",
"is_line_price_overridden": false
},
"quantity_fulfilled": 0,
"is_shipping_required": true,
"unit_price_net_amount": "499.00",
"unit_price_gross_amount": "523.95",
"is_line_price_overridden": false
}
],
"token": "46e33d6f-bce1-4f74-8439-2a2759cb655e",
"total": {
"net": {
"amount": "1013.00",
"currency": "USD"
},
"tax": {
"amount": "49.90",
"currency": "USD"
},
"gross": {
"amount": "1062.90",
"currency": "USD"
}
},
"number": 948,
"status": "unfulfilled",
"created": "2024-01-17T17:30:45.136587+00:00",
"updated": "2024-01-17T17:30:45.146400+00:00",
"currency": "USD",
"discount": {
"amount": "0",
"currency": "USD"
},
"payments": [
{
"id": "UGF5bWVudDo3MjQ=",
"total": "1062.90",
"created": "2024-01-17T17:30:43.471172+00:00",
"gateway": "nautical.payments.stripe",
"cc_brand": "visa",
"currency": "USD",
"modified": "2024-01-17T17:30:43.471193+00:00",
"is_active": true,
"to_confirm": false,
"billing_city": "TORONTO",
"billing_email": "emily.smith@example.com",
"charge_status": "not-charged",
"captured_amount": "0.00",
"billing_address_1": "123 Sesame Street",
"billing_address_2": "",
"billing_city_area": "",
"billing_last_name": "Smith",
"billing_first_name": "Emily",
"billing_postal_code": "M5V0G9",
"payment_method_type": "card",
"billing_company_name": "",
"billing_country_area": "ON",
"billing_country_code": "CA"
}
],
"sub_status": null,
"user_email": "emily.smith@example.com",
"discount_name": null,
"seller_orders": [
{
"id": "T3JkZXI6MTYwNA==",
"user": {
"id": "VXNlcjoyMzQ=",
"note": "",
"email": "emily.smith@example.com",
"metadata": {},
"addresses": [
{
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
{
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
}
],
"is_active": true,
"last_name": "Buyer",
"first_name": "Emily",
"last_login": "2024-01-12T17:04:23.897288+00:00",
"date_joined": "2024-01-12T17:01:24.808178+00:00",
"external_id": null,
"company_name": "",
"is_anonymous": false,
"personal_phone": "",
"external_source": null,
"tax_exempt_code": null,
"private_metadata": {},
"default_billing_address": {
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
"default_shipping_address": {
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
"vat_identification_number": null
},
"lines": [
{
"id": "T3JkZXJMaW5lOjMzMzk=",
"variant": {
"id": "UHJvZHVjdFZhcmlhbnQ6MjU5",
"sku": "",
"name": "",
"price": {
"amount": "499.00",
"currency": "USD"
},
"seller": {
"id": "U2VsbGVyOjE3",
"company_name": "Acme Dive Suits"
},
"status": "active",
"weight": "3.0 kg",
"product": {
"id": "UHJvZHVjdDoxMTA=",
"name": "White Diving Suit ",
"slug": "white-diving-suit",
"seller": {
"id": "U2VsbGVyOjE3",
"company_name": "Acme Dive Suits"
},
"status": "active",
"weight": "3.0 kg",
"category": {
"id": "Q2F0ZWdvcnk6MTg=",
"name": "Scuba Diving",
"slug": "scuba-diving"
},
"currency": "USD",
"metadata": {},
"created_at": "2023-10-13T17:22:57.509388+00:00",
"sub_status": "approved",
"updated_at": "2023-10-13T17:22:58.128887+00:00",
"collections": [
{
"id": "Q29sbGVjdGlvbjoyNA==",
"slug": "starrcollectiona",
"type": "product"
}
],
"description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.\n",
"charge_taxes": true,
"is_published": true,
"product_type": {
"id": "UHJvZHVjdFR5cGU6MTc=",
"name": "Diving Gear (Simple) ",
"slug": "diving-gear-simple",
"weight": "0.0 kg",
"metadata": {
"avatax.code": "O9999999",
"avatax.description": "Temporary Unmapped Other SKU - taxable default"
},
"is_digital": false,
"has_variants": false,
"private_metadata": {},
"is_shipping_required": true
},
"description_html": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.<p></p>",
"private_metadata": {},
"publication_date": "2023-10-13",
"minimal_variant_price_amount": "499.00"
},
"currency": "USD",
"metadata": {},
"is_master": false,
"seo_title": null,
"created_at": "2023-10-13T17:22:57.531123+00:00",
"sub_status": "approved",
"updated_at": "2023-10-13T17:22:57.531160+00:00",
"description": "",
"price_amount": "499.00",
"seo_description": null,
"track_inventory": true,
"description_html": "<div></div>",
"private_metadata": {},
"cost_price_amount": "0.00",
"override_currency": false,
"is_user_defined_name": false,
"nautical_stock_number": "f80d1b22-4b62-4e1b-b6ab-233ba9c1fb6c"
},
"currency": "USD",
"quantity": 2,
"vat_code": "",
"unit_price": {
"net": {
"amount": "499.00",
"currency": "USD"
},
"tax": {
"amount": "24.95",
"currency": "USD"
},
"gross": {
"amount": "523.95",
"currency": "USD"
}
},
"product_sku": "",
"total_price": {
"net": {
"amount": "998.00",
"currency": "USD"
},
"tax": {
"amount": "49.90",
"currency": "USD"
},
"gross": {
"amount": "1047.90",
"currency": "USD"
}
},
"product_name": "White Diving Suit ",
"variant_name": "f80d1b22-4b62-4e1b-b6ab-233ba9c1fb6c",
"quantity_declined": 0,
"quantity_fulfilled": 0,
"is_shipping_required": true,
"translated_product_name": "",
"translated_variant_name": "",
"is_line_price_overridden": false
}
],
"token": "ce0b23d6-d1be-4301-a796-e07665f14ff3",
"total": {
"net": {
"amount": "1013.00",
"currency": "USD"
},
"tax": {
"amount": "49.90",
"currency": "USD"
},
"gross": {
"amount": "1062.90",
"currency": "USD"
}
},
"seller": {
"id": "U2VsbGVyOjE3",
"company_name": "Acme Dive Suits"
},
"status": "unfulfilled",
"weight": "6.0 kg",
"created": "2024-01-17T17:30:45.154448+00:00",
"currency": "USD",
"discount": {
"amount": "0.00",
"currency": "USD"
},
"metadata": {},
"sub_status": null,
"user_email": "emily.smith@example.com",
"external_id": null,
"fulfillments": [],
"discount_name": null,
"payout_status": "not_ready",
"nautical_order": {
"id": "TmF1dGljYWxPcmRlcjo5NDg="
},
"shipping_price": {
"net": {
"amount": "15.00",
"currency": "USD"
},
"tax": {
"amount": "0.00",
"currency": "USD"
},
"gross": {
"amount": "15.00",
"currency": "USD"
}
},
"billing_address": {
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
"external_source": null,
"shipping_method": {
"id": "U2hpcHBpbmdNZXRob2Q6MjA=",
"price": {
"amount": "15.00",
"currency": "USD"
}
},
"private_metadata": {},
"shipping_address": {
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
"total_gross_amount": "1062.90",
"shipping_price_net_amount": "15.00",
"is_shipping_price_overridden": false
}
],
"billing_address": {
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
"shipping_address": {
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
"nautical_event_type": "nautical_order_created",
"nautical_event_timestamp": "2023-09-09T23:42:46.698497-04:00"
}
Show more ↓
Nautical order fully paid
The nautical_order_fully_paid webhook is triggered when a marketplace order is fully paid, meaning all outstanding payments have been captured. This can occur when a customer completes a checkout from the storefront, or when an order is marked as paid.
Sample payload body
{
"id": "TmF1dGljYWxPcmRlcjo5NDg=",
"user": {
"id": "VXNlcjoyMzQ=",
"note": "",
"email": "emily.smith@example.com",
"metadata": {},
"addresses": [
{
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
{
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
}
],
"is_active": true,
"last_name": "Buyer",
"first_name": "Emily",
"last_login": "2024-01-12T17:04:23.897288+00:00",
"date_joined": "2024-01-12T17:01:24.808178+00:00",
"external_id": null,
"company_name": "",
"is_anonymous": false,
"personal_phone": "",
"external_source": null,
"tax_exempt_code": null,
"private_metadata": {},
"default_billing_address": {
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
"default_shipping_address": {
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
"vat_identification_number": null
},
"lines": [
{
"id": "TmF1dGljYWxPcmRlckxpbmU6MzUxNw==",
"variant": {
"id": "UHJvZHVjdFZhcmlhbnQ6MjU5",
"sku": "",
"name": "",
"price": {
"amount": "499.00",
"currency": "USD"
},
"seller": {
"id": "U2VsbGVyOjE3",
"company_name": "Acme Dive Suits"
},
"status": "active",
"weight": "3.0 kg",
"product": {
"id": "UHJvZHVjdDoxMTA=",
"name": "White Diving Suit ",
"slug": "white-diving-suit",
"seller": {
"id": "U2VsbGVyOjE3",
"company_name": "Acme Dive Suits"
},
"status": "active",
"weight": "3.0 kg",
"category": {
"id": "Q2F0ZWdvcnk6MTg=",
"name": "Scuba Diving",
"slug": "scuba-diving"
},
"currency": "USD",
"metadata": {},
"created_at": "2023-10-13T17:22:57.509388+00:00",
"sub_status": "approved",
"updated_at": "2023-10-13T17:22:58.128887+00:00",
"collections": [
{
"id": "Q29sbGVjdGlvbjoyNA==",
"slug": "starrcollectiona",
"type": "product"
}
],
"description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.\n",
"charge_taxes": true,
"is_published": true,
"product_type": {
"id": "UHJvZHVjdFR5cGU6MTc=",
"name": "Diving Gear (Simple) ",
"slug": "diving-gear-simple",
"weight": "0.0 kg",
"metadata": {
"avatax.code": "O9999999",
"avatax.description": "Temporary Unmapped Other SKU - taxable default"
},
"is_digital": false,
"has_variants": false,
"private_metadata": {},
"is_shipping_required": true
},
"description_html": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.<p></p>",
"private_metadata": {},
"publication_date": "2023-10-13",
"minimal_variant_price_amount": "499.00"
},
"currency": "USD",
"metadata": {},
"is_master": false,
"seo_title": null,
"created_at": "2023-10-13T17:22:57.531123+00:00",
"sub_status": "approved",
"updated_at": "2023-10-13T17:22:57.531160+00:00",
"description": "",
"price_amount": "499.00",
"seo_description": null,
"track_inventory": true,
"description_html": "<div></div>",
"private_metadata": {},
"cost_price_amount": "0.00",
"override_currency": false,
"is_user_defined_name": false,
"nautical_stock_number": "f80d1b22-4b62-4e1b-b6ab-233ba9c1fb6c"
},
"quantity": 2,
"unit_price": {
"net": {
"amount": "499.00",
"currency": "USD"
},
"tax": {
"amount": "24.95",
"currency": "USD"
},
"gross": {
"amount": "523.95",
"currency": "USD"
}
},
"product_sku": "",
"total_price": {
"net": {
"amount": "499.00",
"currency": "USD"
},
"tax": {
"amount": "24.95",
"currency": "USD"
},
"gross": {
"amount": "523.95",
"currency": "USD"
}
},
"product_name": "White Diving Suit ",
"variant_name": "f80d1b22-4b62-4e1b-b6ab-233ba9c1fb6c",
"seller_order_line": {
"id": "T3JkZXJMaW5lOjMzMzk=",
"variant": {
"id": "UHJvZHVjdFZhcmlhbnQ6MjU5",
"sku": "",
"name": "",
"price": {
"amount": "499.00",
"currency": "USD"
},
"seller": {
"id": "U2VsbGVyOjE3",
"company_name": "Acme Dive Suits"
},
"status": "active",
"weight": "3.0 kg",
"product": {
"id": "UHJvZHVjdDoxMTA=",
"name": "White Diving Suit ",
"slug": "white-diving-suit",
"seller": {
"id": "U2VsbGVyOjE3",
"company_name": "Acme Dive Suits"
},
"status": "active",
"weight": "3.0 kg",
"category": {
"id": "Q2F0ZWdvcnk6MTg=",
"name": "Scuba Diving",
"slug": "scuba-diving"
},
"currency": "USD",
"metadata": {},
"created_at": "2023-10-13T17:22:57.509388+00:00",
"sub_status": "approved",
"updated_at": "2023-10-13T17:22:58.128887+00:00",
"collections": [
{
"id": "Q29sbGVjdGlvbjoyNA==",
"slug": "starrcollectiona",
"type": "product"
}
],
"description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.\n",
"charge_taxes": true,
"is_published": true,
"product_type": {
"id": "UHJvZHVjdFR5cGU6MTc=",
"name": "Diving Gear (Simple) ",
"slug": "diving-gear-simple",
"weight": "0.0 kg",
"metadata": {
"avatax.code": "O9999999",
"avatax.description": "Temporary Unmapped Other SKU - taxable default"
},
"is_digital": false,
"has_variants": false,
"private_metadata": {},
"is_shipping_required": true
},
"description_html": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.<p></p>",
"private_metadata": {},
"publication_date": "2023-10-13",
"minimal_variant_price_amount": "499.00"
},
"currency": "USD",
"metadata": {},
"is_master": false,
"seo_title": null,
"created_at": "2023-10-13T17:22:57.531123+00:00",
"sub_status": "approved",
"updated_at": "2023-10-13T17:22:57.531160+00:00",
"description": "",
"price_amount": "499.00",
"seo_description": null,
"track_inventory": true,
"description_html": "<div></div>",
"private_metadata": {},
"cost_price_amount": "0.00",
"override_currency": false,
"is_user_defined_name": false,
"nautical_stock_number": "f80d1b22-4b62-4e1b-b6ab-233ba9c1fb6c"
},
"currency": "USD",
"quantity": 2,
"vat_code": "",
"unit_price": {
"net": {
"amount": "499.00",
"currency": "USD"
},
"tax": {
"amount": "24.95",
"currency": "USD"
},
"gross": {
"amount": "523.95",
"currency": "USD"
}
},
"product_sku": "",
"total_price": {
"net": {
"amount": "499.00",
"currency": "USD"
},
"tax": {
"amount": "24.95",
"currency": "USD"
},
"gross": {
"amount": "523.95",
"currency": "USD"
}
},
"product_name": "White Diving Suit ",
"variant_name": "f80d1b22-4b62-4e1b-b6ab-233ba9c1fb6c",
"quantity_declined": 1,
"quantity_fulfilled": 0,
"is_shipping_required": true,
"translated_product_name": "",
"translated_variant_name": "",
"is_line_price_overridden": false
},
"quantity_fulfilled": 0,
"is_shipping_required": true,
"unit_price_net_amount": "499.00",
"unit_price_gross_amount": "523.95",
"is_line_price_overridden": false
}
],
"token": "46e33d6f-bce1-4f74-8439-2a2759cb655e",
"total": {
"net": {
"amount": "514.00",
"currency": "USD"
},
"tax": {
"amount": "24.95",
"currency": "USD"
},
"gross": {
"amount": "538.95",
"currency": "USD"
}
},
"number": 948,
"status": "unfulfilled",
"created": "2024-01-17T17:30:45.136587+00:00",
"updated": "2024-01-17T17:33:38.025303+00:00",
"currency": "USD",
"discount": {
"amount": "0.00",
"currency": "USD"
},
"payments": [
{
"id": "UGF5bWVudDo3MjQ=",
"total": "1062.90",
"created": "2024-01-17T17:30:43.471172+00:00",
"gateway": "nautical.payments.stripe",
"cc_brand": "visa",
"currency": "USD",
"modified": "2024-01-17T17:33:46.807247+00:00",
"is_active": true,
"to_confirm": false,
"billing_city": "TORONTO",
"billing_email": "emily.smith@example.com",
"charge_status": "partially-charged",
"captured_amount": "538.95",
"billing_address_1": "123 Sesame Street",
"billing_address_2": "",
"billing_city_area": "",
"billing_last_name": "Smith",
"billing_first_name": "Emily",
"billing_postal_code": "M5V0G9",
"payment_method_type": "card",
"billing_company_name": "",
"billing_country_area": "ON",
"billing_country_code": "CA"
}
],
"sub_status": null,
"user_email": "emily.smith@example.com",
"discount_name": null,
"seller_orders": [
{
"id": "T3JkZXI6MTYwNA==",
"user": {
"id": "VXNlcjoyMzQ=",
"note": "",
"email": "emily.smith@example.com",
"metadata": {},
"addresses": [
{
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
{
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
}
],
"is_active": true,
"last_name": "Buyer",
"first_name": "Emily",
"last_login": "2024-01-12T17:04:23.897288+00:00",
"date_joined": "2024-01-12T17:01:24.808178+00:00",
"external_id": null,
"company_name": "",
"is_anonymous": false,
"personal_phone": "",
"external_source": null,
"tax_exempt_code": null,
"private_metadata": {},
"default_billing_address": {
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
"default_shipping_address": {
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
"vat_identification_number": null
},
"lines": [
{
"id": "T3JkZXJMaW5lOjMzMzk=",
"variant": {
"id": "UHJvZHVjdFZhcmlhbnQ6MjU5",
"sku": "",
"name": "",
"price": {
"amount": "499.00",
"currency": "USD"
},
"seller": {
"id": "U2VsbGVyOjE3",
"company_name": "Acme Dive Suits"
},
"status": "active",
"weight": "3.0 kg",
"product": {
"id": "UHJvZHVjdDoxMTA=",
"name": "White Diving Suit ",
"slug": "white-diving-suit",
"seller": {
"id": "U2VsbGVyOjE3",
"company_name": "Acme Dive Suits"
},
"status": "active",
"weight": "3.0 kg",
"category": {
"id": "Q2F0ZWdvcnk6MTg=",
"name": "Scuba Diving",
"slug": "scuba-diving"
},
"currency": "USD",
"metadata": {},
"created_at": "2023-10-13T17:22:57.509388+00:00",
"sub_status": "approved",
"updated_at": "2023-10-13T17:22:58.128887+00:00",
"collections": [
{
"id": "Q29sbGVjdGlvbjoyNA==",
"slug": "starrcollectiona",
"type": "product"
}
],
"description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.\n",
"charge_taxes": true,
"is_published": true,
"product_type": {
"id": "UHJvZHVjdFR5cGU6MTc=",
"name": "Diving Gear (Simple) ",
"slug": "diving-gear-simple",
"weight": "0.0 kg",
"metadata": {
"avatax.code": "O9999999",
"avatax.description": "Temporary Unmapped Other SKU - taxable default"
},
"is_digital": false,
"has_variants": false,
"private_metadata": {},
"is_shipping_required": true
},
"description_html": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.<p></p>",
"private_metadata": {},
"publication_date": "2023-10-13",
"minimal_variant_price_amount": "499.00"
},
"currency": "USD",
"metadata": {},
"is_master": false,
"seo_title": null,
"created_at": "2023-10-13T17:22:57.531123+00:00",
"sub_status": "approved",
"updated_at": "2023-10-13T17:22:57.531160+00:00",
"description": "",
"price_amount": "499.00",
"seo_description": null,
"track_inventory": true,
"description_html": "<div></div>",
"private_metadata": {},
"cost_price_amount": "0.00",
"override_currency": false,
"is_user_defined_name": false,
"nautical_stock_number": "f80d1b22-4b62-4e1b-b6ab-233ba9c1fb6c"
},
"currency": "USD",
"quantity": 2,
"vat_code": "",
"unit_price": {
"net": {
"amount": "499.00",
"currency": "USD"
},
"tax": {
"amount": "24.95",
"currency": "USD"
},
"gross": {
"amount": "523.95",
"currency": "USD"
}
},
"product_sku": "",
"total_price": {
"net": {
"amount": "499.00",
"currency": "USD"
},
"tax": {
"amount": "24.95",
"currency": "USD"
},
"gross": {
"amount": "523.95",
"currency": "USD"
}
},
"product_name": "White Diving Suit ",
"variant_name": "f80d1b22-4b62-4e1b-b6ab-233ba9c1fb6c",
"quantity_declined": 1,
"quantity_fulfilled": 0,
"is_shipping_required": true,
"translated_product_name": "",
"translated_variant_name": "",
"is_line_price_overridden": false
}
],
"token": "ce0b23d6-d1be-4301-a796-e07665f14ff3",
"total": {
"net": {
"amount": "514.00",
"currency": "USD"
},
"tax": {
"amount": "24.95",
"currency": "USD"
},
"gross": {
"amount": "538.95",
"currency": "USD"
}
},
"seller": {
"id": "U2VsbGVyOjE3",
"company_name": "Acme Dive Suits"
},
"status": "unfulfilled",
"weight": "6.0 kg",
"created": "2024-01-17T17:30:45.154448+00:00",
"currency": "USD",
"discount": {
"amount": "0.00",
"currency": "USD"
},
"metadata": {},
"sub_status": null,
"user_email": "emily.smith@example.com",
"external_id": null,
"fulfillments": [
{
"id": "RnVsZmlsbG1lbnQ6MzQ3",
"status": "declined",
"created": "2024-01-17T17:33:36.305299+00:00",
"updated": "2024-01-17T17:33:36.305319+00:00",
"tracking_number": ""
}
],
"discount_name": null,
"payout_status": "not_ready",
"nautical_order": {
"id": "TmF1dGljYWxPcmRlcjo5NDg="
},
"shipping_price": {
"net": {
"amount": "15.00",
"currency": "USD"
},
"tax": {
"amount": "0.00",
"currency": "USD"
},
"gross": {
"amount": "15.00",
"currency": "USD"
}
},
"billing_address": {
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
"external_source": null,
"shipping_method": {
"id": "U2hpcHBpbmdNZXRob2Q6MjA=",
"price": {
"amount": "15.00",
"currency": "USD"
}
},
"private_metadata": {},
"shipping_address": {
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
"total_gross_amount": "538.95",
"shipping_price_net_amount": "15.00",
"is_shipping_price_overridden": false
}
],
"billing_address": {
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
"shipping_address": {
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
"nautical_event_type": "nautical_order_fully_paid",
"nautical_event_timestamp": "2023-09-09T23:42:46.698497-04:00"
}
Show more ↓
Nautical order updated
The nautical_order_updated webhook event is triggered when there are changes to a marketplace order. These changes can involve order fulfillments, payment capture, or payout status updates.
Sample payload body
{
"id": "TmF1dGljYWxPcmRlcjo5NDg=",
"user": {
"id": "VXNlcjoyMzQ=",
"note": "",
"email": "emily.smith@example.com",
"metadata": {},
"addresses": [
{
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
{
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
}
],
"is_active": true,
"last_name": "Buyer",
"first_name": "Emily",
"last_login": "2024-01-12T17:04:23.897288+00:00",
"date_joined": "2024-01-12T17:01:24.808178+00:00",
"external_id": null,
"company_name": "",
"is_anonymous": false,
"personal_phone": "",
"external_source": null,
"tax_exempt_code": null,
"private_metadata": {},
"default_billing_address": {
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
"default_shipping_address": {
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
"vat_identification_number": null
},
"lines": [
{
"id": "TmF1dGljYWxPcmRlckxpbmU6MzUxNw==",
"variant": {
"id": "UHJvZHVjdFZhcmlhbnQ6MjU5",
"sku": "",
"name": "",
"price": {
"amount": "499.00",
"currency": "USD"
},
"seller": {
"id": "U2VsbGVyOjE3",
"company_name": "Acme Dive Suits"
},
"status": "active",
"weight": "3.0 kg",
"product": {
"id": "UHJvZHVjdDoxMTA=",
"name": "White Diving Suit ",
"slug": "white-diving-suit",
"seller": {
"id": "U2VsbGVyOjE3",
"company_name": "Acme Dive Suits"
},
"status": "active",
"weight": "3.0 kg",
"category": {
"id": "Q2F0ZWdvcnk6MTg=",
"name": "Scuba Diving",
"slug": "scuba-diving"
},
"currency": "USD",
"metadata": {},
"created_at": "2023-10-13T17:22:57.509388+00:00",
"sub_status": "approved",
"updated_at": "2023-10-13T17:22:58.128887+00:00",
"collections": [
{
"id": "Q29sbGVjdGlvbjoyNA==",
"slug": "starrcollectiona",
"type": "product"
}
],
"description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.\n",
"charge_taxes": true,
"is_published": true,
"product_type": {
"id": "UHJvZHVjdFR5cGU6MTc=",
"name": "Diving Gear (Simple) ",
"slug": "diving-gear-simple",
"weight": "0.0 kg",
"metadata": {
"avatax.code": "O9999999",
"avatax.description": "Temporary Unmapped Other SKU - taxable default"
},
"is_digital": false,
"has_variants": false,
"private_metadata": {},
"is_shipping_required": true
},
"description_html": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.<p></p>",
"private_metadata": {},
"publication_date": "2023-10-13",
"minimal_variant_price_amount": "499.00"
},
"currency": "USD",
"metadata": {},
"is_master": false,
"seo_title": null,
"created_at": "2023-10-13T17:22:57.531123+00:00",
"sub_status": "approved",
"updated_at": "2023-10-13T17:22:57.531160+00:00",
"description": "",
"price_amount": "499.00",
"seo_description": null,
"track_inventory": true,
"description_html": "<div></div>",
"private_metadata": {},
"cost_price_amount": "0.00",
"override_currency": false,
"is_user_defined_name": false,
"nautical_stock_number": "f80d1b22-4b62-4e1b-b6ab-233ba9c1fb6c"
},
"quantity": 2,
"unit_price": {
"net": {
"amount": "499.00",
"currency": "USD"
},
"tax": {
"amount": "24.95",
"currency": "USD"
},
"gross": {
"amount": "523.95",
"currency": "USD"
}
},
"product_sku": "",
"total_price": {
"net": {
"amount": "499.00",
"currency": "USD"
},
"tax": {
"amount": "24.95",
"currency": "USD"
},
"gross": {
"amount": "523.95",
"currency": "USD"
}
},
"product_name": "White Diving Suit ",
"variant_name": "f80d1b22-4b62-4e1b-b6ab-233ba9c1fb6c",
"seller_order_line": {
"id": "T3JkZXJMaW5lOjMzMzk=",
"variant": {
"id": "UHJvZHVjdFZhcmlhbnQ6MjU5",
"sku": "",
"name": "",
"price": {
"amount": "499.00",
"currency": "USD"
},
"seller": {
"id": "U2VsbGVyOjE3",
"company_name": "Acme Dive Suits"
},
"status": "active",
"weight": "3.0 kg",
"product": {
"id": "UHJvZHVjdDoxMTA=",
"name": "White Diving Suit ",
"slug": "white-diving-suit",
"seller": {
"id": "U2VsbGVyOjE3",
"company_name": "Acme Dive Suits"
},
"status": "active",
"weight": "3.0 kg",
"category": {
"id": "Q2F0ZWdvcnk6MTg=",
"name": "Scuba Diving",
"slug": "scuba-diving"
},
"currency": "USD",
"metadata": {},
"created_at": "2023-10-13T17:22:57.509388+00:00",
"sub_status": "approved",
"updated_at": "2023-10-13T17:22:58.128887+00:00",
"collections": [
{
"id": "Q29sbGVjdGlvbjoyNA==",
"slug": "starrcollectiona",
"type": "product"
}
],
"description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.\n",
"charge_taxes": true,
"is_published": true,
"product_type": {
"id": "UHJvZHVjdFR5cGU6MTc=",
"name": "Diving Gear (Simple) ",
"slug": "diving-gear-simple",
"weight": "0.0 kg",
"metadata": {
"avatax.code": "O9999999",
"avatax.description": "Temporary Unmapped Other SKU - taxable default"
},
"is_digital": false,
"has_variants": false,
"private_metadata": {},
"is_shipping_required": true
},
"description_html": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.<p></p>",
"private_metadata": {},
"publication_date": "2023-10-13",
"minimal_variant_price_amount": "499.00"
},
"currency": "USD",
"metadata": {},
"is_master": false,
"seo_title": null,
"created_at": "2023-10-13T17:22:57.531123+00:00",
"sub_status": "approved",
"updated_at": "2023-10-13T17:22:57.531160+00:00",
"description": "",
"price_amount": "499.00",
"seo_description": null,
"track_inventory": true,
"description_html": "<div></div>",
"private_metadata": {},
"cost_price_amount": "0.00",
"override_currency": false,
"is_user_defined_name": false,
"nautical_stock_number": "f80d1b22-4b62-4e1b-b6ab-233ba9c1fb6c"
},
"currency": "USD",
"quantity": 2,
"vat_code": "",
"unit_price": {
"net": {
"amount": "499.00",
"currency": "USD"
},
"tax": {
"amount": "24.95",
"currency": "USD"
},
"gross": {
"amount": "523.95",
"currency": "USD"
}
},
"product_sku": "",
"total_price": {
"net": {
"amount": "499.00",
"currency": "USD"
},
"tax": {
"amount": "24.95",
"currency": "USD"
},
"gross": {
"amount": "523.95",
"currency": "USD"
}
},
"product_name": "White Diving Suit ",
"variant_name": "f80d1b22-4b62-4e1b-b6ab-233ba9c1fb6c",
"quantity_declined": 1,
"quantity_fulfilled": 1,
"is_shipping_required": true,
"translated_product_name": "",
"translated_variant_name": "",
"is_line_price_overridden": false
},
"quantity_fulfilled": 0,
"is_shipping_required": true,
"unit_price_net_amount": "499.00",
"unit_price_gross_amount": "523.95",
"is_line_price_overridden": false
}
],
"token": "46e33d6f-bce1-4f74-8439-2a2759cb655e",
"total": {
"net": {
"amount": "514.00",
"currency": "USD"
},
"tax": {
"amount": "24.95",
"currency": "USD"
},
"gross": {
"amount": "538.95",
"currency": "USD"
}
},
"number": 948,
"status": "partially fulfilled",
"created": "2024-01-17T17:30:45.136587+00:00",
"updated": "2024-01-17T17:34:23.456647+00:00",
"currency": "USD",
"discount": {
"amount": "0.00",
"currency": "USD"
},
"payments": [
{
"id": "UGF5bWVudDo3MjQ=",
"total": "1062.90",
"created": "2024-01-17T17:30:43.471172+00:00",
"gateway": "nautical.payments.stripe",
"cc_brand": "visa",
"currency": "USD",
"modified": "2024-01-17T17:33:46.807247+00:00",
"is_active": true,
"to_confirm": false,
"billing_city": "TORONTO",
"billing_email": "emily.smith@example.com",
"charge_status": "partially-charged",
"captured_amount": "538.95",
"billing_address_1": "123 Sesame Street",
"billing_address_2": "",
"billing_city_area": "",
"billing_last_name": "Smith",
"billing_first_name": "Emily",
"billing_postal_code": "M5V0G9",
"payment_method_type": "card",
"billing_company_name": "",
"billing_country_area": "ON",
"billing_country_code": "CA"
}
],
"sub_status": null,
"user_email": "emily.smith@example.com",
"discount_name": null,
"seller_orders": [
{
"id": "T3JkZXI6MTYwNA==",
"user": {
"id": "VXNlcjoyMzQ=",
"note": "",
"email": "emily.smith@example.com",
"metadata": {},
"addresses": [
{
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
{
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
}
],
"is_active": true,
"last_name": "Buyer",
"first_name": "Emily",
"last_login": "2024-01-12T17:04:23.897288+00:00",
"date_joined": "2024-01-12T17:01:24.808178+00:00",
"external_id": null,
"company_name": "",
"is_anonymous": false,
"personal_phone": "",
"external_source": null,
"tax_exempt_code": null,
"private_metadata": {},
"default_billing_address": {
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
"default_shipping_address": {
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
"vat_identification_number": null
},
"lines": [
{
"id": "T3JkZXJMaW5lOjMzMzk=",
"variant": {
"id": "UHJvZHVjdFZhcmlhbnQ6MjU5",
"sku": "",
"name": "",
"price": {
"amount": "499.00",
"currency": "USD"
},
"seller": {
"id": "U2VsbGVyOjE3",
"company_name": "Acme Dive Suits"
},
"status": "active",
"weight": "3.0 kg",
"product": {
"id": "UHJvZHVjdDoxMTA=",
"name": "White Diving Suit ",
"slug": "white-diving-suit",
"seller": {
"id": "U2VsbGVyOjE3",
"company_name": "Acme Dive Suits"
},
"status": "active",
"weight": "3.0 kg",
"category": {
"id": "Q2F0ZWdvcnk6MTg=",
"name": "Scuba Diving",
"slug": "scuba-diving"
},
"currency": "USD",
"metadata": {},
"created_at": "2023-10-13T17:22:57.509388+00:00",
"sub_status": "approved",
"updated_at": "2023-10-13T17:22:58.128887+00:00",
"collections": [
{
"id": "Q29sbGVjdGlvbjoyNA==",
"slug": "starrcollectiona",
"type": "product"
}
],
"description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.\n",
"charge_taxes": true,
"is_published": true,
"product_type": {
"id": "UHJvZHVjdFR5cGU6MTc=",
"name": "Diving Gear (Simple) ",
"slug": "diving-gear-simple",
"weight": "0.0 kg",
"metadata": {
"avatax.code": "O9999999",
"avatax.description": "Temporary Unmapped Other SKU - taxable default"
},
"is_digital": false,
"has_variants": false,
"private_metadata": {},
"is_shipping_required": true
},
"description_html": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.<p></p>",
"private_metadata": {},
"publication_date": "2023-10-13",
"minimal_variant_price_amount": "499.00"
},
"currency": "USD",
"metadata": {},
"is_master": false,
"seo_title": null,
"created_at": "2023-10-13T17:22:57.531123+00:00",
"sub_status": "approved",
"updated_at": "2023-10-13T17:22:57.531160+00:00",
"description": "",
"price_amount": "499.00",
"seo_description": null,
"track_inventory": true,
"description_html": "<div></div>",
"private_metadata": {},
"cost_price_amount": "0.00",
"override_currency": false,
"is_user_defined_name": false,
"nautical_stock_number": "f80d1b22-4b62-4e1b-b6ab-233ba9c1fb6c"
},
"currency": "USD",
"quantity": 2,
"vat_code": "",
"unit_price": {
"net": {
"amount": "499.00",
"currency": "USD"
},
"tax": {
"amount": "24.95",
"currency": "USD"
},
"gross": {
"amount": "523.95",
"currency": "USD"
}
},
"product_sku": "",
"total_price": {
"net": {
"amount": "499.00",
"currency": "USD"
},
"tax": {
"amount": "24.95",
"currency": "USD"
},
"gross": {
"amount": "523.95",
"currency": "USD"
}
},
"product_name": "White Diving Suit ",
"variant_name": "f80d1b22-4b62-4e1b-b6ab-233ba9c1fb6c",
"quantity_declined": 1,
"quantity_fulfilled": 1,
"is_shipping_required": true,
"translated_product_name": "",
"translated_variant_name": "",
"is_line_price_overridden": false
}
],
"token": "ce0b23d6-d1be-4301-a796-e07665f14ff3",
"total": {
"net": {
"amount": "514.00",
"currency": "USD"
},
"tax": {
"amount": "24.95",
"currency": "USD"
},
"gross": {
"amount": "538.95",
"currency": "USD"
}
},
"seller": {
"id": "U2VsbGVyOjE3",
"company_name": "Acme Dive Suits"
},
"status": "partially fulfilled",
"weight": "6.0 kg",
"created": "2024-01-17T17:30:45.154448+00:00",
"currency": "USD",
"discount": {
"amount": "0.00",
"currency": "USD"
},
"metadata": {},
"sub_status": null,
"user_email": "emily.smith@example.com",
"external_id": null,
"fulfillments": [
{
"id": "RnVsZmlsbG1lbnQ6MzQ3",
"status": "declined",
"created": "2024-01-17T17:33:36.305299+00:00",
"updated": "2024-01-17T17:33:36.305319+00:00",
"tracking_number": ""
},
{
"id": "RnVsZmlsbG1lbnQ6MzQ4",
"status": "fulfilled",
"created": "2024-01-17T17:34:22.905360+00:00",
"updated": "2024-01-17T17:34:22.905382+00:00",
"tracking_number": ""
}
],
"discount_name": null,
"payout_status": "ready_for_payout",
"nautical_order": {
"id": "TmF1dGljYWxPcmRlcjo5NDg="
},
"shipping_price": {
"net": {
"amount": "15.00",
"currency": "USD"
},
"tax": {
"amount": "0.00",
"currency": "USD"
},
"gross": {
"amount": "15.00",
"currency": "USD"
}
},
"billing_address": {
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
"external_source": null,
"shipping_method": {
"id": "U2hpcHBpbmdNZXRob2Q6MjA=",
"price": {
"amount": "15.00",
"currency": "USD"
}
},
"private_metadata": {},
"shipping_address": {
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
"total_gross_amount": "538.95",
"shipping_price_net_amount": "15.00",
"is_shipping_price_overridden": false
}
],
"billing_address": {
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
"shipping_address": {
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
"nautical_event_type": "nautical_order_updated",
"nautical_event_timestamp": "2023-09-09T23:42:46.698497-04:00"
}
Show more ↓
Order cancelled
The order_cancelled payload is sent when a seller's order is canceled. If an marketplace order that involves multiple sellers is cancelled, a separate payload is generated for each seller order.
Sample payload body
{
"id": "T3JkZXI6MTU5MQ==",
"user": {
"id": "VXNlcjoyMzQ=",
"note": "",
"email": "emily.smith@example.com",
"metadata": {},
"addresses": [
{
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
{
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
}
],
"is_active": true,
"last_name": "Buyer",
"first_name": "Emily",
"last_login": "2024-01-12T17:04:23.897288+00:00",
"date_joined": "2024-01-12T17:01:24.808178+00:00",
"external_id": null,
"company_name": "",
"is_anonymous": false,
"personal_phone": "",
"external_source": null,
"tax_exempt_code": null,
"private_metadata": {},
"default_billing_address": {
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
"default_shipping_address": {
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
"vat_identification_number": null
},
"lines": [
{
"id": "T3JkZXJMaW5lOjMzMjU=",
"variant": {
"id": "UHJvZHVjdFZhcmlhbnQ6MjU1",
"sku": "437647",
"name": "S",
"price": {
"amount": "450.00",
"currency": "USD"
},
"seller": {
"id": "U2VsbGVyOjE3",
"company_name": "Acme Dive Suits"
},
"status": "active",
"weight": null,
"product": {
"id": "UHJvZHVjdDoxMDk=",
"name": "Black Diving Suit ",
"slug": "black-diving-suit",
"seller": {
"id": "U2VsbGVyOjE3",
"company_name": "Acme Dive Suits"
},
"status": "active",
"weight": null,
"category": {
"id": "Q2F0ZWdvcnk6MTg=",
"name": "Scuba Diving",
"slug": "scuba-diving"
},
"currency": "USD",
"metadata": {},
"created_at": "2023-10-13T17:10:08.596493+00:00",
"sub_status": "approved",
"updated_at": "2023-11-29T20:45:02.697426+00:00",
"collections": [
{
"id": "Q29sbGVjdGlvbjo3",
"slug": "home-and-health",
"type": "product"
},
{
"id": "Q29sbGVjdGlvbjoyNQ==",
"slug": "starrtestb",
"type": "product"
}
],
"description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.\n",
"charge_taxes": true,
"is_published": true,
"product_type": {
"id": "UHJvZHVjdFR5cGU6MTY=",
"name": "Diving Accessories ",
"slug": "diving-accessories",
"weight": "1.0 kg",
"metadata": {},
"is_digital": false,
"has_variants": true,
"private_metadata": {},
"is_shipping_required": true
},
"description_html": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.<p></p>",
"private_metadata": {},
"publication_date": "2023-10-13",
"minimal_variant_price_amount": "450.00"
},
"currency": "USD",
"metadata": {},
"is_master": false,
"seo_title": null,
"created_at": "2023-10-13T17:10:47.489979+00:00",
"sub_status": "approved",
"updated_at": "2023-10-13T17:10:47.490045+00:00",
"description": "",
"price_amount": "450.00",
"seo_description": null,
"track_inventory": true,
"description_html": "<div></div>",
"private_metadata": {},
"cost_price_amount": null,
"override_currency": false,
"is_user_defined_name": false,
"nautical_stock_number": "69c347a2-779e-4ead-8afd-c5197e776c90"
},
"currency": "USD",
"quantity": 1,
"vat_code": "",
"unit_price": {
"net": {
"amount": "450.00",
"currency": "USD"
},
"tax": {
"amount": "22.50",
"currency": "USD"
},
"gross": {
"amount": "472.50",
"currency": "USD"
}
},
"product_sku": "437647",
"total_price": {
"net": {
"amount": "450.00",
"currency": "USD"
},
"tax": {
"amount": "22.50",
"currency": "USD"
},
"gross": {
"amount": "472.50",
"currency": "USD"
}
},
"product_name": "Black Diving Suit ",
"variant_name": "S",
"quantity_declined": 1,
"quantity_fulfilled": 0,
"is_shipping_required": true,
"translated_product_name": "",
"translated_variant_name": "",
"is_line_price_overridden": false
}
],
"token": "67b7c12e-b9a7-4fe8-be45-20aa122bd55c",
"total": {
"net": {
"amount": "490.00",
"currency": "USD"
},
"tax": {
"amount": "22.50",
"currency": "USD"
},
"gross": {
"amount": "512.50",
"currency": "USD"
}
},
"seller": {
"id": "U2VsbGVyOjE3",
"company_name": "Acme Dive Suits"
},
"status": "canceled",
"weight": "1.0 kg",
"created": "2024-01-17T15:12:46.360107+00:00",
"currency": "USD",
"discount": {
"amount": "0.00",
"currency": "USD"
},
"metadata": {},
"sub_status": null,
"user_email": "emily.smith@example.com",
"external_id": null,
"fulfillments": [
{
"id": "RnVsZmlsbG1lbnQ6MzQy",
"status": "declined",
"created": "2024-01-17T15:24:47.823412+00:00",
"updated": "2024-01-17T15:24:47.823448+00:00",
"tracking_number": ""
}
],
"discount_name": null,
"payout_status": "not_ready",
"nautical_order": {
"id": "TmF1dGljYWxPcmRlcjo5NDA="
},
"shipping_price": {
"net": {
"amount": "0.00",
"currency": "USD"
},
"tax": {
"amount": "0.00",
"currency": "USD"
},
"gross": {
"amount": "0.00",
"currency": "USD"
}
},
"billing_address": {
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
"external_source": null,
"shipping_method": {
"id": "U2hpcHBpbmdNZXRob2Q6MjE=",
"price": {
"amount": "40.00",
"currency": "USD"
}
},
"private_metadata": {},
"shipping_address": {
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
"total_gross_amount": "512.50",
"shipping_price_net_amount": "0.00",
"is_shipping_price_overridden": false,
"nautical_event_type": "order_cancelled",
"nautical_event_timestamp": "2023-09-09T23:42:46.698497-04:00"
}
Show more ↓
Order created
The order_created webhook event is triggered when a seller order is created. This includes all order types, such as draft, quote, and offer orders, as well as orders originating from buyer checkout.
Sample payload body
{
"id": "T3JkZXI6MTU5MA==",
"user": {
"id": "VXNlcjoyMzQ=",
"note": "",
"email": "emily.smith@example.com",
"metadata": {},
"addresses": [
{
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
{
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
}
],
"is_active": true,
"last_name": "Buyer",
"first_name": "Emily",
"last_login": "2024-01-12T17:04:23.897288+00:00",
"date_joined": "2024-01-12T17:01:24.808178+00:00",
"external_id": null,
"company_name": "",
"is_anonymous": false,
"personal_phone": "",
"external_source": null,
"tax_exempt_code": null,
"private_metadata": {},
"default_billing_address": {
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
"default_shipping_address": {
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
"vat_identification_number": null
},
"lines": [
{
"id": "T3JkZXJMaW5lOjMzMjQ=",
"variant": {
"id": "UHJvZHVjdFZhcmlhbnQ6MjI2",
"sku": "",
"name": "Small",
"price": {
"amount": "222.00",
"currency": "USD"
},
"seller": {
"id": "U2VsbGVyOjg=",
"company_name": "Acme Dive Shop"
},
"status": "active",
"weight": "2.0 kg",
"product": {
"id": "UHJvZHVjdDo5Nw==",
"name": "Yellow Diving Fins",
"slug": "yellow-diving-fins",
"seller": {
"id": "U2VsbGVyOjg=",
"company_name": "Acme Dive Shop"
},
"status": "active",
"weight": null,
"category": {
"id": "Q2F0ZWdvcnk6MTg=",
"name": "Scuba Diving",
"slug": "scuba-diving"
},
"currency": "USD",
"metadata": {},
"created_at": "2023-08-24T18:35:42.800266+00:00",
"sub_status": "approved",
"updated_at": "2023-11-15T16:55:58.825735+00:00",
"collections": [
{
"id": "Q29sbGVjdGlvbjo2",
"slug": "featured",
"type": "product"
},
{
"id": "Q29sbGVjdGlvbjoyNA==",
"slug": "starrcollectiona",
"type": "product"
}
],
"description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. \n",
"charge_taxes": true,
"is_published": true,
"product_type": {
"id": "UHJvZHVjdFR5cGU6MTY=",
"name": "Diving Accessories ",
"slug": "diving-accessories",
"weight": "1.0 kg",
"metadata": {},
"is_digital": false,
"has_variants": true,
"private_metadata": {},
"is_shipping_required": true
},
"description_html": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.<p></p>",
"private_metadata": {},
"publication_date": "2023-08-24",
"minimal_variant_price_amount": "150.00"
},
"currency": "USD",
"metadata": {},
"is_master": false,
"seo_title": null,
"created_at": "2023-08-24T18:36:41.312631+00:00",
"sub_status": "approved",
"updated_at": "2023-11-15T16:54:54.976852+00:00",
"description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.\n",
"price_amount": "222.00",
"seo_description": null,
"track_inventory": true,
"description_html": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.<p></p>",
"private_metadata": {},
"cost_price_amount": null,
"override_currency": false,
"is_user_defined_name": true,
"nautical_stock_number": "9e7f338e-c3c7-4683-98d3-11bc6bbecd62"
},
"currency": "USD",
"quantity": 1,
"vat_code": "",
"unit_price": {
"net": {
"amount": "222.00",
"currency": "USD"
},
"tax": {
"amount": "11.10",
"currency": "USD"
},
"gross": {
"amount": "233.10",
"currency": "USD"
}
},
"product_sku": "",
"total_price": {
"net": {
"amount": "222.00",
"currency": "USD"
},
"tax": {
"amount": "11.10",
"currency": "USD"
},
"gross": {
"amount": "233.10",
"currency": "USD"
}
},
"product_name": "Yellow Diving Fins",
"variant_name": "Small",
"quantity_declined": 0,
"quantity_fulfilled": 0,
"is_shipping_required": true,
"translated_product_name": "",
"translated_variant_name": "",
"is_line_price_overridden": false
}
],
"token": "540c349b-0c45-411e-b1b5-ad553b9d13e4",
"total": {
"net": {
"amount": "237.00",
"currency": "USD"
},
"tax": {
"amount": "11.10",
"currency": "USD"
},
"gross": {
"amount": "248.10",
"currency": "USD"
}
},
"seller": {
"id": "U2VsbGVyOjg=",
"company_name": "Acme Dive Shop"
},
"status": "unfulfilled",
"weight": "2.0 kg",
"created": "2024-01-17T15:12:46.359613+00:00",
"currency": "USD",
"discount": {
"amount": "0.00",
"currency": "USD"
},
"metadata": {},
"sub_status": null,
"user_email": "emily.smith@example.com",
"external_id": null,
"fulfillments": [],
"discount_name": null,
"payout_status": "not_ready",
"nautical_order": {
"id": "TmF1dGljYWxPcmRlcjo5NDA="
},
"shipping_price": {
"net": {
"amount": "15.00",
"currency": "USD"
},
"tax": {
"amount": "0.00",
"currency": "USD"
},
"gross": {
"amount": "15.00",
"currency": "USD"
}
},
"billing_address": {
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
"external_source": null,
"shipping_method": {
"id": "U2hpcHBpbmdNZXRob2Q6MjA=",
"price": {
"amount": "15.00",
"currency": "USD"
}
},
"private_metadata": {},
"shipping_address": {
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
"total_gross_amount": "248.10",
"shipping_price_net_amount": "15.00",
"is_shipping_price_overridden": false,
"nautical_event_type": "order_created",
"nautical_event_timestamp": "2023-09-09T23:42:46.698497-04:00"
}
Show more ↓
Order fulfilled
The order_fulfilled webhook event is triggered when all order lines in a seller order have been fulfilled, and the order status becomes FULFILLED
Sample payload body
{
"id": "T3JkZXI6MTU5MA==",
"user": {
"id": "VXNlcjoyMzQ=",
"note": "",
"email": "emily.smith@example.com",
"metadata": {},
"addresses": [
{
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
{
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
}
],
"is_active": true,
"last_name": "Buyer",
"first_name": "Emily",
"last_login": "2024-01-12T17:04:23.897288+00:00",
"date_joined": "2024-01-12T17:01:24.808178+00:00",
"external_id": null,
"company_name": "",
"is_anonymous": false,
"personal_phone": "",
"external_source": null,
"tax_exempt_code": null,
"private_metadata": {},
"default_billing_address": {
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
"default_shipping_address": {
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
"vat_identification_number": null
},
"lines": [
{
"id": "T3JkZXJMaW5lOjMzMjQ=",
"variant": {
"id": "UHJvZHVjdFZhcmlhbnQ6MjI2",
"sku": "",
"name": "Small",
"price": {
"amount": "222.00",
"currency": "USD"
},
"seller": {
"id": "U2VsbGVyOjg=",
"company_name": "Acme Dive Shop"
},
"status": "active",
"weight": "2.0 kg",
"product": {
"id": "UHJvZHVjdDo5Nw==",
"name": "Yellow Diving Fins",
"slug": "yellow-diving-fins",
"seller": {
"id": "U2VsbGVyOjg=",
"company_name": "Acme Dive Shop"
},
"status": "active",
"weight": null,
"category": {
"id": "Q2F0ZWdvcnk6MTg=",
"name": "Scuba Diving",
"slug": "scuba-diving"
},
"currency": "USD",
"metadata": {},
"created_at": "2023-08-24T18:35:42.800266+00:00",
"sub_status": "approved",
"updated_at": "2023-11-15T16:55:58.825735+00:00",
"collections": [
{
"id": "Q29sbGVjdGlvbjo2",
"slug": "featured",
"type": "product"
},
{
"id": "Q29sbGVjdGlvbjoyNA==",
"slug": "starrcollectiona",
"type": "product"
}
],
"description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. \n",
"charge_taxes": true,
"is_published": true,
"product_type": {
"id": "UHJvZHVjdFR5cGU6MTY=",
"name": "Diving Accessories ",
"slug": "diving-accessories",
"weight": "1.0 kg",
"metadata": {},
"is_digital": false,
"has_variants": true,
"private_metadata": {},
"is_shipping_required": true
},
"description_html": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.<p></p>",
"private_metadata": {},
"publication_date": "2023-08-24",
"minimal_variant_price_amount": "150.00"
},
"currency": "USD",
"metadata": {},
"is_master": false,
"seo_title": null,
"created_at": "2023-08-24T18:36:41.312631+00:00",
"sub_status": "approved",
"updated_at": "2023-11-15T16:54:54.976852+00:00",
"description": "Small size variant\n",
"price_amount": "222.00",
"seo_description": null,
"track_inventory": true,
"description_html": "Small size variant<p></p>",
"private_metadata": {},
"cost_price_amount": null,
"override_currency": false,
"is_user_defined_name": true,
"nautical_stock_number": "9e7f338e-c3c7-4683-98d3-11bc6bbecd62"
},
"currency": "USD",
"quantity": 1,
"vat_code": "",
"unit_price": {
"net": {
"amount": "222.00",
"currency": "USD"
},
"tax": {
"amount": "11.10",
"currency": "USD"
},
"gross": {
"amount": "233.10",
"currency": "USD"
}
},
"product_sku": "",
"total_price": {
"net": {
"amount": "222.00",
"currency": "USD"
},
"tax": {
"amount": "11.10",
"currency": "USD"
},
"gross": {
"amount": "233.10",
"currency": "USD"
}
},
"product_name": "Yellow Diving Fins",
"variant_name": "Small",
"quantity_declined": 0,
"quantity_fulfilled": 1,
"is_shipping_required": true,
"translated_product_name": "",
"translated_variant_name": "",
"is_line_price_overridden": false
}
],
"token": "540c349b-0c45-411e-b1b5-ad553b9d13e4",
"total": {
"net": {
"amount": "237.00",
"currency": "USD"
},
"tax": {
"amount": "11.10",
"currency": "USD"
},
"gross": {
"amount": "248.10",
"currency": "USD"
}
},
"seller": {
"id": "U2VsbGVyOjg=",
"company_name": "Acme Dive Shop"
},
"status": "fulfilled",
"weight": "2.0 kg",
"created": "2024-01-17T15:12:46.359613+00:00",
"currency": "USD",
"discount": {
"amount": "0.00",
"currency": "USD"
},
"metadata": {},
"sub_status": null,
"user_email": "emily.smith@example.com",
"external_id": null,
"fulfillments": [
{
"id": "RnVsZmlsbG1lbnQ6MzQz",
"status": "fulfilled",
"created": "2024-01-17T15:28:32.088991+00:00",
"updated": "2024-01-17T15:28:32.089023+00:00",
"tracking_number": ""
}
],
"discount_name": null,
"payout_status": "not_ready",
"nautical_order": {
"id": "TmF1dGljYWxPcmRlcjo5NDA="
},
"shipping_price": {
"net": {
"amount": "15.00",
"currency": "USD"
},
"tax": {
"amount": "0.00",
"currency": "USD"
},
"gross": {
"amount": "15.00",
"currency": "USD"
}
},
"billing_address": {
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
"external_source": null,
"shipping_method": {
"id": "U2hpcHBpbmdNZXRob2Q6MjA=",
"price": {
"amount": "15.00",
"currency": "USD"
}
},
"private_metadata": {},
"shipping_address": {
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
"total_gross_amount": "248.10",
"shipping_price_net_amount": "15.00",
"is_shipping_price_overridden": false,
"nautical_event_type": "order_fulfilled",
"nautical_event_timestamp": "2023-09-09T23:42:46.698497-04:00"
}
Show more ↓
Order fully paid
The order_fully_paid webhook event is triggered when payment is fully captured.
If the marketplace's payment gateway app is configured to not automatically capture payment, the payload is not sent immediately after checkout. This is because only payment authorization occurs at this stage. The payload is sent once the marketplace manually captures payment.
Sample payload body
{
"id": "T3JkZXI6MTU5MA==",
"user": {
"id": "VXNlcjoyMzQ=",
"note": "",
"email": "emily.smith@example.com",
"metadata": {},
"addresses": [
{
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
{
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
}
],
"is_active": true,
"last_name": "Buyer",
"first_name": "Emily",
"last_login": "2024-01-12T17:04:23.897288+00:00",
"date_joined": "2024-01-12T17:01:24.808178+00:00",
"external_id": null,
"company_name": "",
"is_anonymous": false,
"personal_phone": "",
"external_source": null,
"tax_exempt_code": null,
"private_metadata": {},
"default_billing_address": {
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
"default_shipping_address": {
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
"vat_identification_number": null
},
"lines": [
{
"id": "T3JkZXJMaW5lOjMzMjQ=",
"variant": {
"id": "UHJvZHVjdFZhcmlhbnQ6MjI2",
"sku": "",
"name": "Small",
"price": {
"amount": "222.00",
"currency": "USD"
},
"seller": {
"id": "U2VsbGVyOjg=",
"company_name": "Acme Dive Shop"
},
"status": "active",
"weight": "2.0 kg",
"product": {
"id": "UHJvZHVjdDo5Nw==",
"name": "Yellow Diving Fins",
"slug": "yellow-diving-fins",
"seller": {
"id": "U2VsbGVyOjg=",
"company_name": "Acme Dive Shop"
},
"status": "active",
"weight": null,
"category": {
"id": "Q2F0ZWdvcnk6MTg=",
"name": "Scuba Diving",
"slug": "scuba-diving"
},
"currency": "USD",
"metadata": {},
"created_at": "2023-08-24T18:35:42.800266+00:00",
"sub_status": "approved",
"updated_at": "2023-11-15T16:55:58.825735+00:00",
"collections": [
{
"id": "Q29sbGVjdGlvbjo2",
"slug": "featured",
"type": "product"
},
{
"id": "Q29sbGVjdGlvbjoyNA==",
"slug": "starrcollectiona",
"type": "product"
}
],
"description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. \n",
"charge_taxes": true,
"is_published": true,
"product_type": {
"id": "UHJvZHVjdFR5cGU6MTY=",
"name": "Diving Accessories ",
"slug": "diving-accessories",
"weight": "1.0 kg",
"metadata": {},
"is_digital": false,
"has_variants": true,
"private_metadata": {},
"is_shipping_required": true
},
"description_html": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.<p></p>",
"private_metadata": {},
"publication_date": "2023-08-24",
"minimal_variant_price_amount": "150.00"
},
"currency": "USD",
"metadata": {},
"is_master": false,
"seo_title": null,
"created_at": "2023-08-24T18:36:41.312631+00:00",
"sub_status": "approved",
"updated_at": "2023-11-15T16:54:54.976852+00:00",
"description": "Small size variant \n",
"price_amount": "222.00",
"seo_description": null,
"track_inventory": true,
"description_html": "Small size variant<p></p>",
"private_metadata": {},
"cost_price_amount": null,
"override_currency": false,
"is_user_defined_name": true,
"nautical_stock_number": "9e7f338e-c3c7-4683-98d3-11bc6bbecd62"
},
"currency": "USD",
"quantity": 1,
"vat_code": "",
"unit_price": {
"net": {
"amount": "222.00",
"currency": "USD"
},
"tax": {
"amount": "11.10",
"currency": "USD"
},
"gross": {
"amount": "233.10",
"currency": "USD"
}
},
"product_sku": "",
"total_price": {
"net": {
"amount": "222.00",
"currency": "USD"
},
"tax": {
"amount": "11.10",
"currency": "USD"
},
"gross": {
"amount": "233.10",
"currency": "USD"
}
},
"product_name": "Yellow Diving Fins",
"variant_name": "Small",
"quantity_declined": 0,
"quantity_fulfilled": 0,
"is_shipping_required": true,
"translated_product_name": "",
"translated_variant_name": "",
"is_line_price_overridden": false
}
],
"token": "540c349b-0c45-411e-b1b5-ad553b9d13e4",
"total": {
"net": {
"amount": "237.00",
"currency": "USD"
},
"tax": {
"amount": "11.10",
"currency": "USD"
},
"gross": {
"amount": "248.10",
"currency": "USD"
}
},
"seller": {
"id": "U2VsbGVyOjg=",
"company_name": "Acme Dive Shop"
},
"status": "unfulfilled",
"weight": "2.0 kg",
"created": "2024-01-17T15:12:46.359613+00:00",
"currency": "USD",
"discount": {
"amount": "0.00",
"currency": "USD"
},
"metadata": {},
"sub_status": null,
"user_email": "emily.smith@example.com",
"external_id": null,
"fulfillments": [],
"discount_name": null,
"payout_status": "not_ready",
"nautical_order": {
"id": "TmF1dGljYWxPcmRlcjo5NDA="
},
"shipping_price": {
"net": {
"amount": "15.00",
"currency": "USD"
},
"tax": {
"amount": "0.00",
"currency": "USD"
},
"gross": {
"amount": "15.00",
"currency": "USD"
}
},
"billing_address": {
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
"external_source": null,
"shipping_method": {
"id": "U2hpcHBpbmdNZXRob2Q6MjA=",
"price": {
"amount": "15.00",
"currency": "USD"
}
},
"private_metadata": {},
"shipping_address": {
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
"total_gross_amount": "248.10",
"shipping_price_net_amount": "15.00",
"is_shipping_price_overridden": false,
"nautical_event_type": "order_fully_paid",
"nautical_event_timestamp": "2023-09-09T23:42:46.698497-04:00"
}
Show more ↓
Order updated
The order_updated webhook event is triggered when a seller order is updated.
Sample payload body
{
"id": "T3JkZXI6MTU5MA==",
"user": {
"id": "VXNlcjoyMzQ=",
"note": "",
"email": "emily.smith@example.com",
"metadata": {},
"addresses": [
{
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
{
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
}
],
"is_active": true,
"last_name": "Buyer",
"first_name": "Emily",
"last_login": "2024-01-12T17:04:23.897288+00:00",
"date_joined": "2024-01-12T17:01:24.808178+00:00",
"external_id": null,
"company_name": "",
"is_anonymous": false,
"personal_phone": "",
"external_source": null,
"tax_exempt_code": null,
"private_metadata": {},
"default_billing_address": {
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
"default_shipping_address": {
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
"vat_identification_number": null
},
"lines": [
{
"id": "T3JkZXJMaW5lOjMzMjQ=",
"variant": {
"id": "UHJvZHVjdFZhcmlhbnQ6MjI2",
"sku": "",
"name": "Small",
"price": {
"amount": "222.00",
"currency": "USD"
},
"seller": {
"id": "U2VsbGVyOjg=",
"company_name": "Acme Dive Shop"
},
"status": "active",
"weight": "2.0 kg",
"product": {
"id": "UHJvZHVjdDo5Nw==",
"name": "Yellow Diving Fins",
"slug": "yellow-diving-fins",
"seller": {
"id": "U2VsbGVyOjg=",
"company_name": "Acme Dive Shop"
},
"status": "active",
"weight": null,
"category": {
"id": "Q2F0ZWdvcnk6MTg=",
"name": "Scuba Diving",
"slug": "scuba-diving"
},
"currency": "USD",
"metadata": {},
"created_at": "2023-08-24T18:35:42.800266+00:00",
"sub_status": "approved",
"updated_at": "2023-11-15T16:55:58.825735+00:00",
"collections": [
{
"id": "Q29sbGVjdGlvbjo2",
"slug": "featured",
"type": "product"
},
{
"id": "Q29sbGVjdGlvbjoyNA==",
"slug": "starrcollectiona",
"type": "product"
}
],
"description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. \n",
"charge_taxes": true,
"is_published": true,
"product_type": {
"id": "UHJvZHVjdFR5cGU6MTY=",
"name": "Diving Accessories ",
"slug": "diving-accessories",
"weight": "1.0 kg",
"metadata": {},
"is_digital": false,
"has_variants": true,
"private_metadata": {},
"is_shipping_required": true
},
"description_html": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. <p></p>",
"private_metadata": {},
"publication_date": "2023-08-24",
"minimal_variant_price_amount": "150.00"
},
"currency": "USD",
"metadata": {},
"is_master": false,
"seo_title": null,
"created_at": "2023-08-24T18:36:41.312631+00:00",
"sub_status": "approved",
"updated_at": "2023-11-15T16:54:54.976852+00:00",
"description": "Small size variant \n",
"price_amount": "222.00",
"seo_description": null,
"track_inventory": true,
"description_html": "Small size variant <p></p>",
"private_metadata": {},
"cost_price_amount": null,
"override_currency": false,
"is_user_defined_name": true,
"nautical_stock_number": "9e7f338e-c3c7-4683-98d3-11bc6bbecd62"
},
"currency": "USD",
"quantity": 1,
"vat_code": "",
"unit_price": {
"net": {
"amount": "222.00",
"currency": "USD"
},
"tax": {
"amount": "11.10",
"currency": "USD"
},
"gross": {
"amount": "233.10",
"currency": "USD"
}
},
"product_sku": "",
"total_price": {
"net": {
"amount": "222.00",
"currency": "USD"
},
"tax": {
"amount": "11.10",
"currency": "USD"
},
"gross": {
"amount": "233.10",
"currency": "USD"
}
},
"product_name": "Yellow Diving Fins",
"variant_name": "Small",
"quantity_declined": 0,
"quantity_fulfilled": 1,
"is_shipping_required": true,
"translated_product_name": "",
"translated_variant_name": "",
"is_line_price_overridden": false
}
],
"token": "540c349b-0c45-411e-b1b5-ad553b9d13e4",
"total": {
"net": {
"amount": "237.00",
"currency": "USD"
},
"tax": {
"amount": "11.10",
"currency": "USD"
},
"gross": {
"amount": "248.10",
"currency": "USD"
}
},
"seller": {
"id": "U2VsbGVyOjg=",
"company_name": "Acme Dive Shop"
},
"status": "fulfilled",
"weight": "2.0 kg",
"created": "2024-01-17T15:12:46.359613+00:00",
"currency": "USD",
"discount": {
"amount": "0.00",
"currency": "USD"
},
"metadata": {},
"sub_status": null,
"user_email": "emily.smith@example.com",
"external_id": null,
"fulfillments": [
{
"id": "RnVsZmlsbG1lbnQ6MzQz",
"status": "fulfilled",
"created": "2024-01-17T15:28:32.088991+00:00",
"updated": "2024-01-17T15:28:32.089023+00:00",
"tracking_number": ""
}
],
"discount_name": null,
"payout_status": "not_ready",
"nautical_order": {
"id": "TmF1dGljYWxPcmRlcjo5NDA="
},
"shipping_price": {
"net": {
"amount": "15.00",
"currency": "USD"
},
"tax": {
"amount": "0.00",
"currency": "USD"
},
"gross": {
"amount": "15.00",
"currency": "USD"
}
},
"billing_address": {
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
"external_source": null,
"shipping_method": {
"id": "U2hpcHBpbmdNZXRob2Q6MjA=",
"price": {
"amount": "15.00",
"currency": "USD"
}
},
"private_metadata": {},
"shipping_address": {
"city": "TORONTO",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "Smith",
"first_name": "Emily",
"postal_code": "M5V0G9",
"company_name": "",
"country_area": "ON",
"street_address_1": "123 Sesame Street",
"street_address_2": ""
},
"total_gross_amount": "248.10",
"shipping_price_net_amount": "15.00",
"is_shipping_price_overridden": false,
"nautical_event_type": "order_updated",
"nautical_event_timestamp": "2023-09-09T23:42:46.698497-04:00"
}
Show more ↓
Payment created
The payment_created webhook event is triggered when a payment is created. This happens, for instance, when a marketplace operator creates a manual payment against an order in the Dashboard.
Sample payload body
{
"id": "UGF5bWVudDo3Mjg=",
"total": "492.50",
"created": "2024-01-17T19:53:04.499908+00:00",
"gateway": "nautical.payments.wire",
"cc_brand": "",
"currency": "USD",
"modified": "2024-01-17T19:53:04.526705+00:00",
"is_active": true,
"to_confirm": false,
"billing_city": "TORONTO",
"billing_email": "emily.smith@example.com",
"charge_status": "fully-charged",
"captured_amount": "492.50",
"billing_address_1": "123 Sesame Street",
"billing_address_2": "",
"billing_city_area": "",
"billing_last_name": "Smith",
"billing_first_name": "Emily",
"billing_postal_code": "M5V0G9",
"payment_method_type": "",
"billing_company_name": "",
"billing_country_area": "ON",
"billing_country_code": "CA",
"nautical_event_type": "payment_created",
"nautical_event_timestamp": "2023-09-09T23:42:46.698497-04:00"
}
Show more ↓
Payout created
The payout_created webhook event is triggered when a payout is created.
Sample payload body
{
"id": "UGF5b3V0OjEz",
"status": "draft",
"created": "2023-12-04T20:40:53.155992+00:00",
"updated": "2023-12-04T20:40:53.157810+00:00",
"currency": "USD",
"end_date": "2023-12-04",
"start_date": null,
"vendor_type": "sellers",
"nautical_event_type": "payout_created",
"nautical_event_timestamp": "2023-09-09T23:42:46.698497-04:00"
}
Payout updated
The payout_updated webhook event is triggered upon updating a payout, such as adding adjustments or penalties, adding a seller payout note or locking the payout.
Sample payload body
{
"id": "UGF5b3V0OjEz",
"status": "draft",
"created": "2023-12-04T20:40:53.155992+00:00",
"updated": "2023-12-04T20:40:53.157810+00:00",
"currency": "USD",
"end_date": "2023-12-04",
"start_date": null,
"vendor_type": "sellers",
"nautical_event_type": "payout_updated",
"nautical_event_timestamp": "2023-09-09T23:42:46.698497-04:00"
}
Price book created
The price_book_created webhook event is triggered upon creating a price book.
Sample payload body
{
"id": "UHJpY2VCb29rOjE=",
"name": "Wholesale Club",
"type": "PriceBook",
"users": null,
"deleted": false,
"products": null,
"variants": null,
"product_types": null,
"nautical_event_type": "price_book_created",
"nautical_event_timestamp": "2023-09-09T23:42:46.698497-04:00"
}
Price book updated
The price_book_updated webhook event is triggered upon updating a price book. This includes adding or removing product types, products, or variant price adjustments, as well as adding or removing customers from the price book.
Sample payload body
{
"id": "UHJpY2VCb29rOjE=",
"name": "Wholesale Club",
"type": "PriceBook",
"users": [
{
"id": "VXNlcjoxMjc=",
"type": "User",
"email": "dannyg@example.com",
"last_name": "",
"first_name": ""
}
],
"deleted": false,
"products": [
{
"id": "UHJpY2VCb29rUHJvZHVjdDox",
"type": "PriceBookProduct",
"currency": "USD",
"percentage": "-10.00",
"value_type": "adjust_percentage",
"price_amount": "0.00"
}
],
"variants": [
{
"id": "UHJpY2VCb29rVmFyaWFudDox",
"type": "PriceBookVariant",
"currency": "USD",
"percentage": "0.00",
"value_type": "adjust_fixed",
"price_amount": "-2.00"
}
],
"product_types": null,
"nautical_event_type": "price_book_updated",
"nautical_event_timestamp": "2023-09-09T23:42:46.698497-04:00"
}
Show more ↓
Product created
The product_created webhook event is triggered when a new product is first saved. Any subsequent changes will be send in the product_updated webhook.
Sample payload body
{
"id": "UHJvZHVjdDozMzY=",
"name": "AquaGlide Pro Fins",
"slug": "aquaglide-pro-fins",
"seller": {
"id": "U2VsbGVyOjE=",
"company_name": "Nautical"
},
"status": "active",
"category": null,
"currency": "USD",
"metadata": {},
"created_at": "2023-12-07T15:38:09.460903+00:00",
"sub_status": "approved",
"updated_at": "2023-12-07T15:38:09.460874+00:00",
"collections": [],
"description": "Experience the ultimate in underwater mobility with AquaGlide Pro Fins. Designed for divers of all levels, these fins offer a perfect blend of comfort and efficiency.\n",
"charge_taxes": true,
"is_published": false,
"product_type": {
"id": "UHJvZHVjdFR5cGU6MTY=",
"name": "Diving Accessories ",
"slug": "diving-accessories",
"metadata": {},
"is_digital": false,
"has_variants": true,
"private_metadata": {},
"is_shipping_required": true
},
"description_html": "<span style=\"color: rgb(55, 65, 81); font-family: Söhne, ui-sans-serif, system-ui, -apple-system, "Segoe UI", Roboto, Ubuntu, Cantarell, "Noto Sans", sans-serif, "Helvetica Neue", Arial, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol", "Noto Color Emoji"; white-space-collapse: preserve;\">Experience the ultimate in underwater mobility with AquaGlide Pro Fins. Designed for divers of all levels, these fins offer a perfect blend of comfort and efficiency.</span><p></p>",
"private_metadata": {},
"publication_date": null,
"minimal_variant_price_amount": null,
"nautical_event_type": "product_created",
"nautical_event_timestamp": "2023-09-09T23:42:46.698497-04:00"
}
Show more ↓
Product deleted
The product_deleted webhook event is triggered by deleting a product.
Sample payload body
{
"id": "UHJvZHVjdDozMzY=",
"name": "AquaGlide Pro Fins",
"slug": "aquaglide-pro-fins",
"seller": {
"id": "U2VsbGVyOjE=",
"company_name": "Nautical"
},
"status": "active",
"category": {
"id": "Q2F0ZWdvcnk6MTg=",
"name": "Scuba Diving",
"slug": "scuba-diving",
"background_image": null,
"background_image_alt": "",
"allow_product_assignment": true
},
"currency": "USD",
"metadata": {},
"created_at": "2023-12-07T15:38:09.460903+00:00",
"sub_status": "approved",
"updated_at": "2023-12-07T16:08:23.035414+00:00",
"collections": [],
"description": "Experience the ultimate in underwater mobility with AquaGlide Pro Fins. Designed for divers of all levels, these fins offer a perfect blend of comfort and efficiency.\n",
"charge_taxes": true,
"is_published": true,
"product_type": {
"id": "UHJvZHVjdFR5cGU6MTY=",
"name": "Diving Accessories ",
"slug": "diving-accessories",
"metadata": {},
"is_digital": false,
"has_variants": true,
"private_metadata": {},
"is_shipping_required": true
},
"description_html": "<span style=\"color: rgb(55, 65, 81); font-family: Söhne, ui-sans-serif, system-ui, -apple-system, "Segoe UI", Roboto, Ubuntu, Cantarell, "Noto Sans", sans-serif, "Helvetica Neue", Arial, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol", "Noto Color Emoji"; white-space-collapse: preserve;\">Experience the ultimate in underwater mobility with AquaGlide Pro Fins. Designed for divers of all levels, these fins offer a perfect blend of comfort and efficiency.</span><p></p>",
"private_metadata": {},
"publication_date": "2023-12-07",
"minimal_variant_price_amount": "50.00",
"nautical_event_type": "product_deleted",
"nautical_event_timestamp": "2023-09-09T23:42:46.698497-04:00"
}
Show more ↓
Product updated
The product_updated payload will be sent when a change is made to an existing product. For example, editing the product name, description, price, visibility, quantity, and metadata.
Sample payload body
{
"id": "UHJvZHVjdDozMzY=",
"name": "AquaGlide Pro Fins",
"slug": "aquaglide-pro-fins",
"seller": {
"id": "U2VsbGVyOjE=",
"company_name": "Nautical"
},
"status": "active",
"category": {
"id": "Q2F0ZWdvcnk6MTg=",
"name": "Scuba Diving",
"slug": "scuba-diving",
"background_image": null,
"background_image_alt": "",
"allow_product_assignment": true
},
"currency": "USD",
"metadata": {},
"created_at": "2023-12-07T15:38:09.460903+00:00",
"sub_status": "approved",
"updated_at": "2023-12-07T15:57:29.375262+00:00",
"collections": [],
"description": "Experience the ultimate in underwater mobility with AquaGlide Pro Fins. Designed for divers of all levels, these fins offer a perfect blend of comfort and efficiency.\n",
"charge_taxes": true,
"is_published": true,
"product_type": {
"id": "UHJvZHVjdFR5cGU6MTY=",
"name": "Diving Accessories ",
"slug": "diving-accessories",
"metadata": {},
"is_digital": false,
"has_variants": true,
"private_metadata": {},
"is_shipping_required": true
},
"description_html": "<span style=\"color: rgb(55, 65, 81); font-family: Söhne, ui-sans-serif, system-ui, -apple-system, "Segoe UI", Roboto, Ubuntu, Cantarell, "Noto Sans", sans-serif, "Helvetica Neue", Arial, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol", "Noto Color Emoji"; white-space-collapse: preserve;\">Experience the ultimate in underwater mobility with AquaGlide Pro Fins. Designed for divers of all levels, these fins offer a perfect blend of comfort and efficiency.</span><p></p>",
"private_metadata": {},
"publication_date": "2023-12-07",
"minimal_variant_price_amount": "50.00",
"nautical_event_type": "product_updated",
"nautical_event_timestamp": "2023-09-09T23:42:46.698497-04:00"
}
Show more ↓
Seller created
The seller_created webhook event is triggered once a seller is created.
Sample payload body
{
"id": "U2VsbGVyOjE4",
"status": "PENDING",
"created": "2023-10-20T14:41:58.253556+00:00",
"updated": "2023-10-20T14:41:58.253556+00:00",
"company_name": "Acme Inc.",
"identification": null,
"fulfilled_by_marketplace": true,
"nautical_event_type": "seller_created",
"nautical_event_timestamp": "2023-09-09T23:42:46.698497-04:00"
}
Seller updated
The seller_updated webhook event is triggered when fields on a seller are updated.
Sample payload body
{
"id": "U2VsbGVyOjE4",
"status": "APPROVED",
"created": "2023-10-20T14:41:58.253556+00:00",
"updated": "2023-12-07T16:36:27.659523+00:00",
"company_name": "Acme Inc.",
"identification": null,
"fulfilled_by_marketplace": true,
"nautical_event_type": "seller_updated",
"nautical_event_timestamp": "2023-09-09T23:42:46.698497-04:00"
}
Seller agreement acknowledged
The seller_agreement_acknowledged webhook event is triggered when the seller's primary contact acknowledges the agreement assigned to the seller.
Sample payload body
{
"plan": {
"id": "QWdyZWVtZW50Ojg=",
"fees": [
{
"id": "QWdyZWVtZW50RmVlczoz",
"fee_name": "Percentage",
"fee_type": "percentage",
"fee_scope": "total",
"fee_value": "0.0100000"
}
],
"slug": "marketplace-agreement",
"title": "Marketplace Agreement ",
"content": "By operating under this marketplace you agree to the commission rate of 12.75%\n",
"fixed_fee": "0.00",
"is_active": false,
"seo_title": "",
"created_at": "2023-12-07T16:30:51.135406+00:00",
"fee_format": "per sale",
"updated_at": "2023-12-07T16:31:06.848439+00:00",
"vendor_type": "seller",
"content_html": "By operating under this marketplace you agree to the commission rate of 12.75%<p></p>",
"is_published": true,
"jurisdiction": "Worldwide",
"agreement_type": 1,
"commission_type": "marketplace",
"seo_description": "",
"publication_date": null,
"commission_uniform": true,
"default_commission": "0.12750",
"granular_commissions": [],
"markup_commission_type": "percentage",
"markup_commission_value": "0.1275000"
},
"seller": {
"id": "U2VsbGVyOjE4",
"status": "APPROVED",
"created": "2023-10-20T14:41:58.253556+00:00",
"updated": "2023-12-07T16:31:28.432042+00:00",
"company_name": "Acme Inc.",
"identification": null,
"fulfilled_by_marketplace": true
},
"acknowledged_on": "2023-12-07T16:32:02.286233+00:00",
"nautical_event_type": "seller_agreement_acknowledged",
"nautical_event_timestamp": "2023-12-07T23:42:46.698497-04:00"
}
Show more ↓
Variant created
The variant_created webhook event is triggered upon creating a variant.
Sample payload body
{
"id": "UHJvZHVjdFZhcmlhbnQ6Njk1",
"sku": "",
"name": "Black / XL",
"price": {
"amount": "50",
"currency": "USD"
},
"seller": {
"id": "U2VsbGVyOjE=",
"company_name": "Nautical"
},
"status": "active",
"product": {
"id": "UHJvZHVjdDozMzY=",
"name": "AquaGlide Pro Fins",
"slug": "aquaglide-pro-fins",
"seller": {
"id": "U2VsbGVyOjE=",
"company_name": "Nautical"
},
"status": "active",
"category": {
"id": "Q2F0ZWdvcnk6MTg=",
"name": "Scuba Diving",
"slug": "scuba-diving",
"background_image": null,
"background_image_alt": "",
"allow_product_assignment": true
},
"currency": "USD",
"metadata": {},
"created_at": "2023-12-07T15:38:09.460903+00:00",
"sub_status": "approved",
"updated_at": "2023-12-07T15:57:29.375262+00:00",
"collections": [],
"description": "Experience the ultimate in underwater mobility with AquaGlide Pro Fins. Designed for divers of all levels, these fins offer a perfect blend of comfort and efficiency.\n",
"charge_taxes": true,
"is_published": true,
"product_type": {
"id": "UHJvZHVjdFR5cGU6MTY=",
"name": "Diving Accessories ",
"slug": "diving-accessories",
"metadata": {},
"is_digital": false,
"has_variants": true,
"private_metadata": {},
"is_shipping_required": true
},
"description_html": "<span style=\"color: rgb(55, 65, 81); font-family: Söhne, ui-sans-serif, system-ui, -apple-system, "Segoe UI", Roboto, Ubuntu, Cantarell, "Noto Sans", sans-serif, "Helvetica Neue", Arial, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol", "Noto Color Emoji"; white-space-collapse: preserve;\">Experience the ultimate in underwater mobility with AquaGlide Pro Fins. Designed for divers of all levels, these fins offer a perfect blend of comfort and efficiency.</span><p></p>",
"private_metadata": {},
"publication_date": "2023-12-07",
"minimal_variant_price_amount": "50.00"
},
"currency": "USD",
"metadata": {},
"is_master": false,
"seo_title": null,
"created_at": "2023-12-07T16:01:23.479823+00:00",
"sub_status": "approved",
"updated_at": "2023-12-07T16:01:23.479879+00:00",
"description": "\n",
"price_amount": "50",
"seo_description": null,
"track_inventory": true,
"description_html": "<p></p>",
"private_metadata": {},
"cost_price_amount": null,
"override_currency": false,
"is_user_defined_name": true,
"nautical_stock_number": "d59d3d4c-1b92-4a06-89a9-36aaedccaa00",
"nautical_event_type": "variant_created",
"nautical_event_timestamp": "2023-12-07T23:42:46.698497-04:00"
}
Show more ↓
Variant deleted
The variant_deleted webhook event is triggered upon deleting a product variant.
Sample payload body
{
"id": "UHJvZHVjdFZhcmlhbnQ6Njkw",
"sku": "",
"name": "Powder / M",
"price": {
"amount": "50.00",
"currency": "USD"
},
"seller": {
"id": "U2VsbGVyOjE=",
"company_name": "Nautical"
},
"status": "active",
"product": {
"id": "UHJvZHVjdDozMzY=",
"name": "AquaGlide Pro Fins",
"slug": "aquaglide-pro-fins",
"seller": {
"id": "U2VsbGVyOjE=",
"company_name": "Nautical"
},
"status": "active",
"category": {
"id": "Q2F0ZWdvcnk6MTg=",
"name": "Scuba Diving",
"slug": "scuba-diving",
"background_image": null,
"background_image_alt": "",
"allow_product_assignment": true
},
"currency": "USD",
"metadata": {},
"created_at": "2023-12-07T15:38:09.460903+00:00",
"sub_status": "approved",
"updated_at": "2023-12-07T16:08:23.035414+00:00",
"collections": [],
"description": "Experience the ultimate in underwater mobility with AquaGlide Pro Fins. Designed for divers of all levels, these fins offer a perfect blend of comfort and efficiency.\n",
"charge_taxes": true,
"is_published": true,
"product_type": {
"id": "UHJvZHVjdFR5cGU6MTY=",
"name": "Diving Accessories ",
"slug": "diving-accessories",
"metadata": {},
"is_digital": false,
"has_variants": true,
"private_metadata": {},
"is_shipping_required": true
},
"description_html": "<span style=\"color: rgb(55, 65, 81); font-family: Söhne, ui-sans-serif, system-ui, -apple-system, "Segoe UI", Roboto, Ubuntu, Cantarell, "Noto Sans", sans-serif, "Helvetica Neue", Arial, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol", "Noto Color Emoji"; white-space-collapse: preserve;\">Experience the ultimate in underwater mobility with AquaGlide Pro Fins. Designed for divers of all levels, these fins offer a perfect blend of comfort and efficiency.</span><p></p>",
"private_metadata": {},
"publication_date": "2023-12-07",
"minimal_variant_price_amount": "50.00"
},
"currency": "USD",
"metadata": {},
"is_master": false,
"seo_title": null,
"created_at": "2023-12-07T15:57:26.435621+00:00",
"sub_status": "approved",
"updated_at": "2023-12-07T15:57:26.435656+00:00",
"description": "",
"price_amount": "50.00",
"seo_description": null,
"track_inventory": true,
"description_html": "<div></div>",
"private_metadata": {},
"cost_price_amount": null,
"override_currency": false,
"is_user_defined_name": false,
"nautical_stock_number": "2530e0b3-2951-48c4-b8a2-1c8783f8c996",
"nautical_event_type": "variant_deleted",
"nautical_event_timestamp": "2023-12-07T23:42:46.698497-04:00"
}
Show more ↓
Variant updated
The variant_updated webhook event is triggered upon updating a variant or adding metadata.
Sample payload body
{
"id": "UHJvZHVjdFZhcmlhbnQ6Njk1",
"sku": "",
"name": "Black / XL",
"price": {
"amount": "55",
"currency": "USD"
},
"seller": {
"id": "U2VsbGVyOjE=",
"company_name": "Nautical"
},
"status": "active",
"product": {
"id": "UHJvZHVjdDozMzY=",
"name": "AquaGlide Pro Fins",
"slug": "aquaglide-pro-fins",
"seller": {
"id": "U2VsbGVyOjE=",
"company_name": "Nautical"
},
"status": "active",
"category": {
"id": "Q2F0ZWdvcnk6MTg=",
"name": "Scuba Diving",
"slug": "scuba-diving",
"background_image": null,
"background_image_alt": "",
"allow_product_assignment": true
},
"currency": "USD",
"metadata": {},
"created_at": "2023-12-07T15:38:09.460903+00:00",
"sub_status": "approved",
"updated_at": "2023-12-07T16:08:23.035414+00:00",
"collections": [],
"description": "Experience the ultimate in underwater mobility with AquaGlide Pro Fins. Designed for divers of all levels, these fins offer a perfect blend of comfort and efficiency.\n",
"charge_taxes": true,
"is_published": true,
"product_type": {
"id": "UHJvZHVjdFR5cGU6MTY=",
"name": "Diving Accessories ",
"slug": "diving-accessories",
"metadata": {},
"is_digital": false,
"has_variants": true,
"private_metadata": {},
"is_shipping_required": true
},
"description_html": "<span style=\"color: rgb(55, 65, 81); font-family: Söhne, ui-sans-serif, system-ui, -apple-system, "Segoe UI", Roboto, Ubuntu, Cantarell, "Noto Sans", sans-serif, "Helvetica Neue", Arial, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol", "Noto Color Emoji"; white-space-collapse: preserve;\">Experience the ultimate in underwater mobility with AquaGlide Pro Fins. Designed for divers of all levels, these fins offer a perfect blend of comfort and efficiency.</span><p></p>",
"private_metadata": {},
"publication_date": "2023-12-07",
"minimal_variant_price_amount": "50.00"
},
"currency": "USD",
"metadata": {},
"is_master": false,
"seo_title": null,
"created_at": "2023-12-07T16:01:23.479823+00:00",
"sub_status": "approved",
"updated_at": "2023-12-07T16:13:45.623434+00:00",
"description": "\n",
"price_amount": "55",
"seo_description": null,
"track_inventory": true,
"description_html": "<p></p>",
"private_metadata": {},
"cost_price_amount": null,
"override_currency": false,
"is_user_defined_name": true,
"nautical_stock_number": "d59d3d4c-1b92-4a06-89a9-36aaedccaa00",
"nautical_event_type": "variant_updated",
"nautical_event_timestamp": "2023-12-07T23:42:46.698497-04:00"
}
Show more ↓
Refund created
The refund_created webhook event is triggered by initiating a refund on an order.
Sample payload body
{
"id": "UmVmdW5kOjEwMw==",
"name": "RefundOrder#289",
"type": "Refund",
"buyer": {
"id": "VXNlcjoxNDE=",
"type": "User",
"email": "vicki@example.com",
"last_name": "Greer",
"first_name": "Vicki"
},
"lines": null,
"order": [
{
"id": "TmF1dGljYWxPcmRlckxpbmU6MTEwNg==",
"type": "NauticalOrderLine"
}
],
"token": "b4ba4ae7-613e-4751-ae73-f41210e1e866",
"status": "requested",
"payments": null,
"external_id": null,
"nautical_event_type": "refund_created",
"nautical_event_timestamp": "2023-12-07T23:42:46.698497-04:00"
}
Show more ↓
Refund deleted
The refund_deleted webhook event is triggered by deleting a refund.
Sample payload body
{
"id": "UmVmdW5kOjE0NQ==",
"name": "Refund for faulty snowboard",
"buyer": {
"id": "VXNlcjoxNDE=",
"note": "",
"email": "vicki@example.com",
"metadata": {},
"addresses": [
{
"city": "AUBURNDALE",
"phone": "",
"country": "US",
"city_area": "",
"last_name": "Greer",
"first_name": "Vicki",
"postal_code": "33823",
"company_name": "Childrens Bargain Town",
"country_area": "FL",
"street_address_1": "2604 Mill Street",
"street_address_2": ""
},
{
"city": "AUBURNDALE",
"phone": "",
"country": "US",
"city_area": "",
"last_name": "Greer",
"first_name": "Vicki",
"postal_code": "33823",
"company_name": "Childrens Bargain Town",
"country_area": "FL",
"street_address_1": "2604 Mill Street",
"street_address_2": ""
}
],
"is_active": true,
"last_name": "Greer",
"first_name": "Vicki",
"last_login": null,
"date_joined": "2023-11-01T15:33:23.285704+00:00",
"external_id": null,
"company_name": "Childrens Bargain Town",
"is_anonymous": false,
"personal_phone": "",
"external_source": null,
"tax_exempt_code": null,
"private_metadata": {},
"default_billing_address": {
"city": "AUBURNDALE",
"phone": "",
"country": "US",
"city_area": "",
"last_name": "Greer",
"first_name": "Vicki",
"postal_code": "33823",
"company_name": "Childrens Bargain Town",
"country_area": "FL",
"street_address_1": "2604 Mill Street",
"street_address_2": ""
},
"default_shipping_address": {
"city": "AUBURNDALE",
"phone": "",
"country": "US",
"city_area": "",
"last_name": "Greer",
"first_name": "Vicki",
"postal_code": "33823",
"company_name": "Childrens Bargain Town",
"country_area": "FL",
"street_address_1": "2604 Mill Street",
"street_address_2": ""
},
"vat_identification_number": null
},
"lines": [],
"order": {
"id": "TmF1dGljYWxPcmRlcjozMzc=",
"user": {
"id": "VXNlcjoxNDE=",
"note": "",
"email": "vicki@example.com",
"metadata": {},
"addresses": [
{
"city": "AUBURNDALE",
"phone": "",
"country": "US",
"city_area": "",
"last_name": "Greer",
"first_name": "Vicki",
"postal_code": "33823",
"company_name": "Childrens Bargain Town",
"country_area": "FL",
"street_address_1": "2604 Mill Street",
"street_address_2": ""
},
{
"city": "AUBURNDALE",
"phone": "",
"country": "US",
"city_area": "",
"last_name": "Greer",
"first_name": "Vicki",
"postal_code": "33823",
"company_name": "Childrens Bargain Town",
"country_area": "FL",
"street_address_1": "2604 Mill Street",
"street_address_2": ""
}
],
"is_active": true,
"last_name": "Greer",
"first_name": "Vicki",
"last_login": null,
"date_joined": "2023-11-01T15:33:23.285704+00:00",
"external_id": null,
"company_name": "Childrens Bargain Town",
"is_anonymous": false,
"personal_phone": "",
"external_source": null,
"tax_exempt_code": null,
"private_metadata": {},
"default_billing_address": {
"city": "AUBURNDALE",
"phone": "",
"country": "US",
"city_area": "",
"last_name": "Greer",
"first_name": "Vicki",
"postal_code": "33823",
"company_name": "Childrens Bargain Town",
"country_area": "FL",
"street_address_1": "2604 Mill Street",
"street_address_2": ""
},
"default_shipping_address": {
"city": "AUBURNDALE",
"phone": "",
"country": "US",
"city_area": "",
"last_name": "Greer",
"first_name": "Vicki",
"postal_code": "33823",
"company_name": "Childrens Bargain Town",
"country_area": "FL",
"street_address_1": "2604 Mill Street",
"street_address_2": ""
},
"vat_identification_number": null
},
"token": "ff8bca5b-688c-4136-b78f-b16d0c00962c",
"total": {
"net": "Money('754.95', 'USD')",
"tax": "Money('52.85', 'USD')",
"gross": "Money('807.80', 'USD')"
},
"user_email": "vicki@example.com",
"billing_address": {
"city": "AUBURNDALE",
"phone": "",
"country": "US",
"city_area": "",
"last_name": "Greer",
"first_name": "Vicki",
"postal_code": "33823",
"company_name": "Childrens Bargain Town",
"country_area": "FL",
"street_address_1": "2604 Mill Street",
"street_address_2": ""
},
"shipping_address": {
"city": "AUBURNDALE",
"phone": "",
"country": "US",
"city_area": "",
"last_name": "Greer",
"first_name": "Vicki",
"postal_code": "33823",
"company_name": "Childrens Bargain Town",
"country_area": "FL",
"street_address_1": "2604 Mill Street",
"street_address_2": ""
}
},
"token": "be1d92d0-9a40-4955-88a8-fff6e826a506",
"status": "requested",
"metadata": {},
"payments": [],
"created_at": "2023-12-04T20:33:36.554692+00:00",
"updated_at": "2023-12-04T20:33:36.554722+00:00",
"description": "",
"external_id": null,
"description_html": "<div></div>",
"private_metadata": {},
"nautical_event_type": "refund_deleted",
"nautical_event_timestamp": "2023-12-07T23:42:46.698497-04:00"
}
Show more ↓
Refund updated
The refund_updated webhook event is triggered by updating a refund on an order, such as adding or changing refund lines. This is also triggered by changing the refund status, such as approving or cancelling the refund.
Sample payload body
{
"id": "UmVmdW5kOjEwMw==",
"name": "RefundOrder#289",
"type": "Refund",
"buyer": {
"id": "VXNlcjoxNDE=",
"type": "User",
"email": "vicki@example.com",
"last_name": "Greer",
"first_name": "Vicki"
},
"lines": [
{
"id": "UmVmdW5kTGluZTo4Mg==",
"type": "RefundLine",
"currency": "USD",
"quantity": 1,
"line_type": "Percentage",
"charged_to": "Marketplace",
"line_scope": "SellerOrder",
"percentage": "50.00",
"refund_scope_id": 506,
"total_net_amount": "120.00",
"total_gross_amount": "128.40"
}
],
"order": [
{
"id": "TmF1dGljYWxPcmRlckxpbmU6MTEwNg==",
"type": "NauticalOrderLine"
}
],
"token": "b4ba4ae7-613e-4751-ae73-f41210e1e866",
"status": "approved",
"payments": null,
"external_id": null,
"nautical_event_type": "refund_updated",
"nautical_event_timestamp": "2023-12-07T23:42:46.698497-04:00"
}
Show more ↓
Stock created
The stock_created webhook event is triggered upon assigning inventory to a variant.
Sample payload body
{
"stock": {
"id": "U3RvY2s6ODM3",
"quantity": 50,
"warehouse": {
"id": "V2FyZWhvdXNlOjE1NGIwOGMwLWFhOTEtNDUzNC1hNTAwLTljM2E3MjEwMDViZA==",
"name": "Americas",
"slug": "americas",
"seller": {
"id": "U2VsbGVyOjE=",
"status": "APPROVED",
"created": null,
"updated": "2023-11-07T15:54:19.869061+00:00",
"company_name": "Nautical",
"identification": [
"12345"
],
"fulfilled_by_marketplace": false
},
"address": {
"city": "MCCARTHYCHESTER",
"phone": "",
"country": "US",
"city_area": "",
"last_name": "",
"first_name": "",
"postal_code": "83723",
"company_name": "",
"country_area": "ID",
"street_address_1": "1503 Mackenzie Ranch Apt. 921",
"street_address_2": ""
},
"company_name": "Young, Barnes and Hudson"
},
"product_variant": {
"id": "UHJvZHVjdFZhcmlhbnQ6Njk0",
"sku": "",
"name": "Electric / L",
"seller": {
"id": "U2VsbGVyOjE=",
"company_name": "Nautical"
},
"product": {
"id": "UHJvZHVjdDozMzY=",
"name": "AquaGlide Pro Fins",
"slug": "aquaglide-pro-fins",
"seller": {
"id": "U2VsbGVyOjE=",
"company_name": "Nautical"
},
"product_type": {
"id": "UHJvZHVjdFR5cGU6MTY=",
"name": "Diving Accessories ",
"slug": "diving-accessories",
"metadata": {},
"is_digital": false,
"has_variants": true,
"private_metadata": {},
"is_shipping_required": true
}
}
},
"quantity_allocated": 0,
"quantity_available": 50,
"out_of_stock_threshold": 0
},
"stock_change": {
"new": {
"quantity": 50,
"quantity_allocated": 0,
"quantity_available": 50
},
"old": null
},
"nautical_event_type": "stock_created",
"nautical_event_timestamp": "2023-12-07T23:42:46.698497-04:00"
}
Show more ↓
Stock deleted
The stock_deleted webhook event is triggered by deleting stock at a given warehouse from a product variant.
Sample payload body
{
"stock": {
"id": "U3RvY2s6ODM4",
"quantity": 5,
"warehouse": {
"id": "V2FyZWhvdXNlOjgxMWNkMGM4LTM0YTctNDIzYy1hNDJlLTkyYTM0ZTUzMmUxMA==",
"name": "Snow City Warehouse",
"slug": "snow-city-warehouse-2",
"seller": {
"id": "U2VsbGVyOjEx",
"status": "APPROVED",
"created": "2023-10-05T15:33:17.177313+00:00",
"updated": "2023-10-05T15:34:14.447152+00:00",
"company_name": "Hetal's Company",
"identification": null,
"fulfilled_by_marketplace": true
},
"address": {
"city": "",
"phone": "",
"country": "CA",
"city_area": "",
"last_name": "",
"first_name": "",
"postal_code": "",
"company_name": "Snow City Warehouse",
"country_area": "",
"street_address_1": "",
"street_address_2": ""
},
"company_name": ""
},
"product_variant": {
"id": "UHJvZHVjdFZhcmlhbnQ6Mjc2",
"sku": "APDM-3000P",
"name": "AquaPro DiveMate 3000 Plus",
"seller": {
"id": "U2VsbGVyOjk=",
"company_name": "Nemo Dive Shop"
},
"product": {
"id": "UHJvZHVjdDoxMjk=",
"name": "AquaPro DiveMate 3000",
"slug": "aquapro-divemate-3000",
"seller": {
"id": "U2VsbGVyOjk=",
"company_name": "Nemo Dive Shop"
},
"product_type": {
"id": "UHJvZHVjdFR5cGU6MTY=",
"name": "Diving Accessories ",
"slug": "diving-accessories",
"metadata": {},
"is_digital": false,
"has_variants": true,
"private_metadata": {},
"is_shipping_required": true
}
}
},
"quantity_allocated": 0,
"quantity_available": 5,
"out_of_stock_threshold": 0
},
"stock_change": {
"new": {
"quantity": 0,
"quantity_allocated": 0,
"quantity_available": 0
},
"old": {
"quantity": 5,
"quantity_allocated": 0,
"quantity_available": 5
}
},
"nautical_event_type": "stock_deleted",
"nautical_event_timestamp": "2023-12-07T23:42:46.698497-04:00"
}
Show more ↓
Stock updated
The stock_updated webhook event is triggered upon modifying the quantity of variant stock in a warehouse.
Sample payload body
{
"stock": {
"id": "U3RvY2s6NDA4",
"quantity": 15,
"warehouse": {
"id": "V2FyZWhvdXNlOjE1NGIwOGMwLWFhOTEtNDUzNC1hNTAwLTljM2E3MjEwMDViZA==",
"name": "Americas",
"slug": "americas",
"seller": {
"id": "U2VsbGVyOjE=",
"status": "APPROVED",
"created": null,
"updated": "2023-11-07T15:54:19.869061+00:00",
"company_name": "Nautical",
"identification": [
"12345"
],
"fulfilled_by_marketplace": false
},
"address": {
"city": "MCCARTHYCHESTER",
"phone": "",
"country": "US",
"city_area": "",
"last_name": "",
"first_name": "",
"postal_code": "83723",
"company_name": "",
"country_area": "ID",
"street_address_1": "1503 Mackenzie Ranch Apt. 921",
"street_address_2": ""
},
"company_name": "Young, Barnes and Hudson"
},
"product_variant": {
"id": "UHJvZHVjdFZhcmlhbnQ6Mjc2",
"sku": "APDM-3000P",
"name": "AquaPro DiveMate 3000 Plus",
"seller": {
"id": "U2VsbGVyOjk=",
"company_name": "Nemo Dive Shop"
},
"product": {
"id": "UHJvZHVjdDoxMjk=",
"name": "AquaPro DiveMate 3000",
"slug": "aquapro-divemate-3000",
"seller": {
"id": "U2VsbGVyOjk=",
"company_name": "Nemo Dive Shop"
},
"product_type": {
"id": "UHJvZHVjdFR5cGU6MTY=",
"name": "Diving Accessories ",
"slug": "diving-accessories",
"metadata": {},
"is_digital": false,
"has_variants": true,
"private_metadata": {},
"is_shipping_required": true
}
}
},
"quantity_allocated": 12,
"quantity_available": -7,
"out_of_stock_threshold": -10
},
"stock_change": {
"new": {
"quantity": 15,
"quantity_allocated": 12,
"quantity_available": 3
},
"old": {
"quantity": 5,
"quantity_allocated": 12,
"quantity_available": -7
}
},
"nautical_event_type": "stock_updated",
"nautical_event_timestamp": "2023-12-07T23:42:46.698497-04:00"
}
Show more ↓
Stock allocated
The stock_allocated webhook event is triggered when stock is allocated to an order.
Sample payload body
{
"allocation": {
"id": "QWxsb2NhdGlvbjoxMDQy",
"stock": {
"id": "U3RvY2s6NDI3",
"quantity": 3243,
"warehouse": {
"id": "V2FyZWhvdXNlOjE1NGIwOGMwLWFhOTEtNDUzNC1hNTAwLTljM2E3MjEwMDViZA==",
"name": "Americas",
"slug": "americas",
"seller": {
"id": "U2VsbGVyOjE=",
"status": "APPROVED",
"created": null,
"updated": "2023-11-07T15:54:19.869061+00:00",
"company_name": "Nautical",
"identification": [
"12345"
],
"fulfilled_by_marketplace": false
},
"address": {
"city": "NYC",
"phone": "",
"country": "US",
"city_area": "",
"last_name": "",
"first_name": "",
"postal_code": "83723",
"company_name": "",
"country_area": "ID",
"street_address_1": "1503 Mackenzie Ranch Apt. 921",
"street_address_2": ""
},
"company_name": "Diving Co."
},
"product_variant": {
"id": "UHJvZHVjdFZhcmlhbnQ6Mjkz",
"sku": "",
"name": "",
"seller": {
"id": "U2VsbGVyOjEy",
"company_name": "Acme Inc."
},
"product": {
"id": "UHJvZHVjdDoxNDg=",
"name": "Diving Kit",
"slug": "diving-kit",
"seller": {
"id": "U2VsbGVyOjEy",
"company_name": "Acme Inc."
}
}
},
"quantity_allocated": 4,
"quantity_available": 3239,
"out_of_stock_threshold": 0
},
"order_line": {
"id": "T3JkZXJMaW5lOjEwNTA=",
"order": {
"id": "T3JkZXI6NTA2"
}
},
"quantity_allocated": 2
},
"stock_change": {
"new": {
"quantity": 3243,
"quantity_allocated": 4,
"quantity_available": 3239
},
"old": {
"quantity": 3243,
"quantity_allocated": 3,
"quantity_available": 3240
}
},
"nautical_event_type": "stock_allocated",
"nautical_event_timestamp": "2023-12-07T23:42:46.698497-04:00"
}
Show more ↓
Stock deallocated
The stock_deallocated webhook event is triggered by order stock fulfillment or removal/cancellation of order line items.
Sample payload body
{
"allocation": {
"id": "QWxsb2NhdGlvbjoxMDQy",
"stock": {
"id": "U3RvY2s6NDI3",
"quantity": 3243,
"warehouse": {
"id": "V2FyZWhvdXNlOjE1NGIwOGMwLWFhOTEtNDUzNC1hNTAwLTljM2E3MjEwMDViZA==",
"name": "Americas",
"slug": "americas",
"seller": {
"id": "U2VsbGVyOjE=",
"status": "APPROVED",
"created": null,
"updated": "2023-11-07T15:54:19.869061+00:00",
"company_name": "Nautical",
"identification": [
"12345"
],
"fulfilled_by_marketplace": false
},
"address": {
"city": "NYC",
"phone": "",
"country": "US",
"city_area": "",
"last_name": "",
"first_name": "",
"postal_code": "83723",
"company_name": "",
"country_area": "ID",
"street_address_1": "1503 Mackenzie Ranch Apt. 921",
"street_address_2": ""
},
"company_name": "Diving Co."
},
"product_variant": {
"id": "UHJvZHVjdFZhcmlhbnQ6Mjkz",
"sku": "",
"name": "",
"seller": {
"id": "U2VsbGVyOjEy",
"company_name": "Acme Inc."
},
"product": {
"id": "UHJvZHVjdDoxNDg=",
"name": "Diving Kit",
"slug": "diving-kit",
"seller": {
"id": "U2VsbGVyOjEy",
"company_name": "Acme Inc."
}
}
},
"quantity_allocated": 4,
"quantity_available": 3239,
"out_of_stock_threshold": 0
},
"order_line": {
"id": "T3JkZXJMaW5lOjEwNTA=",
"order": {
"id": "T3JkZXI6NTA2"
}
},
"quantity_allocated": 0
},
"stock_change": {
"new": {
"quantity": 3243,
"quantity_allocated": 2,
"quantity_available": 3241
},
"old": {
"quantity": 3243,
"quantity_allocated": 4,
"quantity_available": 3239
}
},
"nautical_event_type": "stock_deallocated",
"nautical_event_timestamp": "2023-12-07T23:42:46.698497-04:00"
}
Show more ↓
Vendor payout created
The vendor_payout_created webhook is triggered by creating a vendor payout.
Sample payload body
{
"id": "VmVuZG9yUGF5b3V0OjE4",
"net": "81.00",
"gross": "86.67",
"taxes": "5.67",
"status": "unpaid",
"average": "86.67",
"created": "2023-12-04T20:40:53.184540+00:00",
"updated": "2023-12-04T20:40:53.185313+00:00",
"currency": "USD",
"included": true,
"metadata": {},
"shipping": "15.00",
"discounts": "0.00",
"commission": "9.90",
"payout_amount": "56.10",
"refund_amount": "0.00",
"penalty_amount": "0.00",
"status_message": null,
"private_metadata": {},
"volume_discounts": "0.00",
"adjustment_amount": "0.00",
"nautical_event_type": "vendor_payout_created",
"nautical_event_timestamp": "2023-12-07T23:42:46.698497-04:00"
}
Show more ↓
Vendor payout updated
The vendor_payout_updated webhook event is triggered upon updating a seller payout, such as adding adjustments or penalties, adding a seller payout note or locking the payout.
Sample payload body
{
"id": "VmVuZG9yUGF5b3V0OjE4",
"net": "81.00",
"gross": "86.67",
"taxes": "5.67",
"status": "unpaid",
"average": "86.67",
"created": "2023-12-04T20:40:53.184540+00:00",
"updated": "2023-12-04T20:40:53.185313+00:00",
"currency": "USD",
"included": true,
"metadata": {},
"shipping": "15.00",
"discounts": "0.00",
"commission": "9.90",
"payout_amount": "56.10",
"refund_amount": "0.00",
"penalty_amount": "-5.00",
"status_message": null,
"private_metadata": {},
"volume_discounts": "0.00",
"adjustment_amount": "0.00",
"nautical_event_type": "vendor_payout_updated",
"nautical_event_timestamp": "2023-12-07T23:42:46.698497-04:00"
}
Show more ↓
Warehouse created
The warehouse_created webhook event is triggered when you create a warehouse.
Sample payload body
{
"id": "V2FyZWhvdXNlOjlhZDY5MzI0LTJhZWYtNDlhOC04YTU2LTY0ZDI4ZTFkYjAyMg==",
"name": "Acme Main Warehouse",
"slug": "acme-main-warehouse",
"seller": {
"id": "U2VsbGVyOjE=",
"status": "APPROVED",
"created": null,
"updated": "2023-11-07T15:54:19.869061+00:00",
"company_name": "Nautical",
"identification": [
"12345"
],
"fulfilled_by_marketplace": false
},
"address": {
"city": "WESTERVILLE",
"phone": "",
"country": "US",
"city_area": "",
"last_name": "",
"first_name": "",
"postal_code": "43081",
"company_name": "",
"country_area": "OH",
"street_address_1": "3160 Quilly Lane",
"street_address_2": ""
},
"company_name": "Acme",
"nautical_event_type": "warehouse_created",
"nautical_event_timestamp": "2023-12-07T23:42:46.698497-04:00"
}
Show more ↓
Warehouse deleted
The warehouse_deleted webhook event is triggered by deleting a warehouse.
Sample payload body
{
"id": "V2FyZWhvdXNlOjlhZDY5MzI0LTJhZWYtNDlhOC04YTU2LTY0ZDI4ZTFkYjAyMg==",
"name": "Acme Main Warehouse",
"slug": "acme-main-warehouse",
"seller": {
"id": "U2VsbGVyOjE=",
"status": "APPROVED",
"created": null,
"updated": "2023-11-07T15:54:19.869061+00:00",
"company_name": "Nautical",
"identification": [
"12345"
],
"fulfilled_by_marketplace": false
},
"address": {
"city": "WESTERVILLE",
"phone": "",
"country": "US",
"city_area": "",
"last_name": "",
"first_name": "",
"postal_code": "43081",
"company_name": "",
"country_area": "OH",
"street_address_1": "3160 Quilly Lane",
"street_address_2": "Unit 10"
},
"company_name": "Acme",
"nautical_event_type": "warehouse_deleted",
"nautical_event_timestamp": "2023-12-07T23:42:46.698497-04:00"
}
Show more ↓
Warehouse updated
The warehouse_updated webhook event is triggered by updating a warehouse, including assigning shipping zones.
Sample payload body
{
"id": "V2FyZWhvdXNlOjlhZDY5MzI0LTJhZWYtNDlhOC04YTU2LTY0ZDI4ZTFkYjAyMg==",
"name": "Acme Main Warehouse",
"slug": "acme-main-warehouse",
"seller": {
"id": "U2VsbGVyOjE=",
"status": "APPROVED",
"created": null,
"updated": "2023-11-07T15:54:19.869061+00:00",
"company_name": "Nautical",
"identification": [
"12345"
],
"fulfilled_by_marketplace": false
},
"address": {
"city": "WESTERVILLE",
"phone": "",
"country": "US",
"city_area": "",
"last_name": "",
"first_name": "",
"postal_code": "43081",
"company_name": "",
"country_area": "OH",
"street_address_1": "3160 Quilly Lane",
"street_address_2": "Unit 10"
},
"company_name": "Acme",
"nautical_event_type": "warehouse_updated",
"nautical_event_timestamp": "2023-12-07T23:42:46.698497-04:00"
}
Show more ↓