Order Application Definition

The Order Application Definition file tells the ShipEngine Connect where to find the resources that define your application, such as methods and forms.

This file can reside anywhere within your application as long as its location is specified in the main property of your package.json file. The definition may be specified in JavaScript, TypeScript, JSON, or YAML.

Order Application

Name	Type	Required?	Description
`id`	UUID	✔	A UUID that uniquely identifies the application for internal ShipEngine Connect purposes. This ID should never change.
`providerId`	UUID		A UUID that is used to relate this app to an existing production application. Do not set this field unless instructed to by the ShipEngine Connect team.
`name`	string	✔	The user-friendly name for this Order application.
`description`	string		A short, user-friendly description of this Order application.
`websiteURL`	string	✔	The URL of your company's website.
`logo`	string	✔	The file path to your company's logo image.
`icon`	string	✔	The file path to the Carrier's icon image.
`sendMail`	boolean		Indicates whether or not emails should be sent to communicate shipping updates on behalf of the seller for orders imported through this Order App.
`canConfigureTimeZone`	boolean		Indicates whether or not to display time zone related settings when this app is used within one of our e-commerce applications, such as ShipStation.
`connectionForm`	Form	✔	A form that allows the user to specify the credentials needed to generate the OAuth token.
`getSalesOrdersByDate`	method or string		A method that returns all orders that were created and/or modified within a given time frame. You may define this method direcly inline inside of this file or you may specify the path to the file that exports your `getSalesOrdersByDate` method.
`shipmentCreated`	method or string		A method that's called when a shipment is created for one or more items in one or more sales orders. A single shipment may contain items from multiple sales orders, and a single sales order may be fulfilled by multiple shipments. You may define this method direcly inline inside of this file or you may specify the path to the file that exports your `shipmentCreated` method.
`acknowledgeOrders`	method or string		A method that's called when a shipment is cancelled for one or more items in one or more sales orders. A single shipment may contain items from multiple sales orders, and a single sales order may be fulfilled by multiple shipments. You may define this method direcly inline inside of this file or you may specify the path to the file that exports your `shipmentCancelled` method.
`oauthConfig`	object or string		The OAuth Config Definition that describes the authorization process. This can be defined directly inline inside this file or you may specify the path to a separate OAuth Config Definition file.

Examples

import { OrderAppDefinition } from "@shipengine/connect";
const orderSource: OrderAppDefinition = {
  id: "5e386891-f693-4cdf-8b0c-82d7eb7542d0",
  name: "IBuy MarketPlace",
  description: "Welcome to iBuy, the international marketplace for all of your needs.",
  websiteURL: "https://www.iBuy.net",
  logo: "./../logo.svg",
  icon: "./../icon.svg",
  connectionForm: import("./forms/connect"),
  getSalesOrdersByDate: import("./methods/get-sales-orders-by-date"),
  shipmentCreated: import("./methods/shipment-created"),
  acknowledgeOrders: import("./methods/acknowledge-orders"),
  sendMail: false,
  canConfigureTimeZone: false,
  oauthConfig: import("./oauth-config"
}
export default orderSource;

const orderSource = {
  id: "5e386891-f693-4cdf-8b0c-82d7eb7542d0",
  name: "IBuy MarketPlace",
  description: "Welcome to iBuy, the international marketplace for all of your needs.",
  websiteURL: "https://www.iBuy.net",
  logo: "./../logo.svg",
  icon: "./../icon.svg",
  connectionForm: "./forms/connect.js",
  getSalesOrdersByDate: "./methods/get-sales-orders-by-date.js",
  shipmentCreated: "./methods/shipment-created.js",
  acknowledgeOrders: "./methods/acknowledge-orders.js",
  sendMail: false,
  canConfigureTimeZone: false,
  oauthConfig: "./definitions/oauth-config.js"
}
module.exports = orderSource;

id: 5e386891-f693-4cdf-8b0c-82d7eb7542d0
name: IBuy MarketPlace
description:  Welcome to iBuy, the international marketplace for all of your needs.
websiteURL: https://www.ibuy.net
logo: ./../logo.svg
icon: ./../icon.svg
connectionForm: ./forms/connection-form.js
getSalesOrdersByDate: ./methods/get-sales-orders-by-date.js
shipmentCreated: ./methods/shipment-created.js
acknowledgeOrders: ./methods/acknowledge-orders.js
sendMail: false
canConfigureTimeZone: false
oauthConfig: ./definitions/oauth-config.js