​
Webhook taxonomy

{
  "id": "hg9b8xyc-a128-4659-9c84-e3b376607977",
  "requestId": "d222c412-fbc8-4e59-8cef-b57696bxyz11",
  "developerId": "xDasf23Jk4LKlxOq",
  "createdAt": "2023-06-27T12:00:00Z",
  "type": "PAYMENT_SUCCEEDED",
  "data": {
    "marketplace": "shopify",
    "amount": 100
  }
}

Note: You should interpret the PRODUCT_UPDATED webhook as an upsert, as Rye currently does not send a separate event for when products are first created inside our system. This behavior is likely to change in future, as firing a separate PRODUCT_CREATED event is on our roadmap.

Product related webhooks are fired when our product catalog is updated. Subscriptions are created for your account when you request a product or store to be tracked by the Sell Anything API.

The product field in the webhook payload comes in a similar format to the response of the productByID query.

{
  "id": "ffd4ee63-b911-48a2-84fe-8ba445746b0b",
  "developerId": "xDasf23Jk4LKlxOq",
  "createdAt": "2024-03-22T23:57:48.009Z",
  "type": "PRODUCT_UPDATED",
  "marketplace": "amazon",
  "data": {
    "product": {
      "id": "B00A2KD8NY",
      "title": "OXO Good Grips 3-in-1 Egg Separator, White/Yellow 1 Count (Pack of 1)",
      "url": "https://www.amazon.com/OXO-Good-Grips-Separator-White/dp/B00A2KD8NY",
      "vendor": "OXO",
      // ...
    }
  }
}

{
  "id": "hg9b8xyc-a128-4659-9c84-e3b376607977",
  "requestId": "d222c412-fbc8-4e59-8cef-b57696bxyz11",
  "developerId": "xDasf23Jk4LKlxOq",
  "createdAt": "2023-06-27T12:00:03Z",
  "type": "ORDER_SUBMISSION_STARTED",
  "data": {
    "marketplace": "shopify"
  }
}

{
  "id": "hg9b8xyc-a128-4659-9c84-e3b376607977",
  "requestId": "d222c412-fbc8-4e59-8cef-b57696bxyz11",
  "developerId": "xDasf23Jk4LKlxOq",
  "createdAt": "2023-06-27T12:00:03Z",
  "type": "ORDER_CANCEL_STARTED",
  "data": {
    "marketplace": "amazon",
    "startedAt": "2023-09-07T17:49:07.267Z"
  }
}

{
  "id": "hg9b8xyc-a128-4659-9c84-e3b376607977",
  "requestId": "d222c412-fbc8-4e59-8cef-b57696bxyz11",
  "developerId": "xDasf23Jk4LKlxOq",
  "createdAt": "2023-06-27T12:00:06Z",
  "type": "ORDER_PLACED",
  "data": {
    "marketplace": "shopify",
    "order": {
      "currency": "USD",
      "shippingCents": 500,
      "subtotalCents": 2000,
      "taxCents": 200,
      "totalCents": 2700,
    },
    "orderEmailOverride": "email-override-used@rye.com"
  }
}

​
Order requires action webhooks

{
  "id": "hg9b8xyc-a128-4659-9c84-e3b376607977",
  "requestId": "d222c412-fbc8-4e59-8cef-b57696bxyz11",
  "developerId": "xDasf23Jk4LKlxOq",
  "createdAt": "2023-06-27T12:00:06Z",
  "type": "ORDER_REQUIRES_ACTION",
  "data": {
    "order": {
      "requiredActions": {
        "CompletePaymentChallenge": {
          "redirectURL": "https://hooks.stripe.com/redirect/authenticate/src_1OZJBQHGDlstla3f4WO2gYDJ?client_secret=src_client_secret_dRbH7vMWvHpueFHzo8ZDpMdo&source_redirect_slug=test_YWNjdF8xTGdEaHJIR0Rsc3RsYTNmLF9QTzVNNGlGdzNyenlMZHRXeDduVnE3bDh2ZGp2TEdS0100HDag50jR",
          "type": "CompletePaymentChallenge",
        },
      }
    },
  }
}

List of possible shipping carriers can be found here.

{
  "id": "hg9b8xyc-a128-4659-9c84-e3b376607977",
  "requestId": "d222c412-fbc8-4e59-8cef-b57696bxyz11",
  "developerId": "xDasf23Jk4LKlxOq",
  "createdAt": "2023-06-27T12:00:09Z",
  "type": "TRACKING_OBTAINED",
  "data": {
    "marketplace": "shopify",
    "order": {
      "fulfillments": [
        {
          "products": [
            {
              "quantity": 1,
              "variantId": "41160207204557"
            }
          ],
          "trackingDetails": [
            {
              "trackingNumber": "1Z87F765679738",
              "courierUrl": "https://www.ups.com/WebTracking?loc=en_US&requester=ST&trackNums=1Z87F765679738",
              "courierName": "UPS"
            }
          ]
        }
      ]
    }
  }
}

{
  "id": "hg9b8xyc-a128-4659-9c84-e3b376607977",
  "requestId": "d222c412-fbc8-4e59-8cef-b57696bxyz11",
  "developerId": "xDasf23Jk4LKlxOq",
  "createdAt": "2023-06-27T12:00:09Z",
  "type": "RETURN_REQUESTED",
  "data": {
    "marketplace": "shopify",
    "returnId": "123456",
    "requestedAt": "2023-06-27T12:00:09Z",
    "requestedLineItems": [
      {
        "variantId": "123456"
      }
    ]
  }
}

{
  "id": "hg9b8xyc-a128-4659-9c84-e3b376607977",
  "requestId": "d222c412-fbc8-4e59-8cef-b57696bxyz11",
  "developerId": "xDasf23Jk4LKlxOq",
  "createdAt": "2023-06-27T12:00:09Z",
  "type": "RETURN_REQUESTED",
  "data": {
    "marketplace": "amazon",
    "returnId": "123456",
    "requestedAt": "2023-06-27T12:00:09Z",
    "requestedLineItems": [
      {
        "productId": "123456",
        "status": "RETURN_REQUESTED",
      }
    ]
  }
}

​
Sync API webhooks

If you are integrated with a Shopify merchant, we will send you webhooks when the state of the Rye Shopify app or sales channel changes.

We fire SHOPIFY_APP_CONNECTED and SHOPIFY_APP_DISCONNECTED events when the Shopify app is installed or uninstalled from the merchant’s store.

We also fire events when the set of products published to our sales channel updates:

  • SHOPIFY_PRODUCT_UPDATED - Fired when the product is published to the Rye sales channel, or when a product published to the Rye sales channel is updated (e.g. the merchant might have changed the product description).
  • SHOPIFY_PRODUCT_DELETED - Fired when a product is unpublished from the Rye sales channel.
{
  "id": "hg9b8xyc-a128-4659-9c84-e3b376607977",
  "developerId": "xDasf23Jk4LKlxOq",
  "createdAt": "2023-06-27T12:00:09Z",
  "type": "SHOPIFY_APP_CONNECTED",
  "data": {
    "shopDomain": "rye.myshopify.com",
  }
}

{
  "type": "EXPERIMENTAL_ORDER_AFFILIATE_COMMISSION_UPDATED",
  "developerId": "xDasf23Jk4LKlxOq",
  "requestId": "123e4567-e89b-12d3-a456-426614174000",
  "data": {
    "commission": {
      "__typename": "ExperimentalAffiliateCommissionPending",
      "updatedAt": "2024-08-27T12:00:00Z"
    }
  }
}

Was this page helpful?