v1

latestSwagger 2.0BeezUP2026-07-13254876845.8 KB

Marketplaces - Orders - Subscriptions - Subscriptions

Get a subscription to the orders

get/v2/user/marketplaces/orders/subscriptions/{id}

Path parameters

idstring SubscriptionId required

Response

Subscription info

idstring guid required

The identifier of the subscription to the orders for a merchant

status'active' | 'inactive' required

The status of your subscription

targetUrlstring required

The URL <a href="https://en.wikipedia.org/wiki/URL">https://en.wikipedia.org/wiki/URL</a>

namestring required

The subscription name you want to use

merchantApplicationNamestring required

The name of your application

merchantApplicationVersionstring required

The version of your application

recoverBeginPeriodOrderLastModificationUtcDatestring date-time

Recover existing orders using the begin period order last modification date. If not set then you will receive new/updated orders in real-time.

recoverEndPeriodOrderLastModificationUtcDatestring date-time

Recover existing orders using the begin and the end period order last modification date. Otherwise, you will receive new/updated orders in real-time.

lastOrderPushedModificationUtcDatestring date-time

This modification date correspond to the last order pushed by your subscription consumer

lastSuccessfulOrderPushedUtcDatestring date-time

The date of the last pushed order successfully received by your subscription consumer

consumerHealthStatus'Available' | 'Degraded' | 'Unavailable'

The subscription consumption status

consumerUnvailableSinceUtcDatestring date-time

This date indicates since when the subscription consumer is unavailable

lastRetryUtcDatestring date-time

The last date we retry to send orders

retryCountinteger

The retry count. When we the retry count will reach maximum retry count, the subscription will be deactivated.

maxRetryCountinteger

The maximum BeezUP will retry to push orders. When we the retry count will reach maximum retry count, the subscription will be deactivated.

nextScheduledRetryUtcDatestring date-time

The next scheduled date we retry to send orders

merchantEmailAlertstring email

The email

consumerLastRequestSentUristring

The URL <a href="https://en.wikipedia.org/wiki/URL">https://en.wikipedia.org/wiki/URL</a>

Example response

{
  "status": "active",
  "targetUrl": "http://www.mydomain.com",
  "name": "MySubscriptionName",
  "merchantApplicationName": "MyApp",
  "merchantApplicationVersion": "1.0",
  "merchantEmailAlert": "paulsimon@mysupercompany.com",
  "lastErrorMessage": {
    "errors": [
      {
        "docUrl": "https://api-docs.imn.io/#operation/EnableChannelCatalog",
        "message": "There is already an importation in progress: b24d0dd8-a561-478a-9b26-34f573f03527\n",
        "cultureName": "en"
      }
    ]
  },
  "consumerLastRequestSentUri": "http://www.mydomain.com",
  "links": {
    "reporting": {
      "label": "The translated label",
      "docUrl": "https://api-docs.imn.io/#operation/EnableChannelCatalog",
      "description": "This is a description link",
      "href": "/merchant/orders/v1/{marketplaceCode}/{IMNOrderId}",
      "operationId": "GetOrder",
      "method": "GET"
    },
    "activate": {
      "label": "The translated label",
      "docUrl": "https://api-docs.imn.io/#operation/EnableChannelCatalog",
      "description": "This is a description link",
      "href": "/merchant/orders/v1/{marketplaceCode}/{IMNOrderId}",
      "operationId": "GetOrder",
      "method": "GET"
    },
    "deactivate": {
      "label": "The translated label",
      "docUrl": "https://api-docs.imn.io/#operation/EnableChannelCatalog",
      "description": "This is a description link",
      "href": "/merchant/orders/v1/{marketplaceCode}/{IMNOrderId}",
      "operationId": "GetOrder",
      "method": "GET"
    },
    "retry": {
      "label": "The translated label",
      "docUrl": "https://api-docs.imn.io/#operation/EnableChannelCatalog",
      "description": "This is a description link",
      "href": "/merchant/orders/v1/{marketplaceCode}/{IMNOrderId}",
      "operationId": "GetOrder",
      "method": "GET"
    },
    "delete": {
      "label": "The translated label",
      "docUrl": "https://api-docs.imn.io/#operation/EnableChannelCatalog",
      "description": "This is a description link",
      "href": "/merchant/orders/v1/{marketplaceCode}/{IMNOrderId}",
      "operationId": "GetOrder",
      "method": "GET"
    }
  }
}