Skip to content
elasticStageDeveloper Portal

Overview

elasticStage Platform API 0.1.0

Section titled “elasticStage Platform API 0.1.0”

API consumed by the elasticStage Shopify App.

Information

  • OpenAPI version: 3.1.0

Operations

Section titled “Operations”
GET
/v1/creator
GET
/v1/releases/{id}
GET
/v1/releases
GET
/v1/shipping-services
POST
/v1/shipping-rates
GET
/v1/orders/{id}
GET
/v1/orders
POST
/v1/orders
DELETE
/v1/webhooks/{id}
GET
/v1/webhooks/{id}
GET
/v1/webhooks
POST
/v1/webhooks
PATCH
/v1/webhooks/{id}
GET
/health/live
GET
/health/ready
POST
`order.cancelled` event WEBHOOK
POST
`order.created` event WEBHOOK
POST
`order.delivered` event WEBHOOK
POST
`order.payment_failed` event WEBHOOK
POST
`order.processing` event WEBHOOK
POST
`order.shipped` event WEBHOOK
POST
`order.tracking_updated` event WEBHOOK
POST
`product.available` event WEBHOOK
POST
`product.in_stock` event WEBHOOK
POST
`product.inventory_changed` event WEBHOOK
POST
`product.out_of_stock` event WEBHOOK
POST
`product.unavailable` event WEBHOOK

Authentication

Section titled “Authentication”

oauth2

Section titled “oauth2”

OAuth 2.1 Authorization Code grant with PKCE, served by the elasticStage authorization server.

Security scheme type: oauth2

Flow type: authorizationCode

Authorization URL: https://auth.staging.elasticstage.com/api/auth/oauth2/authorize

Token URL: https://auth.staging.elasticstage.com/api/auth/oauth2/token

Refresh URL: https://auth.staging.elasticstage.com/api/auth/oauth2/token

Scopes:

  • creator:read - Read the connected creator profile.
  • releases:read - Read the creator's releases and their products.
  • orders:read - Read fulfilment orders for the connected creator.
  • orders:create - Place fulfilment orders.
  • shipping:read - Quote shipping rates and read the service catalogue.
  • webhooks:read - Read webhook subscriptions and their delivery history.
  • webhooks:create - Create webhook subscriptions.
  • webhooks:update - Update webhook subscriptions and send test/sandbox events.
  • webhooks:delete - Delete webhook subscriptions.
  • offline_access - Issue a refresh token so the integrator can renew the access token.