BEbeaconproplus
EagleView

Create the eagle view order

Changed on

This service is the primary mechanism of the eagle view ordering process, as it will actually create the order. A successful PlaceOrder call will return a unique Report Id, which can then be used in other method calls. Optional existingOrderNumber attaches the report to an existing Fusion sales order instead of creating a Mincron order.

post/v1/eagleview/order

Request

  • Base URL
    https://beaconproplus.com
  • Auth
    none declared

Request body

accountIdstring required

The account id

emailstring required

The user email

projectNamestring

The project name

beaconPricenumber

The price

customerNamestring nullable

Required for the nova-carts-service token. The account name is enough when there is no separate person name.

accountNamestring nullable

Required for the nova-carts-service token. POS account name.

osrEmailstring nullable

POS OSR email. Used only for the nova-carts-service token.

branchIdstring nullable

Required for the nova-carts-service token. The branch number used to build branchKey (brn_<branchId>). Not the CommerceTools channel id the customer path stores.

branchKeystring nullable

Required for the nova-carts-service token. The CommerceTools branch-channel key (brn_<branchId>), the same value the customer path stores.

branchNamestring nullable

Required for the nova-carts-service token.

regionNumberstring nullable
regionNamestring nullable
marketstring nullable
divisionNumberstring nullable
divisionNamestring nullable
companyNumberstring nullable
companyNamestring nullable
storePickupAddressNamestring nullable
branchNotificationEmailsstring[] nullable

Branch mail list for the nova-carts-service token. Empty when omitted.

branchEmailLanguagestring nullable

Defaults to en-US for the nova-carts-service token.

cashAccountboolean nullable

Ignored on every path. Cash is read from the CommerceTools account, not from this field.

PromoCodestring

Promotional code for report discount.

PlaceOrderUserstring

Email address of account to place orders on. Only required if not the authenticated user.

uuidstring uuid

The UUID.

existingOrderNumberstring nullable

Required for the nova-carts-service token. Optional for a customer token. Pre-existing Fusion sales-order number. Beacon-only; not sent to EagleView. Max length 40.

commercetoolsIdstring nullable

Ignored on input. The service sets it from the token's commercetools_id and stores it with the order. Beacon-only; not sent to EagleView.

Response

successful operation

If failed, return messageCode, refer to API Response Message Code.

Example

{ "messageCode": "1001", "message": "Validation exception" }

mincronOrderIdstring
orderIdinteger
reportIdsinteger[]

Changes

  • 06dc25ddc4d9Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property