Order Source App Definition

The code for your app definition can be seen here on github.

Metadata

NameTypeRequired?Nullable?Description
IdGUID

The id for this integration (this GUID should not be changed after publishing)

Namestring

The name of this integration, used for internal purposes, can be the same as the branded OrderSource in OrderSources[]

AuthProcessobject

The specification for authorizing with this order source

OrderSources[]object[]

A list of branded order sources

Order Source

NameTypeRequired?Nullable?Description
IdGUID

This is a unique GUID identifier for this order source (this GUID should not be changed after publishing)

Namestring

The branded name for this order source "Shopify", "eBay", "Amazon" (This is what our customers see)

SendEmailboolean

Indicates whether or not our system is allowed to send emails to customers

HasCustomMappingsboolean

Indicates whether or not this marketplace allows custom mappings

CanRefreshboolean

Indicates whether or not orders can be refreshed

CanLeaveFeedbackboolean

Indicates whether or not the order source allows sellers to leave feedback on customers

CanConfirmShipmentsboolean

Indicates whether or not the order source can confirm an order has been shipped

IsRefreshDisabledboolean

Indicates that refreshing is disabled within our platform

HasCustomStatusesboolean

Indicates whether this order source allows for custom statuses on a seller by seller basis

CanConfigureTimeZoneboolean

Indicates whether or not a user is allowed to configure their own timezone

HasInventoryLevelsboolean

Indicates whether or not the order source has inventory levels

AccountConnectionobject

Specifies account connection information

AccountConnection.Namestring

The name of your connection form

AccountConnection   .ConnectionFormSchema

Form

A form that allows the user to specify the credentials needed to generate the OAuth token.

Imagesobject

Images that will be used for this branded order source

Images.Logostring

The full path to the logo used in modals and other areas of our platform for this order source. Use join(__dirname, '../assets/logo.svg') "/dev/integration/assets/ordersource1/logo.svg"

Images.Iconstring

The full path to the icon used for this order source. Use join(__dirname, '../assets/logo.svg') "/dev/integration/assets/ordersource1/icon.svg"

Auth Specification

NameTypeRequired?Nullable?Description
Identifierobject

Identify the type of Auth being used by the integration

Identifier   .AuthenticationTypeobject

Identify the type of Auth being used by the integration (oauth, basic, apikey)

Identifier.IsSandboxobject

Indicates whether or not the authentication server is sandboxed

authorizationobject

The beginning of an OAuth2.0 flow that ensures the user is logged in and approves access to the Resource.

authorization   .url_templatestring

The url to obtain the access token using the authorization code on the backend http://{auth_state:store_name}.store.com/authorize http://store.com/oauth/authorize

authorization   .query_parameters[]array

A list of query parameters that will be attached to the url

authorization   .query_parameters[]   .namestring

The name of the parameter

authorization   .query_parameters[]   .valuestring

The value associated with the parameter

request_tokenobject

The server-server code for token exchange

request_token   .url_templatestring

The url to obtain the access token using the authorization code on the backend http://{auth_state:store_name}.store.com/request http://store.com/oauth/request

request_token.methodstring

The http method to use when making the server-server code for token request "GET", "POST"

request_token.body[]array

A list of query parameters that will be attached to the url

request_token.body[].namestring

The name of the parameter

request_token   .body[]   .valuestring

The value associated with the parameter

request_token.headers[]array

A list of header values that will be sent to request the token

request_token   .headers[]   .namestring

The name of the parameter

request_token   .headers[]   .valuestring

The value associated with the parameter

refresh_tokenobject

The server-server code for token exchange

refresh_token   .url_templatestring

The url to refresh the access token using the authorization code on the backend http://{auth_state:store_name}.store.com/refresh http://store.com/oauth/refresh

refresh_token.methodstring

The http method to use when making the server-server code for token request "GET", "POST"

refresh_token.body[]array

A list of query parameters that will be attached to the url

refresh_token.body[].namestring

The name of the parameter

refresh_token   .body[]   .valuestring

The value associated with the parameter

refresh_token.headers[]array

A list of header values that will be sent to request the token

refresh_token   .headers[]   .namestring

The name of the parameter

refresh_token   .headers[]   .valuestring

The value associated with the parameter