Skip to content

Instantly share code, notes, and snippets.

@kukulogy

kukulogy/pipe17.json

Created February 19, 2021 07:44
Show Gist options
  • Save kukulogy/8cf88ff4c12a2bad1ce00620bc026252 to your computer and use it in GitHub Desktop.
Save kukulogy/8cf88ff4c12a2bad1ce00620bc026252 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
pipe17.json
This file has been truncated, but you can view the full file.
{
"openapi": "3.0.1",
"info": {
"title": "Pipe17 API",
"description": "Generic interface to Pipe17 services\n\n# Authentication\n\n<!-- ReDoc-Inject: <security-definitions> -->",
"termsOfService": "https://www.pipe17.com/terms/",
"contact": {
"email": "support@pipe17.com"
},
"license": {
"name": "Pipe17 License",
"url": "http://www.pipe17.com/licenses/LICENSE.html"
},
"version": "3.0.6",
"x-logo": {
"url": "http://cdn.mcauto-images-production.sendgrid.net/f6066af0e8bef1c4/a0e7bd5a-7edc-43fb-9657-a7dcc88e0df7/513x224.png",
"backgroundColor": "#fafafa",
"altText": "Pipe17 logo"
}
},
"externalDocs": {
"description": "About Pipe17",
"url": "https://pipe17.com"
},
"servers": [
{
"url": "https://localhost:4000/develop/api/v3",
"description": "local"
},
{
"url": "https://api-v3-test-develop.pipe17.com/develop/api/v3",
"description": "develop"
},
{
"url": "https://schema.pipe17.com",
"description": "converter"
}
],
"tags": [
{
"name": "Accounts",
"description": "Operations about Accounts"
},
{
"name": "Api Keys",
"description": "Operations about Api Keys"
},
{
"name": "Arrivals",
"description": "Operations about Arrival Notifications"
},
{
"name": "Connectors",
"description": "Operations about Connectors"
},
{
"name": "Converter",
"description": "Mapping rules based objects conversion"
},
{
"name": "Entity Filters",
"description": "Operations about Entity Filters",
"x-p17-private": true
},
{
"name": "Entity Schemas",
"description": "Operations about Entity Schemas",
"x-p17-private": true
},
{
"name": "Fulfillments",
"description": "When shipments gets fulfilled, a Fulfillment object is created within Pipe17"
},
{
"name": "Integrations",
"description": "Operations about Integrations"
},
{
"name": "Integrations State",
"description": "Operations about State of Integrations",
"x-p17-private": true
},
{
"name": "Inventory",
"description": "Operations about Inventory"
},
{
"name": "Inventory Rules",
"description": "Operations about Inventory Rules"
},
{
"name": "Locations",
"description": "Operations about Locations"
},
{
"name": "Mappings",
"description": "Operations about Mappings"
},
{
"name": "Orders",
"description": "Operations about Orders"
},
{
"name": "Organizations",
"description": "Operations about Organizations"
},
{
"name": "Products",
"description": "Operations about Products"
},
{
"name": "Purchases",
"description": "Operations about Purchase Orders"
},
{
"name": "Receipts",
"description": "Operations about Receipts"
},
{
"name": "Roles",
"description": "Operations about Roles"
},
{
"name": "Routing Rules",
"description": "Operations about Routing Rules",
"x-p17-private": true
},
{
"name": "Routings",
"description": "Operations about Routings"
},
{
"name": "Shipments",
"description": "This is the entity to use for requesting a shipment. Pipe17 generate shipments automatically for Orders"
},
{
"name": "Transfers",
"description": "Operations about Transfer Orders"
},
{
"name": "Users",
"description": "Operations about Users"
},
{
"name": "Webhooks",
"description": "Operations about Webhooks"
}
],
"x-tagGroups": [
{
"name": "General",
"tags": [
"Arrivals",
"Fulfillments",
"Inventory",
"Inventory Rules",
"Locations",
"Orders",
"Products",
"Purchases",
"Receipts",
"Routings",
"Shipments",
"Transfers"
]
},
{
"name": "Management",
"tags": [
"Api Keys",
"Connectors",
"Integrations",
"Mappings",
"Webhooks"
]
},
{
"name": "Administration",
"tags": [
"Accounts",
"Organizations",
"Roles",
"Users"
]
},
{
"name": "Utility",
"tags": [
"Converter"
]
}
],
"security": [
{
"Pipe17KeyAuth": []
}
],
"paths": {
"/accounts": {
"post": {
"tags": [
"Accounts"
],
"summary": "Create Account",
"operationId": "createAccount",
"requestBody": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"email",
"ownerFirstName",
"ownerLastName",
"phone",
"timeZone",
"address"
],
"properties": {
"email": {
"type": "string",
"description": "Account Owner email"
},
"ownerFirstName": {
"type": "string",
"description": "Account Owner First Name"
},
"ownerLastName": {
"type": "string",
"description": "Account Owner Last Name"
},
"accountName": {
"type": "string",
"description": "Account Name"
},
"companyName": {
"type": "string",
"description": "Company Name"
},
"phone": {
"type": "string",
"description": "Account Phone"
},
"timeZone": {
"type": "string",
"description": "Account Time Zone"
},
"address": {
"type": "object",
"required": [
"zipCodeOrPostalCode",
"country",
"stateOrProvince"
],
"properties": {
"address1": {
"description": "Address Line 1",
"type": "string"
},
"address2": {
"description": "Address Line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"stateOrProvince": {
"description": "State or Province",
"type": "string"
},
"zipCodeOrPostalCode": {
"description": "zipcode or postal code",
"type": "string"
},
"country": {
"description": "Country",
"type": "string"
}
}
},
"integrations": {
"type": "array",
"description": "Account Integrations",
"items": {
"type": "string"
}
}
}
},
{
"type": "object",
"required": [
"password"
],
"properties": {
"password": {
"type": "string",
"description": "Account Owner password"
}
}
}
],
"xml": {
"name": "request"
}
}
},
"application/xml": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"email",
"ownerFirstName",
"ownerLastName",
"phone",
"timeZone",
"address"
],
"properties": {
"email": {
"type": "string",
"description": "Account Owner email"
},
"ownerFirstName": {
"type": "string",
"description": "Account Owner First Name"
},
"ownerLastName": {
"type": "string",
"description": "Account Owner Last Name"
},
"accountName": {
"type": "string",
"description": "Account Name"
},
"companyName": {
"type": "string",
"description": "Company Name"
},
"phone": {
"type": "string",
"description": "Account Phone"
},
"timeZone": {
"type": "string",
"description": "Account Time Zone"
},
"address": {
"type": "object",
"required": [
"zipCodeOrPostalCode",
"country",
"stateOrProvince"
],
"properties": {
"address1": {
"description": "Address Line 1",
"type": "string"
},
"address2": {
"description": "Address Line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"stateOrProvince": {
"description": "State or Province",
"type": "string"
},
"zipCodeOrPostalCode": {
"description": "zipcode or postal code",
"type": "string"
},
"country": {
"description": "Country",
"type": "string"
}
}
},
"integrations": {
"type": "array",
"description": "Account Integrations",
"items": {
"type": "string"
}
}
}
},
{
"type": "object",
"required": [
"password"
],
"properties": {
"password": {
"type": "string",
"description": "Account Owner password"
}
}
}
],
"xml": {
"name": "request"
}
}
},
"text/xml": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"email",
"ownerFirstName",
"ownerLastName",
"phone",
"timeZone",
"address"
],
"properties": {
"email": {
"type": "string",
"description": "Account Owner email"
},
"ownerFirstName": {
"type": "string",
"description": "Account Owner First Name"
},
"ownerLastName": {
"type": "string",
"description": "Account Owner Last Name"
},
"accountName": {
"type": "string",
"description": "Account Name"
},
"companyName": {
"type": "string",
"description": "Company Name"
},
"phone": {
"type": "string",
"description": "Account Phone"
},
"timeZone": {
"type": "string",
"description": "Account Time Zone"
},
"address": {
"type": "object",
"required": [
"zipCodeOrPostalCode",
"country",
"stateOrProvince"
],
"properties": {
"address1": {
"description": "Address Line 1",
"type": "string"
},
"address2": {
"description": "Address Line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"stateOrProvince": {
"description": "State or Province",
"type": "string"
},
"zipCodeOrPostalCode": {
"description": "zipcode or postal code",
"type": "string"
},
"country": {
"description": "Country",
"type": "string"
}
}
},
"integrations": {
"type": "array",
"description": "Account Integrations",
"items": {
"type": "string"
}
}
}
},
{
"type": "object",
"required": [
"password"
],
"properties": {
"password": {
"type": "string",
"description": "Account Owner password"
}
}
}
],
"xml": {
"name": "request"
}
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
},
{
"type": "object",
"properties": {
"account": {
"allOf": [
{
"type": "object",
"properties": {
"accountId": {
"type": "string",
"description": "Account ID"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "Account Create Time"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"description": "Account Last Updated Time"
}
}
},
{
"type": "object",
"required": [
"email",
"ownerFirstName",
"ownerLastName",
"phone",
"timeZone",
"address"
],
"properties": {
"email": {
"type": "string",
"description": "Account Owner email"
},
"ownerFirstName": {
"type": "string",
"description": "Account Owner First Name"
},
"ownerLastName": {
"type": "string",
"description": "Account Owner Last Name"
},
"accountName": {
"type": "string",
"description": "Account Name"
},
"companyName": {
"type": "string",
"description": "Company Name"
},
"phone": {
"type": "string",
"description": "Account Phone"
},
"timeZone": {
"type": "string",
"description": "Account Time Zone"
},
"address": {
"type": "object",
"required": [
"zipCodeOrPostalCode",
"country",
"stateOrProvince"
],
"properties": {
"address1": {
"description": "Address Line 1",
"type": "string"
},
"address2": {
"description": "Address Line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"stateOrProvince": {
"description": "State or Province",
"type": "string"
},
"zipCodeOrPostalCode": {
"description": "zipcode or postal code",
"type": "string"
},
"country": {
"description": "Country",
"type": "string"
}
}
},
"integrations": {
"type": "array",
"description": "Account Integrations",
"items": {
"type": "string"
}
}
}
}
]
}
}
}
]
}
},
"application/xml": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
},
{
"type": "object",
"properties": {
"account": {
"allOf": [
{
"type": "object",
"properties": {
"accountId": {
"type": "string",
"description": "Account ID"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "Account Create Time"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"description": "Account Last Updated Time"
}
}
},
{
"type": "object",
"required": [
"email",
"ownerFirstName",
"ownerLastName",
"phone",
"timeZone",
"address"
],
"properties": {
"email": {
"type": "string",
"description": "Account Owner email"
},
"ownerFirstName": {
"type": "string",
"description": "Account Owner First Name"
},
"ownerLastName": {
"type": "string",
"description": "Account Owner Last Name"
},
"accountName": {
"type": "string",
"description": "Account Name"
},
"companyName": {
"type": "string",
"description": "Company Name"
},
"phone": {
"type": "string",
"description": "Account Phone"
},
"timeZone": {
"type": "string",
"description": "Account Time Zone"
},
"address": {
"type": "object",
"required": [
"zipCodeOrPostalCode",
"country",
"stateOrProvince"
],
"properties": {
"address1": {
"description": "Address Line 1",
"type": "string"
},
"address2": {
"description": "Address Line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"stateOrProvince": {
"description": "State or Province",
"type": "string"
},
"zipCodeOrPostalCode": {
"description": "zipcode or postal code",
"type": "string"
},
"country": {
"description": "Country",
"type": "string"
}
}
},
"integrations": {
"type": "array",
"description": "Account Integrations",
"items": {
"type": "string"
}
}
}
}
]
}
}
}
]
}
},
"text/xml": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
},
{
"type": "object",
"properties": {
"account": {
"allOf": [
{
"type": "object",
"properties": {
"accountId": {
"type": "string",
"description": "Account ID"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "Account Create Time"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"description": "Account Last Updated Time"
}
}
},
{
"type": "object",
"required": [
"email",
"ownerFirstName",
"ownerLastName",
"phone",
"timeZone",
"address"
],
"properties": {
"email": {
"type": "string",
"description": "Account Owner email"
},
"ownerFirstName": {
"type": "string",
"description": "Account Owner First Name"
},
"ownerLastName": {
"type": "string",
"description": "Account Owner Last Name"
},
"accountName": {
"type": "string",
"description": "Account Name"
},
"companyName": {
"type": "string",
"description": "Company Name"
},
"phone": {
"type": "string",
"description": "Account Phone"
},
"timeZone": {
"type": "string",
"description": "Account Time Zone"
},
"address": {
"type": "object",
"required": [
"zipCodeOrPostalCode",
"country",
"stateOrProvince"
],
"properties": {
"address1": {
"description": "Address Line 1",
"type": "string"
},
"address2": {
"description": "Address Line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"stateOrProvince": {
"description": "State or Province",
"type": "string"
},
"zipCodeOrPostalCode": {
"description": "zipcode or postal code",
"type": "string"
},
"country": {
"description": "Country",
"type": "string"
}
}
},
"integrations": {
"type": "array",
"description": "Account Integrations",
"items": {
"type": "string"
}
}
}
}
]
}
}
}
]
}
}
}
},
"default": {
"description": "Failed operation",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
},
{
"type": "object",
"properties": {
"account": {
"type": "object",
"required": [
"email",
"ownerFirstName",
"ownerLastName",
"phone",
"timeZone",
"address"
],
"properties": {
"email": {
"type": "string",
"description": "Account Owner email"
},
"ownerFirstName": {
"type": "string",
"description": "Account Owner First Name"
},
"ownerLastName": {
"type": "string",
"description": "Account Owner Last Name"
},
"accountName": {
"type": "string",
"description": "Account Name"
},
"companyName": {
"type": "string",
"description": "Company Name"
},
"phone": {
"type": "string",
"description": "Account Phone"
},
"timeZone": {
"type": "string",
"description": "Account Time Zone"
},
"address": {
"type": "object",
"required": [
"zipCodeOrPostalCode",
"country",
"stateOrProvince"
],
"properties": {
"address1": {
"description": "Address Line 1",
"type": "string"
},
"address2": {
"description": "Address Line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"stateOrProvince": {
"description": "State or Province",
"type": "string"
},
"zipCodeOrPostalCode": {
"description": "zipcode or postal code",
"type": "string"
},
"country": {
"description": "Country",
"type": "string"
}
}
},
"integrations": {
"type": "array",
"description": "Account Integrations",
"items": {
"type": "string"
}
}
}
}
}
}
]
}
},
"application/xml": {
"schema": {
"allOf": [
{
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
},
{
"type": "object",
"properties": {
"account": {
"type": "object",
"required": [
"email",
"ownerFirstName",
"ownerLastName",
"phone",
"timeZone",
"address"
],
"properties": {
"email": {
"type": "string",
"description": "Account Owner email"
},
"ownerFirstName": {
"type": "string",
"description": "Account Owner First Name"
},
"ownerLastName": {
"type": "string",
"description": "Account Owner Last Name"
},
"accountName": {
"type": "string",
"description": "Account Name"
},
"companyName": {
"type": "string",
"description": "Company Name"
},
"phone": {
"type": "string",
"description": "Account Phone"
},
"timeZone": {
"type": "string",
"description": "Account Time Zone"
},
"address": {
"type": "object",
"required": [
"zipCodeOrPostalCode",
"country",
"stateOrProvince"
],
"properties": {
"address1": {
"description": "Address Line 1",
"type": "string"
},
"address2": {
"description": "Address Line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"stateOrProvince": {
"description": "State or Province",
"type": "string"
},
"zipCodeOrPostalCode": {
"description": "zipcode or postal code",
"type": "string"
},
"country": {
"description": "Country",
"type": "string"
}
}
},
"integrations": {
"type": "array",
"description": "Account Integrations",
"items": {
"type": "string"
}
}
}
}
}
}
]
}
},
"text/xml": {
"schema": {
"allOf": [
{
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
},
{
"type": "object",
"properties": {
"account": {
"type": "object",
"required": [
"email",
"ownerFirstName",
"ownerLastName",
"phone",
"timeZone",
"address"
],
"properties": {
"email": {
"type": "string",
"description": "Account Owner email"
},
"ownerFirstName": {
"type": "string",
"description": "Account Owner First Name"
},
"ownerLastName": {
"type": "string",
"description": "Account Owner Last Name"
},
"accountName": {
"type": "string",
"description": "Account Name"
},
"companyName": {
"type": "string",
"description": "Company Name"
},
"phone": {
"type": "string",
"description": "Account Phone"
},
"timeZone": {
"type": "string",
"description": "Account Time Zone"
},
"address": {
"type": "object",
"required": [
"zipCodeOrPostalCode",
"country",
"stateOrProvince"
],
"properties": {
"address1": {
"description": "Address Line 1",
"type": "string"
},
"address2": {
"description": "Address Line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"stateOrProvince": {
"description": "State or Province",
"type": "string"
},
"zipCodeOrPostalCode": {
"description": "zipcode or postal code",
"type": "string"
},
"country": {
"description": "Country",
"type": "string"
}
}
},
"integrations": {
"type": "array",
"description": "Account Integrations",
"items": {
"type": "string"
}
}
}
}
}
}
]
}
}
}
}
}
},
"get": {
"tags": [
"Accounts"
],
"summary": "List Accounts (Not Implemented)",
"operationId": "listAccounts",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
},
{
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "OK (but NYI)"
}
}
}
]
}
},
"application/xml": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
},
{
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "OK (but NYI)"
}
}
}
]
}
},
"text/xml": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
},
{
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "OK (but NYI)"
}
}
}
]
}
}
}
},
"default": {
"description": "Failed operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
}
},
"application/xml": {
"schema": {
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
}
},
"text/xml": {
"schema": {
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
}
}
}
}
}
}
},
"/accounts/{AccountId}": {
"delete": {
"tags": [
"Accounts"
],
"summary": "Delete Account (Not Implemented)",
"operationId": "deleteAccount",
"parameters": [
{
"name": "AccountId",
"in": "path",
"description": "Account ID to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
},
{
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "OK (but NYI)"
}
}
}
]
}
},
"application/xml": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
},
{
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "OK (but NYI)"
}
}
}
]
}
},
"text/xml": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
},
{
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "OK (but NYI)"
}
}
}
]
}
}
}
},
"default": {
"description": "Failed operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
}
},
"application/xml": {
"schema": {
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
}
},
"text/xml": {
"schema": {
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
}
}
}
}
}
},
"get": {
"tags": [
"Accounts"
],
"summary": "Fetch Account (Not Implemented)",
"operationId": "fetchAccount",
"parameters": [
{
"name": "AccountId",
"in": "path",
"description": "Account ID to fetch",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
},
{
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "OK (but NYI)"
}
}
}
]
}
},
"application/xml": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
},
{
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "OK (but NYI)"
}
}
}
]
}
},
"text/xml": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
},
{
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "OK (but NYI)"
}
}
}
]
}
}
}
},
"default": {
"description": "Failed operation",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
}
]
}
},
"application/xml": {
"schema": {
"allOf": [
{
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
}
]
}
},
"text/xml": {
"schema": {
"allOf": [
{
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
}
]
}
}
}
}
}
},
"put": {
"tags": [
"Accounts"
],
"summary": "Update Account",
"operationId": "updateAccount",
"parameters": [
{
"name": "AccountId",
"in": "path",
"description": "Account ID to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"status"
],
"properties": {
"status": {
"type": "string",
"enum": [
"active",
"disabled"
],
"description": "Account's Status"
}
}
}
],
"xml": {
"name": "request"
}
}
},
"application/xml": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"status"
],
"properties": {
"status": {
"type": "string",
"enum": [
"active",
"disabled"
],
"description": "Account's Status"
}
}
}
],
"xml": {
"name": "request"
}
}
},
"text/xml": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"status"
],
"properties": {
"status": {
"type": "string",
"enum": [
"active",
"disabled"
],
"description": "Account's Status"
}
}
}
],
"xml": {
"name": "request"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
}
]
}
},
"application/xml": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
}
]
}
},
"text/xml": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
}
]
}
}
}
},
"default": {
"description": "Failed operation",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
},
{
"type": "object",
"properties": {
"account": {
"type": "object",
"required": [
"status"
],
"properties": {
"status": {
"type": "string",
"enum": [
"active",
"disabled"
],
"description": "Account's Status"
}
}
}
}
}
]
}
},
"application/xml": {
"schema": {
"allOf": [
{
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
},
{
"type": "object",
"properties": {
"account": {
"type": "object",
"required": [
"status"
],
"properties": {
"status": {
"type": "string",
"enum": [
"active",
"disabled"
],
"description": "Account's Status"
}
}
}
}
}
]
}
},
"text/xml": {
"schema": {
"allOf": [
{
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
},
{
"type": "object",
"properties": {
"account": {
"type": "object",
"required": [
"status"
],
"properties": {
"status": {
"type": "string",
"enum": [
"active",
"disabled"
],
"description": "Account's Status"
}
}
}
}
}
]
}
}
}
}
}
}
},
"/apikey": {
"post": {
"tags": [
"Api Keys"
],
"summary": "Create API Key",
"operationId": "createApiKey",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"xml": {
"name": "request"
},
"required": [
"name",
"tier",
"environment"
],
"properties": {
"name": {
"type": "string",
"description": "API Key Name"
},
"description": {
"type": "string",
"description": "API Key Description"
},
"orgKey": {
"type": "string",
"description": "Organization Key or '\\_any\\_'. Required w/master key."
},
"connector": {
"type": "string",
"description": "Connector ID"
},
"integration": {
"type": "string",
"description": "Integration ID"
},
"tier": {
"type": "string",
"description": "Tier (payment plan)",
"enum": [
"free",
"basic",
"enterprise"
]
},
"environment": {
"type": "string",
"description": "Environment ID",
"enum": [
"test",
"prod"
]
},
"methods": {
"type": "object",
"description": "Access Methods Allowed",
"x-p17-methods": true,
"properties": {
"accounts": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
},
"apikey": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
},
"arrivals": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
},
"connectors": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
},
"fulfillments": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
},
"integrations": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
},
"inventory": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
},
"inventoryrules": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
},
"locations": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
},
"mappings": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
},
"orders": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
},
"organizations": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
},
"products": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
},
"purchases": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
},
"receipts": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
},
"roles": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
},
"routings": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
},
"shipments": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
},
"transfers": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
},
"users": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
},
"webhooks": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"type": "object",
"xml": {
"name": "request"
},
"required": [
"name",
"tier",
"environment"
],
"properties": {
"name": {
"type": "string",
"description": "API Key Name"
},
"description": {
"type": "string",
"description": "API Key Description"
},
"orgKey": {
"type": "string",
"description": "Organization Key or '\\_any\\_'. Required w/master key."
},
"connector": {
"type": "string",
"description": "Connector ID"
},
"integration": {
"type": "string",
"description": "Integration ID"
},
"tier": {
"type": "string",
"description": "Tier (payment plan)",
"enum": [
"free",
"basic",
"enterprise"
]
},
"environment": {
"type": "string",
"description": "Environment ID",
"enum": [
"test",
"prod"
]
},
"methods": {
"type": "object",
"description": "Access Methods Allowed",
"x-p17-methods": true,
"properties": {
"accounts": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
},
"apikey": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
},
"arrivals": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
},
"connectors": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
},
"fulfillments": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
},
"integrations": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
},
"inventory": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
},
"inventoryrules": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
},
"locations": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
},
"mappings": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
},
"orders": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
},
"organizations": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
},
"products": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
},
"purchases": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
},
"receipts": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
},
"roles": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
},
"routings": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
},
"shipments": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
},
"transfers": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
},
"users": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
},
"webhooks": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
}
}
}
}
}
},
"text/xml": {
"schema": {
"type": "object",
"xml": {
"name": "request"
},
"required": [
"name",
"tier",
"environment"
],
"properties": {
"name": {
"type": "string",
"description": "API Key Name"
},
"description": {
"type": "string",
"description": "API Key Description"
},
"orgKey": {
"type": "string",
"description": "Organization Key or '\\_any\\_'. Required w/master key."
},
"connector": {
"type": "string",
"description": "Connector ID"
},
"integration": {
"type": "string",
"description": "Integration ID"
},
"tier": {
"type": "string",
"description": "Tier (payment plan)",
"enum": [
"free",
"basic",
"enterprise"
]
},
"environment": {
"type": "string",
"description": "Environment ID",
"enum": [
"test",
"prod"
]
},
"methods": {
"type": "object",
"description": "Access Methods Allowed",
"x-p17-methods": true,
"properties": {
"accounts": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
},
"apikey": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
},
"arrivals": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
},
"connectors": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
},
"fulfillments": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
},
"integrations": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
},
"inventory": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
},
"inventoryrules": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
},
"locations": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
},
"mappings": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
},
"orders": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
},
"organizations": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
},
"products": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
},
"purchases": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
},
"receipts": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
},
"roles": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
},
"routings": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
},
"shipments": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
},
"transfers": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
},
"users": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
},
"webhooks": {
"type": "string",
"enum": [
"<c,r,u,d,l>",
"<r,u,d,l>",
"<r,u,l>",
"<r,l>",
"<r>",
"<l>"
]
}
}
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
},
{
"type": "object",
"required": [
"apikey"
],
"properties": {
"apikey": {
"type": "string",
"description": "New Api Key"
}
}
}
]
}
},
"application/xml": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
},
{
"type": "object",
"required": [
"apikey"
],
"properties": {
"apikey": {
"type": "string",
"description": "New Api Key"
}
}
}
]
}
},
"text/xml": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
},
{
"type": "object",
"required": [
"apikey"
],
"properties": {
"apikey": {
"type": "string",
"description": "New Api Key"
}
}
}
]
}
}
}
},
"default": {
"description": "Failed operation",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
}
]
}
},
"application/xml": {
"schema": {
"allOf": [
{
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
}
]
}
},
"text/xml": {
"schema": {
"allOf": [
{
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
}
]
}
}
}
}
}
}
},
"/apikey/{ApiKey}": {
"delete": {
"tags": [
"Api Keys"
],
"summary": "Delete API Key",
"operationId": "deleteApiKey",
"parameters": [
{
"name": "ApiKey",
"in": "path",
"description": "API Key to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"201": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
}
},
"application/xml": {
"schema": {
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
}
},
"text/xml": {
"schema": {
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
}
}
}
},
"default": {
"description": "Failed operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
}
},
"application/xml": {
"schema": {
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
}
},
"text/xml": {
"schema": {
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
}
}
}
}
}
}
},
"/arrivals": {
"post": {
"tags": [
"Arrivals"
],
"summary": "Create Arrival Notifications",
"operationId": "createArrivals",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"xml": {
"name": "arrival"
},
"required": [
"senderName",
"toLocationId"
],
"properties": {
"transferId": {
"type": "string",
"description": "Transfer Order ID"
},
"purchaseId": {
"type": "string",
"description": "Purchase Order ID"
},
"fulfillmentId": {
"type": "string",
"description": "Fulfillment ID"
},
"extOrderId": {
"type": "string",
"description": "External TO or PO ID"
},
"senderName": {
"type": "string",
"description": "Sender's Name"
},
"expectedArrivalDate": {
"type": "string",
"format": "date-time",
"description": "Expected Arrival Date"
},
"toLocationId": {
"type": "string",
"description": "Arrival Location ID"
},
"fromLocationId": {
"type": "string",
"description": "Sender Location ID (for TO)"
},
"fromAddress": {
"type": "object",
"properties": {
"address1": {
"description": "Address Line 1",
"type": "string"
},
"address2": {
"description": "Address Line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"stateOrProvince": {
"description": "State or Province",
"type": "string"
},
"zipCodeOrPostalCode": {
"description": "zipcode or postal code",
"type": "string"
},
"country": {
"description": "Country",
"type": "string"
},
"email": {
"description": "email",
"type": "string"
},
"phone": {
"description": "Phone",
"type": "string"
}
}
},
"shippingCarrier": {
"type": "string",
"description": "Shipping Carrier"
},
"shippingMethod": {
"type": "string",
"description": "Shipping Method"
},
"shippingNote": {
"type": "string",
"description": "Shipping Note"
},
"incoterms": {
"type": "string",
"description": "International Commercial Terms"
},
"totalWeight": {
"type": "string",
"description": "Total Weight"
},
"weightUnit": {
"type": "string",
"description": "Weight Unit"
},
"lineItems": {
"type": "array",
"items": {
"type": "object",
"required": [
"uniqueId",
"sku",
"quantity"
],
"properties": {
"uniqueId": {
"type": "string",
"description": "Item unique Id (within an order)"
},
"sku": {
"type": "string",
"description": "Item SKU"
},
"quantity": {
"type": "number",
"format": "float",
"description": "Item Quantity"
},
"name": {
"type": "string",
"description": "Item Name"
},
"upc": {
"type": "string",
"description": "Item UPC"
}
}
}
}
}
},
"xml": {
"name": "request",
"wrapped": true
},
"maxItems": 10
}
},
"application/xml": {
"schema": {
"type": "array",
"items": {
"type": "object",
"xml": {
"name": "arrival"
},
"required": [
"senderName",
"toLocationId"
],
"properties": {
"transferId": {
"type": "string",
"description": "Transfer Order ID"
},
"purchaseId": {
"type": "string",
"description": "Purchase Order ID"
},
"fulfillmentId": {
"type": "string",
"description": "Fulfillment ID"
},
"extOrderId": {
"type": "string",
"description": "External TO or PO ID"
},
"senderName": {
"type": "string",
"description": "Sender's Name"
},
"expectedArrivalDate": {
"type": "string",
"format": "date-time",
"description": "Expected Arrival Date"
},
"toLocationId": {
"type": "string",
"description": "Arrival Location ID"
},
"fromLocationId": {
"type": "string",
"description": "Sender Location ID (for TO)"
},
"fromAddress": {
"type": "object",
"properties": {
"address1": {
"description": "Address Line 1",
"type": "string"
},
"address2": {
"description": "Address Line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"stateOrProvince": {
"description": "State or Province",
"type": "string"
},
"zipCodeOrPostalCode": {
"description": "zipcode or postal code",
"type": "string"
},
"country": {
"description": "Country",
"type": "string"
},
"email": {
"description": "email",
"type": "string"
},
"phone": {
"description": "Phone",
"type": "string"
}
}
},
"shippingCarrier": {
"type": "string",
"description": "Shipping Carrier"
},
"shippingMethod": {
"type": "string",
"description": "Shipping Method"
},
"shippingNote": {
"type": "string",
"description": "Shipping Note"
},
"incoterms": {
"type": "string",
"description": "International Commercial Terms"
},
"totalWeight": {
"type": "string",
"description": "Total Weight"
},
"weightUnit": {
"type": "string",
"description": "Weight Unit"
},
"lineItems": {
"type": "array",
"items": {
"type": "object",
"required": [
"uniqueId",
"sku",
"quantity"
],
"properties": {
"uniqueId": {
"type": "string",
"description": "Item unique Id (within an order)"
},
"sku": {
"type": "string",
"description": "Item SKU"
},
"quantity": {
"type": "number",
"format": "float",
"description": "Item Quantity"
},
"name": {
"type": "string",
"description": "Item Name"
},
"upc": {
"type": "string",
"description": "Item UPC"
}
}
}
}
}
},
"xml": {
"name": "request",
"wrapped": true
},
"maxItems": 10
}
},
"text/xml": {
"schema": {
"type": "array",
"items": {
"type": "object",
"xml": {
"name": "arrival"
},
"required": [
"senderName",
"toLocationId"
],
"properties": {
"transferId": {
"type": "string",
"description": "Transfer Order ID"
},
"purchaseId": {
"type": "string",
"description": "Purchase Order ID"
},
"fulfillmentId": {
"type": "string",
"description": "Fulfillment ID"
},
"extOrderId": {
"type": "string",
"description": "External TO or PO ID"
},
"senderName": {
"type": "string",
"description": "Sender's Name"
},
"expectedArrivalDate": {
"type": "string",
"format": "date-time",
"description": "Expected Arrival Date"
},
"toLocationId": {
"type": "string",
"description": "Arrival Location ID"
},
"fromLocationId": {
"type": "string",
"description": "Sender Location ID (for TO)"
},
"fromAddress": {
"type": "object",
"properties": {
"address1": {
"description": "Address Line 1",
"type": "string"
},
"address2": {
"description": "Address Line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"stateOrProvince": {
"description": "State or Province",
"type": "string"
},
"zipCodeOrPostalCode": {
"description": "zipcode or postal code",
"type": "string"
},
"country": {
"description": "Country",
"type": "string"
},
"email": {
"description": "email",
"type": "string"
},
"phone": {
"description": "Phone",
"type": "string"
}
}
},
"shippingCarrier": {
"type": "string",
"description": "Shipping Carrier"
},
"shippingMethod": {
"type": "string",
"description": "Shipping Method"
},
"shippingNote": {
"type": "string",
"description": "Shipping Note"
},
"incoterms": {
"type": "string",
"description": "International Commercial Terms"
},
"totalWeight": {
"type": "string",
"description": "Total Weight"
},
"weightUnit": {
"type": "string",
"description": "Weight Unit"
},
"lineItems": {
"type": "array",
"items": {
"type": "object",
"required": [
"uniqueId",
"sku",
"quantity"
],
"properties": {
"uniqueId": {
"type": "string",
"description": "Item unique Id (within an order)"
},
"sku": {
"type": "string",
"description": "Item SKU"
},
"quantity": {
"type": "number",
"format": "float",
"description": "Item Quantity"
},
"name": {
"type": "string",
"description": "Item Name"
},
"upc": {
"type": "string",
"description": "Item UPC"
}
}
}
}
}
},
"xml": {
"name": "request",
"wrapped": true
},
"maxItems": 10
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
},
{
"type": "object",
"properties": {
"arrivals": {
"type": "array",
"items": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"submitted",
"failed"
]
},
"message": {
"type": "string",
"description": "Error message if failed"
},
"errors": {
"type": "array",
"items": {
"type": "string"
},
"description": "Error details if failed"
},
"arrival": {
"allOf": [
{
"type": "object",
"properties": {
"arrivalId": {
"type": "string",
"description": "Arrival notification ID"
},
"status": {
"type": "string",
"description": "Arrival notification Status",
"enum": [
"shipped",
"received",
"partialReceived",
"canceled"
]
}
}
},
{
"type": "object",
"xml": {
"name": "arrival"
},
"required": [
"senderName",
"toLocationId"
],
"properties": {
"transferId": {
"type": "string",
"description": "Transfer Order ID"
},
"purchaseId": {
"type": "string",
"description": "Purchase Order ID"
},
"fulfillmentId": {
"type": "string",
"description": "Fulfillment ID"
},
"extOrderId": {
"type": "string",
"description": "External TO or PO ID"
},
"senderName": {
"type": "string",
"description": "Sender's Name"
},
"expectedArrivalDate": {
"type": "string",
"format": "date-time",
"description": "Expected Arrival Date"
},
"toLocationId": {
"type": "string",
"description": "Arrival Location ID"
},
"fromLocationId": {
"type": "string",
"description": "Sender Location ID (for TO)"
},
"fromAddress": {
"type": "object",
"properties": {
"address1": {
"description": "Address Line 1",
"type": "string"
},
"address2": {
"description": "Address Line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"stateOrProvince": {
"description": "State or Province",
"type": "string"
},
"zipCodeOrPostalCode": {
"description": "zipcode or postal code",
"type": "string"
},
"country": {
"description": "Country",
"type": "string"
},
"email": {
"description": "email",
"type": "string"
},
"phone": {
"description": "Phone",
"type": "string"
}
}
},
"shippingCarrier": {
"type": "string",
"description": "Shipping Carrier"
},
"shippingMethod": {
"type": "string",
"description": "Shipping Method"
},
"shippingNote": {
"type": "string",
"description": "Shipping Note"
},
"incoterms": {
"type": "string",
"description": "International Commercial Terms"
},
"totalWeight": {
"type": "string",
"description": "Total Weight"
},
"weightUnit": {
"type": "string",
"description": "Weight Unit"
},
"lineItems": {
"type": "array",
"items": {
"type": "object",
"required": [
"uniqueId",
"sku",
"quantity"
],
"properties": {
"uniqueId": {
"type": "string",
"description": "Item unique Id (within an order)"
},
"sku": {
"type": "string",
"description": "Item SKU"
},
"quantity": {
"type": "number",
"format": "float",
"description": "Item Quantity"
},
"name": {
"type": "string",
"description": "Item Name"
},
"upc": {
"type": "string",
"description": "Item UPC"
}
}
}
}
}
},
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was created within Pipe17"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was updated within Pipe17"
},
"orgKey": {
"type": "string",
"readOnly": true,
"description": "Organization this object belong to"
}
}
}
]
}
}
}
}
}
}
]
}
},
"application/xml": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
},
{
"type": "object",
"properties": {
"arrivals": {
"type": "array",
"items": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"submitted",
"failed"
]
},
"message": {
"type": "string",
"description": "Error message if failed"
},
"errors": {
"type": "array",
"items": {
"type": "string"
},
"description": "Error details if failed"
},
"arrival": {
"allOf": [
{
"type": "object",
"properties": {
"arrivalId": {
"type": "string",
"description": "Arrival notification ID"
},
"status": {
"type": "string",
"description": "Arrival notification Status",
"enum": [
"shipped",
"received",
"partialReceived",
"canceled"
]
}
}
},
{
"type": "object",
"xml": {
"name": "arrival"
},
"required": [
"senderName",
"toLocationId"
],
"properties": {
"transferId": {
"type": "string",
"description": "Transfer Order ID"
},
"purchaseId": {
"type": "string",
"description": "Purchase Order ID"
},
"fulfillmentId": {
"type": "string",
"description": "Fulfillment ID"
},
"extOrderId": {
"type": "string",
"description": "External TO or PO ID"
},
"senderName": {
"type": "string",
"description": "Sender's Name"
},
"expectedArrivalDate": {
"type": "string",
"format": "date-time",
"description": "Expected Arrival Date"
},
"toLocationId": {
"type": "string",
"description": "Arrival Location ID"
},
"fromLocationId": {
"type": "string",
"description": "Sender Location ID (for TO)"
},
"fromAddress": {
"type": "object",
"properties": {
"address1": {
"description": "Address Line 1",
"type": "string"
},
"address2": {
"description": "Address Line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"stateOrProvince": {
"description": "State or Province",
"type": "string"
},
"zipCodeOrPostalCode": {
"description": "zipcode or postal code",
"type": "string"
},
"country": {
"description": "Country",
"type": "string"
},
"email": {
"description": "email",
"type": "string"
},
"phone": {
"description": "Phone",
"type": "string"
}
}
},
"shippingCarrier": {
"type": "string",
"description": "Shipping Carrier"
},
"shippingMethod": {
"type": "string",
"description": "Shipping Method"
},
"shippingNote": {
"type": "string",
"description": "Shipping Note"
},
"incoterms": {
"type": "string",
"description": "International Commercial Terms"
},
"totalWeight": {
"type": "string",
"description": "Total Weight"
},
"weightUnit": {
"type": "string",
"description": "Weight Unit"
},
"lineItems": {
"type": "array",
"items": {
"type": "object",
"required": [
"uniqueId",
"sku",
"quantity"
],
"properties": {
"uniqueId": {
"type": "string",
"description": "Item unique Id (within an order)"
},
"sku": {
"type": "string",
"description": "Item SKU"
},
"quantity": {
"type": "number",
"format": "float",
"description": "Item Quantity"
},
"name": {
"type": "string",
"description": "Item Name"
},
"upc": {
"type": "string",
"description": "Item UPC"
}
}
}
}
}
},
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was created within Pipe17"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was updated within Pipe17"
},
"orgKey": {
"type": "string",
"readOnly": true,
"description": "Organization this object belong to"
}
}
}
]
}
}
}
}
}
}
]
}
},
"text/xml": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
},
{
"type": "object",
"properties": {
"arrivals": {
"type": "array",
"items": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"submitted",
"failed"
]
},
"message": {
"type": "string",
"description": "Error message if failed"
},
"errors": {
"type": "array",
"items": {
"type": "string"
},
"description": "Error details if failed"
},
"arrival": {
"allOf": [
{
"type": "object",
"properties": {
"arrivalId": {
"type": "string",
"description": "Arrival notification ID"
},
"status": {
"type": "string",
"description": "Arrival notification Status",
"enum": [
"shipped",
"received",
"partialReceived",
"canceled"
]
}
}
},
{
"type": "object",
"xml": {
"name": "arrival"
},
"required": [
"senderName",
"toLocationId"
],
"properties": {
"transferId": {
"type": "string",
"description": "Transfer Order ID"
},
"purchaseId": {
"type": "string",
"description": "Purchase Order ID"
},
"fulfillmentId": {
"type": "string",
"description": "Fulfillment ID"
},
"extOrderId": {
"type": "string",
"description": "External TO or PO ID"
},
"senderName": {
"type": "string",
"description": "Sender's Name"
},
"expectedArrivalDate": {
"type": "string",
"format": "date-time",
"description": "Expected Arrival Date"
},
"toLocationId": {
"type": "string",
"description": "Arrival Location ID"
},
"fromLocationId": {
"type": "string",
"description": "Sender Location ID (for TO)"
},
"fromAddress": {
"type": "object",
"properties": {
"address1": {
"description": "Address Line 1",
"type": "string"
},
"address2": {
"description": "Address Line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"stateOrProvince": {
"description": "State or Province",
"type": "string"
},
"zipCodeOrPostalCode": {
"description": "zipcode or postal code",
"type": "string"
},
"country": {
"description": "Country",
"type": "string"
},
"email": {
"description": "email",
"type": "string"
},
"phone": {
"description": "Phone",
"type": "string"
}
}
},
"shippingCarrier": {
"type": "string",
"description": "Shipping Carrier"
},
"shippingMethod": {
"type": "string",
"description": "Shipping Method"
},
"shippingNote": {
"type": "string",
"description": "Shipping Note"
},
"incoterms": {
"type": "string",
"description": "International Commercial Terms"
},
"totalWeight": {
"type": "string",
"description": "Total Weight"
},
"weightUnit": {
"type": "string",
"description": "Weight Unit"
},
"lineItems": {
"type": "array",
"items": {
"type": "object",
"required": [
"uniqueId",
"sku",
"quantity"
],
"properties": {
"uniqueId": {
"type": "string",
"description": "Item unique Id (within an order)"
},
"sku": {
"type": "string",
"description": "Item SKU"
},
"quantity": {
"type": "number",
"format": "float",
"description": "Item Quantity"
},
"name": {
"type": "string",
"description": "Item Name"
},
"upc": {
"type": "string",
"description": "Item UPC"
}
}
}
}
}
},
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was created within Pipe17"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was updated within Pipe17"
},
"orgKey": {
"type": "string",
"readOnly": true,
"description": "Organization this object belong to"
}
}
}
]
}
}
}
}
}
}
]
}
}
}
},
"default": {
"description": "Failed operation",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
}
]
}
},
"application/xml": {
"schema": {
"allOf": [
{
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
}
]
}
},
"text/xml": {
"schema": {
"allOf": [
{
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
}
]
}
}
}
}
}
},
"get": {
"tags": [
"Arrivals"
],
"summary": "List Arrival Notifications",
"operationId": "listArrivals",
"parameters": [
{
"name": "transferid",
"in": "query",
"schema": {
"type": "string"
},
"description": "Arrivals of specific transfer order"
},
{
"name": "purchaseid",
"in": "query",
"schema": {
"type": "string"
},
"description": "Arrivals of specific purchase order"
},
{
"name": "extorderid",
"in": "query",
"schema": {
"type": "string"
},
"description": "Arrivals with this external order id (PO or TO)"
},
{
"name": "status",
"in": "query",
"schema": {
"type": "string",
"description": "Arrival notification Status",
"enum": [
"shipped",
"received",
"partialReceived",
"canceled"
]
},
"description": "Arrivals in specific status"
},
{
"name": "since",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
},
"description": "Arrivals created after this date-time"
},
{
"name": "until",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
},
"description": "Arrivals created before this date-time"
},
{
"name": "updatedsince",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
},
"description": "Arrivals updated after this date-time"
},
{
"name": "updateduntil",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
},
"description": "Arrivals updated before this date-time"
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
},
"description": "Skip this many arrivals"
},
{
"name": "count",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
},
"description": "Return at most this many arrivals"
},
{
"name": "order",
"in": "query",
"schema": {
"type": "string"
},
"description": "List sort order"
},
{
"name": "keys",
"in": "query",
"schema": {
"type": "string"
},
"description": "Fields to retrieve"
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
},
{
"type": "object",
"required": [
"arrivals"
],
"properties": {
"filters": {
"type": "object",
"description": "Arrivals Filter",
"properties": {
"transferid": {
"type": "string",
"description": "Arrivals of specific transfer order"
},
"purchaseid": {
"type": "string",
"description": "Arrivals of specific purchase order"
},
"extorderid": {
"type": "string",
"description": "Arrivals with this external order id (PO or TO)"
},
"status": {
"type": "string",
"description": "Arrival notification Status",
"enum": [
"shipped",
"received",
"partialReceived",
"canceled"
]
},
"since": {
"type": "string",
"format": "date-time",
"description": "Arrivals created after this date-time"
},
"until": {
"type": "string",
"format": "date-time",
"description": "Arrivals created before this date-time"
},
"updatedsince": {
"type": "string",
"format": "date-time",
"description": "Arrivals updated after this date-time"
},
"updateduntil": {
"type": "string",
"format": "date-time",
"description": "Arrivals updated before this date-time"
},
"skip": {
"type": "integer",
"format": "int32",
"description": "Skip this many arrivals"
},
"count": {
"type": "integer",
"format": "int32",
"description": "Return at most this many arrivals"
},
"order": {
"type": "string",
"description": "List sort order"
},
"keys": {
"type": "string",
"description": "Fields to retrieve"
}
}
},
"arrivals": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"arrivalId": {
"type": "string",
"description": "Arrival notification ID"
},
"status": {
"type": "string",
"description": "Arrival notification Status",
"enum": [
"shipped",
"received",
"partialReceived",
"canceled"
]
}
}
},
{
"type": "object",
"xml": {
"name": "arrival"
},
"required": [
"senderName",
"toLocationId"
],
"properties": {
"transferId": {
"type": "string",
"description": "Transfer Order ID"
},
"purchaseId": {
"type": "string",
"description": "Purchase Order ID"
},
"fulfillmentId": {
"type": "string",
"description": "Fulfillment ID"
},
"extOrderId": {
"type": "string",
"description": "External TO or PO ID"
},
"senderName": {
"type": "string",
"description": "Sender's Name"
},
"expectedArrivalDate": {
"type": "string",
"format": "date-time",
"description": "Expected Arrival Date"
},
"toLocationId": {
"type": "string",
"description": "Arrival Location ID"
},
"fromLocationId": {
"type": "string",
"description": "Sender Location ID (for TO)"
},
"fromAddress": {
"type": "object",
"properties": {
"address1": {
"description": "Address Line 1",
"type": "string"
},
"address2": {
"description": "Address Line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"stateOrProvince": {
"description": "State or Province",
"type": "string"
},
"zipCodeOrPostalCode": {
"description": "zipcode or postal code",
"type": "string"
},
"country": {
"description": "Country",
"type": "string"
},
"email": {
"description": "email",
"type": "string"
},
"phone": {
"description": "Phone",
"type": "string"
}
}
},
"shippingCarrier": {
"type": "string",
"description": "Shipping Carrier"
},
"shippingMethod": {
"type": "string",
"description": "Shipping Method"
},
"shippingNote": {
"type": "string",
"description": "Shipping Note"
},
"incoterms": {
"type": "string",
"description": "International Commercial Terms"
},
"totalWeight": {
"type": "string",
"description": "Total Weight"
},
"weightUnit": {
"type": "string",
"description": "Weight Unit"
},
"lineItems": {
"type": "array",
"items": {
"type": "object",
"required": [
"uniqueId",
"sku",
"quantity"
],
"properties": {
"uniqueId": {
"type": "string",
"description": "Item unique Id (within an order)"
},
"sku": {
"type": "string",
"description": "Item SKU"
},
"quantity": {
"type": "number",
"format": "float",
"description": "Item Quantity"
},
"name": {
"type": "string",
"description": "Item Name"
},
"upc": {
"type": "string",
"description": "Item UPC"
}
}
}
}
}
},
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was created within Pipe17"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was updated within Pipe17"
},
"orgKey": {
"type": "string",
"readOnly": true,
"description": "Organization this object belong to"
}
}
}
]
}
}
}
}
]
}
},
"application/xml": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
},
{
"type": "object",
"required": [
"arrivals"
],
"properties": {
"filters": {
"type": "object",
"description": "Arrivals Filter",
"properties": {
"transferid": {
"type": "string",
"description": "Arrivals of specific transfer order"
},
"purchaseid": {
"type": "string",
"description": "Arrivals of specific purchase order"
},
"extorderid": {
"type": "string",
"description": "Arrivals with this external order id (PO or TO)"
},
"status": {
"type": "string",
"description": "Arrival notification Status",
"enum": [
"shipped",
"received",
"partialReceived",
"canceled"
]
},
"since": {
"type": "string",
"format": "date-time",
"description": "Arrivals created after this date-time"
},
"until": {
"type": "string",
"format": "date-time",
"description": "Arrivals created before this date-time"
},
"updatedsince": {
"type": "string",
"format": "date-time",
"description": "Arrivals updated after this date-time"
},
"updateduntil": {
"type": "string",
"format": "date-time",
"description": "Arrivals updated before this date-time"
},
"skip": {
"type": "integer",
"format": "int32",
"description": "Skip this many arrivals"
},
"count": {
"type": "integer",
"format": "int32",
"description": "Return at most this many arrivals"
},
"order": {
"type": "string",
"description": "List sort order"
},
"keys": {
"type": "string",
"description": "Fields to retrieve"
}
}
},
"arrivals": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"arrivalId": {
"type": "string",
"description": "Arrival notification ID"
},
"status": {
"type": "string",
"description": "Arrival notification Status",
"enum": [
"shipped",
"received",
"partialReceived",
"canceled"
]
}
}
},
{
"type": "object",
"xml": {
"name": "arrival"
},
"required": [
"senderName",
"toLocationId"
],
"properties": {
"transferId": {
"type": "string",
"description": "Transfer Order ID"
},
"purchaseId": {
"type": "string",
"description": "Purchase Order ID"
},
"fulfillmentId": {
"type": "string",
"description": "Fulfillment ID"
},
"extOrderId": {
"type": "string",
"description": "External TO or PO ID"
},
"senderName": {
"type": "string",
"description": "Sender's Name"
},
"expectedArrivalDate": {
"type": "string",
"format": "date-time",
"description": "Expected Arrival Date"
},
"toLocationId": {
"type": "string",
"description": "Arrival Location ID"
},
"fromLocationId": {
"type": "string",
"description": "Sender Location ID (for TO)"
},
"fromAddress": {
"type": "object",
"properties": {
"address1": {
"description": "Address Line 1",
"type": "string"
},
"address2": {
"description": "Address Line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"stateOrProvince": {
"description": "State or Province",
"type": "string"
},
"zipCodeOrPostalCode": {
"description": "zipcode or postal code",
"type": "string"
},
"country": {
"description": "Country",
"type": "string"
},
"email": {
"description": "email",
"type": "string"
},
"phone": {
"description": "Phone",
"type": "string"
}
}
},
"shippingCarrier": {
"type": "string",
"description": "Shipping Carrier"
},
"shippingMethod": {
"type": "string",
"description": "Shipping Method"
},
"shippingNote": {
"type": "string",
"description": "Shipping Note"
},
"incoterms": {
"type": "string",
"description": "International Commercial Terms"
},
"totalWeight": {
"type": "string",
"description": "Total Weight"
},
"weightUnit": {
"type": "string",
"description": "Weight Unit"
},
"lineItems": {
"type": "array",
"items": {
"type": "object",
"required": [
"uniqueId",
"sku",
"quantity"
],
"properties": {
"uniqueId": {
"type": "string",
"description": "Item unique Id (within an order)"
},
"sku": {
"type": "string",
"description": "Item SKU"
},
"quantity": {
"type": "number",
"format": "float",
"description": "Item Quantity"
},
"name": {
"type": "string",
"description": "Item Name"
},
"upc": {
"type": "string",
"description": "Item UPC"
}
}
}
}
}
},
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was created within Pipe17"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was updated within Pipe17"
},
"orgKey": {
"type": "string",
"readOnly": true,
"description": "Organization this object belong to"
}
}
}
]
}
}
}
}
]
}
},
"text/xml": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
},
{
"type": "object",
"required": [
"arrivals"
],
"properties": {
"filters": {
"type": "object",
"description": "Arrivals Filter",
"properties": {
"transferid": {
"type": "string",
"description": "Arrivals of specific transfer order"
},
"purchaseid": {
"type": "string",
"description": "Arrivals of specific purchase order"
},
"extorderid": {
"type": "string",
"description": "Arrivals with this external order id (PO or TO)"
},
"status": {
"type": "string",
"description": "Arrival notification Status",
"enum": [
"shipped",
"received",
"partialReceived",
"canceled"
]
},
"since": {
"type": "string",
"format": "date-time",
"description": "Arrivals created after this date-time"
},
"until": {
"type": "string",
"format": "date-time",
"description": "Arrivals created before this date-time"
},
"updatedsince": {
"type": "string",
"format": "date-time",
"description": "Arrivals updated after this date-time"
},
"updateduntil": {
"type": "string",
"format": "date-time",
"description": "Arrivals updated before this date-time"
},
"skip": {
"type": "integer",
"format": "int32",
"description": "Skip this many arrivals"
},
"count": {
"type": "integer",
"format": "int32",
"description": "Return at most this many arrivals"
},
"order": {
"type": "string",
"description": "List sort order"
},
"keys": {
"type": "string",
"description": "Fields to retrieve"
}
}
},
"arrivals": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"arrivalId": {
"type": "string",
"description": "Arrival notification ID"
},
"status": {
"type": "string",
"description": "Arrival notification Status",
"enum": [
"shipped",
"received",
"partialReceived",
"canceled"
]
}
}
},
{
"type": "object",
"xml": {
"name": "arrival"
},
"required": [
"senderName",
"toLocationId"
],
"properties": {
"transferId": {
"type": "string",
"description": "Transfer Order ID"
},
"purchaseId": {
"type": "string",
"description": "Purchase Order ID"
},
"fulfillmentId": {
"type": "string",
"description": "Fulfillment ID"
},
"extOrderId": {
"type": "string",
"description": "External TO or PO ID"
},
"senderName": {
"type": "string",
"description": "Sender's Name"
},
"expectedArrivalDate": {
"type": "string",
"format": "date-time",
"description": "Expected Arrival Date"
},
"toLocationId": {
"type": "string",
"description": "Arrival Location ID"
},
"fromLocationId": {
"type": "string",
"description": "Sender Location ID (for TO)"
},
"fromAddress": {
"type": "object",
"properties": {
"address1": {
"description": "Address Line 1",
"type": "string"
},
"address2": {
"description": "Address Line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"stateOrProvince": {
"description": "State or Province",
"type": "string"
},
"zipCodeOrPostalCode": {
"description": "zipcode or postal code",
"type": "string"
},
"country": {
"description": "Country",
"type": "string"
},
"email": {
"description": "email",
"type": "string"
},
"phone": {
"description": "Phone",
"type": "string"
}
}
},
"shippingCarrier": {
"type": "string",
"description": "Shipping Carrier"
},
"shippingMethod": {
"type": "string",
"description": "Shipping Method"
},
"shippingNote": {
"type": "string",
"description": "Shipping Note"
},
"incoterms": {
"type": "string",
"description": "International Commercial Terms"
},
"totalWeight": {
"type": "string",
"description": "Total Weight"
},
"weightUnit": {
"type": "string",
"description": "Weight Unit"
},
"lineItems": {
"type": "array",
"items": {
"type": "object",
"required": [
"uniqueId",
"sku",
"quantity"
],
"properties": {
"uniqueId": {
"type": "string",
"description": "Item unique Id (within an order)"
},
"sku": {
"type": "string",
"description": "Item SKU"
},
"quantity": {
"type": "number",
"format": "float",
"description": "Item Quantity"
},
"name": {
"type": "string",
"description": "Item Name"
},
"upc": {
"type": "string",
"description": "Item UPC"
}
}
}
}
}
},
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was created within Pipe17"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was updated within Pipe17"
},
"orgKey": {
"type": "string",
"readOnly": true,
"description": "Organization this object belong to"
}
}
}
]
}
}
}
}
]
}
}
}
},
"default": {
"description": "Failed operation",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
},
{
"type": "object",
"properties": {
"filters": {
"type": "object",
"description": "Arrivals Filter",
"properties": {
"transferid": {
"type": "string",
"description": "Arrivals of specific transfer order"
},
"purchaseid": {
"type": "string",
"description": "Arrivals of specific purchase order"
},
"extorderid": {
"type": "string",
"description": "Arrivals with this external order id (PO or TO)"
},
"status": {
"type": "string",
"description": "Arrival notification Status",
"enum": [
"shipped",
"received",
"partialReceived",
"canceled"
]
},
"since": {
"type": "string",
"format": "date-time",
"description": "Arrivals created after this date-time"
},
"until": {
"type": "string",
"format": "date-time",
"description": "Arrivals created before this date-time"
},
"updatedsince": {
"type": "string",
"format": "date-time",
"description": "Arrivals updated after this date-time"
},
"updateduntil": {
"type": "string",
"format": "date-time",
"description": "Arrivals updated before this date-time"
},
"skip": {
"type": "integer",
"format": "int32",
"description": "Skip this many arrivals"
},
"count": {
"type": "integer",
"format": "int32",
"description": "Return at most this many arrivals"
},
"order": {
"type": "string",
"description": "List sort order"
},
"keys": {
"type": "string",
"description": "Fields to retrieve"
}
}
}
}
}
]
}
},
"application/xml": {
"schema": {
"allOf": [
{
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
},
{
"type": "object",
"properties": {
"filters": {
"type": "object",
"description": "Arrivals Filter",
"properties": {
"transferid": {
"type": "string",
"description": "Arrivals of specific transfer order"
},
"purchaseid": {
"type": "string",
"description": "Arrivals of specific purchase order"
},
"extorderid": {
"type": "string",
"description": "Arrivals with this external order id (PO or TO)"
},
"status": {
"type": "string",
"description": "Arrival notification Status",
"enum": [
"shipped",
"received",
"partialReceived",
"canceled"
]
},
"since": {
"type": "string",
"format": "date-time",
"description": "Arrivals created after this date-time"
},
"until": {
"type": "string",
"format": "date-time",
"description": "Arrivals created before this date-time"
},
"updatedsince": {
"type": "string",
"format": "date-time",
"description": "Arrivals updated after this date-time"
},
"updateduntil": {
"type": "string",
"format": "date-time",
"description": "Arrivals updated before this date-time"
},
"skip": {
"type": "integer",
"format": "int32",
"description": "Skip this many arrivals"
},
"count": {
"type": "integer",
"format": "int32",
"description": "Return at most this many arrivals"
},
"order": {
"type": "string",
"description": "List sort order"
},
"keys": {
"type": "string",
"description": "Fields to retrieve"
}
}
}
}
}
]
}
},
"text/xml": {
"schema": {
"allOf": [
{
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
},
{
"type": "object",
"properties": {
"filters": {
"type": "object",
"description": "Arrivals Filter",
"properties": {
"transferid": {
"type": "string",
"description": "Arrivals of specific transfer order"
},
"purchaseid": {
"type": "string",
"description": "Arrivals of specific purchase order"
},
"extorderid": {
"type": "string",
"description": "Arrivals with this external order id (PO or TO)"
},
"status": {
"type": "string",
"description": "Arrival notification Status",
"enum": [
"shipped",
"received",
"partialReceived",
"canceled"
]
},
"since": {
"type": "string",
"format": "date-time",
"description": "Arrivals created after this date-time"
},
"until": {
"type": "string",
"format": "date-time",
"description": "Arrivals created before this date-time"
},
"updatedsince": {
"type": "string",
"format": "date-time",
"description": "Arrivals updated after this date-time"
},
"updateduntil": {
"type": "string",
"format": "date-time",
"description": "Arrivals updated before this date-time"
},
"skip": {
"type": "integer",
"format": "int32",
"description": "Skip this many arrivals"
},
"count": {
"type": "integer",
"format": "int32",
"description": "Return at most this many arrivals"
},
"order": {
"type": "string",
"description": "List sort order"
},
"keys": {
"type": "string",
"description": "Fields to retrieve"
}
}
}
}
}
]
}
}
}
}
}
}
},
"/arrivals/{ArrivalId}": {
"get": {
"tags": [
"Arrivals"
],
"summary": "Fetch Arrival Notification",
"operationId": "fetchArrival",
"parameters": [
{
"name": "ArrivalId",
"in": "path",
"description": "Arrival Id to fetch",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
},
{
"type": "object",
"properties": {
"arrival": {
"allOf": [
{
"type": "object",
"properties": {
"arrivalId": {
"type": "string",
"description": "Arrival notification ID"
},
"status": {
"type": "string",
"description": "Arrival notification Status",
"enum": [
"shipped",
"received",
"partialReceived",
"canceled"
]
}
}
},
{
"type": "object",
"xml": {
"name": "arrival"
},
"required": [
"senderName",
"toLocationId"
],
"properties": {
"transferId": {
"type": "string",
"description": "Transfer Order ID"
},
"purchaseId": {
"type": "string",
"description": "Purchase Order ID"
},
"fulfillmentId": {
"type": "string",
"description": "Fulfillment ID"
},
"extOrderId": {
"type": "string",
"description": "External TO or PO ID"
},
"senderName": {
"type": "string",
"description": "Sender's Name"
},
"expectedArrivalDate": {
"type": "string",
"format": "date-time",
"description": "Expected Arrival Date"
},
"toLocationId": {
"type": "string",
"description": "Arrival Location ID"
},
"fromLocationId": {
"type": "string",
"description": "Sender Location ID (for TO)"
},
"fromAddress": {
"type": "object",
"properties": {
"address1": {
"description": "Address Line 1",
"type": "string"
},
"address2": {
"description": "Address Line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"stateOrProvince": {
"description": "State or Province",
"type": "string"
},
"zipCodeOrPostalCode": {
"description": "zipcode or postal code",
"type": "string"
},
"country": {
"description": "Country",
"type": "string"
},
"email": {
"description": "email",
"type": "string"
},
"phone": {
"description": "Phone",
"type": "string"
}
}
},
"shippingCarrier": {
"type": "string",
"description": "Shipping Carrier"
},
"shippingMethod": {
"type": "string",
"description": "Shipping Method"
},
"shippingNote": {
"type": "string",
"description": "Shipping Note"
},
"incoterms": {
"type": "string",
"description": "International Commercial Terms"
},
"totalWeight": {
"type": "string",
"description": "Total Weight"
},
"weightUnit": {
"type": "string",
"description": "Weight Unit"
},
"lineItems": {
"type": "array",
"items": {
"type": "object",
"required": [
"uniqueId",
"sku",
"quantity"
],
"properties": {
"uniqueId": {
"type": "string",
"description": "Item unique Id (within an order)"
},
"sku": {
"type": "string",
"description": "Item SKU"
},
"quantity": {
"type": "number",
"format": "float",
"description": "Item Quantity"
},
"name": {
"type": "string",
"description": "Item Name"
},
"upc": {
"type": "string",
"description": "Item UPC"
}
}
}
}
}
},
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was created within Pipe17"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was updated within Pipe17"
},
"orgKey": {
"type": "string",
"readOnly": true,
"description": "Organization this object belong to"
}
}
}
]
}
}
}
]
}
},
"application/xml": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
},
{
"type": "object",
"properties": {
"arrival": {
"allOf": [
{
"type": "object",
"properties": {
"arrivalId": {
"type": "string",
"description": "Arrival notification ID"
},
"status": {
"type": "string",
"description": "Arrival notification Status",
"enum": [
"shipped",
"received",
"partialReceived",
"canceled"
]
}
}
},
{
"type": "object",
"xml": {
"name": "arrival"
},
"required": [
"senderName",
"toLocationId"
],
"properties": {
"transferId": {
"type": "string",
"description": "Transfer Order ID"
},
"purchaseId": {
"type": "string",
"description": "Purchase Order ID"
},
"fulfillmentId": {
"type": "string",
"description": "Fulfillment ID"
},
"extOrderId": {
"type": "string",
"description": "External TO or PO ID"
},
"senderName": {
"type": "string",
"description": "Sender's Name"
},
"expectedArrivalDate": {
"type": "string",
"format": "date-time",
"description": "Expected Arrival Date"
},
"toLocationId": {
"type": "string",
"description": "Arrival Location ID"
},
"fromLocationId": {
"type": "string",
"description": "Sender Location ID (for TO)"
},
"fromAddress": {
"type": "object",
"properties": {
"address1": {
"description": "Address Line 1",
"type": "string"
},
"address2": {
"description": "Address Line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"stateOrProvince": {
"description": "State or Province",
"type": "string"
},
"zipCodeOrPostalCode": {
"description": "zipcode or postal code",
"type": "string"
},
"country": {
"description": "Country",
"type": "string"
},
"email": {
"description": "email",
"type": "string"
},
"phone": {
"description": "Phone",
"type": "string"
}
}
},
"shippingCarrier": {
"type": "string",
"description": "Shipping Carrier"
},
"shippingMethod": {
"type": "string",
"description": "Shipping Method"
},
"shippingNote": {
"type": "string",
"description": "Shipping Note"
},
"incoterms": {
"type": "string",
"description": "International Commercial Terms"
},
"totalWeight": {
"type": "string",
"description": "Total Weight"
},
"weightUnit": {
"type": "string",
"description": "Weight Unit"
},
"lineItems": {
"type": "array",
"items": {
"type": "object",
"required": [
"uniqueId",
"sku",
"quantity"
],
"properties": {
"uniqueId": {
"type": "string",
"description": "Item unique Id (within an order)"
},
"sku": {
"type": "string",
"description": "Item SKU"
},
"quantity": {
"type": "number",
"format": "float",
"description": "Item Quantity"
},
"name": {
"type": "string",
"description": "Item Name"
},
"upc": {
"type": "string",
"description": "Item UPC"
}
}
}
}
}
},
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was created within Pipe17"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was updated within Pipe17"
},
"orgKey": {
"type": "string",
"readOnly": true,
"description": "Organization this object belong to"
}
}
}
]
}
}
}
]
}
},
"text/xml": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
},
{
"type": "object",
"properties": {
"arrival": {
"allOf": [
{
"type": "object",
"properties": {
"arrivalId": {
"type": "string",
"description": "Arrival notification ID"
},
"status": {
"type": "string",
"description": "Arrival notification Status",
"enum": [
"shipped",
"received",
"partialReceived",
"canceled"
]
}
}
},
{
"type": "object",
"xml": {
"name": "arrival"
},
"required": [
"senderName",
"toLocationId"
],
"properties": {
"transferId": {
"type": "string",
"description": "Transfer Order ID"
},
"purchaseId": {
"type": "string",
"description": "Purchase Order ID"
},
"fulfillmentId": {
"type": "string",
"description": "Fulfillment ID"
},
"extOrderId": {
"type": "string",
"description": "External TO or PO ID"
},
"senderName": {
"type": "string",
"description": "Sender's Name"
},
"expectedArrivalDate": {
"type": "string",
"format": "date-time",
"description": "Expected Arrival Date"
},
"toLocationId": {
"type": "string",
"description": "Arrival Location ID"
},
"fromLocationId": {
"type": "string",
"description": "Sender Location ID (for TO)"
},
"fromAddress": {
"type": "object",
"properties": {
"address1": {
"description": "Address Line 1",
"type": "string"
},
"address2": {
"description": "Address Line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"stateOrProvince": {
"description": "State or Province",
"type": "string"
},
"zipCodeOrPostalCode": {
"description": "zipcode or postal code",
"type": "string"
},
"country": {
"description": "Country",
"type": "string"
},
"email": {
"description": "email",
"type": "string"
},
"phone": {
"description": "Phone",
"type": "string"
}
}
},
"shippingCarrier": {
"type": "string",
"description": "Shipping Carrier"
},
"shippingMethod": {
"type": "string",
"description": "Shipping Method"
},
"shippingNote": {
"type": "string",
"description": "Shipping Note"
},
"incoterms": {
"type": "string",
"description": "International Commercial Terms"
},
"totalWeight": {
"type": "string",
"description": "Total Weight"
},
"weightUnit": {
"type": "string",
"description": "Weight Unit"
},
"lineItems": {
"type": "array",
"items": {
"type": "object",
"required": [
"uniqueId",
"sku",
"quantity"
],
"properties": {
"uniqueId": {
"type": "string",
"description": "Item unique Id (within an order)"
},
"sku": {
"type": "string",
"description": "Item SKU"
},
"quantity": {
"type": "number",
"format": "float",
"description": "Item Quantity"
},
"name": {
"type": "string",
"description": "Item Name"
},
"upc": {
"type": "string",
"description": "Item UPC"
}
}
}
}
}
},
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was created within Pipe17"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was updated within Pipe17"
},
"orgKey": {
"type": "string",
"readOnly": true,
"description": "Organization this object belong to"
}
}
}
]
}
}
}
]
}
}
}
},
"default": {
"description": "Failed operation",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
}
]
}
},
"application/xml": {
"schema": {
"allOf": [
{
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
}
]
}
},
"text/xml": {
"schema": {
"allOf": [
{
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
}
]
}
}
}
}
}
},
"put": {
"tags": [
"Arrivals"
],
"summary": "Update Arrival Notification",
"operationId": "updateArrival",
"parameters": [
{
"name": "ArrivalId",
"in": "path",
"description": "Arrival Id to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"canceled"
],
"description": "Arrival's Status"
}
}
}
],
"xml": {
"name": "request"
}
}
},
"application/xml": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"canceled"
],
"description": "Arrival's Status"
}
}
}
],
"xml": {
"name": "request"
}
}
},
"text/xml": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"canceled"
],
"description": "Arrival's Status"
}
}
}
],
"xml": {
"name": "request"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
}
]
}
},
"application/xml": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
}
]
}
},
"text/xml": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
}
]
}
}
}
},
"default": {
"description": "Failed operation",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
},
{
"type": "object",
"properties": {
"arrival": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"canceled"
],
"description": "Arrival's Status"
}
}
}
}
}
]
}
},
"application/xml": {
"schema": {
"allOf": [
{
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
},
{
"type": "object",
"properties": {
"arrival": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"canceled"
],
"description": "Arrival's Status"
}
}
}
}
}
]
}
},
"text/xml": {
"schema": {
"allOf": [
{
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
},
{
"type": "object",
"properties": {
"arrival": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"canceled"
],
"description": "Arrival's Status"
}
}
}
}
}
]
}
}
}
}
}
}
},
"/entity_schemas/{SchemaId}": {
"get": {
"tags": [
"Entity Schemas"
],
"summary": "Fetch Entity Schema",
"operationId": "fetchEntitySchema",
"parameters": [
{
"name": "SchemaId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
},
{
"type": "object",
"properties": {
"entitySchema": {
"allOf": [
{
"type": "object",
"properties": {
"schemaId": {
"type": "string",
"description": "Schema ID"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Schema name"
},
"fields": {
"type": "array",
"description": "Entity schema field descriptors",
"items": {
"type": "object",
"description": "Entity schema field descriptor"
}
},
"entity": {
"type": "string",
"description": "Entity Name",
"enum": [
"arrivals",
"fulfillments",
"inventory",
"locations",
"orders",
"order_regions",
"products",
"purchases",
"receipts",
"shipments",
"transfers"
]
}
},
"required": [
"name",
"fields",
"entity"
]
},
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was created within Pipe17"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was updated within Pipe17"
},
"orgKey": {
"type": "string",
"readOnly": true,
"description": "Organization this object belong to"
}
}
}
]
}
}
}
]
}
},
"application/xml": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
},
{
"type": "object",
"properties": {
"entitySchema": {
"allOf": [
{
"type": "object",
"properties": {
"schemaId": {
"type": "string",
"description": "Schema ID"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Schema name"
},
"fields": {
"type": "array",
"description": "Entity schema field descriptors",
"items": {
"type": "object",
"description": "Entity schema field descriptor"
}
},
"entity": {
"type": "string",
"description": "Entity Name",
"enum": [
"arrivals",
"fulfillments",
"inventory",
"locations",
"orders",
"order_regions",
"products",
"purchases",
"receipts",
"shipments",
"transfers"
]
}
},
"required": [
"name",
"fields",
"entity"
]
},
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was created within Pipe17"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was updated within Pipe17"
},
"orgKey": {
"type": "string",
"readOnly": true,
"description": "Organization this object belong to"
}
}
}
]
}
}
}
]
}
},
"text/xml": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
},
{
"type": "object",
"properties": {
"entitySchema": {
"allOf": [
{
"type": "object",
"properties": {
"schemaId": {
"type": "string",
"description": "Schema ID"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Schema name"
},
"fields": {
"type": "array",
"description": "Entity schema field descriptors",
"items": {
"type": "object",
"description": "Entity schema field descriptor"
}
},
"entity": {
"type": "string",
"description": "Entity Name",
"enum": [
"arrivals",
"fulfillments",
"inventory",
"locations",
"orders",
"order_regions",
"products",
"purchases",
"receipts",
"shipments",
"transfers"
]
}
},
"required": [
"name",
"fields",
"entity"
]
},
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was created within Pipe17"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was updated within Pipe17"
},
"orgKey": {
"type": "string",
"readOnly": true,
"description": "Organization this object belong to"
}
}
}
]
}
}
}
]
}
}
}
},
"default": {
"description": "Failed operation",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
}
]
}
},
"application/xml": {
"schema": {
"allOf": [
{
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
}
]
}
},
"text/xml": {
"schema": {
"allOf": [
{
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
}
]
}
}
}
}
}
},
"put": {
"tags": [
"Entity Schemas"
],
"summary": "Update Entity Schema",
"operationId": "updateEntitySchema",
"parameters": [
{
"name": "SchemaId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Schema name"
},
"fields": {
"type": "array",
"description": "Entity schema field descriptors",
"items": {
"type": "object",
"description": "Entity schema field descriptor"
}
}
}
}
],
"xml": {
"name": "request"
}
}
},
"application/xml": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Schema name"
},
"fields": {
"type": "array",
"description": "Entity schema field descriptors",
"items": {
"type": "object",
"description": "Entity schema field descriptor"
}
}
}
}
],
"xml": {
"name": "request"
}
}
},
"text/xml": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Schema name"
},
"fields": {
"type": "array",
"description": "Entity schema field descriptors",
"items": {
"type": "object",
"description": "Entity schema field descriptor"
}
}
}
}
],
"xml": {
"name": "request"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
}
]
}
},
"application/xml": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
}
]
}
},
"text/xml": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
}
]
}
}
}
},
"default": {
"description": "Failed operation",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
}
]
}
},
"application/xml": {
"schema": {
"allOf": [
{
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
}
]
}
},
"text/xml": {
"schema": {
"allOf": [
{
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
}
]
}
}
}
}
}
}
},
"/integrations": {
"post": {
"tags": [
"Integrations"
],
"summary": "Create Integration",
"operationId": "createIntegration",
"requestBody": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"integrationName",
"environment"
],
"properties": {
"integrationName": {
"type": "string",
"description": "Integration Name"
},
"connectorName": {
"type": "string",
"description": "Connector Name (either Name or ID required)"
},
"connectorId": {
"type": "string",
"description": "Connector ID (either Name or ID required)"
},
"environment": {
"type": "string",
"description": "Environment ID",
"enum": [
"test",
"prod"
]
},
"entities": {
"type": "array",
"items": {
"type": "object",
"description": "Mapping or Routing Entity",
"properties": {
"name": {
"type": "string",
"description": "Entity Name",
"enum": [
"arrivals",
"fulfillments",
"inventory",
"locations",
"orders",
"order_regions",
"products",
"purchases",
"receipts",
"shipments",
"transfers"
]
},
"direction": {
"type": "string",
"description": "Route/Mapping Direction",
"enum": [
"in",
"out"
]
},
"mappingUuid": {
"type": "string",
"description": "Mapping Id"
},
"routingUuid": {
"description": "Routing Id",
"type": "string"
}
}
}
},
"settings": {
"type": "object",
"description": "Connector specific",
"properties": {
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Setting Option Name"
},
"value": {
"type": "string",
"description": "Setting Option Value"
}
}
},
"description": "correspond to ui fields"
}
}
},
"connection": {
"type": "object",
"description": "3rd party's credentials",
"properties": {
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Connection Option Name"
},
"value": {
"type": "string",
"description": "Connection Option Value"
}
}
},
"description": "correspond to ui fields"
}
}
}
}
}
],
"xml": {
"name": "request"
}
}
},
"application/xml": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"integrationName",
"environment"
],
"properties": {
"integrationName": {
"type": "string",
"description": "Integration Name"
},
"connectorName": {
"type": "string",
"description": "Connector Name (either Name or ID required)"
},
"connectorId": {
"type": "string",
"description": "Connector ID (either Name or ID required)"
},
"environment": {
"type": "string",
"description": "Environment ID",
"enum": [
"test",
"prod"
]
},
"entities": {
"type": "array",
"items": {
"type": "object",
"description": "Mapping or Routing Entity",
"properties": {
"name": {
"type": "string",
"description": "Entity Name",
"enum": [
"arrivals",
"fulfillments",
"inventory",
"locations",
"orders",
"order_regions",
"products",
"purchases",
"receipts",
"shipments",
"transfers"
]
},
"direction": {
"type": "string",
"description": "Route/Mapping Direction",
"enum": [
"in",
"out"
]
},
"mappingUuid": {
"type": "string",
"description": "Mapping Id"
},
"routingUuid": {
"description": "Routing Id",
"type": "string"
}
}
}
},
"settings": {
"type": "object",
"description": "Connector specific",
"properties": {
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Setting Option Name"
},
"value": {
"type": "string",
"description": "Setting Option Value"
}
}
},
"description": "correspond to ui fields"
}
}
},
"connection": {
"type": "object",
"description": "3rd party's credentials",
"properties": {
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Connection Option Name"
},
"value": {
"type": "string",
"description": "Connection Option Value"
}
}
},
"description": "correspond to ui fields"
}
}
}
}
}
],
"xml": {
"name": "request"
}
}
},
"text/xml": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"integrationName",
"environment"
],
"properties": {
"integrationName": {
"type": "string",
"description": "Integration Name"
},
"connectorName": {
"type": "string",
"description": "Connector Name (either Name or ID required)"
},
"connectorId": {
"type": "string",
"description": "Connector ID (either Name or ID required)"
},
"environment": {
"type": "string",
"description": "Environment ID",
"enum": [
"test",
"prod"
]
},
"entities": {
"type": "array",
"items": {
"type": "object",
"description": "Mapping or Routing Entity",
"properties": {
"name": {
"type": "string",
"description": "Entity Name",
"enum": [
"arrivals",
"fulfillments",
"inventory",
"locations",
"orders",
"order_regions",
"products",
"purchases",
"receipts",
"shipments",
"transfers"
]
},
"direction": {
"type": "string",
"description": "Route/Mapping Direction",
"enum": [
"in",
"out"
]
},
"mappingUuid": {
"type": "string",
"description": "Mapping Id"
},
"routingUuid": {
"description": "Routing Id",
"type": "string"
}
}
}
},
"settings": {
"type": "object",
"description": "Connector specific",
"properties": {
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Setting Option Name"
},
"value": {
"type": "string",
"description": "Setting Option Value"
}
}
},
"description": "correspond to ui fields"
}
}
},
"connection": {
"type": "object",
"description": "3rd party's credentials",
"properties": {
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Connection Option Name"
},
"value": {
"type": "string",
"description": "Connection Option Value"
}
}
},
"description": "correspond to ui fields"
}
}
}
}
}
],
"xml": {
"name": "request"
}
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
},
{
"type": "object",
"properties": {
"integration": {
"allOf": [
{
"type": "object",
"properties": {
"integrationId": {
"type": "string",
"description": "Integration Id"
},
"status": {
"type": "string",
"description": "Integration Status",
"enum": [
"created",
"configured",
"connected",
"error"
]
},
"apikey": {
"type": "string",
"description": "Integration api Key"
}
}
},
{
"type": "object",
"required": [
"integrationName",
"environment"
],
"properties": {
"integrationName": {
"type": "string",
"description": "Integration Name"
},
"connectorName": {
"type": "string",
"description": "Connector Name (either Name or ID required)"
},
"connectorId": {
"type": "string",
"description": "Connector ID (either Name or ID required)"
},
"environment": {
"type": "string",
"description": "Environment ID",
"enum": [
"test",
"prod"
]
},
"entities": {
"type": "array",
"items": {
"type": "object",
"description": "Mapping or Routing Entity",
"properties": {
"name": {
"type": "string",
"description": "Entity Name",
"enum": [
"arrivals",
"fulfillments",
"inventory",
"locations",
"orders",
"order_regions",
"products",
"purchases",
"receipts",
"shipments",
"transfers"
]
},
"direction": {
"type": "string",
"description": "Route/Mapping Direction",
"enum": [
"in",
"out"
]
},
"mappingUuid": {
"type": "string",
"description": "Mapping Id"
},
"routingUuid": {
"description": "Routing Id",
"type": "string"
}
}
}
},
"settings": {
"type": "object",
"description": "Connector specific",
"properties": {
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Setting Option Name"
},
"value": {
"type": "string",
"description": "Setting Option Value"
}
}
},
"description": "correspond to ui fields"
}
}
},
"connection": {
"type": "object",
"description": "3rd party's credentials",
"properties": {
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Connection Option Name"
},
"value": {
"type": "string",
"description": "Connection Option Value"
}
}
},
"description": "correspond to ui fields"
}
}
}
}
},
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was created within Pipe17"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was updated within Pipe17"
},
"orgKey": {
"type": "string",
"readOnly": true,
"description": "Organization this object belong to"
}
}
}
]
}
}
}
]
}
},
"application/xml": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
},
{
"type": "object",
"properties": {
"integration": {
"allOf": [
{
"type": "object",
"properties": {
"integrationId": {
"type": "string",
"description": "Integration Id"
},
"status": {
"type": "string",
"description": "Integration Status",
"enum": [
"created",
"configured",
"connected",
"error"
]
},
"apikey": {
"type": "string",
"description": "Integration api Key"
}
}
},
{
"type": "object",
"required": [
"integrationName",
"environment"
],
"properties": {
"integrationName": {
"type": "string",
"description": "Integration Name"
},
"connectorName": {
"type": "string",
"description": "Connector Name (either Name or ID required)"
},
"connectorId": {
"type": "string",
"description": "Connector ID (either Name or ID required)"
},
"environment": {
"type": "string",
"description": "Environment ID",
"enum": [
"test",
"prod"
]
},
"entities": {
"type": "array",
"items": {
"type": "object",
"description": "Mapping or Routing Entity",
"properties": {
"name": {
"type": "string",
"description": "Entity Name",
"enum": [
"arrivals",
"fulfillments",
"inventory",
"locations",
"orders",
"order_regions",
"products",
"purchases",
"receipts",
"shipments",
"transfers"
]
},
"direction": {
"type": "string",
"description": "Route/Mapping Direction",
"enum": [
"in",
"out"
]
},
"mappingUuid": {
"type": "string",
"description": "Mapping Id"
},
"routingUuid": {
"description": "Routing Id",
"type": "string"
}
}
}
},
"settings": {
"type": "object",
"description": "Connector specific",
"properties": {
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Setting Option Name"
},
"value": {
"type": "string",
"description": "Setting Option Value"
}
}
},
"description": "correspond to ui fields"
}
}
},
"connection": {
"type": "object",
"description": "3rd party's credentials",
"properties": {
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Connection Option Name"
},
"value": {
"type": "string",
"description": "Connection Option Value"
}
}
},
"description": "correspond to ui fields"
}
}
}
}
},
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was created within Pipe17"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was updated within Pipe17"
},
"orgKey": {
"type": "string",
"readOnly": true,
"description": "Organization this object belong to"
}
}
}
]
}
}
}
]
}
},
"text/xml": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
},
{
"type": "object",
"properties": {
"integration": {
"allOf": [
{
"type": "object",
"properties": {
"integrationId": {
"type": "string",
"description": "Integration Id"
},
"status": {
"type": "string",
"description": "Integration Status",
"enum": [
"created",
"configured",
"connected",
"error"
]
},
"apikey": {
"type": "string",
"description": "Integration api Key"
}
}
},
{
"type": "object",
"required": [
"integrationName",
"environment"
],
"properties": {
"integrationName": {
"type": "string",
"description": "Integration Name"
},
"connectorName": {
"type": "string",
"description": "Connector Name (either Name or ID required)"
},
"connectorId": {
"type": "string",
"description": "Connector ID (either Name or ID required)"
},
"environment": {
"type": "string",
"description": "Environment ID",
"enum": [
"test",
"prod"
]
},
"entities": {
"type": "array",
"items": {
"type": "object",
"description": "Mapping or Routing Entity",
"properties": {
"name": {
"type": "string",
"description": "Entity Name",
"enum": [
"arrivals",
"fulfillments",
"inventory",
"locations",
"orders",
"order_regions",
"products",
"purchases",
"receipts",
"shipments",
"transfers"
]
},
"direction": {
"type": "string",
"description": "Route/Mapping Direction",
"enum": [
"in",
"out"
]
},
"mappingUuid": {
"type": "string",
"description": "Mapping Id"
},
"routingUuid": {
"description": "Routing Id",
"type": "string"
}
}
}
},
"settings": {
"type": "object",
"description": "Connector specific",
"properties": {
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Setting Option Name"
},
"value": {
"type": "string",
"description": "Setting Option Value"
}
}
},
"description": "correspond to ui fields"
}
}
},
"connection": {
"type": "object",
"description": "3rd party's credentials",
"properties": {
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Connection Option Name"
},
"value": {
"type": "string",
"description": "Connection Option Value"
}
}
},
"description": "correspond to ui fields"
}
}
}
}
},
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was created within Pipe17"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was updated within Pipe17"
},
"orgKey": {
"type": "string",
"readOnly": true,
"description": "Organization this object belong to"
}
}
}
]
}
}
}
]
}
}
}
},
"default": {
"description": "Failed operation",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
},
{
"type": "object",
"properties": {
"integration": {
"type": "object",
"required": [
"integrationName",
"environment"
],
"properties": {
"integrationName": {
"type": "string",
"description": "Integration Name"
},
"connectorName": {
"type": "string",
"description": "Connector Name (either Name or ID required)"
},
"connectorId": {
"type": "string",
"description": "Connector ID (either Name or ID required)"
},
"environment": {
"type": "string",
"description": "Environment ID",
"enum": [
"test",
"prod"
]
},
"entities": {
"type": "array",
"items": {
"type": "object",
"description": "Mapping or Routing Entity",
"properties": {
"name": {
"type": "string",
"description": "Entity Name",
"enum": [
"arrivals",
"fulfillments",
"inventory",
"locations",
"orders",
"order_regions",
"products",
"purchases",
"receipts",
"shipments",
"transfers"
]
},
"direction": {
"type": "string",
"description": "Route/Mapping Direction",
"enum": [
"in",
"out"
]
},
"mappingUuid": {
"type": "string",
"description": "Mapping Id"
},
"routingUuid": {
"description": "Routing Id",
"type": "string"
}
}
}
},
"settings": {
"type": "object",
"description": "Connector specific",
"properties": {
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Setting Option Name"
},
"value": {
"type": "string",
"description": "Setting Option Value"
}
}
},
"description": "correspond to ui fields"
}
}
},
"connection": {
"type": "object",
"description": "3rd party's credentials",
"properties": {
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Connection Option Name"
},
"value": {
"type": "string",
"description": "Connection Option Value"
}
}
},
"description": "correspond to ui fields"
}
}
}
}
}
}
}
]
}
},
"application/xml": {
"schema": {
"allOf": [
{
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
},
{
"type": "object",
"properties": {
"integration": {
"type": "object",
"required": [
"integrationName",
"environment"
],
"properties": {
"integrationName": {
"type": "string",
"description": "Integration Name"
},
"connectorName": {
"type": "string",
"description": "Connector Name (either Name or ID required)"
},
"connectorId": {
"type": "string",
"description": "Connector ID (either Name or ID required)"
},
"environment": {
"type": "string",
"description": "Environment ID",
"enum": [
"test",
"prod"
]
},
"entities": {
"type": "array",
"items": {
"type": "object",
"description": "Mapping or Routing Entity",
"properties": {
"name": {
"type": "string",
"description": "Entity Name",
"enum": [
"arrivals",
"fulfillments",
"inventory",
"locations",
"orders",
"order_regions",
"products",
"purchases",
"receipts",
"shipments",
"transfers"
]
},
"direction": {
"type": "string",
"description": "Route/Mapping Direction",
"enum": [
"in",
"out"
]
},
"mappingUuid": {
"type": "string",
"description": "Mapping Id"
},
"routingUuid": {
"description": "Routing Id",
"type": "string"
}
}
}
},
"settings": {
"type": "object",
"description": "Connector specific",
"properties": {
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Setting Option Name"
},
"value": {
"type": "string",
"description": "Setting Option Value"
}
}
},
"description": "correspond to ui fields"
}
}
},
"connection": {
"type": "object",
"description": "3rd party's credentials",
"properties": {
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Connection Option Name"
},
"value": {
"type": "string",
"description": "Connection Option Value"
}
}
},
"description": "correspond to ui fields"
}
}
}
}
}
}
}
]
}
},
"text/xml": {
"schema": {
"allOf": [
{
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
},
{
"type": "object",
"properties": {
"integration": {
"type": "object",
"required": [
"integrationName",
"environment"
],
"properties": {
"integrationName": {
"type": "string",
"description": "Integration Name"
},
"connectorName": {
"type": "string",
"description": "Connector Name (either Name or ID required)"
},
"connectorId": {
"type": "string",
"description": "Connector ID (either Name or ID required)"
},
"environment": {
"type": "string",
"description": "Environment ID",
"enum": [
"test",
"prod"
]
},
"entities": {
"type": "array",
"items": {
"type": "object",
"description": "Mapping or Routing Entity",
"properties": {
"name": {
"type": "string",
"description": "Entity Name",
"enum": [
"arrivals",
"fulfillments",
"inventory",
"locations",
"orders",
"order_regions",
"products",
"purchases",
"receipts",
"shipments",
"transfers"
]
},
"direction": {
"type": "string",
"description": "Route/Mapping Direction",
"enum": [
"in",
"out"
]
},
"mappingUuid": {
"type": "string",
"description": "Mapping Id"
},
"routingUuid": {
"description": "Routing Id",
"type": "string"
}
}
}
},
"settings": {
"type": "object",
"description": "Connector specific",
"properties": {
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Setting Option Name"
},
"value": {
"type": "string",
"description": "Setting Option Value"
}
}
},
"description": "correspond to ui fields"
}
}
},
"connection": {
"type": "object",
"description": "3rd party's credentials",
"properties": {
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Connection Option Name"
},
"value": {
"type": "string",
"description": "Connection Option Value"
}
}
},
"description": "correspond to ui fields"
}
}
}
}
}
}
}
]
}
}
}
}
}
},
"get": {
"tags": [
"Integrations"
],
"summary": "List Integrations",
"operationId": "listIntegrations",
"parameters": [
{
"name": "connectorName",
"in": "query",
"schema": {
"type": "string"
},
"description": "Retrieve integrations by connector name"
},
{
"name": "connectorId",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Retrieve integrations by connector Id(s)"
},
{
"name": "status",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"description": "Integration Status",
"enum": [
"created",
"configured",
"connected",
"error"
]
}
},
"description": "Retrieve integrations by status"
},
{
"name": "since",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
},
"description": "Integrations created after this date-time"
},
{
"name": "until",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
},
"description": "Integrations created before this date-time"
},
{
"name": "updatedsince",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
},
"description": "Integrations updated after this date-time"
},
{
"name": "updateduntil",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
},
"description": "Integrations updated before this date-time"
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
},
"description": "Skip this many integrations"
},
{
"name": "count",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
},
"description": "Return at most this many integrations"
},
{
"name": "order",
"in": "query",
"schema": {
"type": "string"
},
"description": "List sort order"
},
{
"name": "keys",
"in": "query",
"schema": {
"type": "string"
},
"description": "Fields to retrieve"
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
},
{
"type": "object",
"properties": {
"filters": {
"type": "object",
"description": "Integrations Filter",
"properties": {
"connectorName": {
"type": "string",
"description": "Retrieve integrations by connector name"
},
"connectorId": {
"type": "string",
"description": "Retrieve integrations by connector ID"
},
"status": {
"type": "string",
"description": "Integration Status",
"enum": [
"created",
"configured",
"connected",
"error"
]
},
"since": {
"type": "string",
"format": "date-time",
"description": "Integrations created after this date-time"
},
"until": {
"type": "string",
"format": "date-time",
"description": "Integrations created before this date-time"
},
"updatedsince": {
"type": "string",
"format": "date-time",
"description": "Integrations updated after this date-time"
},
"updateduntil": {
"type": "string",
"format": "date-time",
"description": "Integrations updated before this date-time"
},
"skip": {
"type": "integer",
"format": "int32",
"description": "Skip this many integrations"
},
"count": {
"type": "integer",
"format": "int32",
"description": "Return at most this many integrations"
},
"order": {
"type": "string",
"description": "List sort order"
},
"keys": {
"type": "string",
"description": "Fields to retrieve"
}
}
},
"integrations": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"integrationId": {
"type": "string",
"description": "Integration Id"
},
"status": {
"type": "string",
"description": "Integration Status",
"enum": [
"created",
"configured",
"connected",
"error"
]
},
"apikey": {
"type": "string",
"description": "Integration api Key"
}
}
},
{
"type": "object",
"required": [
"integrationName",
"environment"
],
"properties": {
"integrationName": {
"type": "string",
"description": "Integration Name"
},
"connectorName": {
"type": "string",
"description": "Connector Name (either Name or ID required)"
},
"connectorId": {
"type": "string",
"description": "Connector ID (either Name or ID required)"
},
"environment": {
"type": "string",
"description": "Environment ID",
"enum": [
"test",
"prod"
]
},
"entities": {
"type": "array",
"items": {
"type": "object",
"description": "Mapping or Routing Entity",
"properties": {
"name": {
"type": "string",
"description": "Entity Name",
"enum": [
"arrivals",
"fulfillments",
"inventory",
"locations",
"orders",
"order_regions",
"products",
"purchases",
"receipts",
"shipments",
"transfers"
]
},
"direction": {
"type": "string",
"description": "Route/Mapping Direction",
"enum": [
"in",
"out"
]
},
"mappingUuid": {
"type": "string",
"description": "Mapping Id"
},
"routingUuid": {
"description": "Routing Id",
"type": "string"
}
}
}
},
"settings": {
"type": "object",
"description": "Connector specific",
"properties": {
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Setting Option Name"
},
"value": {
"type": "string",
"description": "Setting Option Value"
}
}
},
"description": "correspond to ui fields"
}
}
},
"connection": {
"type": "object",
"description": "3rd party's credentials",
"properties": {
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Connection Option Name"
},
"value": {
"type": "string",
"description": "Connection Option Value"
}
}
},
"description": "correspond to ui fields"
}
}
}
}
},
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was created within Pipe17"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was updated within Pipe17"
},
"orgKey": {
"type": "string",
"readOnly": true,
"description": "Organization this object belong to"
}
}
}
]
}
}
}
}
]
}
},
"application/xml": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
},
{
"type": "object",
"properties": {
"filters": {
"type": "object",
"description": "Integrations Filter",
"properties": {
"connectorName": {
"type": "string",
"description": "Retrieve integrations by connector name"
},
"connectorId": {
"type": "string",
"description": "Retrieve integrations by connector ID"
},
"status": {
"type": "string",
"description": "Integration Status",
"enum": [
"created",
"configured",
"connected",
"error"
]
},
"since": {
"type": "string",
"format": "date-time",
"description": "Integrations created after this date-time"
},
"until": {
"type": "string",
"format": "date-time",
"description": "Integrations created before this date-time"
},
"updatedsince": {
"type": "string",
"format": "date-time",
"description": "Integrations updated after this date-time"
},
"updateduntil": {
"type": "string",
"format": "date-time",
"description": "Integrations updated before this date-time"
},
"skip": {
"type": "integer",
"format": "int32",
"description": "Skip this many integrations"
},
"count": {
"type": "integer",
"format": "int32",
"description": "Return at most this many integrations"
},
"order": {
"type": "string",
"description": "List sort order"
},
"keys": {
"type": "string",
"description": "Fields to retrieve"
}
}
},
"integrations": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"integrationId": {
"type": "string",
"description": "Integration Id"
},
"status": {
"type": "string",
"description": "Integration Status",
"enum": [
"created",
"configured",
"connected",
"error"
]
},
"apikey": {
"type": "string",
"description": "Integration api Key"
}
}
},
{
"type": "object",
"required": [
"integrationName",
"environment"
],
"properties": {
"integrationName": {
"type": "string",
"description": "Integration Name"
},
"connectorName": {
"type": "string",
"description": "Connector Name (either Name or ID required)"
},
"connectorId": {
"type": "string",
"description": "Connector ID (either Name or ID required)"
},
"environment": {
"type": "string",
"description": "Environment ID",
"enum": [
"test",
"prod"
]
},
"entities": {
"type": "array",
"items": {
"type": "object",
"description": "Mapping or Routing Entity",
"properties": {
"name": {
"type": "string",
"description": "Entity Name",
"enum": [
"arrivals",
"fulfillments",
"inventory",
"locations",
"orders",
"order_regions",
"products",
"purchases",
"receipts",
"shipments",
"transfers"
]
},
"direction": {
"type": "string",
"description": "Route/Mapping Direction",
"enum": [
"in",
"out"
]
},
"mappingUuid": {
"type": "string",
"description": "Mapping Id"
},
"routingUuid": {
"description": "Routing Id",
"type": "string"
}
}
}
},
"settings": {
"type": "object",
"description": "Connector specific",
"properties": {
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Setting Option Name"
},
"value": {
"type": "string",
"description": "Setting Option Value"
}
}
},
"description": "correspond to ui fields"
}
}
},
"connection": {
"type": "object",
"description": "3rd party's credentials",
"properties": {
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Connection Option Name"
},
"value": {
"type": "string",
"description": "Connection Option Value"
}
}
},
"description": "correspond to ui fields"
}
}
}
}
},
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was created within Pipe17"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was updated within Pipe17"
},
"orgKey": {
"type": "string",
"readOnly": true,
"description": "Organization this object belong to"
}
}
}
]
}
}
}
}
]
}
},
"text/xml": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
},
{
"type": "object",
"properties": {
"filters": {
"type": "object",
"description": "Integrations Filter",
"properties": {
"connectorName": {
"type": "string",
"description": "Retrieve integrations by connector name"
},
"connectorId": {
"type": "string",
"description": "Retrieve integrations by connector ID"
},
"status": {
"type": "string",
"description": "Integration Status",
"enum": [
"created",
"configured",
"connected",
"error"
]
},
"since": {
"type": "string",
"format": "date-time",
"description": "Integrations created after this date-time"
},
"until": {
"type": "string",
"format": "date-time",
"description": "Integrations created before this date-time"
},
"updatedsince": {
"type": "string",
"format": "date-time",
"description": "Integrations updated after this date-time"
},
"updateduntil": {
"type": "string",
"format": "date-time",
"description": "Integrations updated before this date-time"
},
"skip": {
"type": "integer",
"format": "int32",
"description": "Skip this many integrations"
},
"count": {
"type": "integer",
"format": "int32",
"description": "Return at most this many integrations"
},
"order": {
"type": "string",
"description": "List sort order"
},
"keys": {
"type": "string",
"description": "Fields to retrieve"
}
}
},
"integrations": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"integrationId": {
"type": "string",
"description": "Integration Id"
},
"status": {
"type": "string",
"description": "Integration Status",
"enum": [
"created",
"configured",
"connected",
"error"
]
},
"apikey": {
"type": "string",
"description": "Integration api Key"
}
}
},
{
"type": "object",
"required": [
"integrationName",
"environment"
],
"properties": {
"integrationName": {
"type": "string",
"description": "Integration Name"
},
"connectorName": {
"type": "string",
"description": "Connector Name (either Name or ID required)"
},
"connectorId": {
"type": "string",
"description": "Connector ID (either Name or ID required)"
},
"environment": {
"type": "string",
"description": "Environment ID",
"enum": [
"test",
"prod"
]
},
"entities": {
"type": "array",
"items": {
"type": "object",
"description": "Mapping or Routing Entity",
"properties": {
"name": {
"type": "string",
"description": "Entity Name",
"enum": [
"arrivals",
"fulfillments",
"inventory",
"locations",
"orders",
"order_regions",
"products",
"purchases",
"receipts",
"shipments",
"transfers"
]
},
"direction": {
"type": "string",
"description": "Route/Mapping Direction",
"enum": [
"in",
"out"
]
},
"mappingUuid": {
"type": "string",
"description": "Mapping Id"
},
"routingUuid": {
"description": "Routing Id",
"type": "string"
}
}
}
},
"settings": {
"type": "object",
"description": "Connector specific",
"properties": {
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Setting Option Name"
},
"value": {
"type": "string",
"description": "Setting Option Value"
}
}
},
"description": "correspond to ui fields"
}
}
},
"connection": {
"type": "object",
"description": "3rd party's credentials",
"properties": {
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Connection Option Name"
},
"value": {
"type": "string",
"description": "Connection Option Value"
}
}
},
"description": "correspond to ui fields"
}
}
}
}
},
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was created within Pipe17"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was updated within Pipe17"
},
"orgKey": {
"type": "string",
"readOnly": true,
"description": "Organization this object belong to"
}
}
}
]
}
}
}
}
]
}
}
}
},
"default": {
"description": "Failed operation",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
},
{
"type": "object",
"properties": {
"filters": {
"type": "object",
"description": "Integrations Filter",
"properties": {
"connectorName": {
"type": "string",
"description": "Retrieve integrations by connector name"
},
"connectorId": {
"type": "string",
"description": "Retrieve integrations by connector ID"
},
"status": {
"type": "string",
"description": "Integration Status",
"enum": [
"created",
"configured",
"connected",
"error"
]
},
"since": {
"type": "string",
"format": "date-time",
"description": "Integrations created after this date-time"
},
"until": {
"type": "string",
"format": "date-time",
"description": "Integrations created before this date-time"
},
"updatedsince": {
"type": "string",
"format": "date-time",
"description": "Integrations updated after this date-time"
},
"updateduntil": {
"type": "string",
"format": "date-time",
"description": "Integrations updated before this date-time"
},
"skip": {
"type": "integer",
"format": "int32",
"description": "Skip this many integrations"
},
"count": {
"type": "integer",
"format": "int32",
"description": "Return at most this many integrations"
},
"order": {
"type": "string",
"description": "List sort order"
},
"keys": {
"type": "string",
"description": "Fields to retrieve"
}
}
}
}
}
]
}
},
"application/xml": {
"schema": {
"allOf": [
{
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
},
{
"type": "object",
"properties": {
"filters": {
"type": "object",
"description": "Integrations Filter",
"properties": {
"connectorName": {
"type": "string",
"description": "Retrieve integrations by connector name"
},
"connectorId": {
"type": "string",
"description": "Retrieve integrations by connector ID"
},
"status": {
"type": "string",
"description": "Integration Status",
"enum": [
"created",
"configured",
"connected",
"error"
]
},
"since": {
"type": "string",
"format": "date-time",
"description": "Integrations created after this date-time"
},
"until": {
"type": "string",
"format": "date-time",
"description": "Integrations created before this date-time"
},
"updatedsince": {
"type": "string",
"format": "date-time",
"description": "Integrations updated after this date-time"
},
"updateduntil": {
"type": "string",
"format": "date-time",
"description": "Integrations updated before this date-time"
},
"skip": {
"type": "integer",
"format": "int32",
"description": "Skip this many integrations"
},
"count": {
"type": "integer",
"format": "int32",
"description": "Return at most this many integrations"
},
"order": {
"type": "string",
"description": "List sort order"
},
"keys": {
"type": "string",
"description": "Fields to retrieve"
}
}
}
}
}
]
}
},
"text/xml": {
"schema": {
"allOf": [
{
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
},
{
"type": "object",
"properties": {
"filters": {
"type": "object",
"description": "Integrations Filter",
"properties": {
"connectorName": {
"type": "string",
"description": "Retrieve integrations by connector name"
},
"connectorId": {
"type": "string",
"description": "Retrieve integrations by connector ID"
},
"status": {
"type": "string",
"description": "Integration Status",
"enum": [
"created",
"configured",
"connected",
"error"
]
},
"since": {
"type": "string",
"format": "date-time",
"description": "Integrations created after this date-time"
},
"until": {
"type": "string",
"format": "date-time",
"description": "Integrations created before this date-time"
},
"updatedsince": {
"type": "string",
"format": "date-time",
"description": "Integrations updated after this date-time"
},
"updateduntil": {
"type": "string",
"format": "date-time",
"description": "Integrations updated before this date-time"
},
"skip": {
"type": "integer",
"format": "int32",
"description": "Skip this many integrations"
},
"count": {
"type": "integer",
"format": "int32",
"description": "Return at most this many integrations"
},
"order": {
"type": "string",
"description": "List sort order"
},
"keys": {
"type": "string",
"description": "Fields to retrieve"
}
}
}
}
}
]
}
}
}
}
}
}
},
"/integrations/{IntegrationId}": {
"delete": {
"tags": [
"Integrations"
],
"summary": "Delete Integration",
"operationId": "deleteIntegration",
"parameters": [
{
"name": "IntegrationId",
"in": "path",
"description": "Integration Id to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
}
},
"application/xml": {
"schema": {
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
}
},
"text/xml": {
"schema": {
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
}
}
}
},
"default": {
"description": "Failed operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
}
},
"application/xml": {
"schema": {
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
}
},
"text/xml": {
"schema": {
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
}
}
}
}
}
},
"get": {
"tags": [
"Integrations"
],
"summary": "Fetch Integration",
"operationId": "fetchIntegration",
"parameters": [
{
"name": "IntegrationId",
"in": "path",
"description": "Integration Id to fetch",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
},
{
"type": "object",
"properties": {
"integration": {
"allOf": [
{
"type": "object",
"properties": {
"integrationId": {
"type": "string",
"description": "Integration Id"
},
"status": {
"type": "string",
"description": "Integration Status",
"enum": [
"created",
"configured",
"connected",
"error"
]
},
"apikey": {
"type": "string",
"description": "Integration api Key"
}
}
},
{
"type": "object",
"required": [
"integrationName",
"environment"
],
"properties": {
"integrationName": {
"type": "string",
"description": "Integration Name"
},
"connectorName": {
"type": "string",
"description": "Connector Name (either Name or ID required)"
},
"connectorId": {
"type": "string",
"description": "Connector ID (either Name or ID required)"
},
"environment": {
"type": "string",
"description": "Environment ID",
"enum": [
"test",
"prod"
]
},
"entities": {
"type": "array",
"items": {
"type": "object",
"description": "Mapping or Routing Entity",
"properties": {
"name": {
"type": "string",
"description": "Entity Name",
"enum": [
"arrivals",
"fulfillments",
"inventory",
"locations",
"orders",
"order_regions",
"products",
"purchases",
"receipts",
"shipments",
"transfers"
]
},
"direction": {
"type": "string",
"description": "Route/Mapping Direction",
"enum": [
"in",
"out"
]
},
"mappingUuid": {
"type": "string",
"description": "Mapping Id"
},
"routingUuid": {
"description": "Routing Id",
"type": "string"
}
}
}
},
"settings": {
"type": "object",
"description": "Connector specific",
"properties": {
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Setting Option Name"
},
"value": {
"type": "string",
"description": "Setting Option Value"
}
}
},
"description": "correspond to ui fields"
}
}
},
"connection": {
"type": "object",
"description": "3rd party's credentials",
"properties": {
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Connection Option Name"
},
"value": {
"type": "string",
"description": "Connection Option Value"
}
}
},
"description": "correspond to ui fields"
}
}
}
}
},
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was created within Pipe17"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was updated within Pipe17"
},
"orgKey": {
"type": "string",
"readOnly": true,
"description": "Organization this object belong to"
}
}
}
]
}
}
}
]
}
},
"application/xml": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
},
{
"type": "object",
"properties": {
"integration": {
"allOf": [
{
"type": "object",
"properties": {
"integrationId": {
"type": "string",
"description": "Integration Id"
},
"status": {
"type": "string",
"description": "Integration Status",
"enum": [
"created",
"configured",
"connected",
"error"
]
},
"apikey": {
"type": "string",
"description": "Integration api Key"
}
}
},
{
"type": "object",
"required": [
"integrationName",
"environment"
],
"properties": {
"integrationName": {
"type": "string",
"description": "Integration Name"
},
"connectorName": {
"type": "string",
"description": "Connector Name (either Name or ID required)"
},
"connectorId": {
"type": "string",
"description": "Connector ID (either Name or ID required)"
},
"environment": {
"type": "string",
"description": "Environment ID",
"enum": [
"test",
"prod"
]
},
"entities": {
"type": "array",
"items": {
"type": "object",
"description": "Mapping or Routing Entity",
"properties": {
"name": {
"type": "string",
"description": "Entity Name",
"enum": [
"arrivals",
"fulfillments",
"inventory",
"locations",
"orders",
"order_regions",
"products",
"purchases",
"receipts",
"shipments",
"transfers"
]
},
"direction": {
"type": "string",
"description": "Route/Mapping Direction",
"enum": [
"in",
"out"
]
},
"mappingUuid": {
"type": "string",
"description": "Mapping Id"
},
"routingUuid": {
"description": "Routing Id",
"type": "string"
}
}
}
},
"settings": {
"type": "object",
"description": "Connector specific",
"properties": {
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Setting Option Name"
},
"value": {
"type": "string",
"description": "Setting Option Value"
}
}
},
"description": "correspond to ui fields"
}
}
},
"connection": {
"type": "object",
"description": "3rd party's credentials",
"properties": {
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Connection Option Name"
},
"value": {
"type": "string",
"description": "Connection Option Value"
}
}
},
"description": "correspond to ui fields"
}
}
}
}
},
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was created within Pipe17"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was updated within Pipe17"
},
"orgKey": {
"type": "string",
"readOnly": true,
"description": "Organization this object belong to"
}
}
}
]
}
}
}
]
}
},
"text/xml": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
},
{
"type": "object",
"properties": {
"integration": {
"allOf": [
{
"type": "object",
"properties": {
"integrationId": {
"type": "string",
"description": "Integration Id"
},
"status": {
"type": "string",
"description": "Integration Status",
"enum": [
"created",
"configured",
"connected",
"error"
]
},
"apikey": {
"type": "string",
"description": "Integration api Key"
}
}
},
{
"type": "object",
"required": [
"integrationName",
"environment"
],
"properties": {
"integrationName": {
"type": "string",
"description": "Integration Name"
},
"connectorName": {
"type": "string",
"description": "Connector Name (either Name or ID required)"
},
"connectorId": {
"type": "string",
"description": "Connector ID (either Name or ID required)"
},
"environment": {
"type": "string",
"description": "Environment ID",
"enum": [
"test",
"prod"
]
},
"entities": {
"type": "array",
"items": {
"type": "object",
"description": "Mapping or Routing Entity",
"properties": {
"name": {
"type": "string",
"description": "Entity Name",
"enum": [
"arrivals",
"fulfillments",
"inventory",
"locations",
"orders",
"order_regions",
"products",
"purchases",
"receipts",
"shipments",
"transfers"
]
},
"direction": {
"type": "string",
"description": "Route/Mapping Direction",
"enum": [
"in",
"out"
]
},
"mappingUuid": {
"type": "string",
"description": "Mapping Id"
},
"routingUuid": {
"description": "Routing Id",
"type": "string"
}
}
}
},
"settings": {
"type": "object",
"description": "Connector specific",
"properties": {
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Setting Option Name"
},
"value": {
"type": "string",
"description": "Setting Option Value"
}
}
},
"description": "correspond to ui fields"
}
}
},
"connection": {
"type": "object",
"description": "3rd party's credentials",
"properties": {
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Connection Option Name"
},
"value": {
"type": "string",
"description": "Connection Option Value"
}
}
},
"description": "correspond to ui fields"
}
}
}
}
},
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was created within Pipe17"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was updated within Pipe17"
},
"orgKey": {
"type": "string",
"readOnly": true,
"description": "Organization this object belong to"
}
}
}
]
}
}
}
]
}
}
}
},
"default": {
"description": "Failed operation",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
}
]
}
},
"application/xml": {
"schema": {
"allOf": [
{
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
}
]
}
},
"text/xml": {
"schema": {
"allOf": [
{
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
}
]
}
}
}
}
}
},
"put": {
"tags": [
"Integrations"
],
"summary": "Update Integration",
"operationId": "updateIntegration",
"parameters": [
{
"name": "IntegrationId",
"in": "path",
"description": "Integration Id to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Integration Status",
"enum": [
"created",
"configured",
"connected",
"error"
]
},
"apikey": {
"type": "boolean",
"description": "Update integration api key"
},
"entities": {
"type": "array",
"items": {
"type": "object",
"description": "Mapping or Routing Entity",
"properties": {
"name": {
"type": "string",
"description": "Entity Name",
"enum": [
"arrivals",
"fulfillments",
"inventory",
"locations",
"orders",
"order_regions",
"products",
"purchases",
"receipts",
"shipments",
"transfers"
]
},
"direction": {
"type": "string",
"description": "Route/Mapping Direction",
"enum": [
"in",
"out"
]
},
"mappingUuid": {
"type": "string",
"description": "Mapping Id"
},
"routingUuid": {
"description": "Routing Id",
"type": "string"
}
}
}
},
"settings": {
"type": "object",
"description": "Connector specific",
"properties": {
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Setting Option Name"
},
"value": {
"type": "string",
"description": "Setting Option Value"
}
}
},
"description": "correspond to ui fields"
}
}
},
"connection": {
"type": "object",
"description": "3rd party's credentials",
"properties": {
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Connection Option Name"
},
"value": {
"type": "string",
"description": "Connection Option Value"
}
}
},
"description": "correspond to ui fields"
}
}
}
}
}
],
"xml": {
"name": "request"
}
}
},
"application/xml": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Integration Status",
"enum": [
"created",
"configured",
"connected",
"error"
]
},
"apikey": {
"type": "boolean",
"description": "Update integration api key"
},
"entities": {
"type": "array",
"items": {
"type": "object",
"description": "Mapping or Routing Entity",
"properties": {
"name": {
"type": "string",
"description": "Entity Name",
"enum": [
"arrivals",
"fulfillments",
"inventory",
"locations",
"orders",
"order_regions",
"products",
"purchases",
"receipts",
"shipments",
"transfers"
]
},
"direction": {
"type": "string",
"description": "Route/Mapping Direction",
"enum": [
"in",
"out"
]
},
"mappingUuid": {
"type": "string",
"description": "Mapping Id"
},
"routingUuid": {
"description": "Routing Id",
"type": "string"
}
}
}
},
"settings": {
"type": "object",
"description": "Connector specific",
"properties": {
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Setting Option Name"
},
"value": {
"type": "string",
"description": "Setting Option Value"
}
}
},
"description": "correspond to ui fields"
}
}
},
"connection": {
"type": "object",
"description": "3rd party's credentials",
"properties": {
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Connection Option Name"
},
"value": {
"type": "string",
"description": "Connection Option Value"
}
}
},
"description": "correspond to ui fields"
}
}
}
}
}
],
"xml": {
"name": "request"
}
}
},
"text/xml": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Integration Status",
"enum": [
"created",
"configured",
"connected",
"error"
]
},
"apikey": {
"type": "boolean",
"description": "Update integration api key"
},
"entities": {
"type": "array",
"items": {
"type": "object",
"description": "Mapping or Routing Entity",
"properties": {
"name": {
"type": "string",
"description": "Entity Name",
"enum": [
"arrivals",
"fulfillments",
"inventory",
"locations",
"orders",
"order_regions",
"products",
"purchases",
"receipts",
"shipments",
"transfers"
]
},
"direction": {
"type": "string",
"description": "Route/Mapping Direction",
"enum": [
"in",
"out"
]
},
"mappingUuid": {
"type": "string",
"description": "Mapping Id"
},
"routingUuid": {
"description": "Routing Id",
"type": "string"
}
}
}
},
"settings": {
"type": "object",
"description": "Connector specific",
"properties": {
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Setting Option Name"
},
"value": {
"type": "string",
"description": "Setting Option Value"
}
}
},
"description": "correspond to ui fields"
}
}
},
"connection": {
"type": "object",
"description": "3rd party's credentials",
"properties": {
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Connection Option Name"
},
"value": {
"type": "string",
"description": "Connection Option Value"
}
}
},
"description": "correspond to ui fields"
}
}
}
}
}
],
"xml": {
"name": "request"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
}
]
}
},
"application/xml": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
}
]
}
},
"text/xml": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
}
]
}
}
}
},
"default": {
"description": "Failed operation",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
},
{
"type": "object",
"properties": {
"integration": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Integration Status",
"enum": [
"created",
"configured",
"connected",
"error"
]
},
"apikey": {
"type": "boolean",
"description": "Update integration api key"
},
"entities": {
"type": "array",
"items": {
"type": "object",
"description": "Mapping or Routing Entity",
"properties": {
"name": {
"type": "string",
"description": "Entity Name",
"enum": [
"arrivals",
"fulfillments",
"inventory",
"locations",
"orders",
"order_regions",
"products",
"purchases",
"receipts",
"shipments",
"transfers"
]
},
"direction": {
"type": "string",
"description": "Route/Mapping Direction",
"enum": [
"in",
"out"
]
},
"mappingUuid": {
"type": "string",
"description": "Mapping Id"
},
"routingUuid": {
"description": "Routing Id",
"type": "string"
}
}
}
},
"settings": {
"type": "object",
"description": "Connector specific",
"properties": {
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Setting Option Name"
},
"value": {
"type": "string",
"description": "Setting Option Value"
}
}
},
"description": "correspond to ui fields"
}
}
},
"connection": {
"type": "object",
"description": "3rd party's credentials",
"properties": {
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Connection Option Name"
},
"value": {
"type": "string",
"description": "Connection Option Value"
}
}
},
"description": "correspond to ui fields"
}
}
}
}
}
}
}
]
}
},
"application/xml": {
"schema": {
"allOf": [
{
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
},
{
"type": "object",
"properties": {
"integration": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Integration Status",
"enum": [
"created",
"configured",
"connected",
"error"
]
},
"apikey": {
"type": "boolean",
"description": "Update integration api key"
},
"entities": {
"type": "array",
"items": {
"type": "object",
"description": "Mapping or Routing Entity",
"properties": {
"name": {
"type": "string",
"description": "Entity Name",
"enum": [
"arrivals",
"fulfillments",
"inventory",
"locations",
"orders",
"order_regions",
"products",
"purchases",
"receipts",
"shipments",
"transfers"
]
},
"direction": {
"type": "string",
"description": "Route/Mapping Direction",
"enum": [
"in",
"out"
]
},
"mappingUuid": {
"type": "string",
"description": "Mapping Id"
},
"routingUuid": {
"description": "Routing Id",
"type": "string"
}
}
}
},
"settings": {
"type": "object",
"description": "Connector specific",
"properties": {
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Setting Option Name"
},
"value": {
"type": "string",
"description": "Setting Option Value"
}
}
},
"description": "correspond to ui fields"
}
}
},
"connection": {
"type": "object",
"description": "3rd party's credentials",
"properties": {
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Connection Option Name"
},
"value": {
"type": "string",
"description": "Connection Option Value"
}
}
},
"description": "correspond to ui fields"
}
}
}
}
}
}
}
]
}
},
"text/xml": {
"schema": {
"allOf": [
{
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
},
{
"type": "object",
"properties": {
"integration": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Integration Status",
"enum": [
"created",
"configured",
"connected",
"error"
]
},
"apikey": {
"type": "boolean",
"description": "Update integration api key"
},
"entities": {
"type": "array",
"items": {
"type": "object",
"description": "Mapping or Routing Entity",
"properties": {
"name": {
"type": "string",
"description": "Entity Name",
"enum": [
"arrivals",
"fulfillments",
"inventory",
"locations",
"orders",
"order_regions",
"products",
"purchases",
"receipts",
"shipments",
"transfers"
]
},
"direction": {
"type": "string",
"description": "Route/Mapping Direction",
"enum": [
"in",
"out"
]
},
"mappingUuid": {
"type": "string",
"description": "Mapping Id"
},
"routingUuid": {
"description": "Routing Id",
"type": "string"
}
}
}
},
"settings": {
"type": "object",
"description": "Connector specific",
"properties": {
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Setting Option Name"
},
"value": {
"type": "string",
"description": "Setting Option Value"
}
}
},
"description": "correspond to ui fields"
}
}
},
"connection": {
"type": "object",
"description": "3rd party's credentials",
"properties": {
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Connection Option Name"
},
"value": {
"type": "string",
"description": "Connection Option Value"
}
}
},
"description": "correspond to ui fields"
}
}
}
}
}
}
}
]
}
}
}
}
}
}
},
"/locations": {
"post": {
"tags": [
"Locations"
],
"summary": "Create Location",
"operationId": "createLocation",
"requestBody": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"name",
"address"
],
"properties": {
"name": {
"type": "string",
"description": "Location Name"
},
"address": {
"type": "object",
"required": [
"address1",
"city",
"zipCodeOrPostalCode",
"country"
],
"properties": {
"company": {
"description": "Company",
"type": "string"
},
"address1": {
"description": "Address",
"type": "string"
},
"address2": {
"description": "Address Line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"stateOrProvince": {
"description": "State or Province",
"type": "string"
},
"zipCodeOrPostalCode": {
"description": "zipcode or postal code",
"type": "string"
},
"country": {
"description": "Country",
"type": "string"
},
"email": {
"description": "email",
"type": "string"
},
"phone": {
"description": "Phone",
"type": "string"
}
}
},
"infinite": {
"type": "boolean",
"description": "Set if this location has \\\"infinite\\\" availability"
},
"fulfillmentIntegrationId": {
"type": "string",
"description": "Set if this is a fulfillment location"
},
"externalSystem": {
"type": "array",
"items": {
"type": "object",
"description": "External System",
"properties": {
"integrationId": {
"type": "string",
"description": "External System Integration Id"
},
"locationValue": {
"type": "string",
"description": "External System Location Value"
}
}
}
}
}
}
],
"xml": {
"name": "request"
}
}
},
"application/xml": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"name",
"address"
],
"properties": {
"name": {
"type": "string",
"description": "Location Name"
},
"address": {
"type": "object",
"required": [
"address1",
"city",
"zipCodeOrPostalCode",
"country"
],
"properties": {
"company": {
"description": "Company",
"type": "string"
},
"address1": {
"description": "Address",
"type": "string"
},
"address2": {
"description": "Address Line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"stateOrProvince": {
"description": "State or Province",
"type": "string"
},
"zipCodeOrPostalCode": {
"description": "zipcode or postal code",
"type": "string"
},
"country": {
"description": "Country",
"type": "string"
},
"email": {
"description": "email",
"type": "string"
},
"phone": {
"description": "Phone",
"type": "string"
}
}
},
"infinite": {
"type": "boolean",
"description": "Set if this location has \\\"infinite\\\" availability"
},
"fulfillmentIntegrationId": {
"type": "string",
"description": "Set if this is a fulfillment location"
},
"externalSystem": {
"type": "array",
"items": {
"type": "object",
"description": "External System",
"properties": {
"integrationId": {
"type": "string",
"description": "External System Integration Id"
},
"locationValue": {
"type": "string",
"description": "External System Location Value"
}
}
}
}
}
}
],
"xml": {
"name": "request"
}
}
},
"text/xml": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"name",
"address"
],
"properties": {
"name": {
"type": "string",
"description": "Location Name"
},
"address": {
"type": "object",
"required": [
"address1",
"city",
"zipCodeOrPostalCode",
"country"
],
"properties": {
"company": {
"description": "Company",
"type": "string"
},
"address1": {
"description": "Address",
"type": "string"
},
"address2": {
"description": "Address Line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"stateOrProvince": {
"description": "State or Province",
"type": "string"
},
"zipCodeOrPostalCode": {
"description": "zipcode or postal code",
"type": "string"
},
"country": {
"description": "Country",
"type": "string"
},
"email": {
"description": "email",
"type": "string"
},
"phone": {
"description": "Phone",
"type": "string"
}
}
},
"infinite": {
"type": "boolean",
"description": "Set if this location has \\\"infinite\\\" availability"
},
"fulfillmentIntegrationId": {
"type": "string",
"description": "Set if this is a fulfillment location"
},
"externalSystem": {
"type": "array",
"items": {
"type": "object",
"description": "External System",
"properties": {
"integrationId": {
"type": "string",
"description": "External System Integration Id"
},
"locationValue": {
"type": "string",
"description": "External System Location Value"
}
}
}
}
}
}
],
"xml": {
"name": "request"
}
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
},
{
"type": "object",
"properties": {
"location": {
"allOf": [
{
"type": "object",
"properties": {
"locationId": {
"type": "string",
"description": "Location ID"
},
"status": {
"type": "string",
"description": "Location Status"
}
}
},
{
"type": "object",
"required": [
"name",
"address"
],
"properties": {
"name": {
"type": "string",
"description": "Location Name"
},
"address": {
"type": "object",
"required": [
"address1",
"city",
"zipCodeOrPostalCode",
"country"
],
"properties": {
"company": {
"description": "Company",
"type": "string"
},
"address1": {
"description": "Address",
"type": "string"
},
"address2": {
"description": "Address Line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"stateOrProvince": {
"description": "State or Province",
"type": "string"
},
"zipCodeOrPostalCode": {
"description": "zipcode or postal code",
"type": "string"
},
"country": {
"description": "Country",
"type": "string"
},
"email": {
"description": "email",
"type": "string"
},
"phone": {
"description": "Phone",
"type": "string"
}
}
},
"infinite": {
"type": "boolean",
"description": "Set if this location has \\\"infinite\\\" availability"
},
"fulfillmentIntegrationId": {
"type": "string",
"description": "Set if this is a fulfillment location"
},
"externalSystem": {
"type": "array",
"items": {
"type": "object",
"description": "External System",
"properties": {
"integrationId": {
"type": "string",
"description": "External System Integration Id"
},
"locationValue": {
"type": "string",
"description": "External System Location Value"
}
}
}
}
}
},
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was created within Pipe17"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was updated within Pipe17"
},
"orgKey": {
"type": "string",
"readOnly": true,
"description": "Organization this object belong to"
}
}
}
]
}
}
}
]
}
},
"application/xml": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
},
{
"type": "object",
"properties": {
"location": {
"allOf": [
{
"type": "object",
"properties": {
"locationId": {
"type": "string",
"description": "Location ID"
},
"status": {
"type": "string",
"description": "Location Status"
}
}
},
{
"type": "object",
"required": [
"name",
"address"
],
"properties": {
"name": {
"type": "string",
"description": "Location Name"
},
"address": {
"type": "object",
"required": [
"address1",
"city",
"zipCodeOrPostalCode",
"country"
],
"properties": {
"company": {
"description": "Company",
"type": "string"
},
"address1": {
"description": "Address",
"type": "string"
},
"address2": {
"description": "Address Line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"stateOrProvince": {
"description": "State or Province",
"type": "string"
},
"zipCodeOrPostalCode": {
"description": "zipcode or postal code",
"type": "string"
},
"country": {
"description": "Country",
"type": "string"
},
"email": {
"description": "email",
"type": "string"
},
"phone": {
"description": "Phone",
"type": "string"
}
}
},
"infinite": {
"type": "boolean",
"description": "Set if this location has \\\"infinite\\\" availability"
},
"fulfillmentIntegrationId": {
"type": "string",
"description": "Set if this is a fulfillment location"
},
"externalSystem": {
"type": "array",
"items": {
"type": "object",
"description": "External System",
"properties": {
"integrationId": {
"type": "string",
"description": "External System Integration Id"
},
"locationValue": {
"type": "string",
"description": "External System Location Value"
}
}
}
}
}
},
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was created within Pipe17"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was updated within Pipe17"
},
"orgKey": {
"type": "string",
"readOnly": true,
"description": "Organization this object belong to"
}
}
}
]
}
}
}
]
}
},
"text/xml": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
},
{
"type": "object",
"properties": {
"location": {
"allOf": [
{
"type": "object",
"properties": {
"locationId": {
"type": "string",
"description": "Location ID"
},
"status": {
"type": "string",
"description": "Location Status"
}
}
},
{
"type": "object",
"required": [
"name",
"address"
],
"properties": {
"name": {
"type": "string",
"description": "Location Name"
},
"address": {
"type": "object",
"required": [
"address1",
"city",
"zipCodeOrPostalCode",
"country"
],
"properties": {
"company": {
"description": "Company",
"type": "string"
},
"address1": {
"description": "Address",
"type": "string"
},
"address2": {
"description": "Address Line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"stateOrProvince": {
"description": "State or Province",
"type": "string"
},
"zipCodeOrPostalCode": {
"description": "zipcode or postal code",
"type": "string"
},
"country": {
"description": "Country",
"type": "string"
},
"email": {
"description": "email",
"type": "string"
},
"phone": {
"description": "Phone",
"type": "string"
}
}
},
"infinite": {
"type": "boolean",
"description": "Set if this location has \\\"infinite\\\" availability"
},
"fulfillmentIntegrationId": {
"type": "string",
"description": "Set if this is a fulfillment location"
},
"externalSystem": {
"type": "array",
"items": {
"type": "object",
"description": "External System",
"properties": {
"integrationId": {
"type": "string",
"description": "External System Integration Id"
},
"locationValue": {
"type": "string",
"description": "External System Location Value"
}
}
}
}
}
},
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was created within Pipe17"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was updated within Pipe17"
},
"orgKey": {
"type": "string",
"readOnly": true,
"description": "Organization this object belong to"
}
}
}
]
}
}
}
]
}
}
}
},
"default": {
"description": "Failed operation",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
},
{
"type": "object",
"properties": {
"location": {
"type": "object",
"required": [
"name",
"address"
],
"properties": {
"name": {
"type": "string",
"description": "Location Name"
},
"address": {
"type": "object",
"required": [
"address1",
"city",
"zipCodeOrPostalCode",
"country"
],
"properties": {
"company": {
"description": "Company",
"type": "string"
},
"address1": {
"description": "Address",
"type": "string"
},
"address2": {
"description": "Address Line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"stateOrProvince": {
"description": "State or Province",
"type": "string"
},
"zipCodeOrPostalCode": {
"description": "zipcode or postal code",
"type": "string"
},
"country": {
"description": "Country",
"type": "string"
},
"email": {
"description": "email",
"type": "string"
},
"phone": {
"description": "Phone",
"type": "string"
}
}
},
"infinite": {
"type": "boolean",
"description": "Set if this location has \\\"infinite\\\" availability"
},
"fulfillmentIntegrationId": {
"type": "string",
"description": "Set if this is a fulfillment location"
},
"externalSystem": {
"type": "array",
"items": {
"type": "object",
"description": "External System",
"properties": {
"integrationId": {
"type": "string",
"description": "External System Integration Id"
},
"locationValue": {
"type": "string",
"description": "External System Location Value"
}
}
}
}
}
}
}
}
]
}
},
"application/xml": {
"schema": {
"allOf": [
{
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
},
{
"type": "object",
"properties": {
"location": {
"type": "object",
"required": [
"name",
"address"
],
"properties": {
"name": {
"type": "string",
"description": "Location Name"
},
"address": {
"type": "object",
"required": [
"address1",
"city",
"zipCodeOrPostalCode",
"country"
],
"properties": {
"company": {
"description": "Company",
"type": "string"
},
"address1": {
"description": "Address",
"type": "string"
},
"address2": {
"description": "Address Line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"stateOrProvince": {
"description": "State or Province",
"type": "string"
},
"zipCodeOrPostalCode": {
"description": "zipcode or postal code",
"type": "string"
},
"country": {
"description": "Country",
"type": "string"
},
"email": {
"description": "email",
"type": "string"
},
"phone": {
"description": "Phone",
"type": "string"
}
}
},
"infinite": {
"type": "boolean",
"description": "Set if this location has \\\"infinite\\\" availability"
},
"fulfillmentIntegrationId": {
"type": "string",
"description": "Set if this is a fulfillment location"
},
"externalSystem": {
"type": "array",
"items": {
"type": "object",
"description": "External System",
"properties": {
"integrationId": {
"type": "string",
"description": "External System Integration Id"
},
"locationValue": {
"type": "string",
"description": "External System Location Value"
}
}
}
}
}
}
}
}
]
}
},
"text/xml": {
"schema": {
"allOf": [
{
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
},
{
"type": "object",
"properties": {
"location": {
"type": "object",
"required": [
"name",
"address"
],
"properties": {
"name": {
"type": "string",
"description": "Location Name"
},
"address": {
"type": "object",
"required": [
"address1",
"city",
"zipCodeOrPostalCode",
"country"
],
"properties": {
"company": {
"description": "Company",
"type": "string"
},
"address1": {
"description": "Address",
"type": "string"
},
"address2": {
"description": "Address Line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"stateOrProvince": {
"description": "State or Province",
"type": "string"
},
"zipCodeOrPostalCode": {
"description": "zipcode or postal code",
"type": "string"
},
"country": {
"description": "Country",
"type": "string"
},
"email": {
"description": "email",
"type": "string"
},
"phone": {
"description": "Phone",
"type": "string"
}
}
},
"infinite": {
"type": "boolean",
"description": "Set if this location has \\\"infinite\\\" availability"
},
"fulfillmentIntegrationId": {
"type": "string",
"description": "Set if this is a fulfillment location"
},
"externalSystem": {
"type": "array",
"items": {
"type": "object",
"description": "External System",
"properties": {
"integrationId": {
"type": "string",
"description": "External System Integration Id"
},
"locationValue": {
"type": "string",
"description": "External System Location Value"
}
}
}
}
}
}
}
}
]
}
}
}
}
}
},
"get": {
"tags": [
"Locations"
],
"summary": "List Locations",
"operationId": "listLocations",
"parameters": [
{
"name": "name",
"in": "query",
"schema": {
"type": "string"
},
"description": "Retrieve locations matching name string"
},
{
"name": "email",
"in": "query",
"schema": {
"type": "string"
},
"description": "Retrieve locations matching email address"
},
{
"name": "phone",
"in": "query",
"schema": {
"type": "string"
},
"description": "Retrieve locations matching phone number"
},
{
"name": "since",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
},
"description": "Locations created after this date-time"
},
{
"name": "until",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
},
"description": "Locations created before this date-time"
},
{
"name": "updatedsince",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
},
"description": "Locations updated after this date-time"
},
{
"name": "updateduntil",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
},
"description": "Locations updated before this date-time"
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
},
"description": "Skip this many locations"
},
{
"name": "count",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
},
"description": "Return at most this many locations"
},
{
"name": "order",
"in": "query",
"schema": {
"type": "string"
},
"description": "List sort order"
},
{
"name": "keys",
"in": "query",
"schema": {
"type": "string"
},
"description": "Fields to retrieve"
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
},
{
"type": "object",
"properties": {
"filters": {
"type": "object",
"description": "Locations Filter",
"properties": {
"name": {
"type": "string",
"description": "Retrieve locations matching name string"
},
"email": {
"type": "string",
"description": "Retrieve locations matching email address"
},
"phone": {
"type": "string",
"description": "Retrieve locations matching phone number"
},
"since": {
"type": "string",
"format": "date-time",
"description": "Locations created after this date-time"
},
"until": {
"type": "string",
"format": "date-time",
"description": "Locations created before this date-time"
},
"updatedsince": {
"type": "string",
"format": "date-time",
"description": "Locations updated after this date-time"
},
"updateduntil": {
"type": "string",
"format": "date-time",
"description": "Locations updated before this date-time"
},
"skip": {
"type": "integer",
"format": "int32",
"description": "Skip this many locations"
},
"count": {
"type": "integer",
"format": "int32",
"description": "Return at most this many locations"
},
"order": {
"type": "string",
"description": "List sort order"
},
"keys": {
"type": "string",
"description": "Fields to retrieve"
}
}
},
"locations": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"locationId": {
"type": "string",
"description": "Location ID"
},
"status": {
"type": "string",
"description": "Location Status"
}
}
},
{
"type": "object",
"required": [
"name",
"address"
],
"properties": {
"name": {
"type": "string",
"description": "Location Name"
},
"address": {
"type": "object",
"required": [
"address1",
"city",
"zipCodeOrPostalCode",
"country"
],
"properties": {
"company": {
"description": "Company",
"type": "string"
},
"address1": {
"description": "Address",
"type": "string"
},
"address2": {
"description": "Address Line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"stateOrProvince": {
"description": "State or Province",
"type": "string"
},
"zipCodeOrPostalCode": {
"description": "zipcode or postal code",
"type": "string"
},
"country": {
"description": "Country",
"type": "string"
},
"email": {
"description": "email",
"type": "string"
},
"phone": {
"description": "Phone",
"type": "string"
}
}
},
"infinite": {
"type": "boolean",
"description": "Set if this location has \\\"infinite\\\" availability"
},
"fulfillmentIntegrationId": {
"type": "string",
"description": "Set if this is a fulfillment location"
},
"externalSystem": {
"type": "array",
"items": {
"type": "object",
"description": "External System",
"properties": {
"integrationId": {
"type": "string",
"description": "External System Integration Id"
},
"locationValue": {
"type": "string",
"description": "External System Location Value"
}
}
}
}
}
},
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was created within Pipe17"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was updated within Pipe17"
},
"orgKey": {
"type": "string",
"readOnly": true,
"description": "Organization this object belong to"
}
}
}
]
}
}
}
}
]
}
},
"application/xml": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
},
{
"type": "object",
"properties": {
"filters": {
"type": "object",
"description": "Locations Filter",
"properties": {
"name": {
"type": "string",
"description": "Retrieve locations matching name string"
},
"email": {
"type": "string",
"description": "Retrieve locations matching email address"
},
"phone": {
"type": "string",
"description": "Retrieve locations matching phone number"
},
"since": {
"type": "string",
"format": "date-time",
"description": "Locations created after this date-time"
},
"until": {
"type": "string",
"format": "date-time",
"description": "Locations created before this date-time"
},
"updatedsince": {
"type": "string",
"format": "date-time",
"description": "Locations updated after this date-time"
},
"updateduntil": {
"type": "string",
"format": "date-time",
"description": "Locations updated before this date-time"
},
"skip": {
"type": "integer",
"format": "int32",
"description": "Skip this many locations"
},
"count": {
"type": "integer",
"format": "int32",
"description": "Return at most this many locations"
},
"order": {
"type": "string",
"description": "List sort order"
},
"keys": {
"type": "string",
"description": "Fields to retrieve"
}
}
},
"locations": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"locationId": {
"type": "string",
"description": "Location ID"
},
"status": {
"type": "string",
"description": "Location Status"
}
}
},
{
"type": "object",
"required": [
"name",
"address"
],
"properties": {
"name": {
"type": "string",
"description": "Location Name"
},
"address": {
"type": "object",
"required": [
"address1",
"city",
"zipCodeOrPostalCode",
"country"
],
"properties": {
"company": {
"description": "Company",
"type": "string"
},
"address1": {
"description": "Address",
"type": "string"
},
"address2": {
"description": "Address Line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"stateOrProvince": {
"description": "State or Province",
"type": "string"
},
"zipCodeOrPostalCode": {
"description": "zipcode or postal code",
"type": "string"
},
"country": {
"description": "Country",
"type": "string"
},
"email": {
"description": "email",
"type": "string"
},
"phone": {
"description": "Phone",
"type": "string"
}
}
},
"infinite": {
"type": "boolean",
"description": "Set if this location has \\\"infinite\\\" availability"
},
"fulfillmentIntegrationId": {
"type": "string",
"description": "Set if this is a fulfillment location"
},
"externalSystem": {
"type": "array",
"items": {
"type": "object",
"description": "External System",
"properties": {
"integrationId": {
"type": "string",
"description": "External System Integration Id"
},
"locationValue": {
"type": "string",
"description": "External System Location Value"
}
}
}
}
}
},
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was created within Pipe17"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was updated within Pipe17"
},
"orgKey": {
"type": "string",
"readOnly": true,
"description": "Organization this object belong to"
}
}
}
]
}
}
}
}
]
}
},
"text/xml": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
},
{
"type": "object",
"properties": {
"filters": {
"type": "object",
"description": "Locations Filter",
"properties": {
"name": {
"type": "string",
"description": "Retrieve locations matching name string"
},
"email": {
"type": "string",
"description": "Retrieve locations matching email address"
},
"phone": {
"type": "string",
"description": "Retrieve locations matching phone number"
},
"since": {
"type": "string",
"format": "date-time",
"description": "Locations created after this date-time"
},
"until": {
"type": "string",
"format": "date-time",
"description": "Locations created before this date-time"
},
"updatedsince": {
"type": "string",
"format": "date-time",
"description": "Locations updated after this date-time"
},
"updateduntil": {
"type": "string",
"format": "date-time",
"description": "Locations updated before this date-time"
},
"skip": {
"type": "integer",
"format": "int32",
"description": "Skip this many locations"
},
"count": {
"type": "integer",
"format": "int32",
"description": "Return at most this many locations"
},
"order": {
"type": "string",
"description": "List sort order"
},
"keys": {
"type": "string",
"description": "Fields to retrieve"
}
}
},
"locations": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"locationId": {
"type": "string",
"description": "Location ID"
},
"status": {
"type": "string",
"description": "Location Status"
}
}
},
{
"type": "object",
"required": [
"name",
"address"
],
"properties": {
"name": {
"type": "string",
"description": "Location Name"
},
"address": {
"type": "object",
"required": [
"address1",
"city",
"zipCodeOrPostalCode",
"country"
],
"properties": {
"company": {
"description": "Company",
"type": "string"
},
"address1": {
"description": "Address",
"type": "string"
},
"address2": {
"description": "Address Line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"stateOrProvince": {
"description": "State or Province",
"type": "string"
},
"zipCodeOrPostalCode": {
"description": "zipcode or postal code",
"type": "string"
},
"country": {
"description": "Country",
"type": "string"
},
"email": {
"description": "email",
"type": "string"
},
"phone": {
"description": "Phone",
"type": "string"
}
}
},
"infinite": {
"type": "boolean",
"description": "Set if this location has \\\"infinite\\\" availability"
},
"fulfillmentIntegrationId": {
"type": "string",
"description": "Set if this is a fulfillment location"
},
"externalSystem": {
"type": "array",
"items": {
"type": "object",
"description": "External System",
"properties": {
"integrationId": {
"type": "string",
"description": "External System Integration Id"
},
"locationValue": {
"type": "string",
"description": "External System Location Value"
}
}
}
}
}
},
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was created within Pipe17"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was updated within Pipe17"
},
"orgKey": {
"type": "string",
"readOnly": true,
"description": "Organization this object belong to"
}
}
}
]
}
}
}
}
]
}
}
}
},
"default": {
"description": "Failed operation",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
},
{
"type": "object",
"properties": {
"filters": {
"type": "object",
"description": "Locations Filter",
"properties": {
"name": {
"type": "string",
"description": "Retrieve locations matching name string"
},
"email": {
"type": "string",
"description": "Retrieve locations matching email address"
},
"phone": {
"type": "string",
"description": "Retrieve locations matching phone number"
},
"since": {
"type": "string",
"format": "date-time",
"description": "Locations created after this date-time"
},
"until": {
"type": "string",
"format": "date-time",
"description": "Locations created before this date-time"
},
"updatedsince": {
"type": "string",
"format": "date-time",
"description": "Locations updated after this date-time"
},
"updateduntil": {
"type": "string",
"format": "date-time",
"description": "Locations updated before this date-time"
},
"skip": {
"type": "integer",
"format": "int32",
"description": "Skip this many locations"
},
"count": {
"type": "integer",
"format": "int32",
"description": "Return at most this many locations"
},
"order": {
"type": "string",
"description": "List sort order"
},
"keys": {
"type": "string",
"description": "Fields to retrieve"
}
}
}
}
}
]
}
},
"application/xml": {
"schema": {
"allOf": [
{
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
},
{
"type": "object",
"properties": {
"filters": {
"type": "object",
"description": "Locations Filter",
"properties": {
"name": {
"type": "string",
"description": "Retrieve locations matching name string"
},
"email": {
"type": "string",
"description": "Retrieve locations matching email address"
},
"phone": {
"type": "string",
"description": "Retrieve locations matching phone number"
},
"since": {
"type": "string",
"format": "date-time",
"description": "Locations created after this date-time"
},
"until": {
"type": "string",
"format": "date-time",
"description": "Locations created before this date-time"
},
"updatedsince": {
"type": "string",
"format": "date-time",
"description": "Locations updated after this date-time"
},
"updateduntil": {
"type": "string",
"format": "date-time",
"description": "Locations updated before this date-time"
},
"skip": {
"type": "integer",
"format": "int32",
"description": "Skip this many locations"
},
"count": {
"type": "integer",
"format": "int32",
"description": "Return at most this many locations"
},
"order": {
"type": "string",
"description": "List sort order"
},
"keys": {
"type": "string",
"description": "Fields to retrieve"
}
}
}
}
}
]
}
},
"text/xml": {
"schema": {
"allOf": [
{
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
},
{
"type": "object",
"properties": {
"filters": {
"type": "object",
"description": "Locations Filter",
"properties": {
"name": {
"type": "string",
"description": "Retrieve locations matching name string"
},
"email": {
"type": "string",
"description": "Retrieve locations matching email address"
},
"phone": {
"type": "string",
"description": "Retrieve locations matching phone number"
},
"since": {
"type": "string",
"format": "date-time",
"description": "Locations created after this date-time"
},
"until": {
"type": "string",
"format": "date-time",
"description": "Locations created before this date-time"
},
"updatedsince": {
"type": "string",
"format": "date-time",
"description": "Locations updated after this date-time"
},
"updateduntil": {
"type": "string",
"format": "date-time",
"description": "Locations updated before this date-time"
},
"skip": {
"type": "integer",
"format": "int32",
"description": "Skip this many locations"
},
"count": {
"type": "integer",
"format": "int32",
"description": "Return at most this many locations"
},
"order": {
"type": "string",
"description": "List sort order"
},
"keys": {
"type": "string",
"description": "Fields to retrieve"
}
}
}
}
}
]
}
}
}
}
}
}
},
"/locations/{LocationId}": {
"delete": {
"tags": [
"Locations"
],
"summary": "Delete Location",
"operationId": "deleteLocation",
"parameters": [
{
"name": "LocationId",
"in": "path",
"description": "Location ID to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
}
},
"application/xml": {
"schema": {
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
}
},
"text/xml": {
"schema": {
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
}
}
}
},
"default": {
"description": "Failed operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
}
},
"application/xml": {
"schema": {
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
}
},
"text/xml": {
"schema": {
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
}
}
}
}
}
},
"get": {
"tags": [
"Locations"
],
"summary": "Fetch Location",
"operationId": "fetchLocation",
"parameters": [
{
"name": "LocationId",
"in": "path",
"description": "Location ID to fetch",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
},
{
"type": "object",
"properties": {
"location": {
"allOf": [
{
"type": "object",
"properties": {
"locationId": {
"type": "string",
"description": "Location ID"
},
"status": {
"type": "string",
"description": "Location Status"
}
}
},
{
"type": "object",
"required": [
"name",
"address"
],
"properties": {
"name": {
"type": "string",
"description": "Location Name"
},
"address": {
"type": "object",
"required": [
"address1",
"city",
"zipCodeOrPostalCode",
"country"
],
"properties": {
"company": {
"description": "Company",
"type": "string"
},
"address1": {
"description": "Address",
"type": "string"
},
"address2": {
"description": "Address Line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"stateOrProvince": {
"description": "State or Province",
"type": "string"
},
"zipCodeOrPostalCode": {
"description": "zipcode or postal code",
"type": "string"
},
"country": {
"description": "Country",
"type": "string"
},
"email": {
"description": "email",
"type": "string"
},
"phone": {
"description": "Phone",
"type": "string"
}
}
},
"infinite": {
"type": "boolean",
"description": "Set if this location has \\\"infinite\\\" availability"
},
"fulfillmentIntegrationId": {
"type": "string",
"description": "Set if this is a fulfillment location"
},
"externalSystem": {
"type": "array",
"items": {
"type": "object",
"description": "External System",
"properties": {
"integrationId": {
"type": "string",
"description": "External System Integration Id"
},
"locationValue": {
"type": "string",
"description": "External System Location Value"
}
}
}
}
}
},
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was created within Pipe17"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was updated within Pipe17"
},
"orgKey": {
"type": "string",
"readOnly": true,
"description": "Organization this object belong to"
}
}
}
]
}
}
}
]
}
},
"application/xml": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
},
{
"type": "object",
"properties": {
"location": {
"allOf": [
{
"type": "object",
"properties": {
"locationId": {
"type": "string",
"description": "Location ID"
},
"status": {
"type": "string",
"description": "Location Status"
}
}
},
{
"type": "object",
"required": [
"name",
"address"
],
"properties": {
"name": {
"type": "string",
"description": "Location Name"
},
"address": {
"type": "object",
"required": [
"address1",
"city",
"zipCodeOrPostalCode",
"country"
],
"properties": {
"company": {
"description": "Company",
"type": "string"
},
"address1": {
"description": "Address",
"type": "string"
},
"address2": {
"description": "Address Line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"stateOrProvince": {
"description": "State or Province",
"type": "string"
},
"zipCodeOrPostalCode": {
"description": "zipcode or postal code",
"type": "string"
},
"country": {
"description": "Country",
"type": "string"
},
"email": {
"description": "email",
"type": "string"
},
"phone": {
"description": "Phone",
"type": "string"
}
}
},
"infinite": {
"type": "boolean",
"description": "Set if this location has \\\"infinite\\\" availability"
},
"fulfillmentIntegrationId": {
"type": "string",
"description": "Set if this is a fulfillment location"
},
"externalSystem": {
"type": "array",
"items": {
"type": "object",
"description": "External System",
"properties": {
"integrationId": {
"type": "string",
"description": "External System Integration Id"
},
"locationValue": {
"type": "string",
"description": "External System Location Value"
}
}
}
}
}
},
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was created within Pipe17"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was updated within Pipe17"
},
"orgKey": {
"type": "string",
"readOnly": true,
"description": "Organization this object belong to"
}
}
}
]
}
}
}
]
}
},
"text/xml": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
},
{
"type": "object",
"properties": {
"location": {
"allOf": [
{
"type": "object",
"properties": {
"locationId": {
"type": "string",
"description": "Location ID"
},
"status": {
"type": "string",
"description": "Location Status"
}
}
},
{
"type": "object",
"required": [
"name",
"address"
],
"properties": {
"name": {
"type": "string",
"description": "Location Name"
},
"address": {
"type": "object",
"required": [
"address1",
"city",
"zipCodeOrPostalCode",
"country"
],
"properties": {
"company": {
"description": "Company",
"type": "string"
},
"address1": {
"description": "Address",
"type": "string"
},
"address2": {
"description": "Address Line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"stateOrProvince": {
"description": "State or Province",
"type": "string"
},
"zipCodeOrPostalCode": {
"description": "zipcode or postal code",
"type": "string"
},
"country": {
"description": "Country",
"type": "string"
},
"email": {
"description": "email",
"type": "string"
},
"phone": {
"description": "Phone",
"type": "string"
}
}
},
"infinite": {
"type": "boolean",
"description": "Set if this location has \\\"infinite\\\" availability"
},
"fulfillmentIntegrationId": {
"type": "string",
"description": "Set if this is a fulfillment location"
},
"externalSystem": {
"type": "array",
"items": {
"type": "object",
"description": "External System",
"properties": {
"integrationId": {
"type": "string",
"description": "External System Integration Id"
},
"locationValue": {
"type": "string",
"description": "External System Location Value"
}
}
}
}
}
},
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was created within Pipe17"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was updated within Pipe17"
},
"orgKey": {
"type": "string",
"readOnly": true,
"description": "Organization this object belong to"
}
}
}
]
}
}
}
]
}
}
}
},
"default": {
"description": "Failed operation",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
}
]
}
},
"application/xml": {
"schema": {
"allOf": [
{
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
}
]
}
},
"text/xml": {
"schema": {
"allOf": [
{
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
}
]
}
}
}
}
}
},
"put": {
"tags": [
"Locations"
],
"summary": "Update Location",
"operationId": "updateLocation",
"parameters": [
{
"name": "LocationId",
"in": "path",
"description": "Location ID to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Location Name"
},
"address": {
"type": "object",
"properties": {
"company": {
"description": "Company",
"type": "string"
},
"address1": {
"description": "Address",
"type": "string"
},
"address2": {
"description": "Address Line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"stateOrProvince": {
"description": "State or Province",
"type": "string"
},
"zipCodeOrPostalCode": {
"description": "zipcode or postal code",
"type": "string"
},
"country": {
"description": "Country",
"type": "string"
},
"email": {
"description": "email",
"type": "string"
},
"phone": {
"description": "Phone",
"type": "string"
}
}
},
"infinite": {
"type": "boolean",
"description": "Set if this location has \\\"infinite\\\" availability"
},
"fulfillmentIntegrationId": {
"type": "string",
"description": "Set if this is a fulfillment location"
},
"externalSystem": {
"type": "array",
"items": {
"type": "object",
"description": "External System",
"properties": {
"integrationId": {
"type": "string",
"description": "External System Integration Id"
},
"locationValue": {
"type": "string",
"description": "External System Location Value"
}
}
}
}
}
}
],
"xml": {
"name": "request"
}
}
},
"application/xml": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Location Name"
},
"address": {
"type": "object",
"properties": {
"company": {
"description": "Company",
"type": "string"
},
"address1": {
"description": "Address",
"type": "string"
},
"address2": {
"description": "Address Line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"stateOrProvince": {
"description": "State or Province",
"type": "string"
},
"zipCodeOrPostalCode": {
"description": "zipcode or postal code",
"type": "string"
},
"country": {
"description": "Country",
"type": "string"
},
"email": {
"description": "email",
"type": "string"
},
"phone": {
"description": "Phone",
"type": "string"
}
}
},
"infinite": {
"type": "boolean",
"description": "Set if this location has \\\"infinite\\\" availability"
},
"fulfillmentIntegrationId": {
"type": "string",
"description": "Set if this is a fulfillment location"
},
"externalSystem": {
"type": "array",
"items": {
"type": "object",
"description": "External System",
"properties": {
"integrationId": {
"type": "string",
"description": "External System Integration Id"
},
"locationValue": {
"type": "string",
"description": "External System Location Value"
}
}
}
}
}
}
],
"xml": {
"name": "request"
}
}
},
"text/xml": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Location Name"
},
"address": {
"type": "object",
"properties": {
"company": {
"description": "Company",
"type": "string"
},
"address1": {
"description": "Address",
"type": "string"
},
"address2": {
"description": "Address Line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"stateOrProvince": {
"description": "State or Province",
"type": "string"
},
"zipCodeOrPostalCode": {
"description": "zipcode or postal code",
"type": "string"
},
"country": {
"description": "Country",
"type": "string"
},
"email": {
"description": "email",
"type": "string"
},
"phone": {
"description": "Phone",
"type": "string"
}
}
},
"infinite": {
"type": "boolean",
"description": "Set if this location has \\\"infinite\\\" availability"
},
"fulfillmentIntegrationId": {
"type": "string",
"description": "Set if this is a fulfillment location"
},
"externalSystem": {
"type": "array",
"items": {
"type": "object",
"description": "External System",
"properties": {
"integrationId": {
"type": "string",
"description": "External System Integration Id"
},
"locationValue": {
"type": "string",
"description": "External System Location Value"
}
}
}
}
}
}
],
"xml": {
"name": "request"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
}
]
}
},
"application/xml": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
}
]
}
},
"text/xml": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
}
]
}
}
}
},
"default": {
"description": "Failed operation",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
},
{
"type": "object",
"properties": {
"location": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Location Name"
},
"address": {
"type": "object",
"properties": {
"company": {
"description": "Company",
"type": "string"
},
"address1": {
"description": "Address",
"type": "string"
},
"address2": {
"description": "Address Line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"stateOrProvince": {
"description": "State or Province",
"type": "string"
},
"zipCodeOrPostalCode": {
"description": "zipcode or postal code",
"type": "string"
},
"country": {
"description": "Country",
"type": "string"
},
"email": {
"description": "email",
"type": "string"
},
"phone": {
"description": "Phone",
"type": "string"
}
}
},
"infinite": {
"type": "boolean",
"description": "Set if this location has \\\"infinite\\\" availability"
},
"fulfillmentIntegrationId": {
"type": "string",
"description": "Set if this is a fulfillment location"
},
"externalSystem": {
"type": "array",
"items": {
"type": "object",
"description": "External System",
"properties": {
"integrationId": {
"type": "string",
"description": "External System Integration Id"
},
"locationValue": {
"type": "string",
"description": "External System Location Value"
}
}
}
}
}
}
}
}
]
}
},
"application/xml": {
"schema": {
"allOf": [
{
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
},
{
"type": "object",
"properties": {
"location": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Location Name"
},
"address": {
"type": "object",
"properties": {
"company": {
"description": "Company",
"type": "string"
},
"address1": {
"description": "Address",
"type": "string"
},
"address2": {
"description": "Address Line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"stateOrProvince": {
"description": "State or Province",
"type": "string"
},
"zipCodeOrPostalCode": {
"description": "zipcode or postal code",
"type": "string"
},
"country": {
"description": "Country",
"type": "string"
},
"email": {
"description": "email",
"type": "string"
},
"phone": {
"description": "Phone",
"type": "string"
}
}
},
"infinite": {
"type": "boolean",
"description": "Set if this location has \\\"infinite\\\" availability"
},
"fulfillmentIntegrationId": {
"type": "string",
"description": "Set if this is a fulfillment location"
},
"externalSystem": {
"type": "array",
"items": {
"type": "object",
"description": "External System",
"properties": {
"integrationId": {
"type": "string",
"description": "External System Integration Id"
},
"locationValue": {
"type": "string",
"description": "External System Location Value"
}
}
}
}
}
}
}
}
]
}
},
"text/xml": {
"schema": {
"allOf": [
{
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
},
{
"type": "object",
"properties": {
"location": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Location Name"
},
"address": {
"type": "object",
"properties": {
"company": {
"description": "Company",
"type": "string"
},
"address1": {
"description": "Address",
"type": "string"
},
"address2": {
"description": "Address Line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"stateOrProvince": {
"description": "State or Province",
"type": "string"
},
"zipCodeOrPostalCode": {
"description": "zipcode or postal code",
"type": "string"
},
"country": {
"description": "Country",
"type": "string"
},
"email": {
"description": "email",
"type": "string"
},
"phone": {
"description": "Phone",
"type": "string"
}
}
},
"infinite": {
"type": "boolean",
"description": "Set if this location has \\\"infinite\\\" availability"
},
"fulfillmentIntegrationId": {
"type": "string",
"description": "Set if this is a fulfillment location"
},
"externalSystem": {
"type": "array",
"items": {
"type": "object",
"description": "External System",
"properties": {
"integrationId": {
"type": "string",
"description": "External System Integration Id"
},
"locationValue": {
"type": "string",
"description": "External System Location Value"
}
}
}
}
}
}
}
}
]
}
}
}
}
}
}
},
"/orders": {
"post": {
"tags": [
"Orders"
],
"summary": "Create Orders",
"operationId": "createOrders",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"xml": {
"name": "order"
},
"required": [
"extOrderId",
"shippingAddress",
"billingAddress"
],
"properties": {
"extOrderId": {
"type": "string",
"description": "External Order ID"
},
"orderSource": {
"type": "string",
"description": "The original order platform, walmart, etsy, etc"
},
"lineItems": {
"type": "array",
"items": {
"type": "object",
"required": [
"uniqueId",
"sku",
"quantity",
"requiresShipping"
],
"properties": {
"uniqueId": {
"type": "string",
"description": "Item unique Id (within an order)"
},
"sku": {
"type": "string",
"description": "Item SKU"
},
"quantity": {
"type": "number",
"format": "float",
"description": "Item Quantity"
},
"itemPrice": {
"type": "number",
"format": "float",
"description": "Item Price"
},
"itemDiscount": {
"type": "number",
"format": "float",
"description": "Item Price"
},
"itemTax": {
"type": "number",
"format": "float"
},
"requiresShipping": {
"type": "boolean"
},
"taxable": {
"type": "boolean"
}
}
}
},
"subTotalPrice": {
"type": "number",
"format": "float",
"description": "Sub Total Price"
},
"orderDiscount": {
"type": "number",
"format": "float",
"description": "Order Discount"
},
"orderTax": {
"type": "number",
"format": "float",
"description": "Order Tax"
},
"totalPrice": {
"type": "number",
"format": "float",
"description": "Total Price"
},
"orderNote": {
"type": "string",
"description": "Order Notes"
},
"shippingAddress": {
"description": "Recipient Address",
"type": "object",
"required": [
"firstName",
"lastName",
"address1",
"city",
"zipCodeOrPostalCode",
"country"
],
"properties": {
"firstName": {
"description": "First Name",
"type": "string"
},
"lastName": {
"description": "Last Name",
"type": "string"
},
"company": {
"description": "Company",
"type": "string"
},
"address1": {
"description": "Address",
"type": "string"
},
"address2": {
"description": "Address Line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"stateOrProvince": {
"description": "If within the US, required 2 letter State Code",
"type": "string"
},
"zipCodeOrPostalCode": {
"description": "zipcode or postal code",
"type": "string"
},
"country": {
"description": "ISO 3 letter code only",
"type": "string"
},
"email": {
"description": "email",
"type": "string"
},
"phone": {
"description": "Phone",
"type": "string"
}
}
},
"shippingCarrier": {
"type": "string",
"description": "Required with ShippingClass, Pipe17 Approved List, 2nd Priority"
},
"shippingClass": {
"type": "string",
"description": "Required with ShippingCarrier, 2nd Priority"
},
"shipByDate": {
"type": "string",
"format": "date-time",
"description": "Ship By Date"
},
"expectedDeliveryDate": {
"type": "string",
"format": "date-time",
"description": "First Priority to be respected"
},
"shippingNote": {
"type": "string",
"description": "Shipping Notes"
},
"incoterms": {
"type": "string",
"description": "International Commercial Terms"
},
"billingAddress": {
"description": "Purchaser Address",
"type": "object",
"required": [
"firstName",
"lastName",
"address1",
"city",
"zipCodeOrPostalCode",
"country"
],
"properties": {
"firstName": {
"description": "First Name",
"type": "string"
},
"lastName": {
"description": "Last Name",
"type": "string"
},
"company": {
"description": "Company",
"type": "string"
},
"address1": {
"description": "Address",
"type": "string"
},
"address2": {
"description": "Address Line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"stateOrProvince": {
"description": "If within the US, required 2 letter State Code",
"type": "string"
},
"zipCodeOrPostalCode": {
"description": "zipcode or postal code",
"type": "string"
},
"country": {
"description": "ISO 3 letter code only",
"type": "string"
},
"email": {
"description": "email",
"type": "string"
},
"phone": {
"description": "Phone",
"type": "string"
}
}
},
"timeStamp": {
"type": "string",
"format": "date-time",
"description": "General Purpose Time Stamp"
},
"shippingCode": {
"type": "string",
"description": "3rd Priority"
},
"customer": {
"type": "object",
"properties": {
"extCustomerId": {
"type": "string"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"company": {
"type": "string"
}
}
},
"paymentStatus": {
"type": "string",
"description": "status of the payment"
},
"fulfillmentStatus": {
"type": "string",
"description": "status of the fulfillment"
},
"extOrderApiId": {
"type": "string",
"description": "External System Order API ID"
},
"extOrderCreatedAt": {
"type": "string",
"format": "date-time",
"description": "When the order was created at source"
},
"extOrderUpdatedAt": {
"type": "string",
"format": "date-time",
"description": "When the order was updated at source"
},
"locationId": {
"type": "string",
"description": "Id of location defined in organization. Used as item origin for shipment."
},
"shippingPrice": {
"type": "number",
"format": "float",
"description": "Shipping price"
},
"requireShippingLabels": {
"type": "boolean",
"description": "Indicates if fetching of shipping labels is required"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Order tags"
}
}
},
"xml": {
"name": "request",
"wrapped": true
},
"maxItems": 10
}
},
"application/xml": {
"schema": {
"type": "array",
"items": {
"type": "object",
"xml": {
"name": "order"
},
"required": [
"extOrderId",
"shippingAddress",
"billingAddress"
],
"properties": {
"extOrderId": {
"type": "string",
"description": "External Order ID"
},
"orderSource": {
"type": "string",
"description": "The original order platform, walmart, etsy, etc"
},
"lineItems": {
"type": "array",
"items": {
"type": "object",
"required": [
"uniqueId",
"sku",
"quantity",
"requiresShipping"
],
"properties": {
"uniqueId": {
"type": "string",
"description": "Item unique Id (within an order)"
},
"sku": {
"type": "string",
"description": "Item SKU"
},
"quantity": {
"type": "number",
"format": "float",
"description": "Item Quantity"
},
"itemPrice": {
"type": "number",
"format": "float",
"description": "Item Price"
},
"itemDiscount": {
"type": "number",
"format": "float",
"description": "Item Price"
},
"itemTax": {
"type": "number",
"format": "float"
},
"requiresShipping": {
"type": "boolean"
},
"taxable": {
"type": "boolean"
}
}
}
},
"subTotalPrice": {
"type": "number",
"format": "float",
"description": "Sub Total Price"
},
"orderDiscount": {
"type": "number",
"format": "float",
"description": "Order Discount"
},
"orderTax": {
"type": "number",
"format": "float",
"description": "Order Tax"
},
"totalPrice": {
"type": "number",
"format": "float",
"description": "Total Price"
},
"orderNote": {
"type": "string",
"description": "Order Notes"
},
"shippingAddress": {
"description": "Recipient Address",
"type": "object",
"required": [
"firstName",
"lastName",
"address1",
"city",
"zipCodeOrPostalCode",
"country"
],
"properties": {
"firstName": {
"description": "First Name",
"type": "string"
},
"lastName": {
"description": "Last Name",
"type": "string"
},
"company": {
"description": "Company",
"type": "string"
},
"address1": {
"description": "Address",
"type": "string"
},
"address2": {
"description": "Address Line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"stateOrProvince": {
"description": "If within the US, required 2 letter State Code",
"type": "string"
},
"zipCodeOrPostalCode": {
"description": "zipcode or postal code",
"type": "string"
},
"country": {
"description": "ISO 3 letter code only",
"type": "string"
},
"email": {
"description": "email",
"type": "string"
},
"phone": {
"description": "Phone",
"type": "string"
}
}
},
"shippingCarrier": {
"type": "string",
"description": "Required with ShippingClass, Pipe17 Approved List, 2nd Priority"
},
"shippingClass": {
"type": "string",
"description": "Required with ShippingCarrier, 2nd Priority"
},
"shipByDate": {
"type": "string",
"format": "date-time",
"description": "Ship By Date"
},
"expectedDeliveryDate": {
"type": "string",
"format": "date-time",
"description": "First Priority to be respected"
},
"shippingNote": {
"type": "string",
"description": "Shipping Notes"
},
"incoterms": {
"type": "string",
"description": "International Commercial Terms"
},
"billingAddress": {
"description": "Purchaser Address",
"type": "object",
"required": [
"firstName",
"lastName",
"address1",
"city",
"zipCodeOrPostalCode",
"country"
],
"properties": {
"firstName": {
"description": "First Name",
"type": "string"
},
"lastName": {
"description": "Last Name",
"type": "string"
},
"company": {
"description": "Company",
"type": "string"
},
"address1": {
"description": "Address",
"type": "string"
},
"address2": {
"description": "Address Line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"stateOrProvince": {
"description": "If within the US, required 2 letter State Code",
"type": "string"
},
"zipCodeOrPostalCode": {
"description": "zipcode or postal code",
"type": "string"
},
"country": {
"description": "ISO 3 letter code only",
"type": "string"
},
"email": {
"description": "email",
"type": "string"
},
"phone": {
"description": "Phone",
"type": "string"
}
}
},
"timeStamp": {
"type": "string",
"format": "date-time",
"description": "General Purpose Time Stamp"
},
"shippingCode": {
"type": "string",
"description": "3rd Priority"
},
"customer": {
"type": "object",
"properties": {
"extCustomerId": {
"type": "string"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"company": {
"type": "string"
}
}
},
"paymentStatus": {
"type": "string",
"description": "status of the payment"
},
"fulfillmentStatus": {
"type": "string",
"description": "status of the fulfillment"
},
"extOrderApiId": {
"type": "string",
"description": "External System Order API ID"
},
"extOrderCreatedAt": {
"type": "string",
"format": "date-time",
"description": "When the order was created at source"
},
"extOrderUpdatedAt": {
"type": "string",
"format": "date-time",
"description": "When the order was updated at source"
},
"locationId": {
"type": "string",
"description": "Id of location defined in organization. Used as item origin for shipment."
},
"shippingPrice": {
"type": "number",
"format": "float",
"description": "Shipping price"
},
"requireShippingLabels": {
"type": "boolean",
"description": "Indicates if fetching of shipping labels is required"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Order tags"
}
}
},
"xml": {
"name": "request",
"wrapped": true
},
"maxItems": 10
}
},
"text/xml": {
"schema": {
"type": "array",
"items": {
"type": "object",
"xml": {
"name": "order"
},
"required": [
"extOrderId",
"shippingAddress",
"billingAddress"
],
"properties": {
"extOrderId": {
"type": "string",
"description": "External Order ID"
},
"orderSource": {
"type": "string",
"description": "The original order platform, walmart, etsy, etc"
},
"lineItems": {
"type": "array",
"items": {
"type": "object",
"required": [
"uniqueId",
"sku",
"quantity",
"requiresShipping"
],
"properties": {
"uniqueId": {
"type": "string",
"description": "Item unique Id (within an order)"
},
"sku": {
"type": "string",
"description": "Item SKU"
},
"quantity": {
"type": "number",
"format": "float",
"description": "Item Quantity"
},
"itemPrice": {
"type": "number",
"format": "float",
"description": "Item Price"
},
"itemDiscount": {
"type": "number",
"format": "float",
"description": "Item Price"
},
"itemTax": {
"type": "number",
"format": "float"
},
"requiresShipping": {
"type": "boolean"
},
"taxable": {
"type": "boolean"
}
}
}
},
"subTotalPrice": {
"type": "number",
"format": "float",
"description": "Sub Total Price"
},
"orderDiscount": {
"type": "number",
"format": "float",
"description": "Order Discount"
},
"orderTax": {
"type": "number",
"format": "float",
"description": "Order Tax"
},
"totalPrice": {
"type": "number",
"format": "float",
"description": "Total Price"
},
"orderNote": {
"type": "string",
"description": "Order Notes"
},
"shippingAddress": {
"description": "Recipient Address",
"type": "object",
"required": [
"firstName",
"lastName",
"address1",
"city",
"zipCodeOrPostalCode",
"country"
],
"properties": {
"firstName": {
"description": "First Name",
"type": "string"
},
"lastName": {
"description": "Last Name",
"type": "string"
},
"company": {
"description": "Company",
"type": "string"
},
"address1": {
"description": "Address",
"type": "string"
},
"address2": {
"description": "Address Line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"stateOrProvince": {
"description": "If within the US, required 2 letter State Code",
"type": "string"
},
"zipCodeOrPostalCode": {
"description": "zipcode or postal code",
"type": "string"
},
"country": {
"description": "ISO 3 letter code only",
"type": "string"
},
"email": {
"description": "email",
"type": "string"
},
"phone": {
"description": "Phone",
"type": "string"
}
}
},
"shippingCarrier": {
"type": "string",
"description": "Required with ShippingClass, Pipe17 Approved List, 2nd Priority"
},
"shippingClass": {
"type": "string",
"description": "Required with ShippingCarrier, 2nd Priority"
},
"shipByDate": {
"type": "string",
"format": "date-time",
"description": "Ship By Date"
},
"expectedDeliveryDate": {
"type": "string",
"format": "date-time",
"description": "First Priority to be respected"
},
"shippingNote": {
"type": "string",
"description": "Shipping Notes"
},
"incoterms": {
"type": "string",
"description": "International Commercial Terms"
},
"billingAddress": {
"description": "Purchaser Address",
"type": "object",
"required": [
"firstName",
"lastName",
"address1",
"city",
"zipCodeOrPostalCode",
"country"
],
"properties": {
"firstName": {
"description": "First Name",
"type": "string"
},
"lastName": {
"description": "Last Name",
"type": "string"
},
"company": {
"description": "Company",
"type": "string"
},
"address1": {
"description": "Address",
"type": "string"
},
"address2": {
"description": "Address Line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"stateOrProvince": {
"description": "If within the US, required 2 letter State Code",
"type": "string"
},
"zipCodeOrPostalCode": {
"description": "zipcode or postal code",
"type": "string"
},
"country": {
"description": "ISO 3 letter code only",
"type": "string"
},
"email": {
"description": "email",
"type": "string"
},
"phone": {
"description": "Phone",
"type": "string"
}
}
},
"timeStamp": {
"type": "string",
"format": "date-time",
"description": "General Purpose Time Stamp"
},
"shippingCode": {
"type": "string",
"description": "3rd Priority"
},
"customer": {
"type": "object",
"properties": {
"extCustomerId": {
"type": "string"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"company": {
"type": "string"
}
}
},
"paymentStatus": {
"type": "string",
"description": "status of the payment"
},
"fulfillmentStatus": {
"type": "string",
"description": "status of the fulfillment"
},
"extOrderApiId": {
"type": "string",
"description": "External System Order API ID"
},
"extOrderCreatedAt": {
"type": "string",
"format": "date-time",
"description": "When the order was created at source"
},
"extOrderUpdatedAt": {
"type": "string",
"format": "date-time",
"description": "When the order was updated at source"
},
"locationId": {
"type": "string",
"description": "Id of location defined in organization. Used as item origin for shipment."
},
"shippingPrice": {
"type": "number",
"format": "float",
"description": "Shipping price"
},
"requireShippingLabels": {
"type": "boolean",
"description": "Indicates if fetching of shipping labels is required"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Order tags"
}
}
},
"xml": {
"name": "request",
"wrapped": true
},
"maxItems": 10
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
},
{
"type": "object",
"properties": {
"orders": {
"type": "array",
"items": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"submitted",
"failed"
]
},
"message": {
"type": "string",
"description": "Error message if failed"
},
"errors": {
"type": "array",
"items": {
"type": "string"
},
"description": "Error details if failed"
},
"order": {
"allOf": [
{
"type": "object",
"properties": {
"orderId": {
"type": "string",
"description": "Auto Generated"
},
"status": {
"type": "string",
"description": "Order Status",
"enum": [
"new",
"hold",
"validate",
"review",
"readyForFulfillment",
"sentForFulfillment",
"partialFulfillment",
"fulfilled",
"inTransit",
"delivered",
"refunded",
"cancelled"
]
}
}
},
{
"type": "object",
"xml": {
"name": "order"
},
"required": [
"extOrderId",
"shippingAddress",
"billingAddress"
],
"properties": {
"extOrderId": {
"type": "string",
"description": "External Order ID"
},
"orderSource": {
"type": "string",
"description": "The original order platform, walmart, etsy, etc"
},
"lineItems": {
"type": "array",
"items": {
"type": "object",
"required": [
"uniqueId",
"sku",
"quantity",
"requiresShipping"
],
"properties": {
"uniqueId": {
"type": "string",
"description": "Item unique Id (within an order)"
},
"sku": {
"type": "string",
"description": "Item SKU"
},
"quantity": {
"type": "number",
"format": "float",
"description": "Item Quantity"
},
"itemPrice": {
"type": "number",
"format": "float",
"description": "Item Price"
},
"itemDiscount": {
"type": "number",
"format": "float",
"description": "Item Price"
},
"itemTax": {
"type": "number",
"format": "float"
},
"requiresShipping": {
"type": "boolean"
},
"taxable": {
"type": "boolean"
}
}
}
},
"subTotalPrice": {
"type": "number",
"format": "float",
"description": "Sub Total Price"
},
"orderDiscount": {
"type": "number",
"format": "float",
"description": "Order Discount"
},
"orderTax": {
"type": "number",
"format": "float",
"description": "Order Tax"
},
"totalPrice": {
"type": "number",
"format": "float",
"description": "Total Price"
},
"orderNote": {
"type": "string",
"description": "Order Notes"
},
"shippingAddress": {
"description": "Recipient Address",
"type": "object",
"required": [
"firstName",
"lastName",
"address1",
"city",
"zipCodeOrPostalCode",
"country"
],
"properties": {
"firstName": {
"description": "First Name",
"type": "string"
},
"lastName": {
"description": "Last Name",
"type": "string"
},
"company": {
"description": "Company",
"type": "string"
},
"address1": {
"description": "Address",
"type": "string"
},
"address2": {
"description": "Address Line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"stateOrProvince": {
"description": "If within the US, required 2 letter State Code",
"type": "string"
},
"zipCodeOrPostalCode": {
"description": "zipcode or postal code",
"type": "string"
},
"country": {
"description": "ISO 3 letter code only",
"type": "string"
},
"email": {
"description": "email",
"type": "string"
},
"phone": {
"description": "Phone",
"type": "string"
}
}
},
"shippingCarrier": {
"type": "string",
"description": "Required with ShippingClass, Pipe17 Approved List, 2nd Priority"
},
"shippingClass": {
"type": "string",
"description": "Required with ShippingCarrier, 2nd Priority"
},
"shipByDate": {
"type": "string",
"format": "date-time",
"description": "Ship By Date"
},
"expectedDeliveryDate": {
"type": "string",
"format": "date-time",
"description": "First Priority to be respected"
},
"shippingNote": {
"type": "string",
"description": "Shipping Notes"
},
"incoterms": {
"type": "string",
"description": "International Commercial Terms"
},
"billingAddress": {
"description": "Purchaser Address",
"type": "object",
"required": [
"firstName",
"lastName",
"address1",
"city",
"zipCodeOrPostalCode",
"country"
],
"properties": {
"firstName": {
"description": "First Name",
"type": "string"
},
"lastName": {
"description": "Last Name",
"type": "string"
},
"company": {
"description": "Company",
"type": "string"
},
"address1": {
"description": "Address",
"type": "string"
},
"address2": {
"description": "Address Line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"stateOrProvince": {
"description": "If within the US, required 2 letter State Code",
"type": "string"
},
"zipCodeOrPostalCode": {
"description": "zipcode or postal code",
"type": "string"
},
"country": {
"description": "ISO 3 letter code only",
"type": "string"
},
"email": {
"description": "email",
"type": "string"
},
"phone": {
"description": "Phone",
"type": "string"
}
}
},
"timeStamp": {
"type": "string",
"format": "date-time",
"description": "General Purpose Time Stamp"
},
"shippingCode": {
"type": "string",
"description": "3rd Priority"
},
"customer": {
"type": "object",
"properties": {
"extCustomerId": {
"type": "string"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"company": {
"type": "string"
}
}
},
"paymentStatus": {
"type": "string",
"description": "status of the payment"
},
"fulfillmentStatus": {
"type": "string",
"description": "status of the fulfillment"
},
"extOrderApiId": {
"type": "string",
"description": "External System Order API ID"
},
"extOrderCreatedAt": {
"type": "string",
"format": "date-time",
"description": "When the order was created at source"
},
"extOrderUpdatedAt": {
"type": "string",
"format": "date-time",
"description": "When the order was updated at source"
},
"locationId": {
"type": "string",
"description": "Id of location defined in organization. Used as item origin for shipment."
},
"shippingPrice": {
"type": "number",
"format": "float",
"description": "Shipping price"
},
"requireShippingLabels": {
"type": "boolean",
"description": "Indicates if fetching of shipping labels is required"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Order tags"
}
}
},
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was created within Pipe17"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was updated within Pipe17"
},
"orgKey": {
"type": "string",
"readOnly": true,
"description": "Organization this object belong to"
}
}
}
]
}
}
}
}
}
}
]
}
},
"application/xml": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
},
{
"type": "object",
"properties": {
"orders": {
"type": "array",
"items": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"submitted",
"failed"
]
},
"message": {
"type": "string",
"description": "Error message if failed"
},
"errors": {
"type": "array",
"items": {
"type": "string"
},
"description": "Error details if failed"
},
"order": {
"allOf": [
{
"type": "object",
"properties": {
"orderId": {
"type": "string",
"description": "Auto Generated"
},
"status": {
"type": "string",
"description": "Order Status",
"enum": [
"new",
"hold",
"validate",
"review",
"readyForFulfillment",
"sentForFulfillment",
"partialFulfillment",
"fulfilled",
"inTransit",
"delivered",
"refunded",
"cancelled"
]
}
}
},
{
"type": "object",
"xml": {
"name": "order"
},
"required": [
"extOrderId",
"shippingAddress",
"billingAddress"
],
"properties": {
"extOrderId": {
"type": "string",
"description": "External Order ID"
},
"orderSource": {
"type": "string",
"description": "The original order platform, walmart, etsy, etc"
},
"lineItems": {
"type": "array",
"items": {
"type": "object",
"required": [
"uniqueId",
"sku",
"quantity",
"requiresShipping"
],
"properties": {
"uniqueId": {
"type": "string",
"description": "Item unique Id (within an order)"
},
"sku": {
"type": "string",
"description": "Item SKU"
},
"quantity": {
"type": "number",
"format": "float",
"description": "Item Quantity"
},
"itemPrice": {
"type": "number",
"format": "float",
"description": "Item Price"
},
"itemDiscount": {
"type": "number",
"format": "float",
"description": "Item Price"
},
"itemTax": {
"type": "number",
"format": "float"
},
"requiresShipping": {
"type": "boolean"
},
"taxable": {
"type": "boolean"
}
}
}
},
"subTotalPrice": {
"type": "number",
"format": "float",
"description": "Sub Total Price"
},
"orderDiscount": {
"type": "number",
"format": "float",
"description": "Order Discount"
},
"orderTax": {
"type": "number",
"format": "float",
"description": "Order Tax"
},
"totalPrice": {
"type": "number",
"format": "float",
"description": "Total Price"
},
"orderNote": {
"type": "string",
"description": "Order Notes"
},
"shippingAddress": {
"description": "Recipient Address",
"type": "object",
"required": [
"firstName",
"lastName",
"address1",
"city",
"zipCodeOrPostalCode",
"country"
],
"properties": {
"firstName": {
"description": "First Name",
"type": "string"
},
"lastName": {
"description": "Last Name",
"type": "string"
},
"company": {
"description": "Company",
"type": "string"
},
"address1": {
"description": "Address",
"type": "string"
},
"address2": {
"description": "Address Line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"stateOrProvince": {
"description": "If within the US, required 2 letter State Code",
"type": "string"
},
"zipCodeOrPostalCode": {
"description": "zipcode or postal code",
"type": "string"
},
"country": {
"description": "ISO 3 letter code only",
"type": "string"
},
"email": {
"description": "email",
"type": "string"
},
"phone": {
"description": "Phone",
"type": "string"
}
}
},
"shippingCarrier": {
"type": "string",
"description": "Required with ShippingClass, Pipe17 Approved List, 2nd Priority"
},
"shippingClass": {
"type": "string",
"description": "Required with ShippingCarrier, 2nd Priority"
},
"shipByDate": {
"type": "string",
"format": "date-time",
"description": "Ship By Date"
},
"expectedDeliveryDate": {
"type": "string",
"format": "date-time",
"description": "First Priority to be respected"
},
"shippingNote": {
"type": "string",
"description": "Shipping Notes"
},
"incoterms": {
"type": "string",
"description": "International Commercial Terms"
},
"billingAddress": {
"description": "Purchaser Address",
"type": "object",
"required": [
"firstName",
"lastName",
"address1",
"city",
"zipCodeOrPostalCode",
"country"
],
"properties": {
"firstName": {
"description": "First Name",
"type": "string"
},
"lastName": {
"description": "Last Name",
"type": "string"
},
"company": {
"description": "Company",
"type": "string"
},
"address1": {
"description": "Address",
"type": "string"
},
"address2": {
"description": "Address Line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"stateOrProvince": {
"description": "If within the US, required 2 letter State Code",
"type": "string"
},
"zipCodeOrPostalCode": {
"description": "zipcode or postal code",
"type": "string"
},
"country": {
"description": "ISO 3 letter code only",
"type": "string"
},
"email": {
"description": "email",
"type": "string"
},
"phone": {
"description": "Phone",
"type": "string"
}
}
},
"timeStamp": {
"type": "string",
"format": "date-time",
"description": "General Purpose Time Stamp"
},
"shippingCode": {
"type": "string",
"description": "3rd Priority"
},
"customer": {
"type": "object",
"properties": {
"extCustomerId": {
"type": "string"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"company": {
"type": "string"
}
}
},
"paymentStatus": {
"type": "string",
"description": "status of the payment"
},
"fulfillmentStatus": {
"type": "string",
"description": "status of the fulfillment"
},
"extOrderApiId": {
"type": "string",
"description": "External System Order API ID"
},
"extOrderCreatedAt": {
"type": "string",
"format": "date-time",
"description": "When the order was created at source"
},
"extOrderUpdatedAt": {
"type": "string",
"format": "date-time",
"description": "When the order was updated at source"
},
"locationId": {
"type": "string",
"description": "Id of location defined in organization. Used as item origin for shipment."
},
"shippingPrice": {
"type": "number",
"format": "float",
"description": "Shipping price"
},
"requireShippingLabels": {
"type": "boolean",
"description": "Indicates if fetching of shipping labels is required"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Order tags"
}
}
},
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was created within Pipe17"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was updated within Pipe17"
},
"orgKey": {
"type": "string",
"readOnly": true,
"description": "Organization this object belong to"
}
}
}
]
}
}
}
}
}
}
]
}
},
"text/xml": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
},
{
"type": "object",
"properties": {
"orders": {
"type": "array",
"items": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"submitted",
"failed"
]
},
"message": {
"type": "string",
"description": "Error message if failed"
},
"errors": {
"type": "array",
"items": {
"type": "string"
},
"description": "Error details if failed"
},
"order": {
"allOf": [
{
"type": "object",
"properties": {
"orderId": {
"type": "string",
"description": "Auto Generated"
},
"status": {
"type": "string",
"description": "Order Status",
"enum": [
"new",
"hold",
"validate",
"review",
"readyForFulfillment",
"sentForFulfillment",
"partialFulfillment",
"fulfilled",
"inTransit",
"delivered",
"refunded",
"cancelled"
]
}
}
},
{
"type": "object",
"xml": {
"name": "order"
},
"required": [
"extOrderId",
"shippingAddress",
"billingAddress"
],
"properties": {
"extOrderId": {
"type": "string",
"description": "External Order ID"
},
"orderSource": {
"type": "string",
"description": "The original order platform, walmart, etsy, etc"
},
"lineItems": {
"type": "array",
"items": {
"type": "object",
"required": [
"uniqueId",
"sku",
"quantity",
"requiresShipping"
],
"properties": {
"uniqueId": {
"type": "string",
"description": "Item unique Id (within an order)"
},
"sku": {
"type": "string",
"description": "Item SKU"
},
"quantity": {
"type": "number",
"format": "float",
"description": "Item Quantity"
},
"itemPrice": {
"type": "number",
"format": "float",
"description": "Item Price"
},
"itemDiscount": {
"type": "number",
"format": "float",
"description": "Item Price"
},
"itemTax": {
"type": "number",
"format": "float"
},
"requiresShipping": {
"type": "boolean"
},
"taxable": {
"type": "boolean"
}
}
}
},
"subTotalPrice": {
"type": "number",
"format": "float",
"description": "Sub Total Price"
},
"orderDiscount": {
"type": "number",
"format": "float",
"description": "Order Discount"
},
"orderTax": {
"type": "number",
"format": "float",
"description": "Order Tax"
},
"totalPrice": {
"type": "number",
"format": "float",
"description": "Total Price"
},
"orderNote": {
"type": "string",
"description": "Order Notes"
},
"shippingAddress": {
"description": "Recipient Address",
"type": "object",
"required": [
"firstName",
"lastName",
"address1",
"city",
"zipCodeOrPostalCode",
"country"
],
"properties": {
"firstName": {
"description": "First Name",
"type": "string"
},
"lastName": {
"description": "Last Name",
"type": "string"
},
"company": {
"description": "Company",
"type": "string"
},
"address1": {
"description": "Address",
"type": "string"
},
"address2": {
"description": "Address Line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"stateOrProvince": {
"description": "If within the US, required 2 letter State Code",
"type": "string"
},
"zipCodeOrPostalCode": {
"description": "zipcode or postal code",
"type": "string"
},
"country": {
"description": "ISO 3 letter code only",
"type": "string"
},
"email": {
"description": "email",
"type": "string"
},
"phone": {
"description": "Phone",
"type": "string"
}
}
},
"shippingCarrier": {
"type": "string",
"description": "Required with ShippingClass, Pipe17 Approved List, 2nd Priority"
},
"shippingClass": {
"type": "string",
"description": "Required with ShippingCarrier, 2nd Priority"
},
"shipByDate": {
"type": "string",
"format": "date-time",
"description": "Ship By Date"
},
"expectedDeliveryDate": {
"type": "string",
"format": "date-time",
"description": "First Priority to be respected"
},
"shippingNote": {
"type": "string",
"description": "Shipping Notes"
},
"incoterms": {
"type": "string",
"description": "International Commercial Terms"
},
"billingAddress": {
"description": "Purchaser Address",
"type": "object",
"required": [
"firstName",
"lastName",
"address1",
"city",
"zipCodeOrPostalCode",
"country"
],
"properties": {
"firstName": {
"description": "First Name",
"type": "string"
},
"lastName": {
"description": "Last Name",
"type": "string"
},
"company": {
"description": "Company",
"type": "string"
},
"address1": {
"description": "Address",
"type": "string"
},
"address2": {
"description": "Address Line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"stateOrProvince": {
"description": "If within the US, required 2 letter State Code",
"type": "string"
},
"zipCodeOrPostalCode": {
"description": "zipcode or postal code",
"type": "string"
},
"country": {
"description": "ISO 3 letter code only",
"type": "string"
},
"email": {
"description": "email",
"type": "string"
},
"phone": {
"description": "Phone",
"type": "string"
}
}
},
"timeStamp": {
"type": "string",
"format": "date-time",
"description": "General Purpose Time Stamp"
},
"shippingCode": {
"type": "string",
"description": "3rd Priority"
},
"customer": {
"type": "object",
"properties": {
"extCustomerId": {
"type": "string"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"company": {
"type": "string"
}
}
},
"paymentStatus": {
"type": "string",
"description": "status of the payment"
},
"fulfillmentStatus": {
"type": "string",
"description": "status of the fulfillment"
},
"extOrderApiId": {
"type": "string",
"description": "External System Order API ID"
},
"extOrderCreatedAt": {
"type": "string",
"format": "date-time",
"description": "When the order was created at source"
},
"extOrderUpdatedAt": {
"type": "string",
"format": "date-time",
"description": "When the order was updated at source"
},
"locationId": {
"type": "string",
"description": "Id of location defined in organization. Used as item origin for shipment."
},
"shippingPrice": {
"type": "number",
"format": "float",
"description": "Shipping price"
},
"requireShippingLabels": {
"type": "boolean",
"description": "Indicates if fetching of shipping labels is required"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Order tags"
}
}
},
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was created within Pipe17"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was updated within Pipe17"
},
"orgKey": {
"type": "string",
"readOnly": true,
"description": "Organization this object belong to"
}
}
}
]
}
}
}
}
}
}
]
}
}
}
},
"default": {
"description": "Failed operation",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
}
]
}
},
"application/xml": {
"schema": {
"allOf": [
{
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
}
]
}
},
"text/xml": {
"schema": {
"allOf": [
{
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
}
]
}
}
}
}
}
},
"get": {
"tags": [
"Orders"
],
"summary": "List Orders",
"operationId": "listOrders",
"parameters": [
{
"name": "extorderid",
"in": "query",
"schema": {
"type": "string"
},
"description": "Fetch a specific order by its external id"
},
{
"name": "email",
"in": "query",
"schema": {
"type": "string"
},
"description": "Fetch all orders matching this recipient email"
},
{
"name": "status",
"in": "query",
"schema": {
"type": "string",
"description": "Order Status",
"enum": [
"new",
"hold",
"validate",
"review",
"readyForFulfillment",
"sentForFulfillment",
"partialFulfillment",
"fulfilled",
"inTransit",
"delivered",
"refunded",
"cancelled"
]
},
"description": "Fetch all orders with this status"
},
{
"name": "requireShippingLabels",
"in": "query",
"schema": {
"type": "boolean"
},
"description": "Filter orders by shipping labels requirement"
},
{
"name": "since",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
},
"description": "Fetch all orders created after this date-time"
},
{
"name": "until",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
},
"description": "Fetch all orders created before this date-time"
},
{
"name": "updatedsince",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
},
"description": "Fetch all orders updated after this date-time"
},
{
"name": "updateduntil",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
},
"description": "Fetch all orders updated before this date-time"
},
{
"name": "timestamp",
"in": "query",
"schema": {
"type": "boolean"
},
"description": "if set to true use timestamp instead of create time"
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
},
"description": "Skip this many orders"
},
{
"name": "count",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
},
"description": "Return at most this many orders"
},
{
"name": "order",
"in": "query",
"schema": {
"type": "string"
},
"description": "List sort order"
},
{
"name": "keys",
"in": "query",
"schema": {
"type": "string"
},
"description": "Fields to retrieve"
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
},
{
"type": "object",
"required": [
"orders"
],
"properties": {
"filters": {
"type": "object",
"description": "Orders Filter",
"properties": {
"extorderid": {
"type": "string",
"description": "Fetch a specific order by its external order ID"
},
"email": {
"type": "string",
"description": "Fetch all orders matching this recipient email"
},
"status": {
"type": "string",
"description": "Order Status",
"enum": [
"new",
"hold",
"validate",
"review",
"readyForFulfillment",
"sentForFulfillment",
"partialFulfillment",
"fulfilled",
"inTransit",
"delivered",
"refunded",
"cancelled"
]
},
"requireShippingLabels": {
"type": "boolean",
"description": "Filter orders by shipping labels requirement"
},
"since": {
"type": "string",
"format": "date-time",
"description": "Fetch all orders created after this date-time"
},
"until": {
"type": "string",
"format": "date-time",
"description": "Fetch all orders created before this date-time"
},
"updatedsince": {
"type": "string",
"format": "date-time",
"description": "Fetch all orders updated after this date-time"
},
"updateduntil": {
"type": "string",
"format": "date-time",
"description": "Fetch all orders updated before this date-time"
},
"timestamp": {
"type": "boolean",
"description": "if set to true use timestamp instead of create time"
},
"skip": {
"type": "integer",
"format": "int32",
"description": "Skip this many orders"
},
"count": {
"type": "integer",
"format": "int32",
"description": "Return at most this many orders"
},
"order": {
"type": "string",
"description": "List sort order"
},
"keys": {
"type": "string",
"description": "Fields to retrieve"
}
}
},
"orders": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"orderId": {
"type": "string",
"description": "Auto Generated"
},
"status": {
"type": "string",
"description": "Order Status",
"enum": [
"new",
"hold",
"validate",
"review",
"readyForFulfillment",
"sentForFulfillment",
"partialFulfillment",
"fulfilled",
"inTransit",
"delivered",
"refunded",
"cancelled"
]
}
}
},
{
"type": "object",
"xml": {
"name": "order"
},
"required": [
"extOrderId",
"shippingAddress",
"billingAddress"
],
"properties": {
"extOrderId": {
"type": "string",
"description": "External Order ID"
},
"orderSource": {
"type": "string",
"description": "The original order platform, walmart, etsy, etc"
},
"lineItems": {
"type": "array",
"items": {
"type": "object",
"required": [
"uniqueId",
"sku",
"quantity",
"requiresShipping"
],
"properties": {
"uniqueId": {
"type": "string",
"description": "Item unique Id (within an order)"
},
"sku": {
"type": "string",
"description": "Item SKU"
},
"quantity": {
"type": "number",
"format": "float",
"description": "Item Quantity"
},
"itemPrice": {
"type": "number",
"format": "float",
"description": "Item Price"
},
"itemDiscount": {
"type": "number",
"format": "float",
"description": "Item Price"
},
"itemTax": {
"type": "number",
"format": "float"
},
"requiresShipping": {
"type": "boolean"
},
"taxable": {
"type": "boolean"
}
}
}
},
"subTotalPrice": {
"type": "number",
"format": "float",
"description": "Sub Total Price"
},
"orderDiscount": {
"type": "number",
"format": "float",
"description": "Order Discount"
},
"orderTax": {
"type": "number",
"format": "float",
"description": "Order Tax"
},
"totalPrice": {
"type": "number",
"format": "float",
"description": "Total Price"
},
"orderNote": {
"type": "string",
"description": "Order Notes"
},
"shippingAddress": {
"description": "Recipient Address",
"type": "object",
"required": [
"firstName",
"lastName",
"address1",
"city",
"zipCodeOrPostalCode",
"country"
],
"properties": {
"firstName": {
"description": "First Name",
"type": "string"
},
"lastName": {
"description": "Last Name",
"type": "string"
},
"company": {
"description": "Company",
"type": "string"
},
"address1": {
"description": "Address",
"type": "string"
},
"address2": {
"description": "Address Line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"stateOrProvince": {
"description": "If within the US, required 2 letter State Code",
"type": "string"
},
"zipCodeOrPostalCode": {
"description": "zipcode or postal code",
"type": "string"
},
"country": {
"description": "ISO 3 letter code only",
"type": "string"
},
"email": {
"description": "email",
"type": "string"
},
"phone": {
"description": "Phone",
"type": "string"
}
}
},
"shippingCarrier": {
"type": "string",
"description": "Required with ShippingClass, Pipe17 Approved List, 2nd Priority"
},
"shippingClass": {
"type": "string",
"description": "Required with ShippingCarrier, 2nd Priority"
},
"shipByDate": {
"type": "string",
"format": "date-time",
"description": "Ship By Date"
},
"expectedDeliveryDate": {
"type": "string",
"format": "date-time",
"description": "First Priority to be respected"
},
"shippingNote": {
"type": "string",
"description": "Shipping Notes"
},
"incoterms": {
"type": "string",
"description": "International Commercial Terms"
},
"billingAddress": {
"description": "Purchaser Address",
"type": "object",
"required": [
"firstName",
"lastName",
"address1",
"city",
"zipCodeOrPostalCode",
"country"
],
"properties": {
"firstName": {
"description": "First Name",
"type": "string"
},
"lastName": {
"description": "Last Name",
"type": "string"
},
"company": {
"description": "Company",
"type": "string"
},
"address1": {
"description": "Address",
"type": "string"
},
"address2": {
"description": "Address Line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"stateOrProvince": {
"description": "If within the US, required 2 letter State Code",
"type": "string"
},
"zipCodeOrPostalCode": {
"description": "zipcode or postal code",
"type": "string"
},
"country": {
"description": "ISO 3 letter code only",
"type": "string"
},
"email": {
"description": "email",
"type": "string"
},
"phone": {
"description": "Phone",
"type": "string"
}
}
},
"timeStamp": {
"type": "string",
"format": "date-time",
"description": "General Purpose Time Stamp"
},
"shippingCode": {
"type": "string",
"description": "3rd Priority"
},
"customer": {
"type": "object",
"properties": {
"extCustomerId": {
"type": "string"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"company": {
"type": "string"
}
}
},
"paymentStatus": {
"type": "string",
"description": "status of the payment"
},
"fulfillmentStatus": {
"type": "string",
"description": "status of the fulfillment"
},
"extOrderApiId": {
"type": "string",
"description": "External System Order API ID"
},
"extOrderCreatedAt": {
"type": "string",
"format": "date-time",
"description": "When the order was created at source"
},
"extOrderUpdatedAt": {
"type": "string",
"format": "date-time",
"description": "When the order was updated at source"
},
"locationId": {
"type": "string",
"description": "Id of location defined in organization. Used as item origin for shipment."
},
"shippingPrice": {
"type": "number",
"format": "float",
"description": "Shipping price"
},
"requireShippingLabels": {
"type": "boolean",
"description": "Indicates if fetching of shipping labels is required"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Order tags"
}
}
},
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was created within Pipe17"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was updated within Pipe17"
},
"orgKey": {
"type": "string",
"readOnly": true,
"description": "Organization this object belong to"
}
}
}
]
}
}
}
}
]
}
},
"application/xml": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
},
{
"type": "object",
"required": [
"orders"
],
"properties": {
"filters": {
"type": "object",
"description": "Orders Filter",
"properties": {
"extorderid": {
"type": "string",
"description": "Fetch a specific order by its external order ID"
},
"email": {
"type": "string",
"description": "Fetch all orders matching this recipient email"
},
"status": {
"type": "string",
"description": "Order Status",
"enum": [
"new",
"hold",
"validate",
"review",
"readyForFulfillment",
"sentForFulfillment",
"partialFulfillment",
"fulfilled",
"inTransit",
"delivered",
"refunded",
"cancelled"
]
},
"requireShippingLabels": {
"type": "boolean",
"description": "Filter orders by shipping labels requirement"
},
"since": {
"type": "string",
"format": "date-time",
"description": "Fetch all orders created after this date-time"
},
"until": {
"type": "string",
"format": "date-time",
"description": "Fetch all orders created before this date-time"
},
"updatedsince": {
"type": "string",
"format": "date-time",
"description": "Fetch all orders updated after this date-time"
},
"updateduntil": {
"type": "string",
"format": "date-time",
"description": "Fetch all orders updated before this date-time"
},
"timestamp": {
"type": "boolean",
"description": "if set to true use timestamp instead of create time"
},
"skip": {
"type": "integer",
"format": "int32",
"description": "Skip this many orders"
},
"count": {
"type": "integer",
"format": "int32",
"description": "Return at most this many orders"
},
"order": {
"type": "string",
"description": "List sort order"
},
"keys": {
"type": "string",
"description": "Fields to retrieve"
}
}
},
"orders": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"orderId": {
"type": "string",
"description": "Auto Generated"
},
"status": {
"type": "string",
"description": "Order Status",
"enum": [
"new",
"hold",
"validate",
"review",
"readyForFulfillment",
"sentForFulfillment",
"partialFulfillment",
"fulfilled",
"inTransit",
"delivered",
"refunded",
"cancelled"
]
}
}
},
{
"type": "object",
"xml": {
"name": "order"
},
"required": [
"extOrderId",
"shippingAddress",
"billingAddress"
],
"properties": {
"extOrderId": {
"type": "string",
"description": "External Order ID"
},
"orderSource": {
"type": "string",
"description": "The original order platform, walmart, etsy, etc"
},
"lineItems": {
"type": "array",
"items": {
"type": "object",
"required": [
"uniqueId",
"sku",
"quantity",
"requiresShipping"
],
"properties": {
"uniqueId": {
"type": "string",
"description": "Item unique Id (within an order)"
},
"sku": {
"type": "string",
"description": "Item SKU"
},
"quantity": {
"type": "number",
"format": "float",
"description": "Item Quantity"
},
"itemPrice": {
"type": "number",
"format": "float",
"description": "Item Price"
},
"itemDiscount": {
"type": "number",
"format": "float",
"description": "Item Price"
},
"itemTax": {
"type": "number",
"format": "float"
},
"requiresShipping": {
"type": "boolean"
},
"taxable": {
"type": "boolean"
}
}
}
},
"subTotalPrice": {
"type": "number",
"format": "float",
"description": "Sub Total Price"
},
"orderDiscount": {
"type": "number",
"format": "float",
"description": "Order Discount"
},
"orderTax": {
"type": "number",
"format": "float",
"description": "Order Tax"
},
"totalPrice": {
"type": "number",
"format": "float",
"description": "Total Price"
},
"orderNote": {
"type": "string",
"description": "Order Notes"
},
"shippingAddress": {
"description": "Recipient Address",
"type": "object",
"required": [
"firstName",
"lastName",
"address1",
"city",
"zipCodeOrPostalCode",
"country"
],
"properties": {
"firstName": {
"description": "First Name",
"type": "string"
},
"lastName": {
"description": "Last Name",
"type": "string"
},
"company": {
"description": "Company",
"type": "string"
},
"address1": {
"description": "Address",
"type": "string"
},
"address2": {
"description": "Address Line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"stateOrProvince": {
"description": "If within the US, required 2 letter State Code",
"type": "string"
},
"zipCodeOrPostalCode": {
"description": "zipcode or postal code",
"type": "string"
},
"country": {
"description": "ISO 3 letter code only",
"type": "string"
},
"email": {
"description": "email",
"type": "string"
},
"phone": {
"description": "Phone",
"type": "string"
}
}
},
"shippingCarrier": {
"type": "string",
"description": "Required with ShippingClass, Pipe17 Approved List, 2nd Priority"
},
"shippingClass": {
"type": "string",
"description": "Required with ShippingCarrier, 2nd Priority"
},
"shipByDate": {
"type": "string",
"format": "date-time",
"description": "Ship By Date"
},
"expectedDeliveryDate": {
"type": "string",
"format": "date-time",
"description": "First Priority to be respected"
},
"shippingNote": {
"type": "string",
"description": "Shipping Notes"
},
"incoterms": {
"type": "string",
"description": "International Commercial Terms"
},
"billingAddress": {
"description": "Purchaser Address",
"type": "object",
"required": [
"firstName",
"lastName",
"address1",
"city",
"zipCodeOrPostalCode",
"country"
],
"properties": {
"firstName": {
"description": "First Name",
"type": "string"
},
"lastName": {
"description": "Last Name",
"type": "string"
},
"company": {
"description": "Company",
"type": "string"
},
"address1": {
"description": "Address",
"type": "string"
},
"address2": {
"description": "Address Line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"stateOrProvince": {
"description": "If within the US, required 2 letter State Code",
"type": "string"
},
"zipCodeOrPostalCode": {
"description": "zipcode or postal code",
"type": "string"
},
"country": {
"description": "ISO 3 letter code only",
"type": "string"
},
"email": {
"description": "email",
"type": "string"
},
"phone": {
"description": "Phone",
"type": "string"
}
}
},
"timeStamp": {
"type": "string",
"format": "date-time",
"description": "General Purpose Time Stamp"
},
"shippingCode": {
"type": "string",
"description": "3rd Priority"
},
"customer": {
"type": "object",
"properties": {
"extCustomerId": {
"type": "string"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"company": {
"type": "string"
}
}
},
"paymentStatus": {
"type": "string",
"description": "status of the payment"
},
"fulfillmentStatus": {
"type": "string",
"description": "status of the fulfillment"
},
"extOrderApiId": {
"type": "string",
"description": "External System Order API ID"
},
"extOrderCreatedAt": {
"type": "string",
"format": "date-time",
"description": "When the order was created at source"
},
"extOrderUpdatedAt": {
"type": "string",
"format": "date-time",
"description": "When the order was updated at source"
},
"locationId": {
"type": "string",
"description": "Id of location defined in organization. Used as item origin for shipment."
},
"shippingPrice": {
"type": "number",
"format": "float",
"description": "Shipping price"
},
"requireShippingLabels": {
"type": "boolean",
"description": "Indicates if fetching of shipping labels is required"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Order tags"
}
}
},
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was created within Pipe17"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was updated within Pipe17"
},
"orgKey": {
"type": "string",
"readOnly": true,
"description": "Organization this object belong to"
}
}
}
]
}
}
}
}
]
}
},
"text/xml": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"success",
"code"
],
"xml": {
"name": "response"
},
"properties": {
"success": {
"type": "boolean",
"description": "Always true",
"enum": [
true
],
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"description": "Copy of HTTP status",
"enum": [
200,
201,
202
],
"example": 200
}
}
},
{
"type": "object",
"required": [
"orders"
],
"properties": {
"filters": {
"type": "object",
"description": "Orders Filter",
"properties": {
"extorderid": {
"type": "string",
"description": "Fetch a specific order by its external order ID"
},
"email": {
"type": "string",
"description": "Fetch all orders matching this recipient email"
},
"status": {
"type": "string",
"description": "Order Status",
"enum": [
"new",
"hold",
"validate",
"review",
"readyForFulfillment",
"sentForFulfillment",
"partialFulfillment",
"fulfilled",
"inTransit",
"delivered",
"refunded",
"cancelled"
]
},
"requireShippingLabels": {
"type": "boolean",
"description": "Filter orders by shipping labels requirement"
},
"since": {
"type": "string",
"format": "date-time",
"description": "Fetch all orders created after this date-time"
},
"until": {
"type": "string",
"format": "date-time",
"description": "Fetch all orders created before this date-time"
},
"updatedsince": {
"type": "string",
"format": "date-time",
"description": "Fetch all orders updated after this date-time"
},
"updateduntil": {
"type": "string",
"format": "date-time",
"description": "Fetch all orders updated before this date-time"
},
"timestamp": {
"type": "boolean",
"description": "if set to true use timestamp instead of create time"
},
"skip": {
"type": "integer",
"format": "int32",
"description": "Skip this many orders"
},
"count": {
"type": "integer",
"format": "int32",
"description": "Return at most this many orders"
},
"order": {
"type": "string",
"description": "List sort order"
},
"keys": {
"type": "string",
"description": "Fields to retrieve"
}
}
},
"orders": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"orderId": {
"type": "string",
"description": "Auto Generated"
},
"status": {
"type": "string",
"description": "Order Status",
"enum": [
"new",
"hold",
"validate",
"review",
"readyForFulfillment",
"sentForFulfillment",
"partialFulfillment",
"fulfilled",
"inTransit",
"delivered",
"refunded",
"cancelled"
]
}
}
},
{
"type": "object",
"xml": {
"name": "order"
},
"required": [
"extOrderId",
"shippingAddress",
"billingAddress"
],
"properties": {
"extOrderId": {
"type": "string",
"description": "External Order ID"
},
"orderSource": {
"type": "string",
"description": "The original order platform, walmart, etsy, etc"
},
"lineItems": {
"type": "array",
"items": {
"type": "object",
"required": [
"uniqueId",
"sku",
"quantity",
"requiresShipping"
],
"properties": {
"uniqueId": {
"type": "string",
"description": "Item unique Id (within an order)"
},
"sku": {
"type": "string",
"description": "Item SKU"
},
"quantity": {
"type": "number",
"format": "float",
"description": "Item Quantity"
},
"itemPrice": {
"type": "number",
"format": "float",
"description": "Item Price"
},
"itemDiscount": {
"type": "number",
"format": "float",
"description": "Item Price"
},
"itemTax": {
"type": "number",
"format": "float"
},
"requiresShipping": {
"type": "boolean"
},
"taxable": {
"type": "boolean"
}
}
}
},
"subTotalPrice": {
"type": "number",
"format": "float",
"description": "Sub Total Price"
},
"orderDiscount": {
"type": "number",
"format": "float",
"description": "Order Discount"
},
"orderTax": {
"type": "number",
"format": "float",
"description": "Order Tax"
},
"totalPrice": {
"type": "number",
"format": "float",
"description": "Total Price"
},
"orderNote": {
"type": "string",
"description": "Order Notes"
},
"shippingAddress": {
"description": "Recipient Address",
"type": "object",
"required": [
"firstName",
"lastName",
"address1",
"city",
"zipCodeOrPostalCode",
"country"
],
"properties": {
"firstName": {
"description": "First Name",
"type": "string"
},
"lastName": {
"description": "Last Name",
"type": "string"
},
"company": {
"description": "Company",
"type": "string"
},
"address1": {
"description": "Address",
"type": "string"
},
"address2": {
"description": "Address Line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"stateOrProvince": {
"description": "If within the US, required 2 letter State Code",
"type": "string"
},
"zipCodeOrPostalCode": {
"description": "zipcode or postal code",
"type": "string"
},
"country": {
"description": "ISO 3 letter code only",
"type": "string"
},
"email": {
"description": "email",
"type": "string"
},
"phone": {
"description": "Phone",
"type": "string"
}
}
},
"shippingCarrier": {
"type": "string",
"description": "Required with ShippingClass, Pipe17 Approved List, 2nd Priority"
},
"shippingClass": {
"type": "string",
"description": "Required with ShippingCarrier, 2nd Priority"
},
"shipByDate": {
"type": "string",
"format": "date-time",
"description": "Ship By Date"
},
"expectedDeliveryDate": {
"type": "string",
"format": "date-time",
"description": "First Priority to be respected"
},
"shippingNote": {
"type": "string",
"description": "Shipping Notes"
},
"incoterms": {
"type": "string",
"description": "International Commercial Terms"
},
"billingAddress": {
"description": "Purchaser Address",
"type": "object",
"required": [
"firstName",
"lastName",
"address1",
"city",
"zipCodeOrPostalCode",
"country"
],
"properties": {
"firstName": {
"description": "First Name",
"type": "string"
},
"lastName": {
"description": "Last Name",
"type": "string"
},
"company": {
"description": "Company",
"type": "string"
},
"address1": {
"description": "Address",
"type": "string"
},
"address2": {
"description": "Address Line 2",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"stateOrProvince": {
"description": "If within the US, required 2 letter State Code",
"type": "string"
},
"zipCodeOrPostalCode": {
"description": "zipcode or postal code",
"type": "string"
},
"country": {
"description": "ISO 3 letter code only",
"type": "string"
},
"email": {
"description": "email",
"type": "string"
},
"phone": {
"description": "Phone",
"type": "string"
}
}
},
"timeStamp": {
"type": "string",
"format": "date-time",
"description": "General Purpose Time Stamp"
},
"shippingCode": {
"type": "string",
"description": "3rd Priority"
},
"customer": {
"type": "object",
"properties": {
"extCustomerId": {
"type": "string"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"company": {
"type": "string"
}
}
},
"paymentStatus": {
"type": "string",
"description": "status of the payment"
},
"fulfillmentStatus": {
"type": "string",
"description": "status of the fulfillment"
},
"extOrderApiId": {
"type": "string",
"description": "External System Order API ID"
},
"extOrderCreatedAt": {
"type": "string",
"format": "date-time",
"description": "When the order was created at source"
},
"extOrderUpdatedAt": {
"type": "string",
"format": "date-time",
"description": "When the order was updated at source"
},
"locationId": {
"type": "string",
"description": "Id of location defined in organization. Used as item origin for shipment."
},
"shippingPrice": {
"type": "number",
"format": "float",
"description": "Shipping price"
},
"requireShippingLabels": {
"type": "boolean",
"description": "Indicates if fetching of shipping labels is required"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Order tags"
}
}
},
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was created within Pipe17"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the object was updated within Pipe17"
},
"orgKey": {
"type": "string",
"readOnly": true,
"description": "Organization this object belong to"
}
}
}
]
}
}
}
}
]
}
}
}
},
"default": {
"description": "Failed operation",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
},
{
"type": "object",
"properties": {
"filters": {
"type": "object",
"description": "Orders Filter",
"properties": {
"extorderid": {
"type": "string",
"description": "Fetch a specific order by its external order ID"
},
"email": {
"type": "string",
"description": "Fetch all orders matching this recipient email"
},
"status": {
"type": "string",
"description": "Order Status",
"enum": [
"new",
"hold",
"validate",
"review",
"readyForFulfillment",
"sentForFulfillment",
"partialFulfillment",
"fulfilled",
"inTransit",
"delivered",
"refunded",
"cancelled"
]
},
"requireShippingLabels": {
"type": "boolean",
"description": "Filter orders by shipping labels requirement"
},
"since": {
"type": "string",
"format": "date-time",
"description": "Fetch all orders created after this date-time"
},
"until": {
"type": "string",
"format": "date-time",
"description": "Fetch all orders created before this date-time"
},
"updatedsince": {
"type": "string",
"format": "date-time",
"description": "Fetch all orders updated after this date-time"
},
"updateduntil": {
"type": "string",
"format": "date-time",
"description": "Fetch all orders updated before this date-time"
},
"timestamp": {
"type": "boolean",
"description": "if set to true use timestamp instead of create time"
},
"skip": {
"type": "integer",
"format": "int32",
"description": "Skip this many orders"
},
"count": {
"type": "integer",
"format": "int32",
"description": "Return at most this many orders"
},
"order": {
"type": "string",
"description": "List sort order"
},
"keys": {
"type": "string",
"description": "Fields to retrieve"
}
}
}
}
}
]
}
},
"application/xml": {
"schema": {
"allOf": [
{
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
},
{
"type": "object",
"properties": {
"filters": {
"type": "object",
"description": "Orders Filter",
"properties": {
"extorderid": {
"type": "string",
"description": "Fetch a specific order by its external order ID"
},
"email": {
"type": "string",
"description": "Fetch all orders matching this recipient email"
},
"status": {
"type": "string",
"description": "Order Status",
"enum": [
"new",
"hold",
"validate",
"review",
"readyForFulfillment",
"sentForFulfillment",
"partialFulfillment",
"fulfilled",
"inTransit",
"delivered",
"refunded",
"cancelled"
]
},
"requireShippingLabels": {
"type": "boolean",
"description": "Filter orders by shipping labels requirement"
},
"since": {
"type": "string",
"format": "date-time",
"description": "Fetch all orders created after this date-time"
},
"until": {
"type": "string",
"format": "date-time",
"description": "Fetch all orders created before this date-time"
},
"updatedsince": {
"type": "string",
"format": "date-time",
"description": "Fetch all orders updated after this date-time"
},
"updateduntil": {
"type": "string",
"format": "date-time",
"description": "Fetch all orders updated before this date-time"
},
"timestamp": {
"type": "boolean",
"description": "if set to true use timestamp instead of create time"
},
"skip": {
"type": "integer",
"format": "int32",
"description": "Skip this many orders"
},
"count": {
"type": "integer",
"format": "int32",
"description": "Return at most this many orders"
},
"order": {
"type": "string",
"description": "List sort order"
},
"keys": {
"type": "string",
"description": "Fields to retrieve"
}
}
}
}
}
]
}
},
"text/xml": {
"schema": {
"allOf": [
{
"type": "object",
"xml": {
"name": "response"
},
"required": [
"success",
"code"
],
"properties": {
"success": {
"type": "boolean",
"description": "Always false",
"enum": [
false
],
"example": false
},
"code": {
"type": "integer",
"description": "Copy of HTTP status",
"format": "int32",
"minimum": 400,
"example": 404
},
"message": {
"type": "string",
"description": "Error message"
},
"errors": {
"type": "array",
"description": "Error detail",
"items": {
"type": "string"
}
}
}
},
{
"type": "object",
"properties": {
"filters": {
"type": "object",
"description": "Orders Filter",
"properties": {
"extorderid": {
"type": "string",
"description": "Fetch a specific order by its external order ID"
},
"email": {
"type": "string",
"description": "Fetch all orders matching this recipient email"
},
"status": {
"type": "string",
"description": "Order Status",
"enum": [
"new",
"hold",
"validate",
"review",
"readyForFulfillment",
"sentForFulfillment",
"partialFulfillment",
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment