AppResellerOpportunities

Request opportunity review

Changed on

Submit the opportunity to the manager for review. After it is submitted, the sales agent cannot modify the opportunity. Managers can still modify and finalize it.

Required: Accept-Language header with Locale format. For example: en-US

post/assistedSales/v1/opportunities/{opportunityId}/requestReview

Request

Path parameters

opportunityIdstring required

Opportunity ID

Response

Success

idstring

Opportunity ID

createdOnnumber

Opportunity creation date, in UNIX Epoch milliseconds

currency'USD' | 'CAD' | 'EUR' | 'JPY' | 'GBP' | 'KRW' | 'CHF' | 'SEK' | 'SGD' | 'MYR' | 'AUD' | 'MXN' | 'INR' | 'BRL' | 'DKK' | 'NZD' | 'NOK' | 'ZAR' | 'PHP' | 'CNY' | 'SAR' | 'GTQ' | 'IDR' | 'ARS' | 'COP' | 'PEN'

The currency using the ISO-4217 currency code

purchaseEffectiveDatenumber

Opportunity purchase effective date, in UNIX Epoch milliseconds

namestring

Opportunity name

status'OPEN' | 'CLOSED' | 'PENDING_REVIEW'

Opportunity status

purchaseIdstring

Purchase ID

purchaseNumberstring

Purchase number

availableActionsAvailableAction[]

Available actions on the opportunity

purchaseCustomAttributesobject

Custom attributes related to the purchase

Example response

{
  "id": "ef6c414f-39da-401f-a4b8-81adc6190fda",
  "ownerUser": {
    "id": "d781ac09-b4fe-4d57-8ba2-4640fc5b7c49",
    "email": "john.doe@acme.com",
    "firstName": "John",
    "lastName": "Doe",
    "company": {
      "id": "1",
      "name": "Acme Corp.",
      "isReseller": true
    }
  },
  "customerUser": {
    "id": "498c62ea-ad14-48e6-96ce-5400c617444c",
    "email": "ubrownfield@stark.com",
    "firstName": "Ulysses",
    "lastName": "Brownfield",
    "company": {
      "id": "100",
      "name": "Customer Company",
      "isReseller": false
    }
  },
  "createdOn": "1546300800000",
  "currency": "USD",
  "purchaseEffectiveDate": "1577750400000",
  "name": "Jarvis Iniative",
  "status": "OPEN",
  "items": [
    {
      "id": "4ccf689b-4339-4fc9-a8b3-b05c5a87c1be",
      "pricingPlanId": "4bc864b5-f63f-4933-be19-3700aa9a8cc4",
      "units": [
        {
          "quantity": "20",
          "unit": "USER"
        }
      ],
      "subscriptionCustomAttributes": {
        "intended_os": [
          "other",
          "ios",
          "macos"
        ],
        "sales_agent_id": [
          "R353113R"
        ]
      },
      "vendorRequiredFields": {
        "name": [
          "jonh"
        ],
        "lastname": [
          "doe"
        ],
        "email": [
          "john.doe@acme.com"
        ]
      }
    },
    {
      "id": "dece524d-0466-4185-b3bb-1f8a300c37cd",
      "pricingPlanId": "80b85538-ffc1-4c4b-acb1-1bf87c8c2fc4",
      "units": []
    }
  ],
  "availableActions": [
    "EDIT",
    "FINALIZE",
    "SUBMIT_FOR_REVIEW",
    "ADD_PRODUCT",
    "SET_CUSTOM_PRICE",
    "SET_CUSTOM_CONTRACT",
    "SET_PROVISIONING_DATE",
    "SET_BILLING_DATE",
    "SET_COMMISSION_RATE",
    "CHANGE_OPPORTUNITY_OWNER"
  ],
  "actionRestrictions": {}
}

Changes

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status