App Access

Create an App Access

Changed on

Create a temporary app access redirect token

Required authorization scope: public.app_access:write

post/2024-09/account/app_accesses

Request

  • Base URL
    https://public-api.easyship.com
  • URL
    https://public-api.easyship.com/2024-09/account/app_accesses
  • Auth
    HTTP bearer

Request body

app_name'lyoc' | 'enterprise_onboarding' | 'shopify_bfs' | 'support_bot' required
redirect_back_urlstring uri

Specifies the URL to which the user should be redirected when the connection needs to be completed in the courier's portal (for example, Canada Post or AU Post MyPost Business). This ensures the user can return to the app seamlessly after the external interaction.

targetstring

Certain apps allow their own target paths

App Name: lyoc Available Targets:

  • couriers: /couriers

Response

app access successfully created with target and redirect url

Changes

    • info

      added the new shopify_bfs enum value to the request property

    • info

      added the new support_bot enum value to the request property