RYrye-com
Test Helpers

Advance simulated shipment

Changed on

Advance the simulated shipment for a checkout intent. To trigger delayed or canceled shipping scenarios, create the checkout intent with a matching shipping and delivery test product: https://rye.com/docs/api-v2/testing/test-products#shipping-&-delivery

post/api/v1/test-helpers/checkout-intents/{checkoutIntentId}/shipments/advance

Request

  • Base URL
    https://staging.api.rye.com
  • URL
    https://staging.api.rye.com/api/v1/test-helpers/checkout-intents/{checkoutIntentId}/shipments/advance
  • Auth
    API key in header Authorization

Path parameters

checkoutIntentIdstring required

Response

The advanced simulated shipment state

Changes