Pipe17 logo
API docs by Redocly

Pipe17 API (3.0.318)

Download OpenAPI specification:Download

E-mail: support@pipe17.com License: Pipe17 License Terms of Service

Generic interface to Pipe17 services

About Pipe17

Arrivals

Operations about Arrival Notifications

Arrival Model

senderName
required
string

Sender's Name

toLocationId
required
string

Arrival Location ID

arrivalId
string

Arrival notification ID

createdAt
string <date-time>

When the object was created within Pipe17

Array of objects (NameValue)

Custom Fields

Array of objects (ExceptionRef)

References to exceptions related to the arrival

expectedArrivalDate
string <date-time>

Expected Arrival Date

extArrivalId
string

Reference to arrival on external system (vendor)

extOrderId
string

External TO or PO ID

extShipmentId
string

External shipment ID

object (Address)
fromLocationId
string

Sender Location ID (for TO)

fulfillmentId
string

Fulfillment ID

incoterms
string

International Commercial Terms

integration
string

Reference to integration that created an item

object (InternalInfo)

Internal info

Array of objects (ArrivalLineItem)
orgKey
string

Organization this object belong to

purchaseId
string

Purchase Order ID

shippingCarrier
string

Shipping Carrier

shippingMethod
string

Shipping Method

shippingNote
string

Shipping Note

object (SourceDoc)

Vendor source document

status
string
Enum: "canceled" "draft" "expected" "failed" "partialReceived" "received" "shipped"

Arrival notification Status

totalWeight
string

Total Weight

trackingNumber
string

Tracking number

transferId
string

Transfer Order ID

object (ArrivalTransport)
updatedAt
string <date-time>

When the object was updated within Pipe17

weightUnit
string

Weight Unit

{
  • "arrivalId": "string",
  • "status": "canceled",
  • "integration": "string",
  • "exceptions": [
    ],
  • "transferId": "string",
  • "purchaseId": "string",
  • "fulfillmentId": "string",
  • "extOrderId": "string",
  • "extShipmentId": "string",
  • "senderName": "string",
  • "expectedArrivalDate": "2019-08-24T14:15:22Z",
  • "toLocationId": "string",
  • "fromLocationId": "string",
  • "fromAddress": {
    },
  • "trackingNumber": "string",
  • "shippingCarrier": "string",
  • "shippingMethod": "string",
  • "shippingNote": "string",
  • "incoterms": "string",
  • "totalWeight": "string",
  • "weightUnit": "string",
  • "lineItems": [
    ],
  • "extArrivalId": "string",
  • "customFields": [
    ],
  • "sourceDoc": {
    },
  • "transport": {
    },
  • "internal": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "orgKey": "string"
}

Create Arrival Notifications

Uniqueness constraints:

  • arrival.transferId, arrival.fulfillmentId (when defined both)
  • arrival.purchaseId, arrival.fulfillmentId (when defined both)
  • arrival.fulfillmentId (when defined)

Uniqueness constraints within organization:

  • arrival.extArrivalId (when defined)
Authorizations:
Pipe17KeyAuth
Request Body schema:
Array (<= 10 items)
senderName
required
string

Sender's Name

toLocationId
required
string

Arrival Location ID

Array of objects (NameValue)

Custom Fields

expectedArrivalDate
string <date-time>

Expected Arrival Date

extArrivalId
string

Reference to arrival on external system (vendor)

extOrderId
string

External TO or PO ID

extShipmentId
string

External shipment ID

object (Address)
fromLocationId
string

Sender Location ID (for TO)

fulfillmentId
string

Fulfillment ID

incoterms
string

International Commercial Terms

object (InternalInfo)

Internal info

Array of objects (ArrivalLineItem)
purchaseId
string

Purchase Order ID

shippingCarrier
string

Shipping Carrier

shippingMethod
string

Shipping Method

shippingNote
string

Shipping Note

object (SourceDoc)

Vendor source document

status
string (ArrivalStatus)
Enum: "canceled" "draft" "expected" "failed" "partialReceived" "received" "shipped"

Arrival notification Status

totalWeight
string

Total Weight

trackingNumber
string

Tracking number

transferId
string

Transfer Order ID

object (ArrivalTransport)
weightUnit
string

Weight Unit

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "arrivals": [
    ]
}

Delete Arrival

Authorizations:
Pipe17KeyAuth
path Parameters
ArrivalId
required
string

Id or ext:{extArrivalId} of arrival to delete

query Parameters
action
string (DeleteAction)
Enum: "hard" "soft"

Delete arrival permanently or not

nested
boolean

Delete nested entities

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Delete Multiple Arrivals

Authorizations:
Pipe17KeyAuth
query Parameters
action
string (ListDeleteAction)
Default: "list"
Enum: "hard" "list" "soft"

Soft/hard delete or list arrivals to be deleted

arrivalId
Array of strings

Delete arrivals by list of arrivalId

count
integer <int32>
Default: 100

Delete at most this many arrivals

deleted
boolean

Delete soft deleted arrivals

extOrderId
Array of strings

Delete arrivals by list external orders (PO or TO)

fulfillmentId
Array of strings

Delete arrivals by list fulfillmentId

integration
Array of strings

Delete arrivals of these integrations.

orgMode
Array of strings (OrganizationMode)
Items Enum: "demo" "production" "test"

Delete arrivals assigned these orgModes.

pagination
string
Value: "disabled"

Exclude pagination info from the response

purchaseId
Array of strings

Delete arrivals by list purchase orders

since
string <date-time>

Delete arrivals created after this date-time

skip
integer <int32>
Default: 0

Skip this many arrivals

status
Array of strings (ArrivalStatus)
Items Enum: "canceled" "draft" "expected" "failed" "partialReceived" "received" "shipped"

Delete arrivals in specific status

transferId
Array of strings

Delete arrivals by list transfer orders

until
string <date-time>

Delete arrivals created before this date-time

updatedSince
string <date-time>

Delete arrivals updated after this date-time

updatedUntil
string <date-time>

Delete arrivals updated before this date-time

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "filters": {
    },
  • "arrivals": [
    ],
  • "deleted": 0,
  • "pagination": {
    }
}

Fetch Arrival Notification

Authorizations:
Pipe17KeyAuth
path Parameters
ArrivalId
required
string

Id or ext:{extArrivalId} of arrival to fetch

query Parameters
sourceDocVersion
number

Fetch specific vendor source doc version if available

withSourceDoc
boolean

Include vendor source doc if available

withSourceDocVersions
boolean

Include available vendor source doc versions

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "arrival": {
    }
}

List Arrival Notifications

Authorizations:
Pipe17KeyAuth
query Parameters
arrivalId
Array of strings

Arrivals by list of arrivalId

count
integer <int32>
Default: 100

Return at most this many arrivals

deleted
boolean

Soft deleted arrivals

exceptionCategoryId
Array of strings

Arrivals by list of categories of the arrival related exceptions

exceptionType
Array of strings (ExceptionType)
Items Enum: "eApprovalRequired" "eAutomation" "eAutomationCodeActionError" "eAutomationCodeFilterError" "eCreditMemoInsufficient" "eDelayed" "eDuplicate" "eDuplicateSKU" "eEarly" "eFraudSuspected" "eGeneric" "eIncomplete" "eIncompleteAddress" "eInvalid" "eInvalidAddress" "eInvalidDate" "eInvalidLocation" "eInvalidMethod" "eInvalidSKU" "eInventoryOutOfStock" "eLarge" "eLate" "eLateCancel" "eLost" "eLow" "eMismatch" "eMismatchTax" "eMissing" "eMissingLocation" "eMissingSKU" "eOrderSyncFailure" "eOrderTaxMismatch" "eOutOfStock" "ePartiallyCanceled" "ePaymentRequired" "ePotentialOverfulfill" "eRestock" "eRouteNotFound" "eRouteOutOfStock" "eShipmentMismatch" "eShippingMethod" "eSplit" "eStuck" "eSyncFailure" "eToday" "eTransform" "eUnacknowledged" "eUnexpected" "eUnexpectedDate" "eUnexpectedSplitShipment" "eUnfulfillable"

Arrivals by list of types of the arrival related exceptions

extArrivalId
Array of strings

Arrivals by list extArrivalId

extOrderId
Array of strings

Arrivals by list external orders (PO or TO)

fromLocationId
Array of strings

Arrivals by list fromLocationId

fulfillmentId
Array of strings

Arrivals by list fulfillmentId

hasSourceDoc
boolean

Arrivals containing a source document

keys
string
Default: "arrivalId,status,transferId,purchaseId,extOrderId,expectedArrivalDate,createdAt,updatedAt,orgKey"

Return these top-level fields

order
string
Default: "createdAt"

Sort by these top-level fields

pagination
string
Value: "disabled"

Exclude pagination info from the response

purchaseId
Array of strings

Arrivals by list purchase orders

since
string <date-time>

Arrivals created after this date-time

skip
integer <int32>
Default: 0

Skip this many arrivals

status
Array of strings (ArrivalStatus)
Items Enum: "canceled" "draft" "expected" "failed" "partialReceived" "received" "shipped"

Arrivals in specific status

toLocationId
Array of strings

Arrivals by list toLocationId

transferId
Array of strings

Arrivals by list transfer orders

until
string <date-time>

Arrivals created before this date-time

updatedSince
string <date-time>

Arrivals updated after this date-time

updatedUntil
string <date-time>

Arrivals updated before this date-time

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "filters": {
    },
  • "arrivals": [
    ],
  • "pagination": {
    }
}

Sync Arrivals

Trigger the arrivals sync

Authorizations:
Pipe17KeyAuth
path Parameters
ArrivalId
required
Array of strings
Request Body schema:
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Update Arrival Notification

Uniqueness constraints:

  • arrival.transferId, arrival.fulfillmentId (when defined both)
  • arrival.purchaseId, arrival.fulfillmentId (when defined both)
  • arrival.fulfillmentId (when defined)

Uniqueness constraints within organization:

  • arrival.extArrivalId (when defined)
Authorizations:
Pipe17KeyAuth
path Parameters
ArrivalId
required
string

Arrival Id to update

Request Body schema:
Array of objects (NameValue)

Custom Fields

expectedArrivalDate
string <date-time>

Expected Arrival Date

extArrivalId
string

Reference to arrival on external system (vendor)

object (Address)
fromLocationId
string

Sender Location ID (for TO)

incoterms
string

International Commercial Terms

object (InternalInfo)

Internal info

Array of objects (ArrivalLineItem)
senderName
string

Sender's Name

shippingCarrier
string

Shipping Carrier

shippingMethod
string

Shipping Method

shippingNote
string

Shipping Note

object (SourceDoc)

Vendor source document

status
string (ArrivalStatus)
Enum: "canceled" "draft" "expected" "failed" "partialReceived" "received" "shipped"

Arrival notification Status

toLocationId
string

Arrival Location ID

totalWeight
string

Total Weight

trackingNumber
string

Tracking number

object (ArrivalTransport)
weightUnit
string

Weight Unit

Responses

Request samples

Content type
{
  • "senderName": "string",
  • "expectedArrivalDate": "2019-08-24T14:15:22Z",
  • "toLocationId": "string",
  • "fromLocationId": "string",
  • "fromAddress": {
    },
  • "trackingNumber": "string",
  • "shippingCarrier": "string",
  • "shippingMethod": "string",
  • "shippingNote": "string",
  • "incoterms": "string",
  • "totalWeight": "string",
  • "weightUnit": "string",
  • "lineItems": [
    ],
  • "status": "canceled",
  • "extArrivalId": "string",
  • "customFields": [
    ],
  • "sourceDoc": {
    },
  • "transport": {
    },
  • "internal": {
    }
}

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Customers

Operations about customers

Customer Model

firstName
required
string

Customer first name

lastName
required
string

Customer last name

object (CustomerBillingAddress)
company
string

Customer company name

createdAt
string <date-time>

When the object was created within Pipe17

customerId
string

Customer ID

Array of objects (CustomerCustomField)
displayName
string

Customer display name

email
string

Customer email

Array of objects (ExceptionRef)

References to exceptions related to the customer

extCustomerId
string

Customer external ID

object (InternalInfo)

Internal info

orgKey
string

Organization this object belong to

phone
string

Customer phone

object (CustomerShippingAddress)
object (SourceDoc)

Vendor source document

status
string (CustomerStatus)
Enum: "active" "deleted"

Customer status

updatedAt
string <date-time>

When the object was updated within Pipe17

{
  • "customerId": "string",
  • "status": "active",
  • "exceptions": [
    ],
  • "firstName": "string",
  • "lastName": "string",
  • "extCustomerId": "string",
  • "displayName": "string",
  • "company": "string",
  • "email": "string",
  • "phone": "string",
  • "shippingAddress": {
    },
  • "billingAddress": {
    },
  • "customFields": [
    ],
  • "sourceDoc": {
    },
  • "internal": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "orgKey": "string"
}

Create Customer

Uniqueness constraints within organization:

  • customer.extCustomerId (when defined)
Authorizations:
Pipe17KeyAuth
Request Body schema:
firstName
required
string

Customer first name

lastName
required
string

Customer last name

object (CustomerBillingAddress)
company
string

Customer company name

Array of objects (CustomerCustomField)
displayName
string

Customer display name

email
string

Customer email

extCustomerId
string

Customer external ID

object (InternalInfo)

Internal info

phone
string

Customer phone

object (CustomerShippingAddress)
object (SourceDoc)

Vendor source document

Responses

Request samples

Content type
{
  • "firstName": "string",
  • "lastName": "string",
  • "extCustomerId": "string",
  • "displayName": "string",
  • "company": "string",
  • "email": "string",
  • "phone": "string",
  • "shippingAddress": {
    },
  • "billingAddress": {
    },
  • "customFields": [
    ],
  • "sourceDoc": {
    },
  • "internal": {
    }
}

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "customer": {
    }
}

Delete Customer

Authorizations:
Pipe17KeyAuth
path Parameters
CustomerId
required
string

ID or ext:{extCustomerId} of customer to delete

query Parameters
action
string (DeleteAction)
Enum: "hard" "soft"

Delete customer permanently or not

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Delete Multiple Customers

Authorizations:
Pipe17KeyAuth
query Parameters
action
string (ListDeleteAction)
Default: "list"
Enum: "hard" "list" "soft"

Soft/hard delete or list customers to be deleted

count
integer <int32>
Default: 100

Delete at most this many customers

customerId
Array of strings

Delete customers by list of customerId

deleted
boolean

Delete soft deleted customers

extCustomerId
Array of strings

Delete customers by list of extCustomerId

orgMode
Array of strings (OrganizationMode)
Items Enum: "demo" "production" "test"

Delete customers assigned these orgModes.

pagination
string
Value: "disabled"

Exclude pagination info from the response

since
string <date-time>

Delete customers created after this date-time

skip
integer <int32>
Default: 0

Skip this many customers

status
string (CustomerStatus)
Enum: "active" "deleted"

Delete by status

until
string <date-time>

Delete customers created before this date-time

updatedSince
string <date-time>

Delete customers updated after this date-time

updatedUntil
string <date-time>

Delete customers updated before this date-time

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "filters": {
    },
  • "customers": [
    ],
  • "deleted": 0,
  • "pagination": {
    }
}

Fetch Customer

Authorizations:
Pipe17KeyAuth
path Parameters
CustomerId
required
string

ID or ext:{extCustomerId} of customer to fetch

query Parameters
sourceDocVersion
number

Fetch specific vendor source doc version if available

withSourceDoc
boolean

Include vendor source doc if available

withSourceDocVersions
boolean

Include available vendor source doc versions

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "customer": {
    }
}

List Customers

Authorizations:
Pipe17KeyAuth
query Parameters
company
string

Retrieve customers by company name (strings "/{pattern}/" and "/{pattern}/i" are interpreted as regexps)

count
integer <int32>
Default: 100

Return at most this many customers

customerId
Array of strings

Retrieve by list of customerId

deleted
boolean

Retrieve soft deleted customers

displayName
string

Retrieve customers by displayName (strings "/{pattern}/" and "/{pattern}/i" are interpreted as regexps)

email
string

Retrieve customers by email (strings "/{pattern}/" and "/{pattern}/i" are interpreted as regexps)

exceptionCategoryId
Array of strings

Retrieve customers by list of categories of the customer related exceptions

exceptionType
Array of strings (ExceptionType)
Items Enum: "eApprovalRequired" "eAutomation" "eAutomationCodeActionError" "eAutomationCodeFilterError" "eCreditMemoInsufficient" "eDelayed" "eDuplicate" "eDuplicateSKU" "eEarly" "eFraudSuspected" "eGeneric" "eIncomplete" "eIncompleteAddress" "eInvalid" "eInvalidAddress" "eInvalidDate" "eInvalidLocation" "eInvalidMethod" "eInvalidSKU" "eInventoryOutOfStock" "eLarge" "eLate" "eLateCancel" "eLost" "eLow" "eMismatch" "eMismatchTax" "eMissing" "eMissingLocation" "eMissingSKU" "eOrderSyncFailure" "eOrderTaxMismatch" "eOutOfStock" "ePartiallyCanceled" "ePaymentRequired" "ePotentialOverfulfill" "eRestock" "eRouteNotFound" "eRouteOutOfStock" "eShipmentMismatch" "eShippingMethod" "eSplit" "eStuck" "eSyncFailure" "eToday" "eTransform" "eUnacknowledged" "eUnexpected" "eUnexpectedDate" "eUnexpectedSplitShipment" "eUnfulfillable"

Retrieve customers by list of types of the customer related exceptions

extCustomerId
Array of strings

Retrieve by list of extCustomerId

firstName
string

Retrieve customers by firstName (strings "/{pattern}/" and "/{pattern}/i" are interpreted as regexps)

hasSourceDoc
boolean

Retrieve customers containing a source document

keys
string
Default: "customerId,status,firstName,lastName,extCustomerId,displayName,shippingAddress,billingAddress,creditCard,createdAt,updatedAt,orgKey"

Return these top-level fields

lastName
string

Retrieve customers by lastName (strings "/{pattern}/" and "/{pattern}/i" are interpreted as regexps)

order
string
Default: "createdAt"

Sort by these top-level fields

pagination
string
Value: "disabled"

Exclude pagination info from the response

phone
string

Retrieve customers by phone (strings "/{pattern}/" and "/{pattern}/i" are interpreted as regexps)

since
string <date-time>

Retrieve customers created after this date-time

skip
integer <int32>
Default: 0

Skip this many customers

status
string (CustomerStatus)
Enum: "active" "deleted"

Retrieve by status

until
string <date-time>

Retrieve customers created before this date-time

updatedSince
string <date-time>

Retrieve customers updated after this date-time

updatedUntil
string <date-time>

Retrieve customers updated before this date-time

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "filters": {
    },
  • "customers": [
    ],
  • "pagination": {
    }
}

Sync Customers

Trigger the customers sync

Authorizations:
Pipe17KeyAuth
path Parameters
CustomerId
required
Array of strings
Request Body schema:
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Update Customer

Uniqueness constraints within organization:

  • customer.extCustomerId (when defined)
Authorizations:
Pipe17KeyAuth
path Parameters
CustomerId
required
string

ID or ext:{extCustomerId} of customer to update

Request Body schema:
object (CustomerBillingAddress)
company
string

Customer company name

Array of objects (CustomerCustomField)
displayName
string

Customer display name

email
string

Customer email

extCustomerId
string

Customer external ID

object (InternalInfo)

Internal info

phone
string

Customer phone

object (CustomerShippingAddress)
object (SourceDoc)

Vendor source document

Responses

Request samples

Content type
{
  • "extCustomerId": "string",
  • "displayName": "string",
  • "company": "string",
  • "email": "string",
  • "phone": "string",
  • "shippingAddress": {
    },
  • "billingAddress": {
    },
  • "customFields": [
    ],
  • "sourceDoc": {
    },
  • "internal": {
    }
}

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Fulfillments

When shipments gets fulfilled, a Fulfillment object is created within Pipe17

Fulfillment Model

acknowledgedBy
Array of strings

Integrations acknowledged this fulfillment

actualShipDate
string <date-time>

Actual ship date

billOfLading
string
createdAt
string <date-time>

When the object was created within Pipe17

Array of objects (NameValue)

Custom Fields

dimensionsUnit
string
Enum: "cm" "ft" "in"

Dimensions UOM

Array of objects (ExceptionRef)

References to exceptions related to the fulfillment

expectedArrivalDate
string <date-time>

Expected arrival date

extFulfillmentId
string

Reference to fulfillment on external system (vendor)

extOrderId
string

External customer friendly ID

fulfillmentId
string

Fulfillment ID

fulfillmentType
string (FulfillmentType)
Enum: "accepted" "rejected" "voided"
height
number <float>

Height

integration
string

Reference to integration that created an item

object (InternalInfo)

Internal info

length
number <float>

Length

Array of objects (FulfillmentItemExt)
locationId
string

locationId of the fulfillment

orderIntegration
string

Reference to integration that created order tied to an item

orgKey
string

Organization this object belong to

sacCode
string
shipmentId
string

Internal Pipe17 ID of the Shipment

shipmentIntegration
string

Reference to integration that created shipment tied to an item

shippingCarrier
string

Shipping Carrier

shippingCharge
number <float>

Shipping Charge

shippingClass
string

Shipping Class

object (SourceDoc)

Vendor source document

ssccCode
string
tags
Array of strings (EntityTags)

Tags assigned to entity

trackedAtSourceChannel
boolean

Whether tracking number were issued by source channel and thus fulfillment reporting is not required

trackingNumber
Array of strings

Tracking number(s). Not required when fulfillmentType is rejected or void.

trackingURLs
Array of strings

Tracking url(s)

ucc128
string
updatedAt
string <date-time>

When the object was updated within Pipe17

weight
number <float>

Weight

weightUnit
string
Enum: "g" "kg" "lb" "oz"

Weight unit

width
number <float>

Width

{
  • "fulfillmentId": "string",
  • "integration": "string",
  • "orderIntegration": "string",
  • "shipmentIntegration": "string",
  • "locationId": "string",
  • "lineItems": [
    ],
  • "acknowledgedBy": [
    ],
  • "exceptions": [
    ],
  • "shipmentId": "string",
  • "fulfillmentType": "accepted",
  • "trackingNumber": [
    ],
  • "trackingURLs": [
    ],
  • "actualShipDate": "2019-08-24T14:15:22Z",
  • "expectedArrivalDate": "2019-08-24T14:15:22Z",
  • "shippingCarrier": "string",
  • "shippingClass": "string",
  • "shippingCharge": 0,
  • "weightUnit": "g",
  • "extOrderId": "string",
  • "weight": 0,
  • "height": 0,
  • "length": 0,
  • "width": 0,
  • "dimensionsUnit": "cm",
  • "extFulfillmentId": "string",
  • "trackedAtSourceChannel": true,
  • "customFields": [
    ],
  • "tags": [
    ],
  • "sourceDoc": {
    },
  • "internal": {
    },
  • "ssccCode": "string",
  • "sacCode": "string",
  • "ucc128": "string",
  • "billOfLading": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "orgKey": "string"
}

Acknowledge Fulfillments

Acknowledges delivery of fulfillment information by integration

Authorizations:
Pipe17KeyAuth
path Parameters
FulfillmentId
required
Array of strings

Id or ext:{extFulfillmentId} of fulfillment to acknowledge

Request Body schema:
integration
string

Acknowledging integration

Responses

Request samples

Content type
{
  • "integration": "string"
}

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Create Fulfillments

Uniqueness constraints within organization:

  • fulfillment.extFulfillmentId (when defined)
Authorizations:
Pipe17KeyAuth
Request Body schema:
Array (<= 10 items)
shipmentId
required
string

Internal Pipe17 ID of the Shipment

trackingNumber
required
Array of strings

Tracking number(s). Not required when fulfillmentType is rejected or void.

actualShipDate
string <date-time>

Actual ship date

billOfLading
string
Array of objects (NameValue)

Custom Fields

dimensionsUnit
string
Enum: "cm" "ft" "in"

Dimensions UOM

expectedArrivalDate
string <date-time>

Expected arrival date

extFulfillmentId
string

Reference to fulfillment on external system (vendor)

extOrderId
string

External customer friendly ID

fulfillmentType
string (FulfillmentType)
Enum: "accepted" "rejected" "voided"
height
number <float>

Height

object (InternalInfo)

Internal info

length
number <float>

Length

Array of objects (FulfillmentItem)
locationId
string

locationId of the fulfillment

sacCode
string
shippingCarrier
string

Shipping Carrier

shippingCharge
number <float>

Shipping Charge

shippingClass
string

Shipping Class

object (SourceDoc)

Vendor source document

ssccCode
string
tags
Array of strings (EntityTags)

Tags assigned to entity

trackedAtSourceChannel
boolean

Whether tracking number were issued by source channel and thus fulfillment reporting is not required

trackingURLs
Array of strings

Tracking url(s)

ucc128
string
weight
number <float>

Weight

weightUnit
string
Enum: "g" "kg" "lb" "oz"

Weight unit

width
number <float>

Width

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "fulfillments": [
    ]
}

Delete Fulfillments

Authorizations:
Pipe17KeyAuth
query Parameters
action
string (ListDeleteAction)
Default: "list"
Enum: "hard" "list" "soft"

Soft/hard delete or list fulfillments to be deleted

count
integer <int32>

Delete at most this many fulfillments

extOrderId
Array of strings

Delete fulfillments by list of extShipmentId

extShipmentId
Array of strings

Delete fulfillments by list of extShipmentId

fulfillmentId
Array of strings

Delete fulfillments by list of fulfillmentId

orgMode
Array of strings (OrganizationMode)
Items Enum: "demo" "production" "test"

Delete fulfillments assigned these orgModes.

shipmentId
Array of strings

Delete fulfillments by list of shipmentId

since
string <date-time>

Delete all fulfillments created after this date-time

skip
integer <int32>

Skip this many fulfillments

until
string <date-time>

Delete all fulfillments created before this date-time

updatedSince
string <date-time>

Delete all fulfillments updated after this date-time

updatedUntil
string <date-time>

Delete all fulfillments updated before this date-time

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "filters": {
    },
  • "fulfillments": [
    ],
  • "deleted": 0,
  • "pagination": {
    }
}

Fetch Fulfillment

Authorizations:
Pipe17KeyAuth
path Parameters
FulfillmentId
required
string

Id or ext:{extFulfillmentId} of fulfillment to fetch

query Parameters
sourceDocVersion
number

Fetch specific vendor source doc version if available

withSourceDoc
boolean

Include vendor source doc if available

withSourceDocVersions
boolean

Include available vendor source doc versions

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "fulfillment": {
    }
}

List Fulfillments

Authorizations:
Pipe17KeyAuth
query Parameters
acknowledgedBy
Array of strings

Fulfillments by list of acknowledged integrations

count
integer <int32>
Default: 100

Return at most this many fulfillments

exceptionCategoryId
Array of strings

Fulfillments by list of categories of the fulfillment related exceptions

exceptionType
Array of strings (ExceptionType)
Items Enum: "eApprovalRequired" "eAutomation" "eAutomationCodeActionError" "eAutomationCodeFilterError" "eCreditMemoInsufficient" "eDelayed" "eDuplicate" "eDuplicateSKU" "eEarly" "eFraudSuspected" "eGeneric" "eIncomplete" "eIncompleteAddress" "eInvalid" "eInvalidAddress" "eInvalidDate" "eInvalidLocation" "eInvalidMethod" "eInvalidSKU" "eInventoryOutOfStock" "eLarge" "eLate" "eLateCancel" "eLost" "eLow" "eMismatch" "eMismatchTax" "eMissing" "eMissingLocation" "eMissingSKU" "eOrderSyncFailure" "eOrderTaxMismatch" "eOutOfStock" "ePartiallyCanceled" "ePaymentRequired" "ePotentialOverfulfill" "eRestock" "eRouteNotFound" "eRouteOutOfStock" "eShipmentMismatch" "eShippingMethod" "eSplit" "eStuck" "eSyncFailure" "eToday" "eTransform" "eUnacknowledged" "eUnexpected" "eUnexpectedDate" "eUnexpectedSplitShipment" "eUnfulfillable"

Fulfillments by list of types of the fulfillment related exceptions

extFulfillmentId
Array of strings

Fulfillments by list of extFulfillmentId

extOrderId
Array of strings

Fulfillments by list of extShipmentId

extShipmentId
Array of strings

Fulfillments by list of extShipmentId

fulfillmentId
Array of strings

Fulfillments by list of fulfillmentId

fulfillmentType
Array of strings (FulfillmentType)
Items Enum: "accepted" "rejected" "voided"

Fulfillments by list of fulfillment types

hasSourceDoc
boolean

Fulfillments containing a source document

integration
Array of strings

Fulfillments by list of integrationId

keys
string
Default: "fulfillmentId,fulfillmentType,shipmentId,extOrderId,actualShipDate,createdAt,updatedAt,orgKey"

Return these top-level fields

locationId
Array of strings

Fulfillments by list of locationId

order
string
Default: "createdAt"

Sort by these top-level fields

orderIntegration
Array of strings

Fulfillments by list of order integrationId

orderIntegrationAcknowledged
boolean

Fulfillments by order integration acknowledgement

pagination
string
Value: "disabled"

Exclude pagination info from the response

shipmentId
Array of strings

Fulfillments by list of shipmentId

since
string <date-time>

Fetch all fulfillments created after this date-time

skip
integer <int32>
Default: 0

Skip this many fulfillments

until
string <date-time>

Fetch all fulfillments created before this date-time

updatedSince
string <date-time>

Fetch all fulfillments updated after this date-time

updatedUntil
string <date-time>

Fetch all fulfillments updated before this date-time

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "filters": {
    },
  • "fulfillments": [
    ],
  • "pagination": {
    }
}

Sync Fulfillments

Trigger the fulfillments sync

Authorizations:
Pipe17KeyAuth
path Parameters
FulfillmentId
required
Array of strings
Request Body schema:
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Inventory

Operations about Inventory

Inventory Model

available
integer <int32>

Number of items available

availableToPromise
integer <int32>

Number of items available to promise

commitShip
integer <int32>

Number of items being shipped (included in committed)

committed
integer <int32>

Number of items committed

committedFuture
integer <int32>

Number of items committed for pre-order

commitXfer
integer <int32>

Number of items being transferred out (included in committed)

createdAt
string <date-time>

When the object was created within Pipe17

entityId
string

Related entity ID

entityType
string

Related entity ID's type

event
string (EventType)
Enum: "POSOrder" "adjust" "fulfill" "futureShip" "futureShipCancel" "ingest" "receive" "release" "return" "ship" "shipCancel" "shipCancelRestock" "touch" "virtualCommit" "xferfulfill" "xferin" "xferout"

Type of event triggering inventory change:

  • ingest - Indicates quantities reported by fulfillment channel (warehouse).
  • adjust - Manual inventory update or result of bundle quantities update by Inventory Engine.
  • touch - Simulated inventory update not tied with quantity changes. Initiates inventory sync and/or recalculation process.
  • POSOrder - Includes quantity updates of inventory item referred in POS order. Reduces available, onHand.
  • virtualCommit - Includes quantity updates of inventory item referred in sales order or shipping request. Indicates the difference between order quantity and shipment(s) quantity. Used to adjust available and committed in the virtual location to maintain inventory totals prior to creation of shipping request.
  • ship - Includes quantity updates of inventory item referred in sales order shipping request. Reduces available, increases committed and commitShip.
  • shipCancel - Includes quantity updates of inventory item referred in canceled sales order shipping request (excluding futureShipCancel case). Decreases committed, adjusts onHand and commitShip.
  • shipCancelRestock - Includes quantity updates of inventory item referred in canceled sales order shipping request with canceledRestock status. Reduces committed, increases available, adjusts commitShip.
  • fulfill - Includes quantity updates of inventory item referred in sales order fulfillment. Reduces committed, onHand, commitShip.
  • futureShip - Includes quantity updates of inventory item referred in sales order shipping request assigned pendingInventory status. Increases committedFuture.
  • release - Includes quantity updates of inventory item referred in sales order shipping request once it transitions from pendingInventory to readyForFulfillment status. Transfers quantity from committedFuture to committed, adjusts available and commitShip.
  • futureShipCancel - Includes quantity updates of inventory item referred in canceled sales order shipping request which was once assigned pendingInventory status. Reduces committedFuture.
  • xferout - Includes quantity updates of inventory item referred in transfer order shipping request with readyForFulfillment status. Reduces available, increases committed, adjusts commitXfer.
  • xferfulfill - Includes quantity updates of inventory item referred in transfer order fulfillment. Reduces committed, onHand, commitXfer.
  • xferin - Includes quantity updates of inventory item referred in arrival. Increases incoming quantity.
  • receive - Includes quantity updates of inventory item referred in receipt. Increases available, decreases incoming, adjusts onHand and future.
Array of objects (ExceptionRef)

References to exceptions related to the inventory

future
integer <int32>

Number of items that can be sold for pre-order

incoming
integer <int32>

Number of incoming items in transit (maybe included in available)

integration
string

Reference to integration that created an item

inventoryId
string

Inventory ID

locationId
string

Location of item

onHand
integer <int32>

Number of items on hand

orderId
string

Pipe17 internal order id that initiated this inventory change

orderType
string

Type of order that initiated this inventory change

orgKey
string

Organization this object belong to

quantity
integer <int32>

Number of items affected

sku
string

Item SKU

status
string

Inventory status

unavailable
integer <int32>

Number of unavailable items

updatedAt
string <date-time>

When the object was updated within Pipe17

user
string

Pipe17 internal id of the user who makes the inventory adjustment via the portal

vendorSKU
string

Item vendor SKU

{
  • "inventoryId": "string",
  • "entityId": "string",
  • "entityType": "string",
  • "event": "POSOrder",
  • "sku": "string",
  • "vendorSKU": "string",
  • "locationId": "string",
  • "onHand": 0,
  • "committed": 0,
  • "committedFuture": 0,
  • "future": 0,
  • "available": 0,
  • "availableToPromise": 0,
  • "quantity": 0,
  • "incoming": 0,
  • "commitShip": 0,
  • "commitXfer": 0,
  • "unavailable": 0,
  • "integration": "string",
  • "status": "string",
  • "orderId": "string",
  • "orderType": "string",
  • "user": "string",
  • "exceptions": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "orgKey": "string"
}

Create Inventory Log Items

Uniqueness constraints:

  • inventory.event, inventory.entityId, inventory.sku (when entityId and materialEvent defined)
Authorizations:
Pipe17KeyAuth
Request Body schema:
Array (<= 10 items)
committed
required
integer <int32>

Number of items committed

event
required
string
Enum: "adjust" "ingest"

Event creating this item

locationId
required
string

Location ID of item

onHand
required
integer <int32>

Number of items on hand

ptype
required
string (EventSource)
Enum: "ims" "oms" "portal" "wms"

Event source partner type

sku
required
string

Item SKU

available
integer <int32>

Number of items available

commitShip
integer <int32>

Number of items being shipped (included in committed)

committedFuture
integer <int32>

Number of items committed for pre-order

commitXfer
integer <int32>

Number of items being transferred out (included in committed)

future
integer <int32>

Number of items that can be sold for pre-order

incoming
integer <int32>

Number of incoming items in transit (maybe included in available)

unavailable
integer <int32>

Number of unavailable items

vendorSKU
string

Item vendor SKU

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "inventory": [
    ]
}

Delete Inventory

Authorizations:
Pipe17KeyAuth
path Parameters
InventoryId
required
string

Inventory Id to delete

query Parameters
action
string (DeleteAction)
Enum: "hard" "soft"

Delete inventory permanently or not

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Delete Multiple Inventory

Authorizations:
Pipe17KeyAuth
query Parameters
action
string (ListDeleteAction)
Default: "list"
Enum: "hard" "list" "soft"

Soft/hard delete or list inventory items to be deleted

count
integer <int32>
Default: 100

Delete at most this many inventory items

entityId
Array of strings

Delete inventory items related to certain event record by record id

inventoryId
Array of strings

Delete inventory by list of inventoryId

ledger
boolean
Default: false

Delete inventory ledger information

locationId
Array of strings

Delete inventory by its location ID

nested
boolean

Delete nested inventory ledger entries

orgMode
Array of strings (OrganizationMode)
Items Enum: "demo" "production" "test"

Delete inventory items assigned these orgModes.

pagination
string
Value: "disabled"

Exclude pagination info from the response

since
string <date-time>

Delete inventory created after this date,time

skip
integer <int32>
Default: 0

Skip this many inventory items

sku
Array of strings

Delete inventory by its SKU

until
string <date-time>

Delete inventory created before this date,time

updatedSince
string <date-time>

Delete inventory updated after this date-time

updatedUntil
string <date-time>

Delete inventory updated before this date-time

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "filters": {
    },
  • "inventory": [
    ],
  • "deleted": 0,
  • "pagination": {
    }
}

Fetch Inventory Log Item

Authorizations:
Pipe17KeyAuth
path Parameters
InventoryId
required
string

Inventory Item ID to fetch

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "inventory": {
    }
}

List Inventory Log Items

Authorizations:
Pipe17KeyAuth
query Parameters
available
integer

Fetch inventory if 'available' value is equal to specified one

available_gt
integer

Fetch inventory if 'available' value is greater than specified one

available_lt
integer

Fetch inventory if 'available' value is less than specified one

count
integer <int32>
Default: 100

Return at most this many inventory items

entityId
Array of strings

Return inventory items related to certain event record by record id

exceptionCategoryId
Array of strings

Fetch inventory by list of categories of the inventory related exceptions

exceptionType
Array of strings (ExceptionType)
Items Enum: "eApprovalRequired" "eAutomation" "eAutomationCodeActionError" "eAutomationCodeFilterError" "eCreditMemoInsufficient" "eDelayed" "eDuplicate" "eDuplicateSKU" "eEarly" "eFraudSuspected" "eGeneric" "eIncomplete" "eIncompleteAddress" "eInvalid" "eInvalidAddress" "eInvalidDate" "eInvalidLocation" "eInvalidMethod" "eInvalidSKU" "eInventoryOutOfStock" "eLarge" "eLate" "eLateCancel" "eLost" "eLow" "eMismatch" "eMismatchTax" "eMissing" "eMissingLocation" "eMissingSKU" "eOrderSyncFailure" "eOrderTaxMismatch" "eOutOfStock" "ePartiallyCanceled" "ePaymentRequired" "ePotentialOverfulfill" "eRestock" "eRouteNotFound" "eRouteOutOfStock" "eShipmentMismatch" "eShippingMethod" "eSplit" "eStuck" "eSyncFailure" "eToday" "eTransform" "eUnacknowledged" "eUnexpected" "eUnexpectedDate" "eUnexpectedSplitShipment" "eUnfulfillable"

Fetch inventory by list of types of the inventory related exceptions

inventoryId
Array of strings

Inventory items by list of inventoryId

keys
string
Default: "All"

Return these top-level fields

ledger
boolean

Return inventory ledger information

locationId
Array of strings

Fetch inventory by its location ID

onHand
integer

Fetch inventory if 'onHand' value is equal to specified one

onHand_gt
integer

Fetch inventory if 'onHand' value is greater than specified one

onHand_lt
integer

Fetch inventory if 'onHand' value is less than specified one

order
string
Default: "-updatedAt"

Sort by these top-level fields

pagination
string
Value: "disabled"

Exclude pagination info from the response

since
string <date-time>

Inventory created after this date,time

skip
integer <int32>
Default: 0

Skip this many inventory items

sku
Array of strings

Fetch inventory by its SKU

sku_gt
string

Fetch inventory in which SKU is lexicographically greater than the specified value

sku_lt
string

Fetch inventory in which SKU is lexicographically less than the specified value

totals
boolean

Return inventory totals across all locations

until
string <date-time>

Inventory created before this date,time

updatedSince
string <date-time>

Inventory updated after this date-time

updatedUntil
string <date-time>

Inventory updated before this date-time

vendorSKU
Array of strings

Fetch inventory by its vendorSKU

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "filters": {
    },
  • "inventory": [
    ],
  • "pagination": {
    }
}

Sync Inventory

Trigger the inventory sync

Authorizations:
Pipe17KeyAuth
path Parameters
InventoryId
required
Array of strings
Request Body schema:
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Update Inventory

Uniqueness constraints:

  • inventory.event, inventory.entityId, inventory.sku (when entityId and materialEvent defined)
Authorizations:
Pipe17KeyAuth
Request Body schema:
event
required
string
Enum: "POSOrder" "fulfill" "futureShip" "futureShipCancel" "receive" "release" "ship" "shipCancel" "shipCancelRestock" "touch" "virtualCommit" "xferfulfill" "xferin" "xferout"

Event updating inventory

locationId
required
string

Location Id of item

ptype
required
string (EventSource)
Enum: "ims" "oms" "portal" "wms"

Event source partner type

quantity
required
integer <int32>

Number of items affected

sku
required
string

Item SKU

entityId
string

Entity id of the record which is directly related to this inventory change

entityType
string
Enum: "arrivals" "fulfillments" "inventory" "orders" "receipts" "shipments"

Type of the record which is directly related to this inventory change

infinite
boolean

Set if item location has "infinite" availability

orderId
string

Pipe17 internal order id that initiated this inventory change

orderType
string
Enum: "purchase" "sales" "transfer"

Type of order that initiated this inventory change

vendorSKU
string

Item vendor SKU

Responses

Request samples

Content type
{
  • "event": "POSOrder",
  • "ptype": "ims",
  • "sku": "string",
  • "vendorSKU": "string",
  • "locationId": "string",
  • "infinite": true,
  • "quantity": 0,
  • "entityId": "string",
  • "entityType": "arrivals",
  • "orderId": "string",
  • "orderType": "purchase"
}

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Inventory Rules

Operations about Inventory Rules

Inventory Rule Model

event
required
string (EventType)
Enum: "POSOrder" "adjust" "fulfill" "futureShip" "futureShipCancel" "ingest" "receive" "release" "return" "ship" "shipCancel" "shipCancelRestock" "touch" "virtualCommit" "xferfulfill" "xferin" "xferout"

Type of event triggering inventory change:

  • ingest - Indicates quantities reported by fulfillment channel (warehouse).
  • adjust - Manual inventory update or result of bundle quantities update by Inventory Engine.
  • touch - Simulated inventory update not tied with quantity changes. Initiates inventory sync and/or recalculation process.
  • POSOrder - Includes quantity updates of inventory item referred in POS order. Reduces available, onHand.
  • virtualCommit - Includes quantity updates of inventory item referred in sales order or shipping request. Indicates the difference between order quantity and shipment(s) quantity. Used to adjust available and committed in the virtual location to maintain inventory totals prior to creation of shipping request.
  • ship - Includes quantity updates of inventory item referred in sales order shipping request. Reduces available, increases committed and commitShip.
  • shipCancel - Includes quantity updates of inventory item referred in canceled sales order shipping request (excluding futureShipCancel case). Decreases committed, adjusts onHand and commitShip.
  • shipCancelRestock - Includes quantity updates of inventory item referred in canceled sales order shipping request with canceledRestock status. Reduces committed, increases available, adjusts commitShip.
  • fulfill - Includes quantity updates of inventory item referred in sales order fulfillment. Reduces committed, onHand, commitShip.
  • futureShip - Includes quantity updates of inventory item referred in sales order shipping request assigned pendingInventory status. Increases committedFuture.
  • release - Includes quantity updates of inventory item referred in sales order shipping request once it transitions from pendingInventory to readyForFulfillment status. Transfers quantity from committedFuture to committed, adjusts available and commitShip.
  • futureShipCancel - Includes quantity updates of inventory item referred in canceled sales order shipping request which was once assigned pendingInventory status. Reduces committedFuture.
  • xferout - Includes quantity updates of inventory item referred in transfer order shipping request with readyForFulfillment status. Reduces available, increases committed, adjusts commitXfer.
  • xferfulfill - Includes quantity updates of inventory item referred in transfer order fulfillment. Reduces committed, onHand, commitXfer.
  • xferin - Includes quantity updates of inventory item referred in arrival. Increases incoming quantity.
  • receive - Includes quantity updates of inventory item referred in receipt. Increases available, decreases incoming, adjusts onHand and future.
rule
required
string

Rule's definition as javascript function

createdAt
string <date-time>

When the object was created within Pipe17

description
string

Description of the rule

integration
string

Event source integration id

object (InternalInfo)

Internal info

orgKey
string

Organization this object belong to

partner
string

Event source partner name

ptype
string (EventSource)
Enum: "ims" "oms" "portal" "wms"

Event source partner type

ruleId
string

Rule ID

status
string

Rule status

updatedAt
string <date-time>

When the object was updated within Pipe17

{
  • "ruleId": "string",
  • "status": "string",
  • "event": "POSOrder",
  • "ptype": "ims",
  • "partner": "string",
  • "integration": "string",
  • "description": "string",
  • "rule": "string",
  • "internal": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "orgKey": "string"
}

Create Inventory Rule

Uniqueness constraints:

  • rule.event, rule.ptype, rule.partner, rule.integration
Authorizations:
Pipe17KeyAuth
Request Body schema:
event
required
string (EventType)
Enum: "POSOrder" "adjust" "fulfill" "futureShip" "futureShipCancel" "ingest" "receive" "release" "return" "ship" "shipCancel" "shipCancelRestock" "touch" "virtualCommit" "xferfulfill" "xferin" "xferout"

Type of event triggering inventory change:

  • ingest - Indicates quantities reported by fulfillment channel (warehouse).
  • adjust - Manual inventory update or result of bundle quantities update by Inventory Engine.
  • touch - Simulated inventory update not tied with quantity changes. Initiates inventory sync and/or recalculation process.
  • POSOrder - Includes quantity updates of inventory item referred in POS order. Reduces available, onHand.
  • virtualCommit - Includes quantity updates of inventory item referred in sales order or shipping request. Indicates the difference between order quantity and shipment(s) quantity. Used to adjust available and committed in the virtual location to maintain inventory totals prior to creation of shipping request.
  • ship - Includes quantity updates of inventory item referred in sales order shipping request. Reduces available, increases committed and commitShip.
  • shipCancel - Includes quantity updates of inventory item referred in canceled sales order shipping request (excluding futureShipCancel case). Decreases committed, adjusts onHand and commitShip.
  • shipCancelRestock - Includes quantity updates of inventory item referred in canceled sales order shipping request with canceledRestock status. Reduces committed, increases available, adjusts commitShip.
  • fulfill - Includes quantity updates of inventory item referred in sales order fulfillment. Reduces committed, onHand, commitShip.
  • futureShip - Includes quantity updates of inventory item referred in sales order shipping request assigned pendingInventory status. Increases committedFuture.
  • release - Includes quantity updates of inventory item referred in sales order shipping request once it transitions from pendingInventory to readyForFulfillment status. Transfers quantity from committedFuture to committed, adjusts available and commitShip.
  • futureShipCancel - Includes quantity updates of inventory item referred in canceled sales order shipping request which was once assigned pendingInventory status. Reduces committedFuture.
  • xferout - Includes quantity updates of inventory item referred in transfer order shipping request with readyForFulfillment status. Reduces available, increases committed, adjusts commitXfer.
  • xferfulfill - Includes quantity updates of inventory item referred in transfer order fulfillment. Reduces committed, onHand, commitXfer.
  • xferin - Includes quantity updates of inventory item referred in arrival. Increases incoming quantity.
  • receive - Includes quantity updates of inventory item referred in receipt. Increases available, decreases incoming, adjusts onHand and future.
rule
required
string

Rule's definition as javascript function

description
string

Description of the rule

integration
string

Event source integration id

object (InternalInfo)

Internal info

partner
string

Event source partner name

ptype
string (EventSource)
Enum: "ims" "oms" "portal" "wms"

Event source partner type

Responses

Request samples

Content type
{
  • "event": "POSOrder",
  • "ptype": "ims",
  • "partner": "string",
  • "integration": "string",
  • "description": "string",
  • "rule": "string",
  • "internal": {
    }
}

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "inventoryrule": {
    }
}

Delete Inventory Rule

Authorizations:
Pipe17KeyAuth
path Parameters
RuleId
required
string

Rule ID to delete

query Parameters
action
string (DeleteAction)
Enum: "hard" "soft"

Delete inventory rule permanently or not

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Delete Multiple InventoryRules

Authorizations:
Pipe17KeyAuth
query Parameters
action
string (ListDeleteAction)
Default: "list"
Enum: "hard" "list" "soft"

Soft/hard delete or list items to be deleted

count
integer <int32>
Default: 100

Max number of items to delete

deleted
boolean

Delete soft deleted rules

integration
Array of strings

Delete rules by list of integration ids

orgMode
Array of strings (OrganizationMode)
Items Enum: "demo" "production" "test"

Delete rules assigned these orgModes.

pagination
string
Value: "disabled"

Exclude pagination info from the response

ruleId
Array of strings

Delete rules by list of ruleId

since
string <date-time>

Delete rules created after this date-time

skip
integer <int32>
Default: 0

Number of items to skip

until
string <date-time>

Delete rules created before this date-time

updatedSince
string <date-time>

Delete rules updated after this date-time

updatedUntil
string <date-time>

Delete rules updated before this date-time

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "filters": {
    },
  • "rules": [
    ],
  • "deleted": 0,
  • "pagination": {
    }
}

Fetch Inventory Rule

Authorizations:
Pipe17KeyAuth
path Parameters
RuleId
required
string

Rule ID to fetch

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "inventoryrule": {
    }
}

List Inventory Rules

Authorizations:
Pipe17KeyAuth
query Parameters
count
integer <int32>
Default: 100

Return at most this many rules

deleted
boolean

Soft deleted rules

event
Array of strings (EventType)
Items Enum: "POSOrder" "adjust" "fulfill" "futureShip" "futureShipCancel" "ingest" "receive" "release" "return" "ship" "shipCancel" "shipCancelRestock" "touch" "virtualCommit" "xferfulfill" "xferin" "xferout"

Event types trigerring rule

integration
Array of strings

Rules by list of integration ids

keys
string
Default: "ruleId,event,ptype,partner,integration,description,rule,createdAt,updatedAt,orgKey"

Return these top-level fields

order
string
Default: "createdAt"

Sort by these top-level fields

pagination
string
Value: "disabled"

Exclude pagination info from the response

partner
Array of strings

Event source partner names

ptype
Array of strings (EventSource)
Items Enum: "ims" "oms" "portal" "wms"

Event source partner types

ruleId
Array of strings

Rules by list of ruleId

since
string <date-time>

Rules created after this date-time

skip
integer <int32>
Default: 0

Skip this many rules

until
string <date-time>

Rules created before this date-time

updatedSince
string <date-time>

Rules updated after this date-time

updatedUntil
string <date-time>

Rules updated before this date-time

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "filters": {
    },
  • "rules": [
    ],
  • "pagination": {
    }
}

Sync Inventory Rules

Trigger the inventory rules sync

Authorizations:
Pipe17KeyAuth
path Parameters
RuleId
required
Array of strings
Request Body schema:
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Update Inventory Rule

Uniqueness constraints:

  • rule.event, rule.ptype, rule.partner, rule.integration
Authorizations:
Pipe17KeyAuth
path Parameters
RuleId
required
string

Rule ID to update

Request Body schema:
rule
required
string

Rule's definition as javascript function

description
string

Description of the rule

object (InternalInfo)

Internal info

Responses

Request samples

Content type
{
  • "description": "string",
  • "rule": "string",
  • "internal": {
    }
}

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Jobs

Long-running jobs operations

Job Model

subType
required
string (JobSubType)
Enum: "arrivals" "exceptions" "fulfillments" "inventory" "locations" "orders" "organizations" "products" "purchases" "replenishment" "returns" "shipments" "shipping_methods" "transfers"

Job sub-type

type
required
string (JobType)
Enum: "delete" "export" "import" "prepare" "report" "update"

Job type

contentType
string

Job result content type

createdAt
string <date-time>

When the object was created within Pipe17

createdBy
string

Job requester ID

object (InternalInfo)

Internal info

jobId
string

Job ID

orgKey
string

Organization this object belong to

params
object

Job type specific parameters

progress
integer (JobProgress) [ 0 .. 100 ]

Job progress (0-100)

state
object (JobState)

This is a free form object that can be used to store any state related to the job.

status
string (JobStatus)
Enum: "canceled" "completed" "failed" "processing" "submitted"

Job status

timeout
number <int32>

Job timeout (in milliseconds)

updatedAt
string <date-time>

When the object was updated within Pipe17

{
  • "jobId": "string",
  • "createdBy": "string",
  • "progress": 100,
  • "status": "canceled",
  • "type": "delete",
  • "subType": "arrivals",
  • "params": { },
  • "contentType": "string",
  • "timeout": 0,
  • "state": { },
  • "internal": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "orgKey": "string"
}

Create long-running job

Authorizations:
Pipe17KeyAuth
Request Body schema:
subType
required
string (JobSubType)
Enum: "arrivals" "exceptions" "fulfillments" "inventory" "locations" "orders" "organizations" "products" "purchases" "replenishment" "returns" "shipments" "shipping_methods" "transfers"

Job sub-type

type
required
string (JobType)
Enum: "delete" "export" "import" "prepare" "report" "update"

Job type

contentType
string

Job result content type

object (InternalInfo)

Internal info

params
object

Job type specific parameters

state
object (JobState)

This is a free form object that can be used to store any state related to the job.

timeout
number <int32>

Job timeout (in milliseconds)

Responses

Request samples

Content type
{
  • "type": "delete",
  • "subType": "arrivals",
  • "params": { },
  • "contentType": "string",
  • "timeout": 0,
  • "state": { },
  • "internal": {
    }
}

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "job": {
    }
}

Delete (cancel) long-running job

Authorizations:
Pipe17KeyAuth
path Parameters
JobId
required
string
query Parameters
action
string (DeleteAction)
Enum: "hard" "soft"

Delete job permanently or not

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Delete Multiple Jobs

Authorizations:
Pipe17KeyAuth
query Parameters
action
string (ListDeleteAction)
Default: "list"
Enum: "hard" "list" "soft"

Soft/hard delete or list items to be deleted

count
integer <int32>
Default: 100

Max number of items to delete

jobId
Array of strings

Delete jobs by list of jobId

orgMode
Array of strings (OrganizationMode)
Items Enum: "demo" "production" "test"

Delete jobs assigned these orgModes.

pagination
string
Value: "disabled"

Exclude pagination info from the response

since
string <date-time>

Delete items created after this date-time

skip
integer <int32>
Default: 0

Number of items to skip

status
Array of strings (JobStatus)
Items Enum: "canceled" "completed" "failed" "processing" "submitted"

Delete items with given status

subType
Array of strings (JobSubType)
Items Enum: "arrivals" "exceptions" "fulfillments" "inventory" "locations" "orders" "organizations" "products" "purchases" "replenishment" "returns" "shipments" "shipping_methods" "transfers"

Delete items with given sub-type

type
Array of strings (JobType)
Items Enum: "delete" "export" "import" "prepare" "report" "update"

Delete items with given type

until
string <date-time>

Delete items created before this date-time

updatedSince
string <date-time>

Delete items updated after this date-time

updatedUntil
string <date-time>

Delete items updated before this date-time

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "filters": {
    },
  • "jobs": [
    ],
  • "deleted": 0,
  • "pagination": {
    }
}

Fetch long-running job

Authorizations:
Pipe17KeyAuth
path Parameters
JobId
required
string

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "job": {
    }
}

Fetch long-running job results

Authorizations:
Pipe17KeyAuth
path Parameters
JobId
required
string

Responses

Response samples

Content type
No sample

List long-running jobs

Authorizations:
Pipe17KeyAuth
query Parameters
count
integer <int32>
Default: 100

Max number of items to return

createdBy
Array of strings

Retrieve by list of job requester IDs

jobId
Array of strings

Retrieve by list of jobId

keys
string
Default: "jobId,createdBy,type,subType,params,status,progress,createdAt,updatedAt,orgKey"

Return these top-level fields

order
string
Default: "createdAt"

Sort by these top-level fields

pagination
string
Value: "disabled"

Exclude pagination info from the response

since
string <date-time>

Fetch items created after this date-time

skip
integer <int32>
Default: 0

Number of items to skip

status
Array of strings (JobStatus)
Items Enum: "canceled" "completed" "failed" "processing" "submitted"

Fetch items with given status

subType
Array of strings (JobSubType)
Items Enum: "arrivals" "exceptions" "fulfillments" "inventory" "locations" "orders" "organizations" "products" "purchases" "replenishment" "returns" "shipments" "shipping_methods" "transfers"

Fetch items with given sub-type

type
Array of strings (JobType)
Items Enum: "delete" "export" "import" "prepare" "report" "update"

Fetch items with given type

until
string <date-time>

Fetch items created before this date-time

updatedSince
string <date-time>

Fetch items updated after this date-time

updatedUntil
string <date-time>

Fetch items updated before this date-time

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "filters": {
    },
  • "jobs": [
    ],
  • "pagination": {
    }
}

Sync Jobs

Trigger the jobs sync

Authorizations:
Pipe17KeyAuth
path Parameters
JobId
required
Array of strings
Request Body schema:
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Update job

Authorizations:
Pipe17KeyAuth
path Parameters
JobId
required
string

Job ID

Request Body schema:
object (InternalInfo)

Internal info

progress
integer (JobProgress) [ 0 .. 100 ]

Job progress (0-100)

resultURL
string <uri>

Job result URL

state
object (JobState)

This is a free form object that can be used to store any state related to the job.

status
string (JobStatus)
Enum: "canceled" "completed" "failed" "processing" "submitted"

Job status

Responses

Request samples

Content type
{
  • "status": "canceled",
  • "progress": 100,
  • "state": { },
  • "resultURL": "http://example.com",
  • "internal": {
    }
}

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Labels

Operations on Labels

Label Model

contentType
required
string
fileName
required
string
createdAt
string <date-time>

When the object was created within Pipe17

Array of objects (NameValue)

Custom Fields

object (InternalInfo)

Internal info

labelId
string

Label ID

labelType
string (LabelType)
Enum: "packingSlip" "shippingLabel"

Label type

orgKey
string

Organization this object belong to

shippingMethod
string
status
string
Enum: "new" "ready"

Label status

trackingNumber
string
updatedAt
string <date-time>

When the object was updated within Pipe17

{
  • "labelId": "string",
  • "status": "new",
  • "fileName": "string",
  • "contentType": "string",
  • "trackingNumber": "string",
  • "shippingMethod": "string",
  • "labelType": "packingSlip",
  • "customFields": [
    ],
  • "internal": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "orgKey": "string"
}

Create Label

Authorizations:
Pipe17KeyAuth
Request Body schema:
contentType
required
string
fileName
required
string
Array of objects (NameValue)

Custom Fields

object (InternalInfo)

Internal info

labelType
string (LabelType)
Enum: "packingSlip" "shippingLabel"

Label type

shippingMethod
string
trackingNumber
string

Responses

Request samples

Content type
{
  • "fileName": "string",
  • "contentType": "string",
  • "trackingNumber": "string",
  • "shippingMethod": "string",
  • "labelType": "packingSlip",
  • "customFields": [
    ],
  • "internal": {
    }
}

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "label": {
    }
}

Delete Label

Authorizations:
Pipe17KeyAuth
path Parameters
LabelId
required
string
query Parameters
action
string (DeleteAction)
Enum: "hard" "soft"

Delete label permanently or not

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Delete Labels

Authorizations:
Pipe17KeyAuth
query Parameters
action
string (ListDeleteAction)
Default: "list"
Enum: "hard" "list" "soft"

Soft/hard delete or list items to be deleted

count
integer <int32>
Default: 100

Max number of items to delete

deleted
boolean

Delete soft deleted items

labelId
Array of strings

Delete items by list of labelId

orgMode
Array of strings (OrganizationMode)
Items Enum: "demo" "production" "test"

Delete labels assigned these orgModes.

since
string <date-time>

Delete items created after this date-time

skip
integer <int32>
Default: 0

Number of items to skip

until
string <date-time>

Delete items created before this date-time

updatedSince
string <date-time>

Delete items updated after this date-time

updatedUntil
string <date-time>

Delete items updated before this date-time

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "filters": {
    },
  • "labels": [
    ],
  • "deleted": 0,
  • "pagination": {
    }
}

Download Label Content

Authorizations:
Pipe17KeyAuth
path Parameters
LabelId
required
string

Responses

Response samples

Content type
application/json
{
  • "success": false,
  • "code": 404,
  • "message": "string",
  • "errors": [
    ],
  • "conflict": { }
}

Fetch Label

Authorizations:
Pipe17KeyAuth
path Parameters
LabelId
required
string

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "label": {
    }
}

List Labels

Authorizations:
Pipe17KeyAuth
query Parameters
count
integer <int32>
Default: 100

Max number of items to return

deleted
boolean

Fetch soft deleted items

keys
string
Default: "labelId,fileName,contentType,createdAt,updatedAt,orgKey,status"

Return these top-level fields

labelId
Array of strings

Fetch items by list of labelId

order
string
Default: "createdAt"

Sort by these top-level fields

pagination
string
Value: "disabled"

Exclude pagination info from the response

since
string <date-time>

Fetch items created after this date-time

skip
integer <int32>
Default: 0

Number of items to skip

until
string <date-time>

Fetch items created before this date-time

updatedSince
string <date-time>

Fetch items updated after this date-time

updatedUntil
string <date-time>

Fetch items updated before this date-time

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "filters": {
    },
  • "labels": [
    ]
}

Sync Labels

Trigger the labels sync

Authorizations:
Pipe17KeyAuth
path Parameters
LabelId
required
Array of strings
Request Body schema:
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Upload Label Content

Authorizations:
Pipe17KeyAuth
path Parameters
LabelId
required
string
Request Body schema: application/octet-stream
string <binary>

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "code": 200
}

Locations

Operations about Locations

Location Model

required
object (LocationAddress)
name
required
string

Location Name

createdAt
string <date-time>

When the object was created within Pipe17

Array of objects (ExceptionRef)

References to exceptions related to the location

excludeFromTotals
boolean

Set to exclude location from calculating inventory totals

excludeInventoryEvents
Array of strings

Set of events to be excluded from automated processing for this location

Array of objects (LocationExternalSystem)
fulfillmentIntegrationId
string

Set if this is a fulfillment location

integration
string

Reference to integration that created an item

object (InternalInfo)

Internal info

inventoryIntegrationId
string

Set if inventory source for this location is different from fulfillmentIntegrationId

inventoryNotTracked
boolean

Do not track inventory flag

locationId
string

Location ID

mergedWithLocationId
string

For merged locations, indicates which locationId current location is merged with

orgKey
string

Organization this object belong to

preserveBundles
boolean

Set if shipments to this location should have lineItems referring to bundles kept intact

object (SourceDoc)

Vendor source document

status
string (LocationStatus)
Enum: "active" "deleted" "inactive" "merged" "pending"

Location status

updatedAt
string <date-time>

When the object was updated within Pipe17

{
  • "locationId": "string",
  • "mergedWithLocationId": "string",
  • "integration": "string",
  • "exceptions": [
    ],
  • "name": "string",
  • "address": {
    },
  • "status": "active",
  • "preserveBundles": true,
  • "fulfillmentIntegrationId": "string",
  • "inventoryIntegrationId": "string",
  • "externalSystem": [
    ],
  • "excludeFromTotals": true,
  • "excludeInventoryEvents": [
    ],
  • "sourceDoc": {
    },
  • "inventoryNotTracked": true,
  • "internal": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "orgKey": "string"
}

Create Location

Uniqueness constraints within organization:

  • location.name, location.integration
Authorizations:
Pipe17KeyAuth
Request Body schema:
required
object (LocationAddress)
name
required
string

Location Name

excludeFromTotals
boolean

Set to exclude location from calculating inventory totals

excludeInventoryEvents
Array of strings

Set of events to be excluded from automated processing for this location

Array of objects (LocationExternalSystem)
fulfillmentIntegrationId
string

Set if this is a fulfillment location

object (InternalInfo)

Internal info

inventoryIntegrationId
string

Set if inventory source for this location is different from fulfillmentIntegrationId

inventoryNotTracked
boolean

Do not track inventory flag

preserveBundles
boolean

Set if shipments to this location should have lineItems referring to bundles kept intact

object (SourceDoc)

Vendor source document

status
string (LocationStatus)
Enum: "active" "deleted" "inactive" "merged" "pending"

Location status

Responses

Request samples

Content type
{
  • "name": "string",
  • "address": {
    },
  • "status": "active",
  • "preserveBundles": true,
  • "fulfillmentIntegrationId": "string",
  • "inventoryIntegrationId": "string",
  • "externalSystem": [
    ],
  • "excludeFromTotals": true,
  • "excludeInventoryEvents": [
    ],
  • "sourceDoc": {
    },
  • "inventoryNotTracked": true,
  • "internal": {
    }
}

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "location": {
    }
}

Delete Location

Authorizations:
Pipe17KeyAuth
path Parameters
LocationId
required
string

Location ID to delete

query Parameters
action
string (DeleteAction)
Enum: "hard" "soft"

Delete location permanently or not

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Delete Multiple Locations

Authorizations:
Pipe17KeyAuth
query Parameters
action
string (ListDeleteAction)
Default: "list"
Enum: "hard" "list" "soft"

Soft/hard delete or list locations to be deleted

count
integer <int32>
Default: 100

Delete at most this many locations

deleted
boolean

Delete soft deleted locations

excludeFromTotals
boolean

Delete locations excluded from calculating inventory totals

integration
Array of strings

Delete locations of these integrations

locationId
Array of strings

Delete locations by list of locationId

orgMode
Array of strings (OrganizationMode)
Items Enum: "demo" "production" "test"

Delete locations assigned these orgModes.

pagination
string
Value: "disabled"

Exclude pagination info from the response

since
string <date-time>

Delete locations created after this date-time

skip
integer <int32>
Default: 0

Skip this many locations

status
Array of strings (LocationStatus)
Items Enum: "active" "deleted" "inactive" "merged" "pending"

Delete by list of location statuses

until
string <date-time>

Delete locations created before this date-time

updatedSince
string <date-time>

Delete locations updated after this date-time

updatedUntil
string <date-time>

Delete locations updated before this date-time

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "filters": {
    },
  • "locations": [
    ],
  • "deleted": 0,
  • "pagination": {
    }
}

Fetch Location

Authorizations:
Pipe17KeyAuth
path Parameters
LocationId
required
string

Location ID to fetch

query Parameters
sourceDocVersion
number

Fetch specific vendor source doc version if available

withSourceDoc
boolean

Include vendor source doc if available

withSourceDocVersions
boolean

Include available vendor source doc versions

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "location": {
    }
}

List Locations

Authorizations:
Pipe17KeyAuth
query Parameters
count
integer <int32>
Default: 100

Return at most this many locations

deleted
boolean

Retrieve soft deleted locations

email
string

Retrieve locations by email (strings "/{pattern}/" and "/{pattern}/i" are interpreted as regexps)

exceptionCategoryId
Array of strings

Locations by list of categories of the location related exceptions

exceptionType
Array of strings (ExceptionType)
Items Enum: "eApprovalRequired" "eAutomation" "eAutomationCodeActionError" "eAutomationCodeFilterError" "eCreditMemoInsufficient" "eDelayed" "eDuplicate" "eDuplicateSKU" "eEarly" "eFraudSuspected" "eGeneric" "eIncomplete" "eIncompleteAddress" "eInvalid" "eInvalidAddress" "eInvalidDate" "eInvalidLocation" "eInvalidMethod" "eInvalidSKU" "eInventoryOutOfStock" "eLarge" "eLate" "eLateCancel" "eLost" "eLow" "eMismatch" "eMismatchTax" "eMissing" "eMissingLocation" "eMissingSKU" "eOrderSyncFailure" "eOrderTaxMismatch" "eOutOfStock" "ePartiallyCanceled" "ePaymentRequired" "ePotentialOverfulfill" "eRestock" "eRouteNotFound" "eRouteOutOfStock" "eShipmentMismatch" "eShippingMethod" "eSplit" "eStuck" "eSyncFailure" "eToday" "eTransform" "eUnacknowledged" "eUnexpected" "eUnexpectedDate" "eUnexpectedSplitShipment" "eUnfulfillable"

Locations by list of types of the location related exceptions

excludeFromTotals
boolean

Locations excluded from calculating inventory totals

extIntegrationId
Array of strings

Retrieve locations by list of external integration ids

extLocationId
Array of strings

Retrieve locations by list of external location ids

hasSourceDoc
boolean

Locations containing a source document

keys
string
Default: "locationId,status,name,address,excludeFromTotals,createdAt,updatedAt,orgKey"

Return these top-level fields

locationId
Array of strings

Retrieve by list of locationId

mergedWithLocationId
Array of strings

Retrieve locations by list of mergedWithLocationId

name
string

Retrieve locations by name (strings "/{pattern}/" and "/{pattern}/i" are interpreted as regexps)

order
string
Default: "createdAt"

Sort by these top-level fields

pagination
string
Value: "disabled"

Exclude pagination info from the response

phone
string

Retrieve locations by phone (strings "/{pattern}/" and "/{pattern}/i" are interpreted as regexps)

since
string <date-time>

Locations created after this date-time

skip
integer <int32>
Default: 0

Skip this many locations

status
Array of strings (LocationStatus)
Items Enum: "active" "deleted" "inactive" "merged" "pending"

Retrieve by list of location statuses

until
string <date-time>

Locations created before this date-time

updatedSince
string <date-time>

Locations updated after this date-time

updatedUntil
string <date-time>

Locations updated before this date-time

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "filters": {
    },
  • "locations": [
    ],
  • "pagination": {
    }
}

Sync Locations

Trigger the locations sync

Authorizations:
Pipe17KeyAuth
path Parameters
LocationId
required
Array of strings
Request Body schema:
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Update Location

Uniqueness constraints within organization:

  • location.name, location.integration
Authorizations:
Pipe17KeyAuth
path Parameters
LocationId
required
string

Location ID to update

Request Body schema:
object (LocationUpdateAddress)
excludeFromTotals
boolean

Set to exclude location from calculating inventory totals

excludeInventoryEvents
Array of strings

Set of events to be excluded from automated processing for this location

Array of objects (LocationExternalSystem)
fulfillmentIntegrationId
string or null

Set if this is a fulfillment location

object (InternalInfo)

Internal info

inventoryIntegrationId
string or null

Set if inventory source for this location is different from fulfillmentIntegrationId

inventoryNotTracked
boolean or null

Do not track inventory flag

mergedWithLocationId
string

For merged locations, indicates which locationId current location is merged with

name
string

Location Name

preserveBundles
boolean

Set if shipments to this location should have lineItems referring to bundles kept intact

object (SourceDoc)

Vendor source document

status
string (LocationStatus)
Enum: "active" "deleted" "inactive" "merged" "pending"

Location status

Responses

Request samples

Content type
{
  • "name": "string",
  • "address": {
    },
  • "status": "active",
  • "mergedWithLocationId": "string",
  • "preserveBundles": true,
  • "fulfillmentIntegrationId": "string",
  • "inventoryIntegrationId": "string",
  • "externalSystem": [
    ],
  • "excludeFromTotals": true,
  • "excludeInventoryEvents": [
    ],
  • "sourceDoc": {
    },
  • "inventoryNotTracked": true,
  • "internal": {
    }
}

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Order Statement Transactions

Operations about Order Statement Transactions

Order Statement Transaction Model

extTransactionId
required
string

External transaction ID

statementId
required
string

Statement ID

transactionType
required
string (TransactionType)
Value: "orders"

Transaction type

createdAt
string <date-time>

When the object was created within Pipe17

Array of objects (NameValue)

Custom Fields

extReferenceId
string

External ID

extStatementId
string

External statement ID

integration
string

Integration associated with transaction

object (InternalInfo)

Internal info

orgKey
string

Organization this object belong to

sku
string

SKU

object (SourceDoc)

Vendor source document

status
string
Enum: "draft" "new" "pending" "reported"

Transaction status

Array of objects (Fee)
transactionId
string

Transaction ID

updatedAt
string <date-time>

When the object was updated within Pipe17

{
  • "transactionId": "string",
  • "integration": "string",
  • "status": "draft",
  • "statementId": "string",
  • "extReferenceId": "string",
  • "extStatementId": "string",
  • "extTransactionId": "string",
  • "sku": "string",
  • "transactionType": "orders",
  • "transactionFees": [
    ],
  • "customFields": [
    ],
  • "sourceDoc": {
    },
  • "internal": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "orgKey": "string"
}

Create Transactions

Authorizations:
Pipe17KeyAuth
Request Body schema:
Array (<= 10 items)
extTransactionId
required
string

External transaction ID

statementId
required
string

Statement ID

transactionType
required
string (TransactionType)
Value: "orders"

Transaction type

Array of objects (NameValue)

Custom Fields

extReferenceId
string

External ID

extStatementId
string

External statement ID

object (InternalInfo)

Internal info

sku
string

SKU

object (SourceDoc)

Vendor source document

status
string (TransactionStatus)
Enum: "draft" "new" "pending" "reported"

Transaction status

Array of objects (Fee)

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "transactions": [
    ]
}

Delete Transaction

Authorizations:
Pipe17KeyAuth
path Parameters
TransactionId
required
string

Transaction Id to delete

query Parameters
action
string (DeleteAction)
Enum: "hard" "soft"

Delete transaction permanently or not

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Fetch Transaction

Authorizations:
Pipe17KeyAuth
path Parameters
TransactionId
required
string

Id or ext:{extTransactionId} of transaction to fetch

query Parameters
sourceDocVersion
number

Fetch specific source doc version if available

withSourceDoc
boolean

Include source doc if available

withSourceDocVersions
boolean

Include available source doc versions

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "transaction": {
    }
}

List Transactions

Authorizations:
Pipe17KeyAuth
query Parameters
count
integer <int32>
Default: 100

Return at most this many transactions

deleted
boolean

Retrieve only soft deleted transactions

extReferenceId
Array of strings

Retrieve transactions by extReferenceId list

extStatementId
Array of strings

Retrieve transactions by extStatementId list

extTransactionId
Array of strings

Retrieve transactions by extTransactionId list

hasSourceDoc
boolean

Retrieve transactions containing a source document

integration
Array of strings

Retrieve transactions by integration list

keys
string
Default: "transactionId,extReferenceId,statementId,extStatementId,extTransactionId,integration,sku,transactionType,transactionFees,status,createdAt,updatedAt,orgKey"

Return these top-level fields

order
string
Default: "createdAt"

Sort by these top-level fields

pagination
string
Value: "disabled"

Exclude pagination info from the response

since
string <date-time>

Transactions created after this date-time

skip
integer <int32>
Default: 0

Skip this many transactions

sku
Array of strings

Retrieve transactions by SKU list

statementId
Array of strings

Retrieve transactions by statementId list

status
Array of strings (TransactionStatus)
Items Enum: "draft" "new" "pending" "reported"

Retrieve transactions by status list

transactionId
Array of strings

Retrieve transactions by transactionId list

transactionType
Array of strings

Retrieve transactions by transactionType list

until
string <date-time>

Transactions created before this date-time

updatedSince
string <date-time>

Transactions updated after this date-time

updatedUntil
string <date-time>

Transactions updated before this date-time

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "filters": {
    },
  • "transactions": [
    ],
  • "pagination": {
    }
}

Sync Statement Transactions

Trigger the statement transactions sync

Authorizations:
Pipe17KeyAuth
path Parameters
TransactionId
required
Array of strings
Request Body schema:
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Update Transaction

Authorizations:
Pipe17KeyAuth
path Parameters
TransactionId
required
string

Transaction Id to update

Request Body schema:
Array of objects or null (NameValue)

Custom Fields

object (InternalInfo)

Internal info

object (SourceDoc)

Vendor source document

status
string (TransactionStatus)
Enum: "draft" "new" "pending" "reported"

Transaction status

Array of objects (Fee)

Responses

Request samples

Content type
{
  • "transactionFees": [
    ],
  • "customFields": [
    ],
  • "status": "draft",
  • "sourceDoc": {
    },
  • "internal": {
    }
}

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Order Statements

Operations about Order Statements

Order Statement Model

extStatementId
required
string

External statement ID

extStatementStartDate
required
string <date-time>

External statement start-date

createdAt
string <date-time>

When the object was created within Pipe17

currency
string

Currency

Array of objects (NameValue)

Custom Fields

depositTotal
number

Deposit total

extStatementApiId
string

External statement Api ID

extStatementDepositDate
string <date-time>

External statement deposit-date

extStatementEndDate
string <date-time>

External statement end-date

integration
string

Integration associated with statement

object (InternalInfo)

Internal info

orgKey
string

Organization this object belong to

object (SourceDoc)

Vendor source document

statementId
string

Statement ID

statementTotal
number

Statement total

status
string
Enum: "draft" "new" "pending" "reported"

Statement status

Array of objects (Fee)
Array of objects (Fee)

Fees totals by all registered transactions

updatedAt
string <date-time>

When the object was updated within Pipe17

{
  • "statementId": "string",
  • "integration": "string",
  • "status": "draft",
  • "transactionFeesTotals": [
    ],
  • "extStatementId": "string",
  • "extStatementApiId": "string",
  • "extStatementStartDate": "2019-08-24T14:15:22Z",
  • "extStatementEndDate": "2019-08-24T14:15:22Z",
  • "extStatementDepositDate": "2019-08-24T14:15:22Z",
  • "depositTotal": 0,
  • "transactionFees": [
    ],
  • "statementTotal": 0,
  • "currency": "string",
  • "customFields": [
    ],
  • "sourceDoc": {
    },
  • "internal": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "orgKey": "string"
}

Create Statements

Authorizations:
Pipe17KeyAuth
Request Body schema:
Array (<= 10 items)
extStatementId
required
string

External statement ID

extStatementStartDate
required
string <date-time>

External statement start-date

currency
string

Currency

Array of objects (NameValue)

Custom Fields

depositTotal
number

Deposit total

extStatementApiId
string

External statement Api ID

extStatementDepositDate
string <date-time>

External statement deposit-date

extStatementEndDate
string <date-time>

External statement end-date

object (InternalInfo)

Internal info

object (SourceDoc)

Vendor source document

statementTotal
number

Statement total

status
string (StatementStatus)
Enum: "draft" "new" "pending" "reported"

Statement status

Array of objects (Fee)

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "statements": [
    ]
}

Delete Statement

Authorizations:
Pipe17KeyAuth
path Parameters
StatementId
required
string

Statement Id to delete

query Parameters
action
string (DeleteAction)
Enum: "hard" "soft"

Delete statement permanently or not

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Fetch Statement

Authorizations:
Pipe17KeyAuth
path Parameters
StatementId
required
string

Id or ext:{extStatementId} of statement to fetch

query Parameters
sourceDocVersion
number

Fetch specific source doc version if available

withFeesTotals
boolean

Add the fees totals in the response

withSourceDoc
boolean

Include source doc if available

withSourceDocVersions
boolean

Include available source doc versions

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "statement": {
    }
}

List Statements

Authorizations:
Pipe17KeyAuth
query Parameters
count
integer <int32>
Default: 100

Return at most this many statements

deleted
boolean

Retrieve only soft deleted statements

extStatementApiId
Array of strings

Retrieve statements by extStatementApiId list

extStatementId
Array of strings

Retrieve statements by extStatementId list

hasSourceDoc
boolean

Retrieve statements containing a source document

integration
Array of strings

Retrieve statements by integration list

keys
string
Default: "statementId,extStatementId,extStatementApiId,integration,extStatementStartDate,extStatementEndDate,depositTotal,transactionFees,statementTotal,currency,status,createdAt,updatedAt,orgKey"

Return these top-level fields

order
string
Default: "createdAt"

Sort by these top-level fields

pagination
string
Value: "disabled"

Exclude pagination info from the response

since
string <date-time>

Statements created after this date-time

skip
integer <int32>
Default: 0

Skip this many statements

statementId
Array of strings

Retrieve statements by statementId list

status
Array of strings (StatementStatus)
Items Enum: "draft" "new" "pending" "reported"

Retrieve statements by status list

until
string <date-time>

Statements created before this date-time

updatedSince
string <date-time>

Statements updated after this date-time

updatedUntil
string <date-time>

Statements updated before this date-time

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "filters": {
    },
  • "statements": [
    ],
  • "pagination": {
    }
}

Sync Statements

Trigger the statements sync

Authorizations:
Pipe17KeyAuth
path Parameters
StatementId
required
Array of strings
Request Body schema:
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Update Statement

Authorizations:
Pipe17KeyAuth
path Parameters
StatementId
required
string

Statement Id to update

Request Body schema:
currency
string

Currency

Array of objects or null (NameValue)

Custom Fields

depositTotal
number

Deposit total

extStatementDepositDate
string <date-time>

External statement deposit-date

extStatementEndDate
string <date-time>

External statement end-date

extStatementStartDate
string <date-time>

External statement start-date

object (InternalInfo)

Internal info

object (SourceDoc)

Vendor source document

statementTotal
number

Statement total

status
string (StatementStatus)
Enum: "draft" "new" "pending" "reported"

Statement status

Array of objects (Fee)

Responses

Request samples

Content type
{
  • "extStatementStartDate": "2019-08-24T14:15:22Z",
  • "extStatementEndDate": "2019-08-24T14:15:22Z",
  • "extStatementDepositDate": "2019-08-24T14:15:22Z",
  • "depositTotal": 0,
  • "transactionFees": [
    ],
  • "statementTotal": 0,
  • "currency": "string",
  • "customFields": [
    ],
  • "status": "draft",
  • "sourceDoc": {
    },
  • "internal": {
    }
}

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Orders

Operations about Orders

Order Model

extOrderId
required
string

External Order ID

Array of objects (AdditionalCharge)

Additional charges

autoEngUpdateStatus
string (AutoEngUpdateStatus)
Enum: "none" "pending" "updated"

A status that indicates whether or not the automation engine may update the entity sometime in the future. Only set internally. Useful for services such as the order routing engine where the user intended order state is critical before action. Used for orders and shipments.

Status definitions:

  • pending: the automation engine will make an update to this entity in the future.
  • updated: the automation engine has successfully made an update to this entity.
  • none: No status to set because the org did not have an enabled automation at the time of create/update.
autoEngUpdateStatusUpdatedAt
string <date-time> (AutoEngUpdateStatusUpdatedAt)

When the autoEngUpdateStatus was last updated

object (Address)
createdAt
string <date-time>

When the object was created within Pipe17

currency
string

Order currency code

object (OrderCustomer)
Array of objects (NameValue)

Custom Fields

Array of objects (Discount)

Discounts

Array of objects (ExceptionRef)

References to exceptions related to the order

expectedDeliveryDate
string <date-time>

First Priority to be respected

extOrderApiId
string

External System Order API ID

extOrderCreatedAt
string <date-time>

When the order was created at source

extOrderUpdatedAt
string <date-time>

When the order was updated at source

extOrderUrl
string

Order Url in External System

fulfillmentStatus
string

status of the fulfillment

giftNote
string

Order Gift note

incoterms
string

International Commercial Terms

integration
string

Reference to integration that created an item

object (InternalInfo)

Internal info

lastRerunRoutingTrigger
string (LastRerunRoutingTrigger)
Enum: "auto" "manual"

Indicates if the order was rerun manually by a user action or automatically.

lastRoutedAt
string <date-time>

When the order was last routed.

Array of objects (OrderLineItem)
locationId
string

Id of location defined in organization. Used as item origin for shipment.

orderDiscount
number <float>

Order Discount

orderId
string

Auto Generated

orderNote
string

Order Notes

orderSource
string

The original order platform, walmart, etsy, etc

orderSourceType
string (OrderType)
Enum: "edi" "online" "other" "pos" "wholesale"

Order Type (online, pos, etc)

orderTax
number <float>

Order Tax

orgKey
string

Organization this object belong to

Array of objects (Payment)

Payments

paymentStatus
string

status of the payment

Array of objects (OrderRefund)

Additional charges

requireShippingLabels
boolean

Indicates if fetching of shipping labels is required

routingStatus
string (RoutingStatus)
Enum: "acknowledged" "disabled" "excluded" "failed" "pending" "pendingInventory" "ready"

Routing Status:

  • pending - order should be be processed by Order Routing engine once its status is readyForFulfillment
  • ready - order is ready to be processed by Order Routing engine. This status is applied
    • when order status transitions to readyForFulfillment and current routing status is pending
    • when routing status is acknowledged or failed and significant order properties are changed
  • pendingInventory - order should be routed by Order Routing engine once inventory is available
  • acknowledged - order is acknowledged by Order Routing engine and will not be processed by Order routing
  • disabled - order routing is disabled
  • failed - order routing failed and will be retried by Order Routing engine
shipAfterDate
string <date-time>

Ship After Date

shipByDate
string <date-time>

Ship By Date

shipCancelByDate
string <date-time>

Ship Cancel By Date

object (Address)
shippingCarrier
string

Required with ShippingClass, Pipe17 Approved List, 2nd Priority

shippingClass
string

Required with ShippingCarrier, 2nd Priority

shippingCode
string

3rd Priority

shippingNote
string

Shipping Notes

shippingPrice
number <float>

Shipping price

object (SourceDoc)

Vendor source document

status
string
Enum: "archived" "canceled" "closed" "draft" "fulfilled" "inTransit" "new" "onHold" "partialFulfillment" "partialReceived" "readyForFulfillment" "received" "refunded" "returned" "reviewRequired" "sentToFulfillment" "toBeValidated"

Order Status

subTotalPrice
number <float>

Sub Total Price

tags
Array of strings (EntityTags)

Tags assigned to entity

timestamp
string <date-time>

General Purpose Time Stamp

totalPrice
number <float>

Total Price

updatedAt
string <date-time>

When the object was updated within Pipe17

{
  • "orderId": "string",
  • "status": "archived",
  • "integration": "string",
  • "exceptions": [
    ],
  • "autoEngUpdateStatus": "none",
  • "autoEngUpdateStatusUpdatedAt": "2019-08-24T14:15:22Z",
  • "extOrderId": "string",
  • "extOrderUrl": "string",
  • "orderSource": "string",
  • "orderSourceType": "edi",
  • "lineItems": [
    ],
  • "currency": "string",
  • "subTotalPrice": 0,
  • "orderDiscount": 0,
  • "orderTax": 0,
  • "totalPrice": 0,
  • "orderNote": "string",
  • "giftNote": "string",
  • "shippingAddress": {
    },
  • "shippingCarrier": "string",
  • "shippingClass": "string",
  • "shipByDate": "2019-08-24T14:15:22Z",
  • "shipAfterDate": "2019-08-24T14:15:22Z",
  • "shipCancelByDate": "2019-08-24T14:15:22Z",
  • "expectedDeliveryDate": "2019-08-24T14:15:22Z",
  • "shippingNote": "string",
  • "incoterms": "string",
  • "billingAddress": {
    },
  • "timestamp": "2019-08-24T14:15:22Z",
  • "shippingCode": "string",
  • "customer": {
    },
  • "paymentStatus": "string",
  • "fulfillmentStatus": "string",
  • "routingStatus": "acknowledged",
  • "extOrderApiId": "string",
  • "extOrderCreatedAt": "2019-08-24T14:15:22Z",
  • "extOrderUpdatedAt": "2019-08-24T14:15:22Z",
  • "locationId": "string",
  • "lastRoutedAt": "2019-08-24T14:15:22Z",
  • "lastRerunRoutingTrigger": "auto",
  • "shippingPrice": 0,
  • "requireShippingLabels": true,
  • "customFields": [
    ],
  • "tags": [
    ],
  • "payments": [
    ],
  • "discounts": [
    ],
  • "additionalCharges": [
    ],
  • "refunds": [
    ],
  • "sourceDoc": {
    },
  • "internal": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "orgKey": "string"
}

Create Orders

Uniqueness constraints within organization:

  • order.extOrderId, order.orderSource
  • order.extOrderApiId (when defined)
Authorizations:
Pipe17KeyAuth
query Parameters
withTransform
boolean

Enable order transformation engine for this request

Request Body schema:
Array (<= 10 items)
extOrderId
required
string

External Order ID

Array of objects (AdditionalCharge)

Additional charges

object (Address)
currency
string

Order currency code

object (OrderCustomer)
Array of objects (NameValue)

Custom Fields

Array of objects (Discount)

Discounts

expectedDeliveryDate
string <date-time>

First Priority to be respected

extOrderApiId
string

External System Order API ID

extOrderCreatedAt
string <date-time>

When the order was created at source

extOrderUpdatedAt
string <date-time>

When the order was updated at source

extOrderUrl
string

Order Url in External System

fulfillmentStatus
string

status of the fulfillment

giftNote
string

Order Gift note

incoterms
string

International Commercial Terms

object (InternalInfo)

Internal info

lastRerunRoutingTrigger
string (LastRerunRoutingTrigger)
Enum: "auto" "manual"

Indicates if the order was rerun manually by a user action or automatically.

lastRoutedAt
string <date-time>

When the order was last routed.

Array of objects (OrderLineItem)
locationId
string

Id of location defined in organization. Used as item origin for shipment.

orderDiscount
number <float>

Order Discount

orderNote
string

Order Notes

orderSource
string

The original order platform, walmart, etsy, etc

orderSourceType
string (OrderType)
Enum: "edi" "online" "other" "pos" "wholesale"

Order Type (online, pos, etc)

orderTax
number <float>

Order Tax

Array of objects (Payment)

Payments

paymentStatus
string

status of the payment

Array of objects (OrderRefund)

Additional charges

requireShippingLabels
boolean

Indicates if fetching of shipping labels is required

routingStatus
string (RoutingStatus)
Enum: "acknowledged" "disabled" "excluded" "failed" "pending" "pendingInventory" "ready"

Routing Status:

  • pending - order should be be processed by Order Routing engine once its status is readyForFulfillment
  • ready - order is ready to be processed by Order Routing engine. This status is applied
    • when order status transitions to readyForFulfillment and current routing status is pending
    • when routing status is acknowledged or failed and significant order properties are changed
  • pendingInventory - order should be routed by Order Routing engine once inventory is available
  • acknowledged - order is acknowledged by Order Routing engine and will not be processed by Order routing
  • disabled - order routing is disabled
  • failed - order routing failed and will be retried by Order Routing engine
shipAfterDate
string <date-time>

Ship After Date

shipByDate
string <date-time>

Ship By Date

shipCancelByDate
string <date-time>

Ship Cancel By Date

object (Address)
shippingCarrier
string

Required with ShippingClass, Pipe17 Approved List, 2nd Priority

shippingClass
string

Required with ShippingCarrier, 2nd Priority

shippingCode
string

3rd Priority

shippingNote
string

Shipping Notes

shippingPrice
number <float>

Shipping price

object (SourceDoc)

Vendor source document

status
string (OrderStatus)
Enum: "archived" "canceled" "closed" "draft" "fulfilled" "inTransit" "new" "onHold" "partialFulfillment" "partialReceived" "readyForFulfillment" "received" "refunded" "returned" "reviewRequired" "sentToFulfillment" "toBeValidated"

Order Status

subTotalPrice
number <float>

Sub Total Price

tags
Array of strings (EntityTags)

Tags assigned to entity

timestamp
string <date-time>

General Purpose Time Stamp

totalPrice
number <float>

Total Price

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "orders": [
    ]
}

Delete Multiple Orders

Authorizations:
Pipe17KeyAuth
query Parameters
action
string (ListDeleteAction)
Default: "list"
Enum: "hard" "list" "soft"

Soft/hard delete or list orders to be deleted

count
integer <int32>
Default: 100

Delete at most this many orders

deleted
boolean

Delete soft deleted orders

extOrderId
Array of strings

Delete orders by list of extOrderId

integration
Array of strings

Delete orders of these integrations

orderId
Array of strings

Delete orders by list of orderId

orderSource
Array of strings

Delete orders by list of order sources

orderSourceType
Array of strings (OrderType)
Items Enum: "edi" "online" "other" "pos" "wholesale"

Delete orders by list of order types

orgMode
Array of strings (OrganizationMode)
Items Enum: "demo" "production" "test"

Delete orders assigned these orgModes.

pagination
string
Value: "disabled"

Exclude pagination info from the response

routingStatus
Array of strings (RoutingStatus)
Items Enum: "acknowledged" "disabled" "excluded" "failed" "pending" "pendingInventory" "ready"

Delete orders by list of routing statuses

since
string <date-time>

Delete orders created after this date-time

skip
integer <int32>
Default: 0

Skip this many orders

status
Array of strings (OrderStatus)
Items Enum: "archived" "canceled" "closed" "draft" "fulfilled" "inTransit" "new" "onHold" "partialFulfillment" "partialReceived" "readyForFulfillment" "received" "refunded" "returned" "reviewRequired" "sentToFulfillment" "toBeValidated"

Delete orders by list of statuses

until
string <date-time>

Delete orders created before this date-time

updatedSince
string <date-time>

Delete orders updated after this date-time

updatedUntil
string <date-time>

Delete orders updated before this date-time

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "filters": {
    },
  • "orders": [
    ],
  • "deleted": 0,
  • "pagination": {
    }
}

Delete Order

Authorizations:
Pipe17KeyAuth
path Parameters
OrderId
required
string

Id, ext:{extOrderId}, or api:{extOrderApiId} of order to delete

query Parameters
action
string (DeleteAction)
Enum: "hard" "soft"

Delete order permanently or not

nested
boolean

Delete nested entities

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Fetch Order

Authorizations:
Pipe17KeyAuth
path Parameters
OrderId
required
string

Id, ext:{extOrderId}, or api:{extOrderApiId} of order to fetch

query Parameters
sourceDocVersion
number

Fetch specific vendor source doc version if available

withSourceDoc
boolean

Include vendor source doc if available

withSourceDocVersions
boolean

Include available vendor source doc versions

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "order": {
    }
}

List Orders

Authorizations:
Pipe17KeyAuth
query Parameters
autoEngUpdateStatus
Array of strings (AutoEngUpdateStatus)
Items Enum: "none" "pending" "updated"
autoEngUpdateStatusUpdatedSince
string <date-time>

Fetch all orders with autoEngUpdateStatus updated after this date-time

autoEngUpdateStatusUpdatedUntil
string <date-time>

Fetch all orders with autoEngUpdateStatus updated before this date-time

count
integer <int32>
Default: 100

Return at most this many orders

deleted
boolean

Fetch soft deleted orders

email
string

Fetch orders by recipient email (strings "/{pattern}/" and "/{pattern}/i" are interpreted as regexps)

exceptionCategoryId
Array of strings

Fetch orders by list of categories of the order related exceptions

exceptionType
Array of strings (ExceptionType)
Items Enum: "eApprovalRequired" "eAutomation" "eAutomationCodeActionError" "eAutomationCodeFilterError" "eCreditMemoInsufficient" "eDelayed" "eDuplicate" "eDuplicateSKU" "eEarly" "eFraudSuspected" "eGeneric" "eIncomplete" "eIncompleteAddress" "eInvalid" "eInvalidAddress" "eInvalidDate" "eInvalidLocation" "eInvalidMethod" "eInvalidSKU" "eInventoryOutOfStock" "eLarge" "eLate" "eLateCancel" "eLost" "eLow" "eMismatch" "eMismatchTax" "eMissing" "eMissingLocation" "eMissingSKU" "eOrderSyncFailure" "eOrderTaxMismatch" "eOutOfStock" "ePartiallyCanceled" "ePaymentRequired" "ePotentialOverfulfill" "eRestock" "eRouteNotFound" "eRouteOutOfStock" "eShipmentMismatch" "eShippingMethod" "eSplit" "eStuck" "eSyncFailure" "eToday" "eTransform" "eUnacknowledged" "eUnexpected" "eUnexpectedDate" "eUnexpectedSplitShipment" "eUnfulfillable"

Fetch orders by list of types of the order related exceptions

extOrderId
Array of strings

Fetch orders by list of extOrderId

hasSourceDoc
boolean

Orders containing a source document

integration
Array of strings

Fetch orders by list of integrationId

keys
string
Default: "orderId,extOrderId,email,status,shipByDate,expectedDeliveryDate,tags,createdAt,updatedAt,orgKey"

Return these top-level fields

lastRerunRoutingTrigger
Array of strings (LastRerunRoutingTrigger)
Items Enum: "auto" "manual"

Fetch orders by list of rerun routing triggers

locationId
Array of strings

Fetch orders by list of locationId

order
string
Default: "createdAt"

Sort by these top-level fields

orderId
Array of strings

Fetch orders by list of orderId

orderSource
Array of strings

Fetch orders by list of order sources

orderSourceType
Array of strings (OrderType)
Items Enum: "edi" "online" "other" "pos" "wholesale"

Fetch orders by list of types

pagination
string
Value: "disabled"

Exclude pagination info from the response

requireShippingLabels
boolean

Filter orders by shipping labels requirement

routingStatus
Array of strings (RoutingStatus)
Items Enum: "acknowledged" "disabled" "excluded" "failed" "pending" "pendingInventory" "ready"

Orders by list of routing statuses

since
string <date-time>

Fetch all orders created after this date-time

skip
integer <int32>
Default: 0

Skip this many orders

status
Array of strings (OrderStatus)
Items Enum: "archived" "canceled" "closed" "draft" "fulfilled" "inTransit" "new" "onHold" "partialFulfillment" "partialReceived" "readyForFulfillment" "received" "refunded" "returned" "reviewRequired" "sentToFulfillment" "toBeValidated"

Fetch orders by list of statuses

timestamp
boolean

if set to true use timestamp instead of create time

until
string <date-time>

Fetch all orders created before this date-time

updatedSince
string <date-time>

Fetch all orders updated after this date-time

updatedUntil
string <date-time>

Fetch all orders updated before this date-time

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "filters": {
    },
  • "orders": [
    ],
  • "pagination": {
    }
}

Sync Orders

Trigger the orders sync

Authorizations:
Pipe17KeyAuth
path Parameters
OrderId
required
Array of strings
Request Body schema:
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Update Order

Uniqueness constraints within organization:

  • order.extOrderId, order.orderSource
  • order.extOrderApiId (when defined)
Authorizations:
Pipe17KeyAuth
path Parameters
OrderId
required
string

Id, ext:{extOrderId}, or api:{extOrderApiId} of order to update

query Parameters
withTransform
boolean

Enable order transformation engine for this request

Request Body schema:
Array of objects or null (AdditionalCharge)

Additional charges

autoEngUpdateStatus
string (AutoEngUpdateStatus)
Enum: "none" "pending" "updated"

A status that indicates whether or not the automation engine may update the entity sometime in the future. Only set internally. Useful for services such as the order routing engine where the user intended order state is critical before action. Used for orders and shipments.

Status definitions:

  • pending: the automation engine will make an update to this entity in the future.
  • updated: the automation engine has successfully made an update to this entity.
  • none: No status to set because the org did not have an enabled automation at the time of create/update.
object (AddressUpdateData)
currency
string

Order currency code

object (OrderCustomer)
Array of objects (NameValue)

Custom Fields

Array of objects or null (Discount)

Discounts

expectedDeliveryDate
string or null <date-time>

First Priority to be respected

extOrderApiId
string or null

External System Order API ID

extOrderCreatedAt
string or null <date-time>

When the order was created at source

extOrderId
string

External Order ID

extOrderUpdatedAt
string or null <date-time>

When the order was updated at source

extOrderUrl
string

Order Url in External System

fulfillmentStatus
string or null

status of the fulfillment

giftNote
string or null

Order Gift note

object (InternalInfo)

Internal info

lastRerunRoutingTrigger
string (LastRerunRoutingTrigger)
Enum: "auto" "manual"

Indicates if the order was rerun manually by a user action or automatically.

lastRoutedAt
string <date-time>

When the order was last routed.

Array of objects (OrderUpdateLineItem)
locationId
string or null

Id of location defined in organization. Used as item origin for shipment.

orderDiscount
number or null <float>

Order Discount

orderNote
string or null

Order Notes

orderSource
string or null

The original order platform, walmart, etsy, etc

orderSourceType
string (OrderType)
Enum: "edi" "online" "other" "pos" "wholesale"

Order Type (online, pos, etc)

orderTax
number or null <float>

Order Tax

Array of objects or null (Payment)

Payments

paymentStatus
string or null

status of the payment

Array of objects or null (OrderRefund)

Order refunds

requireShippingLabels
boolean or null

Indicates if fetching of shipping labels is required

routingStatus
string (RoutingStatus)
Enum: "acknowledged" "disabled" "excluded" "failed" "pending" "pendingInventory" "ready"

Routing Status:

  • pending - order should be be processed by Order Routing engine once its status is readyForFulfillment
  • ready - order is ready to be processed by Order Routing engine. This status is applied
    • when order status transitions to readyForFulfillment and current routing status is pending
    • when routing status is acknowledged or failed and significant order properties are changed
  • pendingInventory - order should be routed by Order Routing engine once inventory is available
  • acknowledged - order is acknowledged by Order Routing engine and will not be processed by Order routing
  • disabled - order routing is disabled
  • failed - order routing failed and will be retried by Order Routing engine
shipAfterDate
string or null <date-time>

Ship After Date

shipByDate
string or null <date-time>

Ship By Date

shipCancelByDate
string or null <date-time>

Ship Cancel By Date

object (AddressUpdateData)
shippingCarrier
string or null

Required with ShippingClass, Pipe17 Approved List, 2nd Priority

shippingClass
string or null

Required with ShippingCarrier, 2nd Priority

shippingCode
string or null

3rd Priority

shippingNote
string or null

Shipping Notes

shippingPrice
number or null <float>
object (SourceDoc)

Vendor source document

status
string (OrderStatus)
Enum: "archived" "canceled" "closed" "draft" "fulfilled" "inTransit" "new" "onHold" "partialFulfillment" "partialReceived" "readyForFulfillment" "received" "refunded" "returned" "reviewRequired" "sentToFulfillment" "toBeValidated"

Order Status

subTotalPrice
number or null <float>

Sub Total Price

tags
Array of strings (EntityTags)

Tags assigned to entity

timestamp
string or null <date-time>

General Purpose Time Stamp

totalPrice
number or null <float>

Total Price

Responses

Request samples

Content type
{
  • "status": "archived",
  • "orderSource": "string",
  • "orderSourceType": "edi",
  • "extOrderUrl": "string",
  • "lineItems": [
    ],
  • "currency": "string",
  • "subTotalPrice": 0,
  • "orderDiscount": 0,
  • "orderTax": 0,
  • "totalPrice": 0,
  • "orderNote": "string",
  • "giftNote": "string",
  • "shippingAddress": {
    },
  • "shippingCarrier": "string",
  • "shippingClass": "string",
  • "shipByDate": "2019-08-24T14:15:22Z",
  • "shipAfterDate": "2019-08-24T14:15:22Z",
  • "shipCancelByDate": "2019-08-24T14:15:22Z",
  • "expectedDeliveryDate": "2019-08-24T14:15:22Z",
  • "shippingNote": "string",
  • "billingAddress": {
    },
  • "timestamp": "2019-08-24T14:15:22Z",
  • "paymentStatus": "string",
  • "fulfillmentStatus": "string",
  • "routingStatus": "acknowledged",
  • "extOrderId": "string",
  • "extOrderApiId": "string",
  • "extOrderCreatedAt": "2019-08-24T14:15:22Z",
  • "extOrderUpdatedAt": "2019-08-24T14:15:22Z",
  • "locationId": "string",
  • "lastRoutedAt": "2019-08-24T14:15:22Z",
  • "lastRerunRoutingTrigger": "auto",
  • "shippingPrice": 0,
  • "requireShippingLabels": true,
  • "customer": {
    },
  • "shippingCode": "string",
  • "customFields": [
    ],
  • "tags": [
    ],
  • "payments": [
    ],
  • "discounts": [
    ],
  • "additionalCharges": [
    ],
  • "refunds": [
    ],
  • "sourceDoc": {
    },
  • "autoEngUpdateStatus": "none",
  • "internal": {
    }
}

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Products

Operations about Products

Product Model

name
required
string

Display Name

sku
required
string

Product SKU

Array of objects (ProductBundleItem)

Bundle Item need to reference the SKU of the actual product

cost
number <float>

Cost

costCurrency
string

Currency

countryOfOrigin
string

Country of Origin

createdAt
string <date-time>

When the object was created within Pipe17

Array of objects (NameValue)

Custom Fields

description
string

Description

dimensionsUnit
string
Enum: "cm" "ft" "in"

Dimensions UOM

Array of objects (ExceptionRef)

References to exceptions related to the product

extProductApiId
string

External Product API Id

extProductCreatedAt
string <date-time>
extProductId
string

External Product Id

extProductUpdatedAt
string <date-time>
harmonizedCode
string

Harmonized System/Tarrif Code

height
number <float>

Height

hideInStore
boolean

Mark item as hidden in marketplace Storefront

imageURLs
Array of strings

Image URLs

integration
string

Reference to integration that created an item

object (InternalInfo)

Internal info

inventoryNotTracked
boolean

Do not track inventory flag

length
number <float>

Length

object (ProductPublishedItem)
orgKey
string

Organization this object belong to

parentExtProductId
string

Variant parent external product Id

partId
string

Manufacturer part number

Array of objects (Price)

Start off with basePrice

productId
string

Product ID

Array of objects (ProductPublishedItem)

Published Channels

object (SourceDoc)

Vendor source document

status
string (ProductStatus)
Enum: "active" "inactive"

Product Status

tags
Array of strings (EntityTags)

Tags assigned to entity

taxable
boolean

Taxable

types
Array of strings (ProductType)
Items Enum: "bundle" "bundleItem" "child" "parent" "simple"

Product types

upc
string

UPC

updatedAt
string <date-time>

When the object was updated within Pipe17

Array of objects (NameValue)

this let us know the variant description

vendor
string

vendor

weight
number <float>

Weight

weightUnit
string
Enum: "g" "kg" "lb" "oz"

Weight UOM

width
number <float>

Width

{
  • "productId": "string",
  • "integration": "string",
  • "mappedProduct": {
    },
  • "exceptions": [
    ],
  • "sku": "string",
  • "name": "string",
  • "status": "active",
  • "description": "string",
  • "types": [
    ],
  • "extProductId": "string",
  • "extProductApiId": "string",
  • "upc": "string",
  • "partId": "string",
  • "prices": [
    ],
  • "cost": 0,
  • "costCurrency": "string",
  • "taxable": true,
  • "countryOfOrigin": "string",
  • "harmonizedCode": "string",
  • "weight": 0,
  • "weightUnit": "g",
  • "height": 0,
  • "length": 0,
  • "width": 0,
  • "dimensionsUnit": "cm",
  • "vendor": "string",
  • "tags": [
    ],
  • "imageURLs": [
    ],
  • "parentExtProductId": "string",
  • "variantOptions": [
    ],
  • "bundleItems": [
    ],
  • "customFields": [
    ],
  • "published": [
    ],
  • "inventoryNotTracked": true,
  • "hideInStore": true,
  • "extProductCreatedAt": "2019-08-24T14:15:22Z",
  • "extProductUpdatedAt": "2019-08-24T14:15:22Z",
  • "sourceDoc": {
    },
  • "internal": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "orgKey": "string"
}

Create Products

Uniqueness constraints within organization:

  • product.sku
  • product.extProductId (when defined)
  • product.mappedProduct.sku, product.mappedProduct.integrationId
  • product.mappedProduct.extProductId, product.mappedProduct.integrationId
  • product.sku, product.mappedProduct.integrationId
  • product.sku, product.published.integrationId
  • product.published.integrationId, product.published.sku
  • product.published.integrationId, product.published.extProductId
Authorizations:
Pipe17KeyAuth
Request Body schema:
Array (<= 10 items)
name
required
string

Display Name

sku
required
string

Product SKU

Array of objects (ProductBundleItem)

Bundle Item need to reference the SKU of the actual product

cost
number <float>

Cost

costCurrency
string

Currency

countryOfOrigin
string

Country of Origin

Array of objects (NameValue)

Custom Fields

description
string

Description

dimensionsUnit
string
Enum: "cm" "ft" "in"

Dimensions UOM

extProductApiId
string

External Product API Id

extProductCreatedAt
string <date-time>
extProductId
string

External Product Id

extProductUpdatedAt
string <date-time>
harmonizedCode
string

Harmonized System/Tarrif Code

height
number <float>

Height

hideInStore
boolean

Mark item as hidden in marketplace Storefront

imageURLs
Array of strings

Image URLs

object (InternalInfo)

Internal info

inventoryNotTracked
boolean

Do not track inventory flag

length
number <float>

Length

parentExtProductId
string

Variant parent external product Id

partId
string

Manufacturer part number

Array of objects (Price)

Start off with basePrice

Array of objects (ProductPublishedItem)

Published Channels

object (SourceDoc)

Vendor source document

status
string (ProductStatus)
Enum: "active" "inactive"

Product Status

tags
Array of strings (EntityTags)

Tags assigned to entity

taxable
boolean

Taxable

types
Array of strings (ProductType)
Items Enum: "bundle" "bundleItem" "child" "parent" "simple"

Product types

upc
string

UPC

Array of objects (NameValue)

this let us know the variant description

vendor
string

vendor

weight
number <float>

Weight

weightUnit
string
Enum: "g" "kg" "lb" "oz"

Weight UOM

width
number <float>

Width

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "products": [
    ]
}

Delete Multiple Products

Authorizations:
Pipe17KeyAuth
query Parameters
action
string (ListDeleteAction)
Default: "list"
Enum: "hard" "list" "soft"

Soft/hard delete or list products to be deleted

count
integer <int32>
Default: 100

Delete at most this many products

deleted
boolean

Delete soft deleted products

extProductId
Array of strings

Delete products by list of extProductId

integration
Array of strings

Delete products of these integrations

orgMode
Array of strings (OrganizationMode)
Items Enum: "demo" "production" "test"

Delete products assigned these orgModes.

pagination
string
Value: "disabled"

Exclude pagination info from the response

parentExtProductId
Array of strings

Delete all variants of a parent product by list of external id

productId
Array of strings

Delete products by list of productId

since
string <date-time>

Delete products created after this date-time

skip
integer <int32>
Default: 0

Skip this many products

status
Array of strings (ProductStatus)
Items Enum: "active" "inactive"

Delete products with this status

types
Array of strings (ProductType)
Items Enum: "bundle" "bundleItem" "child" "parent" "simple"

Delete products matching specified types

until
string <date-time>

Delete products created before this date-time

updatedSince
string <date-time>

Delete products updated after this date-time

updatedUntil
string <date-time>

Delete products updated before this date-time

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "filters": {
    },
  • "products": [
    ],
  • "deleted": 0,
  • "pagination": {
    }
}

Delete Product

Authorizations:
Pipe17KeyAuth
path Parameters
ProductId
required
string

Id, sku:{sku}, or ext:{extProductId} of product to delete

query Parameters
action
string (DeleteAction)
Enum: "hard" "soft"

Delete product permanently or not

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

List Products

Authorizations:
Pipe17KeyAuth
query Parameters
bundleSKU
string

Retrieve all products of the bundle with this SKU

count
integer <int32>
Default: 100

Return at most this many products

deleted
boolean

Retrieve soft deleted products

exceptionCategoryId
Array of strings

Retrieve products by list of categories of the product related exceptions

exceptionType
Array of strings (ExceptionType)
Items Enum: "eApprovalRequired" "eAutomation" "eAutomationCodeActionError" "eAutomationCodeFilterError" "eCreditMemoInsufficient" "eDelayed" "eDuplicate" "eDuplicateSKU" "eEarly" "eFraudSuspected" "eGeneric" "eIncomplete" "eIncompleteAddress" "eInvalid" "eInvalidAddress" "eInvalidDate" "eInvalidLocation" "eInvalidMethod" "eInvalidSKU" "eInventoryOutOfStock" "eLarge" "eLate" "eLateCancel" "eLost" "eLow" "eMismatch" "eMismatchTax" "eMissing" "eMissingLocation" "eMissingSKU" "eOrderSyncFailure" "eOrderTaxMismatch" "eOutOfStock" "ePartiallyCanceled" "ePaymentRequired" "ePotentialOverfulfill" "eRestock" "eRouteNotFound" "eRouteOutOfStock" "eShipmentMismatch" "eShippingMethod" "eSplit" "eStuck" "eSyncFailure" "eToday" "eTransform" "eUnacknowledged" "eUnexpected" "eUnexpectedDate" "eUnexpectedSplitShipment" "eUnfulfillable"

Retrieve products by list of types of the product related exceptions

extProductId
Array of strings

Retrieve products by list of extProductId

hasSourceDoc
boolean

Retrieve products containing a source document

inBundle
string

Retrieve all bundles containing the item with this SKU

keys
string
Default: "productId,extProductId,parentExtProductId,status,types,sku,name,tags,createdAt,updatedAt,orgKey"

Return these top-level fields

mappedSKU
boolean

Retrieve products with SKU mapping defined

name
string

Retrieve products by name (strings "/{pattern}/" and "/{pattern}/i" are interpreted as regexps)

notPublished
boolean

Retrieve products that do not have "published channels"

order
string
Default: "createdAt"

Sort by these top-level fields

pagination
string
Value: "disabled"

Exclude pagination info from the response

parentExtProductId
Array of strings

Retrieve all variants of a parent product by list of external id

productId
Array of strings

Retrieve by list of productId

publishedSKU
Array of strings

Retrieve all products with published SKU

publishedStatus
Array of strings (ProductPublishedItemStatus)
Items Enum: "disabled" "published" "tobepublished" "tobeunpublished" "unpublished"

Retrieve all products with published status

since
string <date-time>

Retrieve all products created after this date-time

skip
integer <int32>
Default: 0

Skip this many products

sku
Array of strings

Retrieve products by list of SKU

status
Array of strings (ProductStatus)
Items Enum: "active" "inactive"

Retrieve all products with this status

types
Array of strings (ProductType)
Items Enum: "bundle" "bundleItem" "child" "parent" "simple"

Retrieve all products matching specified types

until
string <date-time>

Retrieve all products created before this date-time

updatedSince
string <date-time>

Retrieve all products updated after this date-time

updatedUntil
string <date-time>

Retrieve all products updated before this date-time

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "filters": {
    },
  • "products": [
    ],
  • "pagination": {
    }
}

Retrieve Product

Authorizations:
Pipe17KeyAuth
path Parameters
ProductId
required
string

Id, sku:{sku}, or ext:{extProductId} of product to fetch

query Parameters
sourceDocVersion
number

Fetch specific vendor source doc version if available

withSourceDoc
boolean

Include vendor source doc if available

withSourceDocVersions
boolean

Include available vendor source doc versions

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "product": {
    }
}

Sync Products

Trigger the products sync

Authorizations:
Pipe17KeyAuth
path Parameters
ProductId
required
Array of strings
Request Body schema:
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Update Product

Uniqueness constraints within organization:

  • product.sku
  • product.extProductId (when defined)
  • product.mappedProduct.sku, product.mappedProduct.integrationId
  • product.mappedProduct.extProductId, product.mappedProduct.integrationId
  • product.sku, product.mappedProduct.integrationId
  • product.sku, product.published.integrationId
  • product.published.integrationId, product.published.sku
  • product.published.integrationId, product.published.extProductId operationId: createProducts
Authorizations:
Pipe17KeyAuth
path Parameters
ProductId
required
string

Id, sku:{sku}, or ext:{extProductId} of product to update

Request Body schema:
Array of objects or null (ProductBundleItem)

Bundle Item need to reference the SKU of the actual product

cost
number or null <float>

Cost

costCurrency
string or null

Currency

countryOfOrigin
string or null

Country of Origin

Array of objects or null (NameValue)

Custom Fields

description
string

Description

dimensionsUnit
string
Enum: "cm" "ft" "in"

Dimensions UOM

extProductApiId
string

External Product API Id

extProductCreatedAt
string or null <date-time>
extProductUpdatedAt
string or null <date-time>
harmonizedCode
string or null

Harmonized System/Tariff Code

height
number or null <float>

Height

hideInStore
boolean or null

Mark item as hidden in marketplace Storefront

imageURLs
Array of strings or null

Image URLs

object (InternalInfo)

Internal info

inventoryNotTracked
boolean or null

Do not track inventory flag

length
number or null <float>

Length

object (ProductPublishedItemUpdate)
name
string

Display Name

parentExtProductId
string or null

Variant parent external product Id

partId
string or null

Manufacturer part number

Array of objects or null (Price)

Start off with basePrice

Array of objects or null (ProductPublishedItem)

Published Channels

sku
string

Product SKU

object (SourceDoc)

Vendor source document

status
string (ProductStatus)
Enum: "active" "inactive"

Product Status

tags
Array of strings (EntityTags)

Tags assigned to entity

taxable
boolean or null

Taxable

types
Array of strings (ProductType)
Items Enum: "bundle" "bundleItem" "child" "parent" "simple"

Product types

upc
string or null

UPC

Array of objects or null (NameValue)

this let us know the variant description

vendor
string or null

vendor

weight
number or null <float>

Weight

weightUnit
string or null
Enum: "g" "kg" "lb" "oz"

Weight UOM

width
number or null <float>

Width

Responses

Request samples

Content type
{
  • "sku": "string",
  • "name": "string",
  • "status": "active",
  • "description": "string",
  • "types": [
    ],
  • "extProductApiId": "string",
  • "upc": "string",
  • "partId": "string",
  • "prices": [
    ],
  • "imageURLs": [
    ],
  • "cost": 0,
  • "costCurrency": "string",
  • "taxable": true,
  • "countryOfOrigin": "string",
  • "harmonizedCode": "string",
  • "weight": 0,
  • "weightUnit": "g",
  • "height": 0,
  • "length": 0,
  • "width": 0,
  • "dimensionsUnit": "cm",
  • "vendor": "string",
  • "tags": [
    ],
  • "parentExtProductId": "string",
  • "variantOptions": [
    ],
  • "extProductCreatedAt": "2019-08-24T14:15:22Z",
  • "extProductUpdatedAt": "2019-08-24T14:15:22Z",
  • "bundleItems": [
    ],
  • "customFields": [
    ],
  • "published": [
    ],
  • "inventoryNotTracked": true,
  • "hideInStore": true,
  • "mappedProduct": {
    },
  • "sourceDoc": {
    },
  • "internal": {
    }
}

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Purchases

Operations about Purchase Orders

Purchase Model

extOrderId
required
string

External Purchase Order ID

actualArrivalDate
string <date-time>

Actual Arrival Date (from most recent Arrival)

object (Address)
Array of objects or null (PurchaseCosts)

Purchase costs

createdAt
string <date-time>

When the object was created within Pipe17

currency
string

Order currency code

Array of objects (NameValue)

Custom Fields

employeeName
string

Purchase order created by

Array of objects (ExceptionRef)

References to exceptions related to the purchase

expectedArrivalDate
string <date-time>

Expected Arrival Date

incoterms
string

International Commercial Terms

integration
string

Reference to integration that created an item

object (InternalInfo)

Internal info

Array of objects (PurchaseLineItem)
orgKey
string

Organization this object belong to

purchaseId
string

Purchase ID

purchaseNotes
string

Purchase Notes

purchaseOrderDate
string <date-time>

Purchase Order Date

purchaseTax
number <float>

Purchase Tax

referenceNumber
string

Purchase order reference number

shipByDate
string <date-time>

Ship By Date

shippingCarrier
string

Shipping Carrier

shippingNotes
string

Shipping Notes

shippingService
string

Shipping Service Type

object (SourceDoc)

Vendor source document

status
string (PurchaseStatus)
Enum: "archived" "canceled" "closed" "draft" "fulfilled" "inTransit" "new" "onHold" "partialFulfillment" "partialReceived" "readyForFulfillment" "received" "refunded" "returned" "reviewRequired" "sentToFulfillment" "toBeValidated"

Purchase Status

subTotalPrice
number <float>

Sub Total Price

timestamp
string <date-time>

General Purpose Time Stamp

object (Address)
toLocationId
string

Ship to location ID

totalPrice
number <float>

Total Price

updatedAt
string <date-time>

When the object was updated within Pipe17

object (Address)
{
  • "purchaseId": "string",
  • "integration": "string",
  • "exceptions": [
    ],
  • "status": "archived",
  • "extOrderId": "string",
  • "purchaseOrderDate": "2019-08-24T14:15:22Z",
  • "lineItems": [
    ],
  • "currency": "string",
  • "subTotalPrice": 0,
  • "purchaseTax": 0,
  • "costs": [
    ],
  • "totalPrice": 0,
  • "employeeName": "string",
  • "purchaseNotes": "string",
  • "vendorAddress": {
    },
  • "toAddress": {
    },
  • "toLocationId": "string",
  • "shippingCarrier": "string",
  • "shippingService": "string",
  • "shipByDate": "2019-08-24T14:15:22Z",
  • "actualArrivalDate": "2019-08-24T14:15:22Z",
  • "expectedArrivalDate": "2019-08-24T14:15:22Z",
  • "shippingNotes": "string",
  • "incoterms": "string",
  • "billingAddress": {
    },
  • "referenceNumber": "string",
  • "customFields": [
    ],
  • "timestamp": "2019-08-24T14:15:22Z",
  • "sourceDoc": {
    },
  • "internal": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "orgKey": "string"
}

Create Purchases

Uniqueness constraints within organization:

  • purchase.extOrderId
Authorizations:
Pipe17KeyAuth
Request Body schema:
Array (<= 10 items)
extOrderId
required
string

External Purchase Order ID

actualArrivalDate
string <date-time>

Actual Arrival Date (from most recent Arrival)

object (Address)
Array of objects or null (PurchaseCosts)

Purchase costs

currency
string

Order currency code

Array of objects (NameValue)

Custom Fields

employeeName
string

Purchase order created by

expectedArrivalDate
string <date-time>

Expected Arrival Date

incoterms
string

International Commercial Terms

object (InternalInfo)

Internal info

Array of objects (PurchaseLineItem)
purchaseNotes
string

Purchase Notes

purchaseOrderDate
string <date-time>

Purchase Order Date

purchaseTax
number <float>

Purchase Tax

referenceNumber
string

Purchase order reference number

shipByDate
string <date-time>

Ship By Date

shippingCarrier
string

Shipping Carrier

shippingNotes
string

Shipping Notes

shippingService
string

Shipping Service Type

object (SourceDoc)

Vendor source document

status
string (PurchaseStatus)
Enum: "archived" "canceled" "closed" "draft" "fulfilled" "inTransit" "new" "onHold" "partialFulfillment" "partialReceived" "readyForFulfillment" "received" "refunded" "returned" "reviewRequired" "sentToFulfillment" "toBeValidated"

Purchase Status

subTotalPrice
number <float>

Sub Total Price

timestamp
string <date-time>

General Purpose Time Stamp

object (Address)
toLocationId
string

Ship to location ID

totalPrice
number <float>

Total Price

object (Address)

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "purchases": [
    ]
}

Delete Multiple Purchases

Authorizations:
Pipe17KeyAuth
query Parameters
action
string (ListDeleteAction)
Default: "list"
Enum: "hard" "list" "soft"

Soft/hard delete or list purchases to be deleted

count
integer <int32>
Default: 100

Delete at most this many purchases

deleted
boolean

Delete soft deleted purchaases

extOrderId
Array of strings

Delete purchases by list of external purchase IDs

integration
Array of strings

Delete purchases of these integrations

orgMode
Array of strings (OrganizationMode)
Items Enum: "demo" "production" "test"

Delete purchases assigned these orgModes.

pagination
string
Value: "disabled"

Exclude pagination info from the response

purchaseId
Array of strings

Delete purchases by list of purchaseId

since
string <date-time>

Delete purchases created after this date-time

skip
integer <int32>
Default: 0

Skip this many purchases

status
Array of strings (PurchaseStatus)
Items Enum: "archived" "canceled" "closed" "draft" "fulfilled" "inTransit" "new" "onHold" "partialFulfillment" "partialReceived" "readyForFulfillment" "received" "refunded" "returned" "reviewRequired" "sentToFulfillment" "toBeValidated"

Delete purchases by list of statuses

until
string <date-time>

Delete purchases created before this date-time

updatedSince
string <date-time>

Delete purchases updated after this date-time

updatedUntil
string <date-time>

Delete purchases updated before this date-time

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "filters": {
    },
  • "purchases": [
    ],
  • "deleted": 0,
  • "pagination": {
    }
}

Delete Purchase

Authorizations:
Pipe17KeyAuth
path Parameters
PurchaseId
required
string

Id or ext:{extOrderId} of purchase order to delete

query Parameters
action
string (DeleteAction)
Enum: "hard" "soft"

Delete purchase permanently or not

nested
boolean

Delete nested entities

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Fetch Purchase

Authorizations:
Pipe17KeyAuth
path Parameters
PurchaseId
required
string

Id or ext:{extOrderId} of purchase order to fetch

query Parameters
sourceDocVersion
number

Fetch specific vendor source doc version if available

withSourceDoc
boolean

Include vendor source doc if available

withSourceDocVersions
boolean

Include available vendor source doc versions

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "purchase": {
    }
}

List Purchases

Authorizations:
Pipe17KeyAuth
query Parameters
count
integer <int32>
Default: 100

Return at most this many purchases

deleted
boolean

Retrieve soft deleted purchaases

exceptionCategoryId
Array of strings

Retrieve purchases by list of categories of the purchase related exceptions

exceptionType
Array of strings (ExceptionType)
Items Enum: "eApprovalRequired" "eAutomation" "eAutomationCodeActionError" "eAutomationCodeFilterError" "eCreditMemoInsufficient" "eDelayed" "eDuplicate" "eDuplicateSKU" "eEarly" "eFraudSuspected" "eGeneric" "eIncomplete" "eIncompleteAddress" "eInvalid" "eInvalidAddress" "eInvalidDate" "eInvalidLocation" "eInvalidMethod" "eInvalidSKU" "eInventoryOutOfStock" "eLarge" "eLate" "eLateCancel" "eLost" "eLow" "eMismatch" "eMismatchTax" "eMissing" "eMissingLocation" "eMissingSKU" "eOrderSyncFailure" "eOrderTaxMismatch" "eOutOfStock" "ePartiallyCanceled" "ePaymentRequired" "ePotentialOverfulfill" "eRestock" "eRouteNotFound" "eRouteOutOfStock" "eShipmentMismatch" "eShippingMethod" "eSplit" "eStuck" "eSyncFailure" "eToday" "eTransform" "eUnacknowledged" "eUnexpected" "eUnexpectedDate" "eUnexpectedSplitShipment" "eUnfulfillable"

Retrieve purchases by list of types of the purchase related exceptions

extOrderId
Array of strings

Retrieve by list of external purchase IDs

hasSourceDoc
boolean

Retrieve purchases containing a source document

keys
string
Default: "purchaseId,extOrderId,referenceNumber,vendorAddress,expectedArrivalDate,shipByDate,toLocationId,totalPrice,status,createdAt,updatedAt,orgKey"

Return these top-level fields

order
string
Default: "createdAt"

Sort by these top-level fields

pagination
string
Value: "disabled"

Exclude pagination info from the response

purchaseId
Array of strings

Retrieve by list of purchaseId

since
string <date-time>

Retrieve all purchases created after this date-time

skip
integer <int32>
Default: 0

Skip this many purchases

status
Array of strings (PurchaseStatus)
Items Enum: "archived" "canceled" "closed" "draft" "fulfilled" "inTransit" "new" "onHold" "partialFulfillment" "partialReceived" "readyForFulfillment" "received" "refunded" "returned" "reviewRequired" "sentToFulfillment" "toBeValidated"

Retrieve by list of statuses

timestamp
boolean

if set to true use timestamp instead of create time

toLocationId
Array of strings

Retrieve by list of toLocationId

until
string <date-time>

Retrieve all purchases created before this date-time

updatedSince
string <date-time>

Retrieve all purchases updated after this date-time

updatedUntil
string <date-time>

Retrieve all purchases updated before this date-time

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "filters": {
    },
  • "purchases": [
    ],
  • "pagination": {
    }
}

Sync Purchases

Trigger the purchases sync

Authorizations:
Pipe17KeyAuth
path Parameters
PurchaseId
required
Array of strings
Request Body schema:
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Update Purchase

Uniqueness constraints within organization:

  • purchase.extOrderId
Authorizations:
Pipe17KeyAuth
path Parameters
PurchaseId
required
string

Id or ext:{extOrderId} of purchase order to update

Request Body schema:
actualArrivalDate
string or null <date-time>

Actual Arrival Date (from most recent Arrival)

object (AddressUpdateData)
Array of objects or null (PurchaseCosts)

Purchase costs

currency
string

Order currency code

Array of objects (NameValue)

Custom Fields

employeeName
string or null

Purchase order created by

expectedArrivalDate
string or null <date-time>

Expected Arrival Date

object (InternalInfo)

Internal info

Array of objects (PurchaseUpdateLineItem)
purchaseNotes
string or null

Purchase Notes

purchaseTax
number or null <float>

Purchase Tax

referenceNumber
string or null

Purchase order reference number

shipByDate
string or null <date-time>

Ship By Date

shippingCarrier
string or null

Shipping Carrier

shippingNotes
string or null

Shipping Notes

shippingService
string or null

Shipping Service Type

object (SourceDoc)

Vendor source document

status
string (PurchaseStatus)
Enum: "archived" "canceled" "closed" "draft" "fulfilled" "inTransit" "new" "onHold" "partialFulfillment" "partialReceived" "readyForFulfillment" "received" "refunded" "returned" "reviewRequired" "sentToFulfillment" "toBeValidated"

Purchase Status

subTotalPrice
number or null <float>

Sub Total Price

timestamp
string or null <date-time>

General Purpose Time Stamp

object or null (AddressNullable)
toLocationId
string or null

Ship to location ID

totalPrice
number or null <float>

Total Price

object (AddressUpdateData)

Responses

Request samples

Content type
{
  • "status": "archived",
  • "lineItems": [
    ],
  • "currency": "string",
  • "subTotalPrice": 0,
  • "purchaseTax": 0,
  • "totalPrice": 0,
  • "costs": [
    ],
  • "employeeName": "string",
  • "purchaseNotes": "string",
  • "vendorAddress": {
    },
  • "toAddress": {
    },
  • "toLocationId": "string",
  • "shippingCarrier": "string",
  • "shippingService": "string",
  • "shipByDate": "2019-08-24T14:15:22Z",
  • "actualArrivalDate": "2019-08-24T14:15:22Z",
  • "expectedArrivalDate": "2019-08-24T14:15:22Z",
  • "shippingNotes": "string",
  • "billingAddress": {
    },
  • "referenceNumber": "string",
  • "customFields": [
    ],
  • "timestamp": "2019-08-24T14:15:22Z",
  • "sourceDoc": {
    },
  • "internal": {
    }
}

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Receipts

Operations about Receipts

Receipt Model

arrivalId
required
string

Arrival ID

actualArrivalDate
string <date-time>

Actual arrival date

createdAt
string <date-time>

When the object was created within Pipe17

currency
string

Currency

Array of objects (NameValue)

Custom Fields

Array of objects (ExceptionRef)

References to exceptions related to the receipt

extOrderId
string

External Order ID

extReceiptId
string

Reference to receipt on external system (vendor)

integration
string

Reference to integration that created an item

object (InternalInfo)

Internal info

Array of objects (ReceiptItemWithRefs)
orgKey
string

Organization this object belong to

receiptId
string

Receipt ID

shippingCarrier
string

Shipping Carrier

shippingClass
string

Shipping Carrier

object (SourceDoc)

Vendor source document

updatedAt
string <date-time>

When the object was updated within Pipe17

{
  • "receiptId": "string",
  • "extOrderId": "string",
  • "integration": "string",
  • "lineItems": [
    ],
  • "exceptions": [
    ],
  • "arrivalId": "string",
  • "shippingCarrier": "string",
  • "shippingClass": "string",
  • "currency": "string",
  • "actualArrivalDate": "2019-08-24T14:15:22Z",
  • "extReceiptId": "string",
  • "customFields": [
    ],
  • "sourceDoc": {
    },
  • "internal": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "orgKey": "string"
}

Create Arrival Receipts

Uniqueness constraints within organization:

  • receipt.extReceiptId (when defined)
Authorizations:
Pipe17KeyAuth
Request Body schema:
Array (<= 10 items)
arrivalId
required
string

Arrival ID

actualArrivalDate
string <date-time>

Actual arrival date

currency
string

Currency

Array of objects (NameValue)

Custom Fields

extReceiptId
string

Reference to receipt on external system (vendor)

object (InternalInfo)

Internal info

Array of objects (ReceiptItem)
shippingCarrier
string

Shipping Carrier

shippingClass
string

Shipping Carrier

object (SourceDoc)

Vendor source document

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "receipts": [
    ]
}

Fetch Receipt

Authorizations:
Pipe17KeyAuth
path Parameters
ReceiptId
required
string

Id or ext:{extReceiptId} of receipt to fetch

query Parameters
sourceDocVersion
number

Fetch specific vendor source doc version if available

withSourceDoc
boolean

Include vendor source doc if available

withSourceDocVersions
boolean

Include available vendor source doc versions

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "receipt": {
    }
}

List Receipts

Authorizations:
Pipe17KeyAuth
query Parameters
arrivalId
Array of strings

Receipts by list of arrivalId

count
integer <int32>
Default: 100

Return at most this many receipts

exceptionCategoryId
Array of strings

Receipts by list of categories of the receipt related exceptions

exceptionType
Array of strings (ExceptionType)
Items Enum: "eApprovalRequired" "eAutomation" "eAutomationCodeActionError" "eAutomationCodeFilterError" "eCreditMemoInsufficient" "eDelayed" "eDuplicate" "eDuplicateSKU" "eEarly" "eFraudSuspected" "eGeneric" "eIncomplete" "eIncompleteAddress" "eInvalid" "eInvalidAddress" "eInvalidDate" "eInvalidLocation" "eInvalidMethod" "eInvalidSKU" "eInventoryOutOfStock" "eLarge" "eLate" "eLateCancel" "eLost" "eLow" "eMismatch" "eMismatchTax" "eMissing" "eMissingLocation" "eMissingSKU" "eOrderSyncFailure" "eOrderTaxMismatch" "eOutOfStock" "ePartiallyCanceled" "ePaymentRequired" "ePotentialOverfulfill" "eRestock" "eRouteNotFound" "eRouteOutOfStock" "eShipmentMismatch" "eShippingMethod" "eSplit" "eStuck" "eSyncFailure" "eToday" "eTransform" "eUnacknowledged" "eUnexpected" "eUnexpectedDate" "eUnexpectedSplitShipment" "eUnfulfillable"

Receipts by list of types of the receipt related exceptions

extOrderId
Array of strings

Receipts by list of extOrderId

hasSourceDoc
boolean

Receipts containing a source document

keys
string
Default: "receiptId,arrivalId,extOrderId,actualArrivalDate,createdAt,updatedAt,orgKey"

Return these top-level fields

order
string
Default: "createdAt"

Sort by these top-level fields

pagination
string
Value: "disabled"

Exclude pagination info from the response

receiptId
Array of strings

Receipts by list of receiptId

since
string <date-time>

Receipts created after this date-time

skip
integer <int32>
Default: 0

Skip this many receipts

until
string <date-time>

Receipts created before this date-time

updatedSince
string <date-time>

Receipts updated after this date-time

updatedUntil
string <date-time>

Receipts updated before this date-time

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "filters": {
    },
  • "receipts": [
    ],
  • "pagination": {
    }
}

Sync Receipts

Trigger the receipts sync

Authorizations:
Pipe17KeyAuth
path Parameters
ReceiptId
required
Array of strings
Request Body schema:
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Refunds

Operations about Refunds

Refund Model

returnId
required
string

Return ID

type
required
string (RefundType)
Enum: "refund" "voucher"

Refund type

amount
number <float>

Refund amount

createdAt
string <date-time>

When the object was created within Pipe17

creditIssued
number <float>

Credit issued to customer

creditSpent
number <float>

Credit spent by customer

currency
string

Refund currency

customerInvoiceAmount
number <float>

Customer invoice amount

Array of objects (NameValue)

Custom Fields

extOrderId
string

Order ID on external system

extRefundId
string

Refund ID on external system

integration
string

Reference to integration that created an item

object (InternalInfo)

Internal info

merchantInvoiceAmount
number <float>

Merchant invoice amount

orgKey
string

Organization this object belong to

refundId
string

Refund ID

object (SourceDoc)

Vendor source document

status
string (RefundStatus)
Enum: "pending" "settled"

Refund status

updatedAt
string <date-time>

When the object was updated within Pipe17

{
  • "refundId": "string",
  • "integration": "string",
  • "returnId": "string",
  • "extRefundId": "string",
  • "extOrderId": "string",
  • "type": "refund",
  • "status": "pending",
  • "currency": "string",
  • "amount": 0,
  • "creditIssued": 0,
  • "creditSpent": 0,
  • "merchantInvoiceAmount": 0,
  • "customerInvoiceAmount": 0,
  • "customFields": [
    ],
  • "sourceDoc": {
    },
  • "internal": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "orgKey": "string"
}

Create Refund

Uniqueness constraints within organization:

  • refund.extRefundId (when defined)
Authorizations:
Pipe17KeyAuth
Request Body schema:
returnId
required
string

Return ID

type
required
string (RefundType)
Enum: "refund" "voucher"

Refund type

amount
number <float>

Refund amount

creditIssued
number <float>

Credit issued to customer

creditSpent
number <float>

Credit spent by customer

currency
string

Refund currency

customerInvoiceAmount
number <float>

Customer invoice amount

Array of objects (NameValue)

Custom Fields

extOrderId
string

Order ID on external system

extRefundId
string

Refund ID on external system

object (InternalInfo)

Internal info

merchantInvoiceAmount
number <float>

Merchant invoice amount

object (SourceDoc)

Vendor source document

status
string (RefundStatus)
Enum: "pending" "settled"

Refund status

Responses

Request samples

Content type
{
  • "returnId": "string",
  • "extRefundId": "string",
  • "extOrderId": "string",
  • "type": "refund",
  • "status": "pending",
  • "currency": "string",
  • "amount": 0,
  • "creditIssued": 0,
  • "creditSpent": 0,
  • "merchantInvoiceAmount": 0,
  • "customerInvoiceAmount": 0,
  • "customFields": [
    ],
  • "sourceDoc": {
    },
  • "internal": {
    }
}

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "refund": {
    }
}

Delete Multiple Refunds

Authorizations:
Pipe17KeyAuth
query Parameters
action
string (ListDeleteAction)
Default: "list"
Enum: "hard" "list" "soft"

Soft/hard delete or list refunds to be deleted

count
integer <int32>
Default: 100

Delete at most this many refunds

deleted
boolean

Delete soft deleted refunds

extOrderId
Array of strings

Delete refunds by list of external order ids

extRefundId
Array of strings

Delete refunds by list of external refund ids

extReturnId
Array of strings

Delete refunds by list of external return ids

integration
Array of strings

Delete refunds of these integrations

orgMode
Array of strings (OrganizationMode)
Items Enum: "demo" "production" "test"

Delete refunds assigned these orgModes.

pagination
string
Value: "disabled"

Exclude pagination info from the response

refundId
Array of strings

Delete by list of refundId

since
string <date-time>

Delete refunds created after this date-time

skip
integer <int32>
Default: 0

Skip this many refunds

status
Array of strings (RefundStatus)
Items Enum: "pending" "settled"
type
Array of strings (RefundType)
Items Enum: "refund" "voucher"
until
string <date-time>

Delete refunds created before this date-time

updatedSince
string <date-time>

Delete refunds updated after this date-time

updatedUntil
string <date-time>

Delete refunds updated before this date-time

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "filters": {
    },
  • "refunds": [
    ],
  • "deleted": 0,
  • "pagination": {
    }
}

Delete Refund

Authorizations:
Pipe17KeyAuth
path Parameters
RefundId
required
string

Id or ext:{extRefundId} of refund to delete

query Parameters
action
string (DeleteAction)
Enum: "hard" "soft"

Delete refund permanently or not

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Fetch Refund

Authorizations:
Pipe17KeyAuth
path Parameters
RefundId
required
string

Id or ext:{extRefundId} of refund to fetch

query Parameters
sourceDocVersion
number

Fetch specific vendor source doc version if available

withSourceDoc
boolean

Include vendor source doc if available

withSourceDocVersions
boolean

Include available vendor source doc versions

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "refund": {
    }
}

List Refunds

Authorizations:
Pipe17KeyAuth
query Parameters
count
integer <int32>
Default: 100

Return at most this many refunds

deleted
boolean

Retrieve soft deleted refunds

extOrderId
Array of strings

Retrieve refunds by list of external order ids

extRefundId
Array of strings

Retrieve refunds by list of external refund ids

extReturnId
Array of strings

Retrieve refunds by list of external return ids

hasSourceDoc
boolean

Retrieve refunds containing a source document

keys
string
Default: "refundId,extRefundId,status,createdAt,updatedAt,orgKey"

Return these top-level fields

order
string
Default: "createdAt"

Sort by these top-level fields

pagination
string
Value: "disabled"

Exclude pagination info from the response

refundId
Array of strings

Retrieve by list of refundId

returnId
Array of strings

Retrieve refunds by list of return ids

since
string <date-time>

Refunds created after this date-time

skip
integer <int32>
Default: 0

Skip this many refunds

status
Array of strings (RefundStatus)
Items Enum: "pending" "settled"
type
Array of strings (RefundType)
Items Enum: "refund" "voucher"
until
string <date-time>

Refunds created before this date-time

updatedSince
string <date-time>

Refunds updated after this date-time

updatedUntil
string <date-time>

Refunds updated before this date-time

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "filters": {
    },
  • "refunds": [
    ],
  • "pagination": {
    }
}

Sync Refunds

Trigger the refunds sync

Authorizations:
Pipe17KeyAuth
path Parameters
RefundId
required
Array of strings
Request Body schema:
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Update Refund

Uniqueness constraints within organization:

  • refund.extRefundId (when defined)
Authorizations:
Pipe17KeyAuth
path Parameters
RefundId
required
string

Id or ext:{extRefundId} of refund to update

Request Body schema:
amount
number <float>

Refund amount

creditIssued
number <float>

Credit issued to customer

creditSpent
number <float>

Credit spent by customer

customerInvoiceAmount
number <float>

Customer invoice amount

Array of objects (NameValue)

Custom Fields

object (InternalInfo)

Internal info

merchantInvoiceAmount
number <float>

Merchant invoice amount

object (SourceDoc)

Vendor source document

status
string (RefundStatus)
Enum: "pending" "settled"

Refund status

Responses

Request samples

Content type
{
  • "status": "pending",
  • "amount": 0,
  • "creditIssued": 0,
  • "creditSpent": 0,
  • "merchantInvoiceAmount": 0,
  • "customerInvoiceAmount": 0,
  • "customFields": [
    ],
  • "sourceDoc": {
    },
  • "internal": {
    }
}

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Returns

Operations about Returns

Return Model

arrivedAt
string <date-time>
completedAt
string <date-time>
createdAt
string <date-time>

When the object was created within Pipe17

currency
string

Currency value, e.g. 'USD'

customerNotes
string

Customer notes

Array of objects (NameValue)

Custom Fields

discount
number <float>
estimatedTotal
number <float>
Array of objects (ExceptionRef)

References to exceptions related to the return

expectedArrivalDate
string <date-time>

Expected arrival date

extReferenceId
string
extReferenceUrl
string
extReturnId
string

Return ID on external system

fulfillmentIntegrationId
string

fulfillment integration Id

integration
string

Reference to integration that created an item

object (InternalInfo)

Internal info

isExchange
boolean
isGift
boolean
Array of objects (ReturnLineItem)
locationId
string

Destination location Id

notes
string

Merchant notes

orgKey
string

Organization this object belong to

Array of objects (ReturnReceipt)
refundedAt
string <date-time>
requiresShipping
boolean
restockingFee
number <float>
returnId
string

Return ID

object (Address)
shippingCarrier
string

shipping carrier

shippingLabelFee
number <float>
shippingPrice
number <float>
shippingQuote
number <float>
shippingRefund
number <float>
shippingService
string

shipping service

object (SourceDoc)

Vendor source document

status
string
Enum: "accepted" "authorized" "canceled" "completed" "deleted" "draft" "expected" "expired" "failed" "partialReceived" "received" "refunded" "shipped"

Return status

subTotal
number <float>
tax
number <float>
total
number <float>
trackingNumber
string

Tracking number

updatedAt
string <date-time>

When the object was updated within Pipe17

{
  • "returnId": "string",
  • "integration": "string",
  • "status": "accepted",
  • "extReferenceId": "string",
  • "extReferenceUrl": "string",
  • "receipts": [
    ],
  • "exceptions": [
    ],
  • "extReturnId": "string",
  • "lineItems": [
    ],
  • "locationId": "string",
  • "fulfillmentIntegrationId": "string",
  • "trackingNumber": "string",
  • "shippingCarrier": "string",
  • "shippingService": "string",
  • "expectedArrivalDate": "2019-08-24T14:15:22Z",
  • "shippingAddress": {
    },
  • "currency": "string",
  • "customerNotes": "string",
  • "notes": "string",
  • "tax": 0,
  • "discount": 0,
  • "subTotal": 0,
  • "total": 0,
  • "shippingPrice": 0,
  • "shippingRefund": 0,
  • "shippingQuote": 0,
  • "shippingLabelFee": 0,
  • "restockingFee": 0,
  • "estimatedTotal": 0,
  • "isExchange": true,
  • "isGift": true,
  • "requiresShipping": true,
  • "arrivedAt": "2019-08-24T14:15:22Z",
  • "completedAt": "2019-08-24T14:15:22Z",
  • "refundedAt": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "sourceDoc": {
    },
  • "internal": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "orgKey": "string"
}

Create Return

Uniqueness constraints within organization:

  • refund.extReturnId (when defined)
Authorizations:
Pipe17KeyAuth
Request Body schema:
arrivedAt
string <date-time>
completedAt
string <date-time>
currency
string

Currency value, e.g. 'USD'

customerNotes
string

Customer notes

Array of objects (NameValue)

Custom Fields

discount
number <float>
estimatedTotal
number <float>
expectedArrivalDate
string <date-time>

Expected arrival date

extReturnId
string

Return ID on external system

fulfillmentIntegrationId
string

fulfillment integration Id

object (InternalInfo)

Internal info

isExchange
boolean
isGift
boolean
Array of objects (ReturnLineItem)
locationId
string

Destination location Id

notes
string

Merchant notes

refundedAt
string <date-time>
requiresShipping
boolean
restockingFee
number <float>
object (Address)
shippingCarrier
string

shipping carrier

shippingLabelFee
number <float>
shippingPrice
number <float>
shippingQuote
number <float>
shippingRefund
number <float>
shippingService
string

shipping service

object (SourceDoc)

Vendor source document

status
string (ReturnStatus)
Enum: "accepted" "authorized" "canceled" "completed" "deleted" "draft" "expected" "expired" "failed" "partialReceived" "received" "refunded" "shipped"

Return status

subTotal
number <float>
tax
number <float>
total
number <float>
trackingNumber
string

Tracking number

Responses

Request samples

Content type
{
  • "extReturnId": "string",
  • "status": "accepted",
  • "lineItems": [
    ],
  • "locationId": "string",
  • "fulfillmentIntegrationId": "string",
  • "trackingNumber": "string",
  • "shippingCarrier": "string",
  • "shippingService": "string",
  • "expectedArrivalDate": "2019-08-24T14:15:22Z",
  • "shippingAddress": {
    },
  • "currency": "string",
  • "customerNotes": "string",
  • "notes": "string",
  • "tax": 0,
  • "discount": 0,
  • "subTotal": 0,
  • "total": 0,
  • "shippingPrice": 0,
  • "shippingRefund": 0,
  • "shippingQuote": 0,
  • "shippingLabelFee": 0,
  • "restockingFee": 0,
  • "estimatedTotal": 0,
  • "isExchange": true,
  • "isGift": true,
  • "requiresShipping": true,
  • "arrivedAt": "2019-08-24T14:15:22Z",
  • "completedAt": "2019-08-24T14:15:22Z",
  • "refundedAt": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "sourceDoc": {
    },
  • "internal": {
    }
}

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "return": {
    }
}

Delete Multiple Returns

Authorizations:
Pipe17KeyAuth
query Parameters
action
string (ListDeleteAction)
Default: "list"
Enum: "hard" "list" "soft"

Soft/hard delete or list returns to be deleted

count
integer <int32>
Default: 100

Delete at most this many returns

deleted
boolean

Delete soft deleted returns

extReturnId
Array of strings

Delete returns by list of external return ids

integration
Array of strings

Delete returns of these integrations

orgMode
Array of strings (OrganizationMode)
Items Enum: "demo" "production" "test"

Delete returns assigned these orgModes.

pagination
string
Value: "disabled"

Exclude pagination info from the response

returnId
Array of strings

Delete returns by list of returnId

since
string <date-time>

Delete returns created after this date-time

skip
integer <int32>
Default: 0

Skip this many returns

status
Array of strings (ReturnStatus)
Items Enum: "accepted" "authorized" "canceled" "completed" "deleted" "draft" "expected" "expired" "failed" "partialReceived" "received" "refunded" "shipped"
until
string <date-time>

Delete returns created before this date-time

updatedSince
string <date-time>

Delete returns updated after this date-time

updatedUntil
string <date-time>

Delete returns updated before this date-time

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "filters": {
    },
  • "returns": [
    ],
  • "deleted": 0,
  • "pagination": {
    }
}

Delete Return

Authorizations:
Pipe17KeyAuth
path Parameters
ReturnId
required
string

Id or ext:{extReturnId} of return to delete

query Parameters
action
string (DeleteAction)
Enum: "hard" "soft"

Delete return permanently or not

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Fetch Return

Authorizations:
Pipe17KeyAuth
path Parameters
ReturnId
required
string

Id or ext:{extReturnId} of return to fetch

query Parameters
sourceDocVersion
number

Fetch specific vendor source doc version if available

withSourceDoc
boolean

Include vendor source doc if available

withSourceDocVersions
boolean

Include available vendor source doc versions

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "return": {
    }
}

List Returns

Authorizations:
Pipe17KeyAuth
query Parameters
count
integer <int32>
Default: 100

Return at most this many returns

deleted
boolean

Retrieve soft deleted returns

exceptionCategoryId
Array of strings

Retrieve returns by list of categories of the return related exceptions

exceptionType
Array of strings (ExceptionType)
Items Enum: "eApprovalRequired" "eAutomation" "eAutomationCodeActionError" "eAutomationCodeFilterError" "eCreditMemoInsufficient" "eDelayed" "eDuplicate" "eDuplicateSKU" "eEarly" "eFraudSuspected" "eGeneric" "eIncomplete" "eIncompleteAddress" "eInvalid" "eInvalidAddress" "eInvalidDate" "eInvalidLocation" "eInvalidMethod" "eInvalidSKU" "eInventoryOutOfStock" "eLarge" "eLate" "eLateCancel" "eLost" "eLow" "eMismatch" "eMismatchTax" "eMissing" "eMissingLocation" "eMissingSKU" "eOrderSyncFailure" "eOrderTaxMismatch" "eOutOfStock" "ePartiallyCanceled" "ePaymentRequired" "ePotentialOverfulfill" "eRestock" "eRouteNotFound" "eRouteOutOfStock" "eShipmentMismatch" "eShippingMethod" "eSplit" "eStuck" "eSyncFailure" "eToday" "eTransform" "eUnacknowledged" "eUnexpected" "eUnexpectedDate" "eUnexpectedSplitShipment" "eUnfulfillable"

Retrieve returns by list of types of the return related exceptions

extOrderId
Array of strings

Retrieve returns by list of external order ids

extReturnId
Array of strings

Retrieve returns by list of external return ids

hasSourceDoc
boolean

Retrieve returns containing a source document

keys
string
Default: "returnId,extReturnId,status,createdAt,updatedAt,orgKey"

Return these top-level fields

locationId
Array of strings

Retrieve returns by list of location ids

order
string
Default: "createdAt"

Sort by these top-level fields

pagination
string
Value: "disabled"

Exclude pagination info from the response

returnId
Array of strings

Retrieve by list of returnId

since
string <date-time>

Returns created after this date-time

skip
integer <int32>
Default: 0

Skip this many returns

status
Array of strings (ReturnStatus)
Items Enum: "accepted" "authorized" "canceled" "completed" "deleted" "draft" "expected" "expired" "failed" "partialReceived" "received" "refunded" "shipped"
until
string <date-time>

Returns created before this date-time

updatedSince
string <date-time>

Returns updated after this date-time

updatedUntil
string <date-time>

Returns updated before this date-time

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "filters": {
    },
  • "returns": [
    ],
  • "pagination": {
    }
}

Sync Returns

Trigger the returns sync

Authorizations:
Pipe17KeyAuth
path Parameters
ReturnId
required
Array of strings
Request Body schema:
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Update Return

Uniqueness constraints within organization:

  • refund.extReturnId (when defined)
Authorizations:
Pipe17KeyAuth
path Parameters
ReturnId
required
string

Id or ext:{extReturnId} of return to update

Request Body schema:
arrivedAt
string <date-time>
completedAt
string <date-time>
currency
string

Currency value, e.g. 'USD'

customerNotes
string

Customer notes

Array of objects (NameValue)

Custom Fields

discount
number <float>
estimatedTotal
number <float>
expectedArrivalDate
string <date-time>

Expected arrival date

extReferenceId
string
extReferenceUrl
string
fulfillmentIntegrationId
string

fulfillment integration Id

object (InternalInfo)

Internal info

isExchange
boolean
isGift
boolean
Array of objects (ReturnLineItem)
locationId
string

Destination location Id

notes
string

Merchant notes

Array of objects (ReturnReceipt)
refundedAt
string <date-time>
requiresShipping
boolean
restockingFee
number <float>
object (Address)
shippingCarrier
string

shipping carrier

shippingLabelFee
number <float>
shippingPrice
number <float>
shippingQuote
number <float>
shippingRefund
number <float>
shippingService
string

shipping service

object (SourceDoc)

Vendor source document

status
string (ReturnStatus)
Enum: "accepted" "authorized" "canceled" "completed" "deleted" "draft" "expected" "expired" "failed" "partialReceived" "received" "refunded" "shipped"

Return status

subTotal
number <float>
tax
number <float>
total
number <float>
trackingNumber
string

Tracking number

Responses

Request samples

Content type
{
  • "status": "accepted",
  • "extReferenceId": "string",
  • "extReferenceUrl": "string",
  • "lineItems": [
    ],
  • "locationId": "string",
  • "fulfillmentIntegrationId": "string",
  • "trackingNumber": "string",
  • "shippingCarrier": "string",
  • "shippingService": "string",
  • "expectedArrivalDate": "2019-08-24T14:15:22Z",
  • "shippingAddress": {
    },
  • "currency": "string",
  • "customerNotes": "string",
  • "notes": "string",
  • "tax": 0,
  • "discount": 0,
  • "subTotal": 0,
  • "total": 0,
  • "shippingPrice": 0,
  • "shippingRefund": 0,
  • "shippingQuote": 0,
  • "shippingLabelFee": 0,
  • "restockingFee": 0,
  • "estimatedTotal": 0,
  • "isExchange": true,
  • "isGift": true,
  • "requiresShipping": true,
  • "arrivedAt": "2019-08-24T14:15:22Z",
  • "completedAt": "2019-08-24T14:15:22Z",
  • "refundedAt": "2019-08-24T14:15:22Z",
  • "receipts": [
    ],
  • "customFields": [
    ],
  • "sourceDoc": {
    },
  • "internal": {
    }
}

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Routings

Operations about Routings

Routing Model

description
required
string

Description

enabled
required
boolean

Is Routing Filter Enabled

filter
required
string

Routing Filter

isPublic
required
boolean

Public Routing

createdAt
string <date-time>

When the object was created within Pipe17

object (InternalInfo)

Internal info

orgKey
string

Organization this object belong to

routingId
string

Routing ID

updatedAt
string <date-time>

When the object was updated within Pipe17

uuid
string

UUID

{
  • "routingId": "string",
  • "isPublic": true,
  • "description": "string",
  • "uuid": "string",
  • "enabled": true,
  • "filter": "string",
  • "internal": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "orgKey": "string"
}

Create Routing

Uniqueness constraints within organization:

  • routing.uuid
Authorizations:
Pipe17KeyAuth
Request Body schema:
description
required
string

Description

enabled
required
boolean

Is Routing Filter Enabled

filter
required
string

Routing Filter

isPublic
required
boolean

Public Routing

object (InternalInfo)

Internal info

uuid
string

UUID

Responses

Request samples

Content type
{
  • "isPublic": true,
  • "description": "string",
  • "uuid": "string",
  • "enabled": true,
  • "filter": "string",
  • "internal": {
    }
}

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "routing": {
    }
}

Delete Routing

Authorizations:
Pipe17KeyAuth
path Parameters
RoutingId
required
string

Id or uuid:{uuid} of routing to delete

query Parameters
action
string (DeleteAction)
Enum: "hard" "soft"

Delete routing permanently or not

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Delete Routings

Authorizations:
Pipe17KeyAuth
query Parameters
action
string (ListDeleteAction)
Default: "list"
Enum: "hard" "list" "soft"

Soft/hard delete or list items to be deleted

count
integer <int32>
Default: 100

Delete at most this many routings

deleted
boolean

Delete soft deleted routings

orgMode
Array of strings (OrganizationMode)
Items Enum: "demo" "production" "test"

Delete routings assigned these orgModes.

routingId
Array of strings

Delete routings by list of routingId

since
string <date-time>

Delete routings created after this date-time

skip
integer <int32>
Default: 0

Skip this many routings

until
string <date-time>

Delete routings created before this date-time

updatedSince
string <date-time>

Delete routings updated after this date-time

updatedUntil
string <date-time>

Delete routings updated before this date-time

uuid
Array of strings

Delete routings by list of UUIDs

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "filters": {
    },
  • "routings": [
    ],
  • "deleted": 0,
  • "pagination": {
    }
}

Fetch Routing

Authorizations:
Pipe17KeyAuth
path Parameters
RoutingId
required
string

Id or uuid:{uuid} of routing to fetch

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "routing": {
    }
}

List Routings

Authorizations:
Pipe17KeyAuth
query Parameters
count
integer <int32>
Default: 100

Return at most this many routings

deleted
boolean

Fetch soft deleted routings

desc
string

Fetch routings by description (strings "/{pattern}/" and "/{pattern}/i" are interpreted as regexps)

keys
string
Default: "routingId,uuid,description,createdAt,updatedAt,orgKey"

Return these top-level fields

order
string
Default: "createdAt"

Sort by these top-level fields

pagination
string
Value: "disabled"

Exclude pagination info from the response

routingId
Array of strings

Routings by list of routingId

since
string <date-time>

Routings created after this date-time

skip
integer <int32>
Default: 0

Skip this many routings

until
string <date-time>

Routings created before this date-time

updatedSince
string <date-time>

Routings updated after this date-time

updatedUntil
string <date-time>

Routings updated before this date-time

uuid
Array of strings

Routings by list of UUIDs

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "filters": {
    },
  • "routings": [
    ],
  • "pagination": {
    }
}

Sync Routings

Trigger the routings sync

Authorizations:
Pipe17KeyAuth
path Parameters
RoutingId
required
Array of strings
Request Body schema:
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Update Routing

Uniqueness constraints within organization:

  • routing.uuid
Authorizations:
Pipe17KeyAuth
path Parameters
RoutingId
required
string

Id or uuid:{uuid} of routing to update

Request Body schema:
description
string

Description

enabled
boolean

Is Routing Filter Enabled

filter
string or null

Routing Filter

object (InternalInfo)

Internal info

Responses

Request samples

Content type
{
  • "description": "string",
  • "enabled": true,
  • "filter": "string",
  • "internal": {
    }
}

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Shipment Boxes

Operations about Shipment Boxes

Shipment Box Model

extBoxId
required
string

External Box Id

billOfLading
string
boxId
string

Box Id

createdAt
string <date-time>

When the object was created within Pipe17

Array of objects or null (NameValue)

Custom Fields

dimensionsUnit
string
Enum: "cm" "ft" "in"

Dimensions UOM

height
number <float>

Height

object (InternalInfo)

Internal info

labelId
Array of strings

Label Ids

length
number <float>

Length

Array of objects (ShipmentBoxLineItem)
orgKey
string

Organization this object belong to

shipmentId
string

Shipment Id

ssccCode
string
status
string (ShipmentBoxStatus)
Enum: "labeled" "new" "packed" "reported" "shipped"

Box Status

ucc128
string
updatedAt
string <date-time>

When the object was updated within Pipe17

weight
number <float>

Weight

weightUnit
string
Enum: "g" "kg" "lb" "oz"

Weight UOM

width
number <float>

Width

{
  • "boxId": "string",
  • "extBoxId": "string",
  • "shipmentId": "string",
  • "labelId": [
    ],
  • "weight": 0,
  • "weightUnit": "g",
  • "height": 0,
  • "length": 0,
  • "width": 0,
  • "dimensionsUnit": "cm",
  • "lineItems": [
    ],
  • "customFields": [
    ],
  • "status": "labeled",
  • "internal": {
    },
  • "ssccCode": "string",
  • "ucc128": "string",
  • "billOfLading": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "orgKey": "string"
}

Create Shipment Box

Uniqueness constraints within organization:

  • box.extBoxId
Authorizations:
Pipe17KeyAuth
Request Body schema:
extBoxId
required
string

External Box Id

billOfLading
string
Array of objects or null (NameValue)

Custom Fields

dimensionsUnit
string
Enum: "cm" "ft" "in"

Dimensions UOM

height
number <float>

Height

object (InternalInfo)

Internal info

labelId
Array of strings

Label Ids

length
number <float>

Length

Array of objects (ShipmentBoxLineItem)
shipmentId
string

Shipment Id

ssccCode
string
status
string (ShipmentBoxStatus)
Enum: "labeled" "new" "packed" "reported" "shipped"

Box Status

ucc128
string
weight
number <float>

Weight

weightUnit
string
Enum: "g" "kg" "lb" "oz"

Weight UOM

width
number <float>

Width

Responses

Request samples

Content type
{
  • "extBoxId": "string",
  • "shipmentId": "string",
  • "labelId": [
    ],
  • "weight": 0,
  • "weightUnit": "g",
  • "height": 0,
  • "length": 0,
  • "width": 0,
  • "dimensionsUnit": "cm",
  • "lineItems": [
    ],
  • "customFields": [
    ],
  • "status": "labeled",
  • "internal": {
    },
  • "ssccCode": "string",
  • "ucc128": "string",
  • "billOfLading": "string"
}

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "box": {
    }
}

Delete Shipment Box

Authorizations:
Pipe17KeyAuth
path Parameters
BoxId
required
string

Box Id to delete

query Parameters
action
string (DeleteAction)
Enum: "hard" "soft"

Delete box permanently or not

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Fetch Shipment Box

Authorizations:
Pipe17KeyAuth
path Parameters
BoxId
required
string

Box Id to fetch

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "box": {
    }
}

List Shipment Boxes

Authorizations:
Pipe17KeyAuth
query Parameters
boxId
Array of strings

Retrieve by list of boxId

count
integer <int32>
Default: 100

Return at most this many shipment boxes

extBoxId
Array of strings

Retrieve shipment by list of extBoxId

keys
string
Default: "boxId,extBoxId,shipmentId,createdAt,updatedAt,orgKey,status"

Return these top-level fields

order
string
Default: "createdAt"

Sort by these top-level fields

pagination
string
Value: "disabled"

Exclude pagination info from the response

shipmentId
Array of strings

Retrieve shipment by list of shipmentId

since
string <date-time>

Shipment boxes created after this date-time

skip
integer <int32>
Default: 0

Skip this many shipment boxes

status
Array of strings (ShipmentBoxStatus)
Items Enum: "labeled" "new" "packed" "reported" "shipped"
until
string <date-time>

Shipment boxes created before this date-time

updatedSince
string <date-time>

Shipment boxes updated after this date-time

updatedUntil
string <date-time>

Shipment boxes updated before this date-time

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "filters": {
    },
  • "boxes": [
    ],
  • "pagination": {
    }
}

Sync Shipment Boxes

Trigger the shipment boxes sync

Authorizations:
Pipe17KeyAuth
path Parameters
BoxId
required
Array of strings
Request Body schema:
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Update Shipment Box

Uniqueness constraints within organization:

  • box.name, box.integration
Authorizations:
Pipe17KeyAuth
path Parameters
BoxId
required
string

Box Id to update

Request Body schema:
billOfLading
string
Array of objects or null (NameValue)

Custom Fields

dimensionsUnit
string
Enum: "cm" "ft" "in"

Dimensions UOM

height
number <float>

Height

object (InternalInfo)

Internal info

labelId
Array of strings

Label Ids

length
number <float>

Length

Array of objects (ShipmentBoxUpdateLineItem)
shipmentId
string

Shipment Id

ssccCode
string
status
string (ShipmentBoxStatus)
Enum: "labeled" "new" "packed" "reported" "shipped"

Box Status

ucc128
string
weight
number <float>

Weight

weightUnit
string
Enum: "g" "kg" "lb" "oz"

Weight UOM

width
number <float>

Width

Responses

Request samples

Content type
{
  • "shipmentId": "string",
  • "labelId": [
    ],
  • "weight": 0,
  • "weightUnit": "g",
  • "height": 0,
  • "length": 0,
  • "width": 0,
  • "dimensionsUnit": "cm",
  • "lineItems": [
    ],
  • "customFields": [
    ],
  • "status": "labeled",
  • "internal": {
    },
  • "ssccCode": "string",
  • "ucc128": "string",
  • "billOfLading": "string"
}

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Shipments

This is the entity to use for requesting a shipment. Pipe17 generate shipments automatically for Orders.

Shipment Model

extOrderId
required
string

Customer friendly ID on the order object

required
object (Address)
autoEngUpdateStatus
string (AutoEngUpdateStatus)
Enum: "none" "pending" "updated"

A status that indicates whether or not the automation engine may update the entity sometime in the future. Only set internally. Useful for services such as the order routing engine where the user intended order state is critical before action. Used for orders and shipments.

Status definitions:

  • pending: the automation engine will make an update to this entity in the future.
  • updated: the automation engine has successfully made an update to this entity.
  • none: No status to set because the org did not have an enabled automation at the time of create/update.
autoEngUpdateStatusUpdatedAt
string <date-time> (AutoEngUpdateStatusUpdatedAt)

When the autoEngUpdateStatus was last updated

cancellationStatus
string (ShipmentCancellationStatus)
Enum: "accepted" "pending" "rejected"

Shipment cancellation status

createdAt
string <date-time>

When the object was created within Pipe17

currency
string

Currency code (inherited from order)

Array of objects (NameValue)

Custom Fields

Array of objects (ExceptionRef)

References to exceptions related to the shipment

expectedDeliveryDate
string <date-time>

First Priority to be respected

expectedShipDate
string <date-time>

Expected ship date

extOrderApiId
string

External System Order API ID

extReferenceId
string

Customer Friendly reference to this shipping request on destination vendor

extReferenceUrl
string

Direct link to this shipping request on destination vendor

extShipmentId
string

Customer Friendly reference to this shipping request on originating vendor, auto generated if not provided

fulfillmentIntegrationId
string

Destination of this shipment request

giftNote
string

Shipping Gift note

incoterms
string

International Commercial Terms

integration
string

Reference to integration that created an item

object (InternalInfo)

Internal info

Array of objects (ShipmentLineItem)
locationId
string

Id of location defined in organization

orderCreateTime
string <date-time>

Create time of linked order

orderId
string

Pipe17 Internal Order's orderId

orderIntegration
string

Reference to integration that created order tied to an item

orderSource
string

Actual Order source, Walmart, Etsy, etc

orderSourceType
string (OrderType)
Enum: "edi" "online" "other" "pos" "wholesale"

Order Type (online, pos, etc)

orderType
string (ShipmentOrderType)
Enum: "purchase" "sales" "transfer"

Type of order that initiated this shipment

orgKey
string

Organization this object belong to

overfulfillPolicy
string (OverfulfillPolicy)
Enum: "approved" "report" "strict"

Overfulfill policy

sentToFulfillmentAt
string <date-time>

Sent to fulfillment timestamp

shipAfterDate
string <date-time>

Ship After Date

shipByDate
string <date-time>

Ship By Date

shipCancelByDate
string <date-time>

Ship Cancel By Date

shipmentId
string

Shipment ID

shippingCarrier
string

Required with ShippingClass, Pipe17 Approved List, 2nd Priority

shippingClass
string

Required with ShippingCarrier, 2nd Priority

shippingCode
string

3rd Priority

shippingLabels
Array of strings

Shipping Labels

shippingMethodMapping
boolean

Enable shipping method mapping (defaults to company setting if not provided)

shippingNote
string

Shipping Note

shippingPrice
number <float>

Shipping price

object (SourceDoc)

Vendor source document

status
string
Enum: "canceled" "canceledRestock" "failed" "fulfilled" "new" "onHold" "partialFulfillment" "pendingInventory" "pendingShippingLabel" "readyForFulfillment" "reviewRequired" "sentToFulfillment"

Shipment Status

tags
Array of strings (EntityTags)

Tags assigned to entity

Array of objects (ShipmentLog)

Shipping request updates timeline

updatedAt
string <date-time>

When the object was updated within Pipe17

version
number

Shipping request ordinal number - each new shipping request will have this value incremented for the same orderId

{
  • "shipmentId": "string",
  • "status": "new",
  • "integration": "string",
  • "orderIntegration": "string",
  • "extOrderApiId": "string",
  • "sentToFulfillmentAt": "2019-08-24T14:15:22Z",
  • "cancellationStatus": "accepted",
  • "version": 0,
  • "timeline": [
    ],
  • "autoEngUpdateStatus": "none",
  • "autoEngUpdateStatusUpdatedAt": "2019-08-24T14:15:22Z",
  • "exceptions": [
    ],
  • "fulfillmentIntegrationId": "string",
  • "extOrderId": "string",
  • "extShipmentId": "string",
  • "extReferenceId": "string",
  • "extReferenceUrl": "string",
  • "orderId": "string",
  • "orderSource": "string",
  • "orderSourceType": "edi",
  • "orderType": "purchase",
  • "orderCreateTime": "2019-08-24T14:15:22Z",
  • "shipByDate": "2019-08-24T14:15:22Z",
  • "shipAfterDate": "2019-08-24T14:15:22Z",
  • "shipCancelByDate": "2019-08-24T14:15:22Z",
  • "expectedShipDate": "2019-08-24T14:15:22Z",
  • "expectedDeliveryDate": "2019-08-24T14:15:22Z",
  • "shippingAddress": {
    },
  • "shippingCarrier": "string",
  • "shippingCode": "string",
  • "shippingClass": "string",
  • "shippingPrice": 0,
  • "shippingMethodMapping": true,
  • "shippingNote": "string",
  • "shippingLabels": [
    ],
  • "giftNote": "string",
  • "incoterms": "string",
  • "locationId": "string",
  • "overfulfillPolicy": "approved",
  • "lineItems": [
    ],
  • "customFields": [
    ],
  • "tags": [
    ],
  • "currency": "string",
  • "sourceDoc": {
    },
  • "internal": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "orgKey": "string"
}

Create Shipments

Uniqueness constraints within organization:

  • shipment.extShipmentId (when defined)
  • shipment.extReferenceId, shipment.fulfillmentIntegrationId (when extReferenceId defined)
Authorizations:
Pipe17KeyAuth
Request Body schema:
Array (<= 10 items)
extOrderId
required
string

Customer friendly ID on the order object

required
object (Address)
currency
string

Currency code (inherited from order)

Array of objects (NameValue)

Custom Fields

expectedDeliveryDate
string <date-time>

First Priority to be respected

expectedShipDate
string <date-time>

Expected ship date

extReferenceId
string

Customer Friendly reference to this shipping request on destination vendor

extReferenceUrl
string

Direct link to this shipping request on destination vendor

extShipmentId
string

Customer Friendly reference to this shipping request on originating vendor, auto generated if not provided

fulfillmentIntegrationId
string

Destination of this shipment request

giftNote
string

Shipping Gift note

incoterms
string

International Commercial Terms

object (InternalInfo)

Internal info

Array of objects (ShipmentLineItem)
locationId
string

Id of location defined in organization

orderCreateTime
string <date-time>

Create time of linked order

orderId
string

Pipe17 Internal Order's orderId

orderSource
string

Actual Order source, Walmart, Etsy, etc

orderSourceType
string (OrderType)
Enum: "edi" "online" "other" "pos" "wholesale"

Order Type (online, pos, etc)

orderType
string (ShipmentOrderType)
Enum: "purchase" "sales" "transfer"

Type of order that initiated this shipment

overfulfillPolicy
string (OverfulfillPolicy)
Enum: "approved" "report" "strict"

Overfulfill policy

shipAfterDate
string <date-time>

Ship After Date

shipByDate
string <date-time>

Ship By Date

shipCancelByDate
string <date-time>

Ship Cancel By Date

shippingCarrier
string

Required with ShippingClass, Pipe17 Approved List, 2nd Priority

shippingClass
string

Required with ShippingCarrier, 2nd Priority

shippingCode
string

3rd Priority

shippingLabels
Array of strings

Shipping Labels

shippingMethodMapping
boolean

Enable shipping method mapping (defaults to company setting if not provided)

shippingNote
string

Shipping Note

shippingPrice
number <float>

Shipping price

object (SourceDoc)

Vendor source document

status
string (ShipmentCreateStatus)
Enum: "new" "pendingInventory" "pendingShippingLabel" "readyForFulfillment" "reviewRequired"

Shipment Status

tags
Array of strings (EntityTags)

Tags assigned to entity

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "shipments": [
    ]
}

Delete Multiple Shipments

Authorizations:
Pipe17KeyAuth
query Parameters
action
string (ListDeleteAction)
Default: "list"
Enum: "hard" "list" "soft"

Soft/hard delete or list shipments to be deleted

count
integer <int32>
Default: 100

Delete at most this many shipments

deleted
boolean

Soft deleted shipments

extOrderId
Array of strings

Shipments by list of External Order Ids

integration
Array of strings

Shipments of these integrations

orderId
Array of strings

Shipments by list of Pipe17 Order Ids

orderType
Array of strings (ShipmentOrderType)
Items Enum: "purchase" "sales" "transfer"

Shipments by list of order types

orgMode
Array of strings (OrganizationMode)
Items Enum: "demo" "production" "test"

Delete shipments assigned these orgModes.

pagination
string
Value: "disabled"

Exclude pagination info from the response

shipmentId
Array of strings

Shipments by list of shipmentId

since
string <date-time>

Shipments created after this date-time

skip
integer <int32>
Default: 0

Skip this many shipments

status
Array of strings (ShipmentStatus)
Items Enum: "canceled" "canceledRestock" "failed" "fulfilled" "new" "onHold" "partialFulfillment" "pendingInventory" "pendingShippingLabel" "readyForFulfillment" "reviewRequired" "sentToFulfillment"

Shipments by list of statuses

until
string <date-time>

Shipments created before this date-time

updatedSince
string <date-time>

Shipments updated after this date-time

updatedUntil
string <date-time>

Shipments updated before this date-time

version
number

Shipments by version number

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "filters": {
    },
  • "shipments": [
    ],
  • "deleted": 0,
  • "pagination": {
    }
}

Delete Shipment

Authorizations:
Pipe17KeyAuth
path Parameters
ShipmentId
required
string

Id, ext:{extShipmentId}, or ref:{extReferenceId} of shipment to delete

query Parameters
action
string (DeleteAction)
Enum: "hard" "soft"

Delete shipment permanently or not

nested
boolean

Delete nested entities

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Fetch Shipment

Authorizations:
Pipe17KeyAuth
path Parameters
ShipmentId
required
string

Id, ext:{extShipmentId}, or ref:{extReferenceId} of shipment to fetch

query Parameters
sourceDocVersion
number

Fetch specific vendor source doc version if available

withSourceDoc
boolean

Include vendor source doc if available

withSourceDocVersions
boolean

Include available vendor source doc versions

withTimeline
boolean

Include timeline of updates when available

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "shipment": {
    }
}

List Shipments

Authorizations:
Pipe17KeyAuth
query Parameters
autoEngUpdateStatus
Array of strings (AutoEngUpdateStatus)
Items Enum: "none" "pending" "updated"
autoEngUpdateStatusUpdatedSince
string <date-time>

Fetch all shipments with autoEngUpdateStatus updated after this date-time

autoEngUpdateStatusUpdatedUntil
string <date-time>

Fetch all shipments with autoEngUpdateStatus updated before this date-time

cancellationStatus
Array of strings (ShipmentCancellationStatus)
Items Enum: "accepted" "pending" "rejected"
count
integer <int32>
Default: 100

Return at most this many shipments

deleted
boolean

Soft deleted shipments

exceptionCategoryId
Array of strings

Shipments by list of categories of the shipment related exceptions

exceptionType
Array of strings (ExceptionType)
Items Enum: "eApprovalRequired" "eAutomation" "eAutomationCodeActionError" "eAutomationCodeFilterError" "eCreditMemoInsufficient" "eDelayed" "eDuplicate" "eDuplicateSKU" "eEarly" "eFraudSuspected" "eGeneric" "eIncomplete" "eIncompleteAddress" "eInvalid" "eInvalidAddress" "eInvalidDate" "eInvalidLocation" "eInvalidMethod" "eInvalidSKU" "eInventoryOutOfStock" "eLarge" "eLate" "eLateCancel" "eLost" "eLow" "eMismatch" "eMismatchTax" "eMissing" "eMissingLocation" "eMissingSKU" "eOrderSyncFailure" "eOrderTaxMismatch" "eOutOfStock" "ePartiallyCanceled" "ePaymentRequired" "ePotentialOverfulfill" "eRestock" "eRouteNotFound" "eRouteOutOfStock" "eShipmentMismatch" "eShippingMethod" "eSplit" "eStuck" "eSyncFailure" "eToday" "eTransform" "eUnacknowledged" "eUnexpected" "eUnexpectedDate" "eUnexpectedSplitShipment" "eUnfulfillable"

Shipments by list of types of the shipment related exceptions

extOrderId
Array of strings

Shipments by list of External Order Ids

extReferenceId
Array of strings

Shipments by list of extReferenceId

extShipmentId
Array of strings

Shipments by list of extShipmentId

fulfillmentIntegrationId
Array of strings

Shipments by list of fulfillmentIntegrationId

hasSourceDoc
boolean

Shipments containing a source document

keys
string
Default: "shipmentId,status,extShipmentId,extReferenceId,orderId,extOrderId,orderType,orderCreateTime,shipByDate,expectedDeliveryDate,sentToFulfillmentAt,tags,createdAt,updatedAt,orgKey,version"

Return these top-level fields

locationId
Array of strings

Shipments by list of locationId

order
string
Default: "createdAt"

Sort by these top-level fields

orderId
Array of strings

Shipments by list of Pipe17 Order Ids

orderType
Array of strings (ShipmentOrderType)
Items Enum: "purchase" "sales" "transfer"

Shipments by list of order types

pagination
string
Value: "disabled"

Exclude pagination info from the response

shipmentId
Array of strings

Shipments by list of shipmentId

since
string <date-time>

Shipments created after this date-time

skip
integer <int32>
Default: 0

Skip this many shipments

status
Array of strings (ShipmentStatus)
Items Enum: "canceled" "canceledRestock" "failed" "fulfilled" "new" "onHold" "partialFulfillment" "pendingInventory" "pendingShippingLabel" "readyForFulfillment" "reviewRequired" "sentToFulfillment"

Shipments by list of statuses

until
string <date-time>

Shipments created before this date-time

updatedSince
string <date-time>

Shipments updated after this date-time

updatedUntil
string <date-time>

Shipments updated before this date-time

version
number

Shipments by version number

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "filters": {
    },
  • "shipments": [
    ],
  • "pagination": {
    }
}

Sync Shipments

Trigger the shipments sync

Authorizations:
Pipe17KeyAuth
path Parameters
ShipmentId
required
Array of strings
Request Body schema:
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Update Shipment

Uniqueness constraints within organization:

  • shipment.extShipmentId (when defined)
  • shipment.extReferenceId, shipment.fulfillmentIntegrationId (when extReferenceId defined)
Authorizations:
Pipe17KeyAuth
path Parameters
ShipmentId
required
string

Shipment Id to update

Request Body schema:
autoEngUpdateStatus
string (AutoEngUpdateStatus)
Enum: "none" "pending" "updated"

A status that indicates whether or not the automation engine may update the entity sometime in the future. Only set internally. Useful for services such as the order routing engine where the user intended order state is critical before action. Used for orders and shipments.

Status definitions:

  • pending: the automation engine will make an update to this entity in the future.
  • updated: the automation engine has successfully made an update to this entity.
  • none: No status to set because the org did not have an enabled automation at the time of create/update.
cancellationStatus
string (ShipmentCancellationStatus)
Enum: "accepted" "pending" "rejected"

Shipment cancellation status

Array of objects (NameValue)

Custom Fields

expectedDeliveryDate
string <date-time>

First Priority to be respected (can be updated if shipment is not sentToFulfillment yet)

expectedShipDate
string <date-time>

Expected ship date (can be updated if shipment is not sentToFulfillment yet)

extReferenceId
string

Customer Friendly reference to this shipping request on destination vendor

extReferenceUrl
string

Direct link to this shipping request on destination vendor

extShipmentId
string

Customer Friendly reference to this shipping request on originating vendor, auto generated if not provided

giftNote
string

Shipping Gift note

incoterms
string

International Commercial Terms. (can be updated if shipment is not sentToFulfillment yet)

object (InternalInfo)

Internal info

Array of objects
locationId
string

Id of location defined in organization. (can be updated if shipment is not sentToFulfillment yet)

overfulfillPolicy
string (OverfulfillPolicy)
Enum: "approved" "report" "strict"

Overfulfill policy

shipAfterDate
string <date-time>

Ship After Date

shipByDate
string <date-time>

Ship By Date (can be updated if shipment is not sentToFulfillment yet)

shipCancelByDate
string or null <date-time>

Ship Cancel By Date

object (AddressUpdateData)
shippingCarrier
string

Required with ShippingClass, Pipe17 Approved List, 2nd Priority. (can be updated if shipment is not sentToFulfillment yet)

shippingClass
string

Required with ShippingCarrier, 2nd Priority. (can be updated if shipment is not sentToFulfillment yet)

shippingCode
string

3rd Priority. (can be updated if shipment is not sentToFulfillment yet)

shippingLabels
Array of strings

Shipping Labels. (can be updated if shipment is not sentToFulfillment yet)

shippingMethodMapping
boolean

Enable shipping method mapping (defaults to company setting if not provided)

shippingNote
string

Shipping Note. (can be updated if shipment is not sentToFulfillment yet)

shippingPrice
number <float>

Shipping price

object (SourceDoc)

Vendor source document

status
string (ShipmentStatus)
Enum: "canceled" "canceledRestock" "failed" "fulfilled" "new" "onHold" "partialFulfillment" "pendingInventory" "pendingShippingLabel" "readyForFulfillment" "reviewRequired" "sentToFulfillment"

Shipment Status

tags
Array of strings (EntityTags)

Tags assigned to entity

Responses

Request samples

Content type
{
  • "shipByDate": "2019-08-24T14:15:22Z",
  • "shipAfterDate": "2019-08-24T14:15:22Z",
  • "shipCancelByDate": "2019-08-24T14:15:22Z",
  • "expectedShipDate": "2019-08-24T14:15:22Z",
  • "expectedDeliveryDate": "2019-08-24T14:15:22Z",
  • "shippingAddress": {
    },
  • "shippingCarrier": "string",
  • "shippingCode": "string",
  • "shippingClass": "string",
  • "shippingPrice": 0,
  • "shippingNote": "string",
  • "shippingMethodMapping": true,
  • "shippingLabels": [
    ],
  • "giftNote": "string",
  • "incoterms": "string",
  • "locationId": "string",
  • "status": "canceled",
  • "extShipmentId": "string",
  • "extReferenceId": "string",
  • "extReferenceUrl": "string",
  • "lineItems": [
    ],
  • "customFields": [
    ],
  • "overfulfillPolicy": "approved",
  • "tags": [
    ],
  • "cancellationStatus": "accepted",
  • "sourceDoc": {
    },
  • "autoEngUpdateStatus": "none",
  • "internal": {
    }
}

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Shipping Methods

Operations about Shipping Methods

Shipping Method Model

sourceType
required
string (ShippingMethodSourceType)
Enum: "ecommerce" "finance" "logistics"

Shipping Source type

createdAt
string <date-time>

When the object was created within Pipe17

description
string

Shipping method description

extMethodId
string

Shipping method external Id

integration
string

Reference to integration that created an item

object (InternalInfo)

Internal info

isDefault
boolean

Marks shipping method as default for given sourceIntegrationId

isPassthrough
boolean

Marks shipping method as passthrough for given sourceIntegrationId

Array of objects (ShippingMethodMapping)

List of mapped methods

methodId
string

Shipping Method ID

name
string

Shipping method name

orgKey
string

Organization this object belong to

shippingCarrier
string

Shipping carrier

shippingCode
string

Shipping code

shippingService
string

Shipping service

sourceIntegrationId
string

Shipping method source integrationId

status
string (ShippingMethodStatus)
Enum: "active" "deleted" "inactive"

Shipping Method status

updatedAt
string <date-time>

When the object was updated within Pipe17

{
  • "methodId": "string",
  • "integration": "string",
  • "name": "string",
  • "description": "string",
  • "shippingCarrier": "string",
  • "shippingService": "string",
  • "shippingCode": "string",
  • "sourceIntegrationId": "string",
  • "sourceType": "ecommerce",
  • "status": "active",
  • "isDefault": true,
  • "isPassthrough": true,
  • "extMethodId": "string",
  • "mappedMethods": [
    ],
  • "internal": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "orgKey": "string"
}

Create Shipping Method

Uniqueness constraints within organization:

  • method.source, method.shippingCarrier, method.shippingService, method.shippingCode
Authorizations:
Pipe17KeyAuth
Request Body schema:
Array (<= 10 items)
sourceType
required
string (ShippingMethodSourceType)
Enum: "ecommerce" "finance" "logistics"

Shipping Source type

description
string

Shipping method description

extMethodId
string

Shipping method external Id

object (InternalInfo)

Internal info

isDefault
boolean

Marks shipping method as default for given sourceIntegrationId

isPassthrough
boolean

Marks shipping method as passthrough for given sourceIntegrationId

Array of objects (ShippingMethodMapping)

List of mapped methods

name
string

Shipping method name

shippingCarrier
string

Shipping carrier

shippingCode
string

Shipping code

shippingService
string

Shipping service

sourceIntegrationId
string

Shipping method source integrationId

status
string (ShippingMethodStatus)
Enum: "active" "deleted" "inactive"

Shipping Method status

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "methods": [
    ]
}

Delete Multiple Shipping Methods

Authorizations:
Pipe17KeyAuth
query Parameters
action
string (ListDeleteAction)
Default: "list"
Enum: "hard" "list" "soft"

Soft/hard delete or list shipping methods to be deleted

count
integer <int32>
Default: 100

Delete at most this many shipping methods

methodId
Array of strings

Delete shipping methods by list of methodId

orgMode
Array of strings (OrganizationMode)
Items Enum: "demo" "production" "test"

Delete shipping methods assigned these orgModes.

pagination
string
Value: "disabled"

Exclude pagination info from the response

since
string <date-time>

Delete shipping methods created after this date-time

skip
integer <int32>
Default: 0

Skip this many shipping methods

until
string <date-time>

Delete shipping methods created before this date-time

updatedSince
string <date-time>

Delete shipping methods updated after this date-time

updatedUntil
string <date-time>

Delete shipping methods updated before this date-time

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "filters": {
    },
  • "methods": [
    ],
  • "deleted": 0,
  • "pagination": {
    }
}

Delete Shipping Method

Authorizations:
Pipe17KeyAuth
path Parameters
MethodId
required
string

Id or ext:{extMethodId} of shipping method to delete

query Parameters
action
string (DeleteAction)
Enum: "hard" "soft"

Delete Shipping Method permanently or not

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Fetch Shipping Method

Authorizations:
Pipe17KeyAuth
path Parameters
MethodId
required
string

Id or ext:{extMethodId} of shipping method to fetch

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "method": {
    }
}

List Shipping Methods

Authorizations:
Pipe17KeyAuth
query Parameters
count
integer <int32>
Default: 100

Return at most this many shipping methods

isDefault
boolean

Shipping method default flag

isPassthrough
boolean

Shipping method passthrough flag

keys
string
Default: "methodId,name,createdAt,updatedAt,orgKey"

Return these top-level fields

mappedMethodId
Array of strings

Mapped shipping method Ids

methodId
Array of strings

Retrieve by list of methodId

order
string
Default: "createdAt"

Sort by these top-level fields

pagination
string
Value: "disabled"

Exclude pagination info from the response

shippingCarrier
Array of strings

Retrieve by list of shipping carriers

shippingCode
Array of strings

Retrieve by list of shipping codes

shippingService
Array of strings

Retrieve by list of shipping services

since
string <date-time>

Shipping Methods created after this date-time

skip
integer <int32>
Default: 0

Skip this many shipping methods

sourceIntegrationId
Array of strings

Shipping method source IntegrationIds

sourceType
Array of strings (ShippingMethodSourceType)
Items Enum: "ecommerce" "finance" "logistics"

Shipping method source types

status
Array of strings (ShippingMethodStatus)
Items Enum: "active" "deleted" "inactive"

Shipping method statuses

until
string <date-time>

Shipping Methods created before this date-time

updatedSince
string <date-time>

Shipping Methods updated after this date-time

updatedUntil
string <date-time>

Shipping Methods updated before this date-time

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "filters": {
    },
  • "methods": [
    ],
  • "pagination": {
    }
}

Sync Shipping Methods

Trigger the shipping methods sync

Authorizations:
Pipe17KeyAuth
path Parameters
MethodId
required
Array of strings
Request Body schema:
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Update Shipping Method

Uniqueness constraints within organization:

  • method.source, method.shippingCarrier, method.shippingService, method.shippingCode
Authorizations:
Pipe17KeyAuth
path Parameters
MethodId
required
string

Id or ext:{extMethodId} of shipping method to update

Request Body schema:
description
string

Shipping method description

object (InternalInfo)

Internal info

isDefault
boolean

Marks shipping method as default for given sourceIntegrationId

isPassthrough
boolean

Marks shipping method as passthrough for given sourceIntegrationId

Array of objects or null (ShippingMethodMapping)

List of mapped methods

name
string

Shipping method name

shippingCarrier
string or null

Shipping carrier

shippingCode
string or null

Shipping code

shippingService
string or null

Shipping service

status
string (ShippingMethodStatus)
Enum: "active" "deleted" "inactive"

Shipping Method status

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "shippingCarrier": "string",
  • "shippingService": "string",
  • "shippingCode": "string",
  • "status": "active",
  • "isDefault": true,
  • "isPassthrough": true,
  • "mappedMethods": [
    ],
  • "internal": {
    }
}

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Suppliers

Operations about Suppliers

Supplier Model

required
object (SupplierAddress)
name
required
string

Supplier Name

Array of objects (SupplierContact)
createdAt
string <date-time>

When the object was created within Pipe17

Array of objects (ExceptionRef)

References to exceptions related to the supplier

object (InternalInfo)

Internal info

orgKey
string

Organization this object belong to

object (SourceDoc)

Vendor source document

supplierId
string

Supplier ID

updatedAt
string <date-time>

When the object was updated within Pipe17

{
  • "supplierId": "string",
  • "exceptions": [
    ],
  • "name": "string",
  • "address": {
    },
  • "contacts": [
    ],
  • "sourceDoc": {
    },
  • "internal": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "orgKey": "string"
}

Create Supplier

Uniqueness constraints within organization:

  • supplier.name
Authorizations:
Pipe17KeyAuth
Request Body schema:
required
object (SupplierAddress)
name
required
string

Supplier Name

Array of objects (SupplierContact)
object (InternalInfo)

Internal info

object (SourceDoc)

Vendor source document

Responses

Request samples

Content type
{
  • "name": "string",
  • "address": {
    },
  • "contacts": [
    ],
  • "sourceDoc": {
    },
  • "internal": {
    }
}

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "supplier": {
    }
}

Delete Multiple Suppliers

Authorizations:
Pipe17KeyAuth
query Parameters
action
string (ListDeleteAction)
Default: "list"
Enum: "hard" "list" "soft"

Soft/hard delete or list items to be deleted

count
integer <int32>
Default: 100

Delete at most this many suppliers

deleted
boolean

Delete soft deleted suppliers

name
string

Delete suppliers matching name string

orgMode
Array of strings (OrganizationMode)
Items Enum: "demo" "production" "test"

Delete suppliers assigned these orgModes.

pagination
string
Value: "disabled"

Exclude pagination info from the response

since
string <date-time>

Delete suppliers created after this date-time

skip
integer <int32>
Default: 0

Skip this many suppliers

supplierId
Array of strings

Delete suppliers by list of supplierId

until
string <date-time>

Delete suppliers created before this date-time

updatedSince
string <date-time>

Delete suppliers updated after this date-time

updatedUntil
string <date-time>

Delete suppliers updated before this date-time

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "filters": {
    },
  • "suppliers": [
    ],
  • "deleted": 0,
  • "pagination": {
    }
}

Delete Supplier

Authorizations:
Pipe17KeyAuth
path Parameters
SupplierId
required
string

Supplier ID to delete

query Parameters
action
string (DeleteAction)
Enum: "hard" "soft"

Delete supplier permanently or not

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Fetch Supplier

Authorizations:
Pipe17KeyAuth
path Parameters
SupplierId
required
string

Supplier ID to fetch

query Parameters
sourceDocVersion
number

Fetch specific vendor source doc version if available

withSourceDoc
boolean

Include vendor source doc if available

withSourceDocVersions
boolean

Include available vendor source doc versions

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "supplier": {
    }
}

List Suppliers

Authorizations:
Pipe17KeyAuth
query Parameters
count
integer <int32>
Default: 100

Return at most this many suppliers

deleted
boolean

Retrieve soft deleted suppliers

exceptionCategoryId
Array of strings

Retrieve suppliers by list of categories of the supplier related exceptions

exceptionType
Array of strings (ExceptionType)
Items Enum: "eApprovalRequired" "eAutomation" "eAutomationCodeActionError" "eAutomationCodeFilterError" "eCreditMemoInsufficient" "eDelayed" "eDuplicate" "eDuplicateSKU" "eEarly" "eFraudSuspected" "eGeneric" "eIncomplete" "eIncompleteAddress" "eInvalid" "eInvalidAddress" "eInvalidDate" "eInvalidLocation" "eInvalidMethod" "eInvalidSKU" "eInventoryOutOfStock" "eLarge" "eLate" "eLateCancel" "eLost" "eLow" "eMismatch" "eMismatchTax" "eMissing" "eMissingLocation" "eMissingSKU" "eOrderSyncFailure" "eOrderTaxMismatch" "eOutOfStock" "ePartiallyCanceled" "ePaymentRequired" "ePotentialOverfulfill" "eRestock" "eRouteNotFound" "eRouteOutOfStock" "eShipmentMismatch" "eShippingMethod" "eSplit" "eStuck" "eSyncFailure" "eToday" "eTransform" "eUnacknowledged" "eUnexpected" "eUnexpectedDate" "eUnexpectedSplitShipment" "eUnfulfillable"

Retrieve suppliers by list of types of the supplier related exceptions

hasSourceDoc
boolean

Suppliers containing a source document

keys
string
Default: "supplierId,name,address,contacts,createdAt,updatedAt,orgKey"

Return these top-level fields

name
string

Retrieve suppliers by name (strings "/{pattern}/" and "/{pattern}/i" are interpreted as regexps)

order
string
Default: "createdAt"

Sort by these top-level fields

pagination
string
Value: "disabled"

Exclude pagination info from the response

since
string <date-time>

Suppliers created after this date-time

skip
integer <int32>
Default: 0

Skip this many suppliers

supplierId
Array of strings

Retrieve by list of supplierId

until
string <date-time>

Suppliers created before this date-time

updatedSince
string <date-time>

Suppliers updated after this date-time

updatedUntil
string <date-time>

Suppliers updated before this date-time

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "filters": {
    },
  • "suppliers": [
    ],
  • "pagination": {
    }
}

Sync Suppliers

Trigger the suppliers sync

Authorizations:
Pipe17KeyAuth
path Parameters
SupplierId
required
Array of strings
Request Body schema:
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Update Supplier

Uniqueness constraints within organization:

  • supplier.name
Authorizations:
Pipe17KeyAuth
path Parameters
SupplierId
required
string

Supplier ID to update

Request Body schema:
object (SupplierAddress)
Array of objects (SupplierContact)

Supplier Contacts

object (InternalInfo)

Internal info

name
string

Supplier Name

object (SourceDoc)

Vendor source document

Responses

Request samples

Content type
{
  • "name": "string",
  • "address": {
    },
  • "contacts": [
    ],
  • "sourceDoc": {
    },
  • "internal": {
    }
}

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Trackings

Operations about Fulfillment Tracking

Tracking Model

fulfillmentId
required
string
shippingCarrier
required
string (ShippingCarrier)
Enum: "amazon" "deliverr" "fedex" "other" "ups" "usps"
trackingNumber
required
string
actualArrivalDate
string <date-time>
actualShipDate
string <date-time>
createdAt
string <date-time>

When the object was created within Pipe17

expectedArrivalDate
string <date-time>
object (InternalInfo)

Internal info

orgKey
string

Organization this object belong to

status
string (TrackingStatus)
Enum: "created" "delivered" "shipped"
trackingId
string
updatedAt
string <date-time>

When the object was updated within Pipe17

url
string
{
  • "trackingId": "string",
  • "status": "created",
  • "actualShipDate": "2019-08-24T14:15:22Z",
  • "actualArrivalDate": "2019-08-24T14:15:22Z",
  • "trackingNumber": "string",
  • "fulfillmentId": "string",
  • "shippingCarrier": "amazon",
  • "url": "string",
  • "expectedArrivalDate": "2019-08-24T14:15:22Z",
  • "internal": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "orgKey": "string"
}

Create Tracking

Uniqueness constraints within organization:

  • tracking.trackingNumber
Authorizations:
Pipe17KeyAuth
Request Body schema:
fulfillmentId
required
string
shippingCarrier
required
string (ShippingCarrier)
Enum: "amazon" "deliverr" "fedex" "other" "ups" "usps"
trackingNumber
required
string
expectedArrivalDate
string <date-time>
object (InternalInfo)

Internal info

url
string

Responses

Request samples

Content type
{
  • "trackingNumber": "string",
  • "fulfillmentId": "string",
  • "shippingCarrier": "amazon",
  • "url": "string",
  • "expectedArrivalDate": "2019-08-24T14:15:22Z",
  • "internal": {
    }
}

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "tracking": {
    }
}

Fetch Tracking

Authorizations:
Pipe17KeyAuth
path Parameters
TrackingId
required
string

Id or ext:{trackingNumber} of tracking to fetch

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "tracking": {
    }
}

List Trackings

Authorizations:
Pipe17KeyAuth
query Parameters
count
integer <int32>
Default: 100

Return at most this many tracking

fulfillmentId
Array of strings
keys
string
Default: "trackingId,trackingNumber,fulfillmentId,shipper,url,actualShipDate,expectedArrivalDate,actualArrivalDate,createdAt,updatedAt,orgKey,status"

Return these top-level fields

order
string
Default: "createdAt"

Sort by these top-level fields

pagination
string
Value: "disabled"

Exclude pagination info from the response

shippingCarrier
Array of strings
since
string <date-time>

Tracking created after this date-time

skip
integer <int32>
Default: 0

Skip this many tracking

status
Array of strings (TrackingStatus)
Items Enum: "created" "delivered" "shipped"
trackingId
Array of strings
trackingNumber
Array of strings
until
string <date-time>

Tracking created before this date-time

updatedSince
string <date-time>

Tracking updated after this date-time

updatedUntil
string <date-time>

Tracking updated before this date-time

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "filters": {
    },
  • "trackings": [
    ],
  • "pagination": {
    }
}

Sync Trackings

Trigger the trackings sync

Authorizations:
Pipe17KeyAuth
path Parameters
TrackingId
required
Array of strings
Request Body schema:
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Update Tracking

Uniqueness constraints within organization:

  • tracking.trackingNumber
Authorizations:
Pipe17KeyAuth
path Parameters
TrackingId
required
string

Id or ext:{trackingNumber} of tracking to update

Request Body schema:
status
required
string
Enum: "delivered" "shipped"
expectedArrivalDate
string <date-time>
object (InternalInfo)

Internal info

Responses

Request samples

Content type
{
  • "expectedArrivalDate": "2019-08-24T14:15:22Z",
  • "status": "delivered",
  • "internal": {
    }
}

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Transfers

Operations about Transfer Orders

Transfer Model

extOrderId
required
string

External Transfer Order ID

actualArrivalDate
string <date-time>

Actual Arrival Date (from most recent Arrival)

createdAt
string <date-time>

When the object was created within Pipe17

Array of objects (NameValue)

Custom Fields

employeeName
string

Transfer order created by

Array of objects (ExceptionRef)

References to exceptions related to the transfer

expectedArrivalDate
string <date-time>

Expected Arrival Date

expectedShipDate
string <date-time>

Expected Ship Date

object (TransfersFromLocationAddress)

Shipping Location Address

fromLocationId
string

Shipping Location ID

incoterms
string

International Commercial Terms

integration
string

Reference to integration that created an item

object (InternalInfo)

Internal info

Array of objects (TransferLineItem)
orderSourceType
string (OrderType)
Enum: "edi" "online" "other" "pos" "wholesale"

Order Type (online, pos, etc)

orgKey
string

Organization this object belong to

shipByDate
string <date-time>

Ship By Date

shippingCarrier
string

Shipping Carrier

shippingNotes
string

Shipping Notes

shippingService
string

Shipping Service Type

object (SourceDoc)

Vendor source document

status
string (TransferStatus)
Enum: "archived" "canceled" "closed" "draft" "fulfilled" "inTransit" "new" "onHold" "partialFulfillment" "partialReceived" "readyForFulfillment" "received" "refunded" "returned" "reviewRequired" "sentToFulfillment" "toBeValidated"

Transfer Status

timestamp
string <date-time>

General Purpose Time Stamp

object (Address)
toLocationId
string

Arrival Location ID

transferId
string

Transfer ID

transferNotes
string

Transfer Notes

transferOrderDate
string <date-time>

Transfer Order Date

updatedAt
string <date-time>

When the object was updated within Pipe17

{
  • "transferId": "string",
  • "integration": "string",
  • "fromLocationAddress": {
    },
  • "exceptions": [
    ],
  • "status": "archived",
  • "extOrderId": "string",
  • "transferOrderDate": "2019-08-24T14:15:22Z",
  • "orderSourceType": "edi",
  • "lineItems": [
    ],
  • "fromLocationId": "string",
  • "toAddress": {
    },
  • "toLocationId": "string",
  • "shippingCarrier": "string",
  • "shippingService": "string",
  • "shipByDate": "2019-08-24T14:15:22Z",
  • "expectedShipDate": "2019-08-24T14:15:22Z",
  • "expectedArrivalDate": "2019-08-24T14:15:22Z",
  • "actualArrivalDate": "2019-08-24T14:15:22Z",
  • "shippingNotes": "string",
  • "employeeName": "string",
  • "incoterms": "string",
  • "transferNotes": "string",
  • "customFields": [
    ],
  • "timestamp": "2019-08-24T14:15:22Z",
  • "sourceDoc": {
    },
  • "internal": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "orgKey": "string"
}

Create Transfers

Uniqueness constraints within organization:

  • transfer.extOrderId
Authorizations:
Pipe17KeyAuth
Request Body schema:
Array (<= 10 items)
extOrderId
required
string

External Transfer Order ID

actualArrivalDate
string <date-time>

Actual Arrival Date (from most recent Arrival)

Array of objects (NameValue)

Custom Fields

employeeName
string

Transfer order created by

expectedArrivalDate
string <date-time>

Expected Arrival Date

expectedShipDate
string <date-time>

Expected Ship Date

fromLocationId
string

Shipping Location ID

incoterms
string

International Commercial Terms

object (InternalInfo)

Internal info

Array of objects (TransferLineItem)
orderSourceType
string (OrderType)
Enum: "edi" "online" "other" "pos" "wholesale"

Order Type (online, pos, etc)

shipByDate
string <date-time>

Ship By Date

shippingCarrier
string

Shipping Carrier

shippingNotes
string

Shipping Notes

shippingService
string

Shipping Service Type

object (SourceDoc)

Vendor source document

status
string (TransferStatus)
Enum: "archived" "canceled" "closed" "draft" "fulfilled" "inTransit" "new" "onHold" "partialFulfillment" "partialReceived" "readyForFulfillment" "received" "refunded" "returned" "reviewRequired" "sentToFulfillment" "toBeValidated"

Transfer Status

timestamp
string <date-time>

General Purpose Time Stamp

object (Address)
toLocationId
string

Arrival Location ID

transferNotes
string

Transfer Notes

transferOrderDate
string <date-time>

Transfer Order Date

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "transfers": [
    ]
}

Delete Multiple Transfers

Authorizations:
Pipe17KeyAuth
query Parameters
action
string (ListDeleteAction)
Default: "list"
Enum: "hard" "list" "soft"

Soft/hard delete or list transfers to be deleted

count
integer <int32>
Default: 100

Delete at most this many transfers

deleted
boolean

Delete soft deleted transfers

extOrderId
Array of strings

Delete transfers by list of external transfer IDs

integration
Array of strings

Delete transfers of these integrations

orderSourceType
Array of strings (OrderType)
Items Enum: "edi" "online" "other" "pos" "wholesale"

Delete orders by list of order types

orgMode
Array of strings (OrganizationMode)
Items Enum: "demo" "production" "test"

Delete transfers assigned these orgModes.

pagination
string
Value: "disabled"

Exclude pagination info from the response

since
string <date-time>

Delete transfers created after this date-time

skip
integer <int32>
Default: 0

Skip this many transfers

status
Array of strings (TransferStatus)
Items Enum: "archived" "canceled" "closed" "draft" "fulfilled" "inTransit" "new" "onHold" "partialFulfillment" "partialReceived" "readyForFulfillment" "received" "refunded" "returned" "reviewRequired" "sentToFulfillment" "toBeValidated"

Delete transfers by list of statuses

transferId
Array of strings

Delete transfers by list of transferId

until
string <date-time>

Delete transfers created before this date-time

updatedSince
string <date-time>

Delete transfers updated after this date-time

updatedUntil
string <date-time>

Delete transfers updated before this date-time

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "filters": {
    },
  • "transfers": [
    ],
  • "deleted": 0,
  • "pagination": {
    }
}

Delete Transfer

Authorizations:
Pipe17KeyAuth
path Parameters
TransferId
required
string

Id or ext:{extOrderId} of transfer to delete

query Parameters
action
string (DeleteAction)
Enum: "hard" "soft"

Delete transfer permanently or not

nested
boolean

Delete nested entities

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Fetch Transfer

Authorizations:
Pipe17KeyAuth
path Parameters
TransferId
required
string

Id or ext:{extOrderId} of transfer to fetch

query Parameters
sourceDocVersion
number

Fetch specific vendor source doc version if available

withSourceDoc
boolean

Include vendor source doc if available

withSourceDocVersions
boolean

Include available vendor source doc versions

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "transfer": {
    }
}

List Transfers

Authorizations:
Pipe17KeyAuth
query Parameters
count
integer <int32>
Default: 100

Return at most this many transfers

deleted
boolean

Retrieve soft deleted transfers

exceptionCategoryId
Array of strings

Retrieve transfers by list of categories of the transfer related exceptions

exceptionType
Array of strings (ExceptionType)
Items Enum: "eApprovalRequired" "eAutomation" "eAutomationCodeActionError" "eAutomationCodeFilterError" "eCreditMemoInsufficient" "eDelayed" "eDuplicate" "eDuplicateSKU" "eEarly" "eFraudSuspected" "eGeneric" "eIncomplete" "eIncompleteAddress" "eInvalid" "eInvalidAddress" "eInvalidDate" "eInvalidLocation" "eInvalidMethod" "eInvalidSKU" "eInventoryOutOfStock" "eLarge" "eLate" "eLateCancel" "eLost" "eLow" "eMismatch" "eMismatchTax" "eMissing" "eMissingLocation" "eMissingSKU" "eOrderSyncFailure" "eOrderTaxMismatch" "eOutOfStock" "ePartiallyCanceled" "ePaymentRequired" "ePotentialOverfulfill" "eRestock" "eRouteNotFound" "eRouteOutOfStock" "eShipmentMismatch" "eShippingMethod" "eSplit" "eStuck" "eSyncFailure" "eToday" "eTransform" "eUnacknowledged" "eUnexpected" "eUnexpectedDate" "eUnexpectedSplitShipment" "eUnfulfillable"

Retrieve transfers by list of types of the transfer related exceptions

extOrderId
Array of strings

Retrieve by list of external transfer IDs

fromLocationId
Array of strings

Retrieve by list of fromLocationId

hasSourceDoc
boolean

Retrieve transfers containing a source document

keys
string
Default: "transferId,extOrderId,status,shipByDate,expectedArrivalDate,createdAt,updatedAt,orgKey"

Return these top-level fields

order
string
Default: "createdAt"

Sort by these top-level fields

orderSourceType
Array of strings (OrderType)
Items Enum: "edi" "online" "other" "pos" "wholesale"

Fetch orders by list of types

pagination
string
Value: "disabled"

Exclude pagination info from the response

since
string <date-time>

Retrieve all transfers created after this date-time

skip
integer <int32>
Default: 0

Skip this many transfers

status
Array of strings (TransferStatus)
Items Enum: "archived" "canceled" "closed" "draft" "fulfilled" "inTransit" "new" "onHold" "partialFulfillment" "partialReceived" "readyForFulfillment" "received" "refunded" "returned" "reviewRequired" "sentToFulfillment" "toBeValidated"

Retrieve by list of statuses

timestamp
boolean

if set to true use timestamp instead of create time

toLocationId
Array of strings

Retrieve by list of toLocationId

transferId
Array of strings

Retrieve by list of transferId

until
string <date-time>

Retrieve all transfers created before this date-time

updatedSince
string <date-time>

Retrieve all transfers updated after this date-time

updatedUntil
string <date-time>

Retrieve all transfers updated before this date-time

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "filters": {
    },
  • "transfers": [
    ],
  • "pagination": {
    }
}

Sync Transfers

Trigger the transfers sync

Authorizations:
Pipe17KeyAuth
path Parameters
TransferId
required
Array of strings
Request Body schema:
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Update Transfer

Uniqueness constraints within organization:

  • transfer.extOrderId
Authorizations:
Pipe17KeyAuth
path Parameters
TransferId
required
string

Id or ext:{extOrderId} of transfer to update

Request Body schema:
actualArrivalDate
string or null <date-time>

Actual Arrival Date (from most recent Arrival)

Array of objects (NameValue)

Custom Fields

employeeName
string or null

Transfer order created by

expectedArrivalDate
string or null <date-time>

Expected Arrival Date

expectedShipDate
string or null <date-time>

Expected Ship Date

fromLocationId
string or null

Shipping Location ID

incoterms
string or null

International Commercial Terms

object (InternalInfo)

Internal info

Array of objects (TransferUpdateLineItem)
orderSourceType
string (OrderType)
Enum: "edi" "online" "other" "pos" "wholesale"

Order Type (online, pos, etc)

shipByDate
string or null <date-time>

Ship By Date

shippingCarrier
string or null

Shipping Carrier

shippingNotes
string or null

Shipping Notes

shippingService
string or null

Shipping Service Type

object (SourceDoc)

Vendor source document

status
string (TransferStatus)
Enum: "archived" "canceled" "closed" "draft" "fulfilled" "inTransit" "new" "onHold" "partialFulfillment" "partialReceived" "readyForFulfillment" "received" "refunded" "returned" "reviewRequired" "sentToFulfillment" "toBeValidated"

Transfer Status

timestamp
string or null <date-time>

General Purpose Time Stamp

object or null (AddressNullable)
toLocationId
string or null

Arrival Location ID

transferNotes
string or null

Transfer Notes

Responses

Request samples

Content type
{
  • "status": "archived",
  • "lineItems": [
    ],
  • "orderSourceType": "edi",
  • "fromLocationId": "string",
  • "toAddress": {
    },
  • "toLocationId": "string",
  • "shippingCarrier": "string",
  • "shippingService": "string",
  • "shipByDate": "2019-08-24T14:15:22Z",
  • "expectedShipDate": "2019-08-24T14:15:22Z",
  • "expectedArrivalDate": "2019-08-24T14:15:22Z",
  • "actualArrivalDate": "2019-08-24T14:15:22Z",
  • "shippingNotes": "string",
  • "employeeName": "string",
  • "incoterms": "string",
  • "transferNotes": "string",
  • "customFields": [
    ],
  • "timestamp": "2019-08-24T14:15:22Z",
  • "sourceDoc": {
    },
  • "internal": {
    }
}

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Api Keys

Operations about Api Keys

Api Key Model

allowedIPs
required
Array of strings

IP/CIDR Whitelist

required
object (Methods)

Access Methods Allowed

name
required
string

API Key Name

apikeyId
string

API key Id

connector
string

Connector ID

createdAt
string <date-time>

When the object was created within Pipe17

description
string

API Key Description

environment
string (Env)
Enum: "prod" "test"

Environment ID

integration
string

Integration ID

object (InternalInfo)

Internal info

orgKey
string

Organization this object belong to

tier
string (Tier)
Enum: "basic" "enterprise" "free"

Tier (usage plan)

type
string
Enum: "regular" "temporary"

API Key type (default - regular)

updatedAt
string <date-time>

When the object was updated within Pipe17

userId
string

User ID of the key creator, if known

{
  • "apikeyId": "string",
  • "userId": "string",
  • "name": "string",
  • "description": "string",
  • "connector": "string",
  • "integration": "string",
  • "tier": "basic",
  • "environment": "prod",
  • "methods": {
    },
  • "allowedIPs": [
    ],
  • "internal": {
    },
  • "type": "regular",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "orgKey": "string"
}

Create API Key

Authorizations:
Pipe17KeyAuth
Request Body schema:
allowedIPs
required
Array of strings

IP/CIDR Whitelist

required
object (Methods)

Access Methods Allowed

name
required
string

API Key Name

connector
string

Connector ID

description
string

API Key Description

environment
string (Env)
Enum: "prod" "test"

Environment ID

integration
string

Integration ID

object (InternalInfo)

Internal info

tier
string (Tier)
Enum: "basic" "enterprise" "free"

Tier (usage plan)

type
string
Enum: "regular" "temporary"

API Key type (default - regular)

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "connector": "string",
  • "integration": "string",
  • "tier": "basic",
  • "environment": "prod",
  • "methods": {
    },
  • "allowedIPs": [
    ],
  • "internal": {
    },
  • "type": "regular"
}

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "apikey": "string",
  • "apikeyId": "string"
}

Delete API Key

Authorizations:
Pipe17KeyAuth
path Parameters
ApiKey
required
string

Value or ID of API key to delete

query Parameters
action
string (DeleteAction)
Enum: "hard" "soft"

Delete API key permanently or not

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Fetch API Key Info

Authorizations:
Pipe17KeyAuth
path Parameters
ApiKey
required
string

Value or ID of API key to fetch

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "apikey": {
    }
}

Fetch API Key Info, including the key value

Authorizations:
Pipe17KeyAuth
path Parameters
ApiKey
required
string

Value or ID of API key to fetch

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "apikey": {
    }
}

List API Keys

Authorizations:
Pipe17KeyAuth
query Parameters
apikeyId
Array of strings

API Keys by list of apikey ids

connector
Array of strings

List API Keys matching to provided connector id(s)

count
integer <int32>
Default: 100

Return at most this many API Keys

integration
Array of strings

List API Keys matching to provided integration id(s)

keys
string
Default: "apikeyId,name,description,integration,connector,tier,environment,methods,allowedIPs,createdAt,updatedAt,orgKey"

Return these top-level fields

name
string

List API Keys matching to provided name(s)

order
string
Default: "createdAt"

Sort by these top-level fields

pagination
string
Value: "disabled"

Exclude pagination info from the response

since
string <date-time>

List API Keys created after this date-time

skip
integer <int32>
Default: 0

Skip this many API Keys

type
string
Enum: "regular" "temporary"

List API Keys of this type (default - all)

until
string <date-time>

List API Keys created before this date-time

updatedSince
string <date-time>

List API Keys updated after this date-time

updatedUntil
string <date-time>

List API Keys updated before this date-time

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "filters": {
    },
  • "apikeys": [
    ],
  • "pagination": {
    }
}

Update API Key Info

Authorizations:
Pipe17KeyAuth
path Parameters
ApiKey
required
string

Value or ID of API key to update

Request Body schema:
allowedIPs
Array of strings

IP/CIDR Whitelist

description
string

API Key Description

object (InternalInfo)

Internal info

object (MethodsUpdateData)

Access Methods Allowed

name
string

API Key Name

tier
string

Usage plan

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "methods": {
    },
  • "allowedIPs": [
    ],
  • "internal": {
    },
  • "tier": "string"
}

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Automation Rules

Operations around Automation Rules. An automation rule contains filters and actions that determine when and how to execute automation actions. An automation rule always belongs to an automation.

Automation Rule Model

automationId
required
string (AutomationRuleAutomationId)

The ID of the parent automation

required
object (AutomationRuleFilter)

Determines whether or not the automation rule is applied to the entity.

name
required
string (AutomationRuleName)

The name of the automation rule. Must be unique within the automation.

Array of objects (AutomationRuleActions)

The actions to be performed by the automation rule. An automation rule must contain at least one action.

assessmentOrder
integer >= -1

The order that the automation rule gets assessed. The default rule's order will be -1.

automationRuleId
string

The unique identifier of the automation rule

createdAt
string <date-time>

When the object was created within Pipe17

createdBy
string

ID of the user who created the automation rule

description
string (AutomationRuleDescription)

The description of the automation rule. A good place to note a rule's when, where and why.

object (InternalInfo)

Internal info

isDefault
boolean (AutomationRuleIsDefault)
Default: false

Whether or not this is the default rule for the automation. There can only be one default rule within an automation rule and it must be enabled. The default automation rule is something that's managed by the platform and will always execute last if no other rules that terminate the automation run are applied.

isEnabled
boolean (AutomationRuleIsEnabled)
Default: true

Whether the automation rule is enabled or not. Disabled rules will not be assesesed when their parent automation is triggered.

orgKey
string

Organization this object belong to

updatedAt
string <date-time>

When the object was updated within Pipe17

updatedBy
string

ID of the user who last updated the automation rule

{
  • "automationRuleId": "string",
  • "assessmentOrder": -1,
  • "createdBy": "string",
  • "updatedBy": "string",
  • "isEnabled": true,
  • "name": "string",
  • "description": "string",
  • "automationId": "string",
  • "filter": {
    },
  • "isDefault": false,
  • "actions": [
    ],
  • "internal": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "orgKey": "string"
}

Create Automation Rule

Uniqueness constraints:

  • automationId + name
Authorizations:
Pipe17KeyAuth
Request Body schema:
automationId
required
string (AutomationRuleAutomationId)

The ID of the parent automation

required
object (AutomationRuleFilter)

Determines whether or not the automation rule is applied to the entity.

name
required
string (AutomationRuleName)

The name of the automation rule. Must be unique within the automation.

Array of objects (AutomationRuleActions)

The actions to be performed by the automation rule. An automation rule must contain at least one action.

description
string (AutomationRuleDescription)

The description of the automation rule. A good place to note a rule's when, where and why.

object (InternalInfo)

Internal info

isDefault
boolean (AutomationRuleIsDefault)
Default: false

Whether or not this is the default rule for the automation. There can only be one default rule within an automation rule and it must be enabled. The default automation rule is something that's managed by the platform and will always execute last if no other rules that terminate the automation run are applied.

isEnabled
boolean (AutomationRuleIsEnabled)
Default: true

Whether the automation rule is enabled or not. Disabled rules will not be assesesed when their parent automation is triggered.

Responses

Request samples

Content type
{
  • "isEnabled": true,
  • "name": "string",
  • "description": "string",
  • "automationId": "string",
  • "filter": {
    },
  • "isDefault": false,
  • "actions": [
    ],
  • "internal": {
    }
}

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "automationRule": {
    }
}

Delete Automation Rule

Authorizations:
Pipe17KeyAuth
path Parameters
AutomationRuleId
required
string

Id of the Automation Rule to delete

query Parameters
action
string (DeleteAction)
Enum: "hard" "soft"

Determines whether or not to delete automation rule permanently

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Fetch Automation Rule

Authorizations:
Pipe17KeyAuth
path Parameters
AutomationRuleId
required
string

Id of the automation rule to fetch

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "automationRule": {
    }
}

List Automation Rules

Authorizations:
Pipe17KeyAuth
query Parameters
automationId
Array of strings (AutomationRulesListFilterAutomationId)

Filter by list of automationIds

automationRuleId
Array of strings (AutomationRulesListFilterAutomationRuleId)

Filter by list of automationRuleIds

count
integer <int32>
Default: 100

Max number of items to return

deleted
boolean

Whether to retrieve soft deleted items

isDefault
boolean

Filter by isDefault

isEnabled
boolean

Filter by isEnabled

keys
string
Default: "automationId,automationRuleId,isEnabled,createdAt,updatedAt,orgKey,assessmentOrder,name,description,isDefault"

Return these top-level fields

order
string
Default: "createdAt"

Sort by these top-level field

orgKey
string

Organization key

pagination
string
Value: "disabled"

Exclude pagination info from the response

since
string <date-time>

Fetch items created after this date-time

skip
integer <int32>
Default: 0

Number of items to skip

until
string <date-time>

Fetch items created before this date-time

updatedSince
string <date-time>

Fetch items updated after this date-time

updatedUntil
string <date-time>

Fetch items updated before this date-time

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "filters": {
    },
  • "automationRules": [
    ],
  • "pagination": {
    }
}

Update Automation Rule

Authorizations:
Pipe17KeyAuth
path Parameters
AutomationRuleId
required
string

Id of the automation rule to update

Request Body schema:
Array of objects (AutomationRuleActions)

The actions to be performed by the automation rule. An automation rule must contain at least one action.

description
string (AutomationRuleDescription)

The description of the automation rule. A good place to note a rule's when, where and why.

object (AutomationRuleFilter)

Determines whether or not the automation rule is applied to the entity.

object (InternalInfo)

Internal info

isEnabled
boolean (AutomationRuleIsEnabled)
Default: true

Whether the automation rule is enabled or not. Disabled rules will not be assesesed when their parent automation is triggered.

name
string (AutomationRuleName)

The name of the automation rule. Must be unique within the automation.

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "isEnabled": true,
  • "filter": {
    },
  • "actions": [
    ],
  • "internal": {
    }
}

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Automation Runs

Operations around Automation Runs. An automation run captures the history of an automation being executed on an entity.

Automation Run Model

automationId
required
string

The type of the entity being operated on

automationRunId
required
string

The unique identifier of the automation.

entityId
required
string

The id of the entity being operated on

entityType
required
string
Enum: "orders" "shipments"
status
required
string
Enum: "COMPLETED" "FAILED" "IN_PROGRESS"

Status of the automation run

Array of objects (AutomationRunAction)

Required. The actions that were planned out for the automation run.

automationRuleIds
Array of strings

IDs of the automation rules that matched the filter and had actions that were used. Some rules may have a passing filter but won't be used if a preceding rule had a terminal action. In this case, those rule ids should not be included in this array.

completedAt
string <date-time>

The time the automation run was completed

createdAt
string <date-time>

When the object was created within Pipe17

errorMessage
string

The error message if the automation run failed

execCount
integer (AutomationRunExecCount) >= 1

The number of times the automation run has been executed. If a job fails and is retried, this number will increase.

failedAt
string <date-time>

The time the automation run failed

object (InternalInfo)

Internal info

orgKey
string

Organization this object belong to

Array of objects (AutomationStep)

Required. The steps that were planned out for the automation run.

updatedAt
string <date-time>

When the object was updated within Pipe17

{
  • "execCount": 1,
  • "automationRunId": "string",
  • "status": "COMPLETED",
  • "entityId": "string",
  • "entityType": "orders",
  • "automationId": "string",
  • "automationRuleIds": [
    ],
  • "completedAt": "2019-08-24T14:15:22Z",
  • "failedAt": "2019-08-24T14:15:22Z",
  • "errorMessage": "string",
  • "actions": [
    ],
  • "steps": [
    ],
  • "internal": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "orgKey": "string"
}

Create AutomationRun

Authorizations:
Pipe17KeyAuth
Request Body schema:
automationId
required
string

The type of the entity being operated on

entityId
required
string

The id of the entity being operated on

entityType
required
string
Enum: "orders" "shipments"
Array of objects (AutomationRunAction)

Required. The actions that were planned out for the automation run.

automationRuleIds
Array of strings

IDs of the automation rules that matched the filter and had actions that were used. Some rules may have a passing filter but won't be used if a preceding rule had a terminal action. In this case, those rule ids should not be included in this array.

completedAt
string <date-time>

The time the automation run was completed

errorMessage
string

The error message if the automation run failed

failedAt
string <date-time>

The time the automation run failed

object (InternalInfo)

Internal info

status
string (AutomationRunStatus)
Enum: "COMPLETED" "FAILED" "IN_PROGRESS"
Array of objects (AutomationStep)

Required. The steps that were planned out for the automation run.

Responses

Request samples

Content type
{
  • "entityId": "string",
  • "entityType": "orders",
  • "automationId": "string",
  • "automationRuleIds": [
    ],
  • "status": "COMPLETED",
  • "completedAt": "2019-08-24T14:15:22Z",
  • "failedAt": "2019-08-24T14:15:22Z",
  • "errorMessage": "string",
  • "actions": [
    ],
  • "steps": [
    ],
  • "internal": {
    }
}

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "automationRun": {
    }
}

Delete Automation Run

Authorizations:
Pipe17KeyAuth
path Parameters
AutomationRunId
required
string

Id of the Automation Run to delete

query Parameters
action
string (DeleteAction)
Enum: "hard" "soft"

Determines whether or not to delete automation run permanently

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Fetch Automation Run

Authorizations:
Pipe17KeyAuth
path Parameters
AutomationRunId
required
string

Id of the automation run

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "automationRun": {
    }
}

List Automation Runs

Authorizations:
Pipe17KeyAuth
query Parameters
automationId
Array of strings (AutomationRunsListFilterAutomationId)

Filter by list of automationIds

automationRunId
Array of strings (AutomationRunsListFilterAutomationRunId)

Filter by list of automationRunIds

count
integer <int32>
Default: 100

Max number of items to return

deleted
boolean

Whether to retrieve soft deleted items

entityId
Array of strings (AutomationRunsListFilterEntityId)

Filter by list of entityIds

keys
string
Default: "orgKey,automationId,automationRunId,entityId,orgKey,createdAt,updatedAt,status,completedAt,failedAt,errorMessage"

Return these top-level fields

order
string
Default: "createdAt"

Sort by these top-level field

orgKey
string

Organization key

pagination
string
Value: "disabled"

Exclude pagination info from the response

since
string <date-time>

Fetch items created after this date-time

skip
integer <int32>
Default: 0

Number of items to skip

status
Array of strings (AutomationRunsListFilterStatus)

Filter by automation run status

until
string <date-time>

Fetch items created before this date-time

updatedSince
string <date-time>

Fetch items updated after this date-time

updatedUntil
string <date-time>

Fetch items updated before this date-time

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "filters": {
    },
  • "automationRuns": [
    ],
  • "pagination": {
    }
}

Update Automation Run

Authorizations:
Pipe17KeyAuth
path Parameters
AutomationRunId
required
string

Id of the automation run to update

Request Body schema:
automationRuleIds
Array of strings

IDs of the automation rules that matched the filter and had actions that were used. Some rules may have a passing filter but won't be used if a preceding rule had a terminal action. In this case, those rule ids should not be included in this array.

completedAt
string <date-time>

The time the automation run was completed

errorMessage
string

The error message if the automation run failed

execCount
integer (AutomationRunExecCount) >= 1

The number of times the automation run has been executed. If a job fails and is retried, this number will increase.

failedAt
string <date-time>

The time the automation run failed

object (InternalInfo)

Internal info

status
string (AutomationRunStatus)
Enum: "COMPLETED" "FAILED" "IN_PROGRESS"
Array of objects (AutomationStep)

The steps that the automation run will take.

Responses

Request samples

Content type
{
  • "execCount": 1,
  • "status": "COMPLETED",
  • "completedAt": "2019-08-24T14:15:22Z",
  • "failedAt": "2019-08-24T14:15:22Z",
  • "automationRuleIds": [
    ],
  • "errorMessage": "string",
  • "steps": [
    ],
  • "internal": {
    }
}

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Automations

Operations around Automations. An automation is the highest level entity of the Automation Engine.

Automation Model

trigger
required
string (AutomationTrigger)
Enum: "NEW_ORDER" "ORDER_UPDATED" "SHIPMENT_UPDATED"

The name of the event that starts the automation.

automationId
string

The unique identifier of the automation.

createdAt
string <date-time>

When the object was created within Pipe17

object (InternalInfo)

Internal info

isEnabled
boolean
Default: true

Whether the automation is enabled or not.

orgKey
string

Organization this object belong to

updatedAt
string <date-time>

When the object was updated within Pipe17

{
  • "automationId": "string",
  • "isEnabled": true,
  • "trigger": "NEW_ORDER",
  • "internal": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "orgKey": "string"
}

Create Automation

Uniqueness constraints:

  • automation.trigger
Authorizations:
Pipe17KeyAuth
Request Body schema:
trigger
required
string (AutomationTrigger)
Enum: "NEW_ORDER" "ORDER_UPDATED" "SHIPMENT_UPDATED"

The name of the event that starts the automation.

object (InternalInfo)

Internal info

isEnabled
boolean
Default: true

Whether the automation is enabled or not.

Responses

Request samples

Content type
{
  • "isEnabled": true,
  • "trigger": "NEW_ORDER",
  • "internal": {
    }
}

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "automation": {
    }
}

Delete Automation

Authorizations:
Pipe17KeyAuth
path Parameters
AutomationId
required
string

Automation Id to delete

query Parameters
action
string (DeleteAction)
Enum: "hard" "soft"

Determines whether or not to delete automation permanently

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Fetch Automation

Authorizations:
Pipe17KeyAuth
path Parameters
AutomationId
required
string

Id of the automation to fetch

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "automation": {
    }
}

List Automations

Authorizations:
Pipe17KeyAuth
query Parameters
automationId
Array of strings (AutomationsListFilterAutomationId)

Filter by list of automationId

count
integer <int32>
Default: 100

Max number of items to return

deleted
boolean

Whether to retrieve soft deleted items

isEnabled
boolean
keys
string
Default: "automationId,isEnabled,trigger,createdAt,updatedAt,orgKey"

Return these top-level fields

order
string
Default: "createdAt"

Sort by these top-level field

orgKey
string

Organization key

pagination
string
Value: "disabled"

Exclude pagination info from the response

since
string <date-time>

Fetch items created after this date-time

skip
integer <int32>
Default: 0

Number of items to skip

trigger
Array of strings (AutomationsListFilterTrigger)
Items Enum: "NEW_ORDER" "ORDER_UPDATED" "SHIPMENT_UPDATED"

Filter by matching trigger

until
string <date-time>

Fetch items created before this date-time

updatedSince
string <date-time>

Fetch items updated after this date-time

updatedUntil
string <date-time>

Fetch items updated before this date-time

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "filters": {
    },
  • "automations": [
    ],
  • "pagination": {
    }
}

Set Automation Rule Assessment Order

Authorizations:
Pipe17KeyAuth
path Parameters
AutomationId
required
string

Automation Id to update

Request Body schema:
automationRuleIds
Array of strings

List of automation rule ids in the order they should be evaluated. Must include all automation rule ids for the automation, excluding that of the default automation rule.

Responses

Request samples

Content type
{
  • "automationRuleIds": [
    ]
}

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Update Automation

Authorizations:
Pipe17KeyAuth
path Parameters
AutomationId
required
string

Automation Id to update

Request Body schema:
object (InternalInfo)

Internal info

isEnabled
boolean

Whether the automation is enabled or not.

Responses

Request samples

Content type
{
  • "isEnabled": true,
  • "internal": {
    }
}

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Connectors

Operations about Connectors

Connector Model

connectorName
required
string

Connector Name

connectorType
required
string (ConnectorType)
Enum: "ecommerce" "finance" "logistics" "other" "plugin"

Connector Type

Array of objects (ConnectorAction)

List of actions supported by connector

availabilityStatus
string (ConnectorAvailabilityStatus)
Enum: "beta" "deprecated" "future" "general" "limited"

Connector availability status

capability
Array of strings
Items Enum: "arrivals:in" "arrivals:out" "customers:in" "customers:out" "events_outbound_batch" "events_outbound_replay" "fulfillments:in" "fulfillments:out" "inventory:in" "inventory:out" "inventory_incremental" "inventory_requires_products" "labels:in" "labels:out" "locations:in" "locations:out" "locations_multiple" "orders:in" "orders:out" "orders_cancel_in" "orders_cancel_out" "products:in" "products:out" "purchases:in" "purchases:out" "receipts:in" "receipts:out" "refunds:in" "refunds:out" "returns:in" "returns:out" "shipments:in" "shipments:out" "shipments_cancel_in" "shipments_cancel_out" "shipping_methods" "sku_mapping" "suppliers:in" "suppliers:out" "transfers:in" "transfers:out"
object (ConnectorConnection)

3rd party's credentials

connectorId
string

Connector ID

createdAt
string <date-time>

When the object was created within Pipe17

description
string

Connector description

disableAutoProvision
boolean

Disables plugin connector from being auto-provisioned to new orgs

displayName
string

Connector Display Name

Array of objects (ConnectorEntity)
intentName
string

Connector intent label

intentRank
number

Connector intent rank (higher ranks indicate better match)

intentShow
boolean

Indicates whether to show connector on intent

object (InternalInfo)

Internal info

isPublic
boolean

Public connector indicator

linkedConnectorId
string

Link connector with parent connectorId to allow parent accessing all integrations of this connector

linkedConnectorName
string

Link connector with parent by name to allow parent accessing all integrations of this connector

logoUrl
string

Logo URL

orgKey
string

Organization this object belong to

orgUnique
boolean

Indicates whether only one integration is allowed to be created in org

orgWideAccess
boolean

Indicates whether connector/integration should have access to all declared entity types

pricingCategory
string

Connector pricing category

rank
number

Connector rank in category (higher ranks indicate better match)

readme
string

Connector readme markup

selfServiceMode
string (ConnectorSelfServiceMode)
Enum: "assisted" "disabled" "full"

Connector self service mode status

object (ConnectorSettings)

Connector specific settings

slug
string

Connector Slug

status
string (ConnectorStatus)
Enum: "active" "created" "deleted" "inactive"

Connector Status

tags
Array of strings (EntityTags)

Tags assigned to entity

updatedAt
string <date-time>

When the object was updated within Pipe17

version
string

Connector version

object (ConnectorWebhook)
{
  • "connectorId": "string",
  • "status": "active",
  • "isPublic": true,
  • "rank": 0,
  • "intentShow": true,
  • "intentRank": 0,
  • "intentName": "string",
  • "capability": [
    ],
  • "availabilityStatus": "beta",
  • "selfServiceMode": "assisted",
  • "disableAutoProvision": true,
  • "description": "string",
  • "readme": "string",
  • "version": "string",
  • "connectorName": "string",
  • "connectorType": "ecommerce",
  • "pricingCategory": "string",
  • "logoUrl": "string",
  • "entities": [
    ],
  • "settings": {
    },
  • "connection": {
    },
  • "actions": [
    ],
  • "webhook": {
    },
  • "orgWideAccess": true,
  • "orgUnique": true,
  • "displayName": "string",
  • "slug": "string",
  • "linkedConnectorId": "string",
  • "linkedConnectorName": "string",
  • "tags": [
    ],
  • "internal": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "orgKey": "string"
}

Create Connector

Uniqueness constraints:

  • connector.connectorName
Authorizations:
Pipe17KeyAuth
Request Body schema:
connectorName
required
string

Connector Name

connectorType
required
string (ConnectorType)
Enum: "ecommerce" "finance" "logistics" "other" "plugin"

Connector Type

Array of objects (ConnectorAction)

List of actions supported by connector

capability
Array of strings
object (ConnectorConnection)

3rd party's credentials

description
string

Connector description

displayName
string

Connector Display Name

Array of objects (ConnectorEntity)
object (InternalInfo)

Internal info

linkedConnectorId
string

Link connector with parent connectorId to allow parent accessing all integrations of this connector

linkedConnectorName
string

Link connector with parent by name to allow parent accessing all integrations of this connector

logoUrl
string

Logo URL

orgUnique
boolean

Indicates whether only one integration is allowed to be created in org

orgWideAccess
boolean

Indicates whether connector/integration should have access to all declared entity types

pricingCategory
string

Connector pricing category

readme
string

Connector readme markup

object (ConnectorSettings)

Connector specific settings

slug
string

Connector Slug

tags
Array of strings (EntityTags)

Tags assigned to entity

version
string

Connector version

object (ConnectorWebhook)

Responses

Request samples

Content type
{
  • "description": "string",
  • "readme": "string",
  • "version": "string",
  • "connectorName": "string",
  • "connectorType": "ecommerce",
  • "pricingCategory": "string",
  • "logoUrl": "string",
  • "entities": [
    ],
  • "settings": {
    },
  • "connection": {
    },
  • "capability": [
    ],
  • "actions": [
    ],
  • "webhook": {
    },
  • "orgWideAccess": true,
  • "orgUnique": true,
  • "displayName": "string",
  • "slug": "string",
  • "linkedConnectorId": "string",
  • "linkedConnectorName": "string",
  • "tags": [
    ],
  • "internal": {
    }
}

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "connector": {
    }
}

Delete Connector

Authorizations:
Pipe17KeyAuth
path Parameters
ConnectorId
required
string

Connector Id to delete

query Parameters
action
string (DeleteAction)
Enum: "hard" "soft"

Delete connector permanently or not

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Fetch Connector

Authorizations:
Pipe17KeyAuth
path Parameters
ConnectorId
required
string

Connector Id to fetch

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "connector": {
    }
}

List Connectors

Authorizations:
Pipe17KeyAuth
query Parameters
availabilityStatus
Array of strings (ConnectorAvailabilityStatus)
Items Enum: "beta" "deprecated" "future" "general" "limited"

Retrieve connectors by list of availability statuses

capability
Array of strings

Retrieve connectors by list of capabilities

connectorId
Array of strings

Retrieve connectors by list of connectorId

connectorName
Array of strings

Retrieve connectors by list of connector names

connectorType
Array of strings (ConnectorType)
Items Enum: "ecommerce" "finance" "logistics" "other" "plugin"
count
integer <int32>
Default: 100

Return at most this many connectors

intentShow
boolean

Retrieve connectors by intentShow attribute

keys
string
Default: "displayName,description,version,connectorId,status,connectorName,connectorType,logoUrl,entities,settings,connection,createdAt,updatedAt,orgKey,tags"

Return these top-level fields

order
string
Default: "createdAt"

Sort by these top-level fields

pagination
string
Value: "disabled"

Exclude pagination info from the response

selfServiceMode
Array of strings (ConnectorSelfServiceMode)
Items Enum: "assisted" "disabled" "full"

Retrieve connectors by list of self-service modes

since
string <date-time>

Connectors created after this date-time

skip
integer <int32>
Default: 0

Skip this many connectors

slug
Array of strings

Retrieve connectors by list of connector slugs

tags
Array of strings (EntityTags)

Tags assigned to entity

until
string <date-time>

Connectors created before this date-time

updatedSince
string <date-time>

Connectors updated after this date-time

updatedUntil
string <date-time>

Connectors updated before this date-time

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "filters": {
    },
  • "connectors": [
    ],
  • "pagination": {
    }
}

Update Connector

Uniqueness constraints:

  • connector.connectorName
Authorizations:
Pipe17KeyAuth
path Parameters
ConnectorId
required
string

Connector Id to update

Request Body schema:
Array of objects or null (ConnectorAction)

List of actions supported by connector

capability
Array of strings or null
object (ConnectorConnection)

3rd party's credentials

connectorType
string (ConnectorType)
Enum: "ecommerce" "finance" "logistics" "other" "plugin"

Connector Type

description
string

Connector description

displayName
string

Connector Display Name

Array of objects (ConnectorEntity)
object (InternalInfo)

Internal info

linkedConnectorId
string or null

Link connector with parent connectorId to allow parent accessing all integrations of this connector

linkedConnectorName
string or null

Link connector with parent by name to allow parent accessing all integrations of this connector

logoUrl
string or null

Logo URL

orgUnique
boolean

Indicates whether only one integration is allowed to be created in org

orgWideAccess
boolean

Indicates whether connector/integration should have access to all declared entity types

pricingCategory
string

Connector pricing category

readme
string

Connector readme markup

object (ConnectorSettings)

Connector specific settings

slug
string

Connector Slug

status
string
Enum: "active" "inactive"

Connector Status

tags
Array of strings (EntityTags)

Tags assigned to entity

version
string

Connector version

object or null

Connector Webhook

Responses

Request samples

Content type
{
  • "description": "string",
  • "readme": "string",
  • "version": "string",
  • "connectorType": "ecommerce",
  • "pricingCategory": "string",
  • "status": "active",
  • "logoUrl": "string",
  • "entities": [
    ],
  • "settings": {
    },
  • "connection": {
    },
  • "actions": [
    ],
  • "capability": [
    ],
  • "webhook": {
    },
  • "orgWideAccess": true,
  • "orgUnique": true,
  • "displayName": "string",
  • "slug": "string",
  • "linkedConnectorId": "string",
  • "linkedConnectorName": "string",
  • "tags": [
    ],
  • "internal": {
    }
}

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Converter

Mapping rules based objects conversion

Convert a source object to target using specified mapping rules

Authorizations:
Pipe17KeyAuth
Request Body schema: application/json
required
object
source
required
object

Source object to convert

Responses

Request samples

Content type
application/json
{
  • "rules": {
    },
  • "source": { }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "code": 200,
  • "message": "string",
  • "result": {
    },
  • "info": { }
}

Event Log

Operations on Event Log

Event Model

createdAt
string <date-time>

When the object was created within Pipe17

direction
string (Direction)
Enum: "in" "out"

Route/Mapping Direction

duration
number <int32>

operation duration

entityId
string

entityId

entityType
string

entity type

eventId
string

Event ID

extEntityId
string

extEntityId

integration
string

integration id

isBatch
boolean

Indicates if the event is for a batch action

keywords
Array of strings
operation
string (EventOperation)
Enum: "acknowledge" "check" "cleanup" "create" "delete" "detach" "download" "mode" "move" "poll" "reinvite" "replay" "reset_password" "results" "set-rule-order" "setup" "sync" "update" "upgrade" "upload" "variables"

Name of operation with entity. The following operations are applicable only to particular types of entities:

  • "acknowledge" - fulfillments
  • "check" - orders
  • "cleanup" - organizations
  • "detach" - organizations
  • "download" - labels
  • "mode" - organizations
  • "move" - organizations
  • "reinvite" - users
  • "replay" - events
  • "reset_password" - users
  • "results" - jobs
  • "set-rule-order" - automations
  • "setup" - connectors
  • "sync" - arrivals, fulfillments, inventory, orders, products, receipts, shipments
  • "upgrade" - integrations
  • "upload" - labels
  • "variables" - integrations
orgKey
string

Organization this object belong to

object (EventRequestData)
requestId
string

API request Id

object (EventResponseData)
source
string
Enum: "api" "api-webhook" "custom"

Event Type

status
string (EventRequestStatus)
Enum: "acknowledged" "completed" "failed" "pending"

Event Status

timestamp
string <date-time>

When the event was triggered

updatedAt
string <date-time>

When the object was updated within Pipe17

userId
string

API user id

{
  • "eventId": "string",
  • "source": "custom",
  • "keywords": [
    ],
  • "status": "acknowledged",
  • "requestId": "string",
  • "request": {
    },
  • "response": {
    },
  • "integration": "string",
  • "operation": "acknowledge",
  • "direction": "in",
  • "entityType": "string",
  • "entityId": "string",
  • "extEntityId": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "duration": 0,
  • "userId": "string",
  • "isBatch": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "orgKey": "string"
}

Create event

Authorizations:
Pipe17KeyAuth
Request Body schema:
direction
string (Direction)
Enum: "in" "out"

Route/Mapping Direction

duration
number <int32>

operation duration

entityId
string

entityId

entityType
string

entity type

extEntityId
string

extEntityId

integration
string

integration id

isBatch
boolean

Indicates if the event is for a batch action

operation
string (EventOperation)
Enum: "acknowledge" "check" "cleanup" "create" "delete" "detach" "download" "mode" "move" "poll" "reinvite" "replay" "reset_password" "results" "set-rule-order" "setup" "sync" "update" "upgrade" "upload" "variables"

Name of operation with entity. The following operations are applicable only to particular types of entities:

  • "acknowledge" - fulfillments
  • "check" - orders
  • "cleanup" - organizations
  • "detach" - organizations
  • "download" - labels
  • "mode" - organizations
  • "move" - organizations
  • "reinvite" - users
  • "replay" - events
  • "reset_password" - users
  • "results" - jobs
  • "set-rule-order" - automations
  • "setup" - connectors
  • "sync" - arrivals, fulfillments, inventory, orders, products, receipts, shipments
  • "upgrade" - integrations
  • "upload" - labels
  • "variables" - integrations
object (EventRequestData)
requestId
string

API request Id

object (EventResponseData)
source
string (EventRequestSourcePublic)
Value: "custom"

Event Type

status
string (EventRequestStatus)
Enum: "acknowledged" "completed" "failed" "pending"

Event Status

timestamp
string <date-time>

When the event was triggered

userId
string

API user id

Responses

Request samples

Content type
{
  • "source": "custom",
  • "status": "acknowledged",
  • "requestId": "string",
  • "request": {
    },
  • "response": {
    },
  • "integration": "string",
  • "operation": "acknowledge",
  • "direction": "in",
  • "entityType": "string",
  • "entityId": "string",
  • "extEntityId": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "duration": 0,
  • "userId": "string",
  • "isBatch": true
}

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "event": {
    }
}

Delete Event

Authorizations:
Pipe17KeyAuth
path Parameters
EventId
required
string
query Parameters
action
string (DeleteAction)
Enum: "hard" "soft"

Delete event permanently or not

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Fetch Event

Authorizations:
Pipe17KeyAuth
path Parameters
EventId
required
string

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "event": {
    }
}

List Events

Authorizations:
Pipe17KeyAuth
query Parameters
apikeyId
Array of strings

Fetch by list of api keys

count
integer <int32>
Default: 100

Max number of events to return

direction
Array of strings (Direction)
Items Enum: "in" "out"

Fetch by list of direction

entityId
Array of strings

Fetch by list of entityId

entityType
Array of strings

Fetch by list of entity types

eventId
Array of strings

Fetch by list of eventId

extEntityId
Array of strings

Fetch by list of extEntityId

identity
Array of strings

Fetch by identity ids (- either integration, apikeyId, or userId)

integration
Array of strings

Fetch by list of integrations

keys
string
Default: "eventId,source,status,operation,direction,entityType,entityId,integration,extEntityId,requestId,userId,createdAt,updatedAt,orgKey"

Return these top-level fields

keywords
Array of strings

Fetch by keywords

operation
Array of strings (EventOperation)
Items Enum: "acknowledge" "check" "cleanup" "create" "delete" "detach" "download" "mode" "move" "poll" "reinvite" "replay" "reset_password" "results" "set-rule-order" "setup" "sync" "update" "upgrade" "upload" "variables"

Fetch by list of operation types

order
string
Default: "createdAt"

Sort by these top-level fields

pagination
string
Value: "disabled"

Exclude pagination info from the response

since
string <date-time>

Fetch events triggered after this date-time

skip
integer <int32>
Default: 0

Number of events to skip

source
Array of strings (EventRequestSource)
Items Enum: "api" "api-webhook" "custom"

Fetch by list of event sources

status
Array of strings (EventRequestStatus)
Items Enum: "acknowledged" "completed" "failed" "pending"

Fetch by list of event statuses

until
string <date-time>

Fetch events triggered before this date-time

userId
Array of strings

Fetch by list of userId

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "filters": {
    },
  • "events": [
    ],
  • "pagination": {
    }
}

Replay event entry

Authorizations:
Pipe17KeyAuth
path Parameters
EventId
required
string

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Update event entry

Authorizations:
Pipe17KeyAuth
path Parameters
EventId
required
string
Request Body schema:
duration
number <int32>

operation duration

isBatch
boolean

Indicates if the event is for a batch action

object (EventResponseData)
status
string (EventRequestStatus)
Enum: "acknowledged" "completed" "failed" "pending"

Event Status

Responses

Request samples

Content type
{
  • "status": "acknowledged",
  • "response": {
    },
  • "duration": 0,
  • "isBatch": true
}

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Exceptions

Operations on Exceptions

Exception Model

entityId
required
string

Entity ID

entityType
required
string (ExceptionEntityName)
Enum: "accounts" "apikey" "arrivals" "automation_rules" "automation_runs" "automations" "connectors" "customers" "entity_filters" "entity_schemas" "events" "exception_categories" "exception_filters" "exceptions" "fulfillments" "integration_actions" "integration_state" "integrations" "inventory" "inventoryrules" "jobs" "labels" "locations" "mappings" "notes" "order_routing_runs" "order_routings" "orders" "organizations" "pricing" "products" "purchases" "receipts" "references" "refunds" "returns" "roles" "routings" "shipment_boxes" "shipment_logs" "shipments" "shipping_methods" "statement_transactions" "statements" "suppliers" "trackings" "transfers" "usagedata" "usageplans" "users" "webhooks"

Exception Entity Name

exceptionType
required
string (ExceptionType)
Enum: "eApprovalRequired" "eAutomation" "eAutomationCodeActionError" "eAutomationCodeFilterError" "eCreditMemoInsufficient" "eDelayed" "eDuplicate" "eDuplicateSKU" "eEarly" "eFraudSuspected" "eGeneric" "eIncomplete" "eIncompleteAddress" "eInvalid" "eInvalidAddress" "eInvalidDate" "eInvalidLocation" "eInvalidMethod" "eInvalidSKU" "eInventoryOutOfStock" "eLarge" "eLate" "eLateCancel" "eLost" "eLow" "eMismatch" "eMismatchTax" "eMissing" "eMissingLocation" "eMissingSKU" "eOrderSyncFailure" "eOrderTaxMismatch" "eOutOfStock" "ePartiallyCanceled" "ePaymentRequired" "ePotentialOverfulfill" "eRestock" "eRouteNotFound" "eRouteOutOfStock" "eShipmentMismatch" "eShippingMethod" "eSplit" "eStuck" "eSyncFailure" "eToday" "eTransform" "eUnacknowledged" "eUnexpected" "eUnexpectedDate" "eUnexpectedSplitShipment" "eUnfulfillable"

Exception type

categoryId
string

Exception category ID

createdAt
string <date-time>

When the object was created within Pipe17

exceptionDetails
string

Exception specific error message/details

exceptionId
string

Exception ID

exceptionPriority
string (ExceptionPriority)
Enum: "high" "low" "medium"

Exception priority

exceptionSeverity
string (ExceptionSeverity)
Enum: "high" "low" "medium"

Exception severity

extEntityId
string

External Entity ID

extRelatedEntityId
string

External ID of Related Entity

integration
string

Reference to integration that created an item

object (InternalInfo)

Internal info

orgKey
string

Organization this object belong to

relatedEntityId
string

Related Entity ID (e.g. for shipping request related entity is sales order or transfer order)

relatedEntityType
string (ExceptionEntityName)
Enum: "accounts" "apikey" "arrivals" "automation_rules" "automation_runs" "automations" "connectors" "customers" "entity_filters" "entity_schemas" "events" "exception_categories" "exception_filters" "exceptions" "fulfillments" "integration_actions" "integration_state" "integrations" "inventory" "inventoryrules" "jobs" "labels" "locations" "mappings" "notes" "order_routing_runs" "order_routings" "orders" "organizations" "pricing" "products" "purchases" "receipts" "references" "refunds" "returns" "roles" "routings" "shipment_boxes" "shipment_logs" "shipments" "shipping_methods" "statement_transactions" "statements" "suppliers" "trackings" "transfers" "usagedata" "usageplans" "users" "webhooks"

Exception Entity Name

status
string (ExceptionStatus)
Enum: "active" "dismissed" "resolved"

Exception status

updatedAt
string <date-time>

When the object was updated within Pipe17

{
  • "exceptionId": "string",
  • "categoryId": "string",
  • "exceptionSeverity": "high",
  • "exceptionPriority": "high",
  • "status": "active",
  • "integration": "string",
  • "exceptionType": "eApprovalRequired",
  • "exceptionDetails": "string",
  • "entityId": "string",
  • "entityType": "accounts",
  • "relatedEntityId": "string",
  • "relatedEntityType": "accounts",
  • "extEntityId": "string",
  • "extRelatedEntityId": "string",
  • "internal": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "orgKey": "string"
}

Create Exception

Uniqueness constraints within organization:

  • exception.integration, exception.entityType, exception.exceptionType, exception.status, exception.entityId (when status==active)
Authorizations:
Pipe17KeyAuth
Request Body schema:
entityId
required
string

Entity ID

entityType
required
string (ExceptionEntityName)
Enum: "accounts" "apikey" "arrivals" "automation_rules" "automation_runs" "automations" "connectors" "customers" "entity_filters" "entity_schemas" "events" "exception_categories" "exception_filters" "exceptions" "fulfillments" "integration_actions" "integration_state" "integrations" "inventory" "inventoryrules" "jobs" "labels" "locations" "mappings" "notes" "order_routing_runs" "order_routings" "orders" "organizations" "pricing" "products" "purchases" "receipts" "references" "refunds" "returns" "roles" "routings" "shipment_boxes" "shipment_logs" "shipments" "shipping_methods" "statement_transactions" "statements" "suppliers" "trackings" "transfers" "usagedata" "usageplans" "users" "webhooks"

Exception Entity Name

exceptionType
required
string (ExceptionType)
Enum: "eApprovalRequired" "eAutomation" "eAutomationCodeActionError" "eAutomationCodeFilterError" "eCreditMemoInsufficient" "eDelayed" "eDuplicate" "eDuplicateSKU" "eEarly" "eFraudSuspected" "eGeneric" "eIncomplete" "eIncompleteAddress" "eInvalid" "eInvalidAddress" "eInvalidDate" "eInvalidLocation" "eInvalidMethod" "eInvalidSKU" "eInventoryOutOfStock" "eLarge" "eLate" "eLateCancel" "eLost" "eLow" "eMismatch" "eMismatchTax" "eMissing" "eMissingLocation" "eMissingSKU" "eOrderSyncFailure" "eOrderTaxMismatch" "eOutOfStock" "ePartiallyCanceled" "ePaymentRequired" "ePotentialOverfulfill" "eRestock" "eRouteNotFound" "eRouteOutOfStock" "eShipmentMismatch" "eShippingMethod" "eSplit" "eStuck" "eSyncFailure" "eToday" "eTransform" "eUnacknowledged" "eUnexpected" "eUnexpectedDate" "eUnexpectedSplitShipment" "eUnfulfillable"

Exception type

exceptionDetails
string

Exception specific error message/details

extEntityId
string

External Entity ID

extRelatedEntityId
string

External ID of Related Entity

object (InternalInfo)

Internal info

relatedEntityId
string

Related Entity ID (e.g. for shipping request related entity is sales order or transfer order)

relatedEntityType
string (ExceptionEntityName)
Enum: "accounts" "apikey" "arrivals" "automation_rules" "automation_runs" "automations" "connectors" "customers" "entity_filters" "entity_schemas" "events" "exception_categories" "exception_filters" "exceptions" "fulfillments" "integration_actions" "integration_state" "integrations" "inventory" "inventoryrules" "jobs" "labels" "locations" "mappings" "notes" "order_routing_runs" "order_routings" "orders" "organizations" "pricing" "products" "purchases" "receipts" "references" "refunds" "returns" "roles" "routings" "shipment_boxes" "shipment_logs" "shipments" "shipping_methods" "statement_transactions" "statements" "suppliers" "trackings" "transfers" "usagedata" "usageplans" "users" "webhooks"

Exception Entity Name

Responses

Request samples

Content type
{
  • "exceptionType": "eApprovalRequired",
  • "exceptionDetails": "string",
  • "entityId": "string",
  • "entityType": "accounts",
  • "relatedEntityId": "string",
  • "relatedEntityType": "accounts",
  • "extEntityId": "string",
  • "extRelatedEntityId": "string",
  • "internal": {
    }
}

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "exception": {
    }
}

Delete Exception

Authorizations:
Pipe17KeyAuth
path Parameters
ExceptionId
required
string

Exception ID to delete

query Parameters
action
string (DeleteAction)
Enum: "hard" "soft"

Delete exception permanently or not

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Delete Exceptions (Not Implemented)

Authorizations:
Pipe17KeyAuth

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "message": "OK (but NYI)"
}

Fetch Exception

Authorizations:
Pipe17KeyAuth
path Parameters
ExceptionId
required
string

Exception ID to fetch

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "exception": {
    }
}

List Exceptions

Authorizations:
Pipe17KeyAuth
query Parameters
categoryId
Array of strings

Exceptions by categoryId-list

count
integer <int32>
Default: 100

Max number of exceptions to return

entityId
Array of strings

Exceptions related to this list of entities

entityType
Array of strings (ExceptionEntityName)
Items Enum: "accounts" "apikey" "arrivals" "automation_rules" "automation_runs" "automations" "connectors" "customers" "entity_filters" "entity_schemas" "events" "exception_categories" "exception_filters" "exceptions" "fulfillments" "integration_actions" "integration_state" "integrations" "inventory" "inventoryrules" "jobs" "labels" "locations" "mappings" "notes" "order_routing_runs" "order_routings" "orders" "organizations" "pricing" "products" "purchases" "receipts" "references" "refunds" "returns" "roles" "routings" "shipment_boxes" "shipment_logs" "shipments" "shipping_methods" "statement_transactions" "statements" "suppliers" "trackings" "transfers" "usagedata" "usageplans" "users" "webhooks"

Exceptions related to list of entity types

exceptionId
Array of strings

Exceptions by exceptionId-list

exceptionPriority
Array of strings (ExceptionPriority)
Items Enum: "high" "low" "medium"

Exceptions by exceptionPriority-list

exceptionSeverity
Array of strings (ExceptionSeverity)
Items Enum: "high" "low" "medium"

Exceptions by exceptionSeverity-list

exceptionType
Array of strings (ExceptionType)
Items Enum: "eApprovalRequired" "eAutomation" "eAutomationCodeActionError" "eAutomationCodeFilterError" "eCreditMemoInsufficient" "eDelayed" "eDuplicate" "eDuplicateSKU" "eEarly" "eFraudSuspected" "eGeneric" "eIncomplete" "eIncompleteAddress" "eInvalid" "eInvalidAddress" "eInvalidDate" "eInvalidLocation" "eInvalidMethod" "eInvalidSKU" "eInventoryOutOfStock" "eLarge" "eLate" "eLateCancel" "eLost" "eLow" "eMismatch" "eMismatchTax" "eMissing" "eMissingLocation" "eMissingSKU" "eOrderSyncFailure" "eOrderTaxMismatch" "eOutOfStock" "ePartiallyCanceled" "ePaymentRequired" "ePotentialOverfulfill" "eRestock" "eRouteNotFound" "eRouteOutOfStock" "eShipmentMismatch" "eShippingMethod" "eSplit" "eStuck" "eSyncFailure" "eToday" "eTransform" "eUnacknowledged" "eUnexpected" "eUnexpectedDate" "eUnexpectedSplitShipment" "eUnfulfillable"

Exceptions by exceptionType-list

extEntityId
Array of strings

Exceptions related to this list of entities

extRelatedEntityId
Array of strings

Exceptions related to this list of related entities

integrationOwned
boolean

Exceptions created by current integration only

keys
string
Default: "exceptionId,categoryId,exceptionType,exceptionDetails,entityId,entityType,relatedEntityId,relatedEntityType,extEntityId,extRelatedEntityId,status,createdAt,updatedAt,orgKey"

Return these top-level fields

order
string
Default: "createdAt"

Sort by these top-level fields

pagination
string
Value: "disabled"

Exclude pagination info from the response

relatedEntityId
Array of strings

Exceptions related to this list of related entities

relatedEntityType
Array of strings (ExceptionEntityName)
Items Enum: "accounts" "apikey" "arrivals" "automation_rules" "automation_runs" "automations" "connectors" "customers" "entity_filters" "entity_schemas" "events" "exception_categories" "exception_filters" "exceptions" "fulfillments" "integration_actions" "integration_state" "integrations" "inventory" "inventoryrules" "jobs" "labels" "locations" "mappings" "notes" "order_routing_runs" "order_routings" "orders" "organizations" "pricing" "products" "purchases" "receipts" "references" "refunds" "returns" "roles" "routings" "shipment_boxes" "shipment_logs" "shipments" "shipping_methods" "statement_transactions" "statements" "suppliers" "trackings" "transfers" "usagedata" "usageplans" "users" "webhooks"

Exceptions related to list of related entity types

since
string <date-time>

Exceptions created after this date-time

skip
integer <int32>
Default: 0

Number of exceptions to skip

status
Array of strings (ExceptionStatus)
Items Enum: "active" "dismissed" "resolved"

Exceptions by status-list

until
string <date-time>

Exceptions created before this date-time

updatedSince
string <date-time>

Exceptions updated after this date-time

updatedUntil
string <date-time>

Exceptions updated before this date-time

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "filters": {
    },
  • "exceptions": [
    ],
  • "pagination": {
    }
}

Update Exception

Uniqueness constraints within organization:

  • exception.integration, exception.entityType, exception.exceptionType, exception.status, exception.entityId (when status==active)
Authorizations:
Pipe17KeyAuth
path Parameters
ExceptionId
required
string

Exception ID to update

Request Body schema:
status
required
string (ExceptionStatus)
Enum: "active" "dismissed" "resolved"

Exception status

object (InternalInfo)

Internal info

Responses

Request samples

Content type
{
  • "status": "active",
  • "internal": {
    }
}

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Integration Actions

Operations with Integration Actions

Integration Action Model

actionType
required
string

Action Type (matches to what is included in connector manifest)

integrationId
required
string

Integration ID

actionId
string

Integration action ID

actionName
string

Action Name - label for this action invocation

Array of objects (IntegrationActionParam)

Action parameters (array of parameters, collected for this action from user)

createdAt
string <date-time>

When the object was created within Pipe17

object (InternalInfo)

Internal info

orgKey
string

Organization this object belong to

progress
number

Percent action complete

status
string (IntegrationActionStatus)
Enum: "canceled" "completed" "failed" "processing" "submitted"

Integration action status

updatedAt
string <date-time>

When the object was updated within Pipe17

{
  • "actionId": "string",
  • "progress": 0,
  • "status": "canceled",
  • "actionType": "string",
  • "actionName": "string",
  • "integrationId": "string",
  • "actionParams": [
    ],
  • "internal": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "orgKey": "string"
}

Create Integration Action

Authorizations:
Pipe17KeyAuth
Request Body schema:
actionType
required
string

Action Type (matches to what is included in connector manifest)

integrationId
required
string

Integration ID

actionName
string

Action Name - label for this action invocation

Array of objects (IntegrationActionParam)

Action parameters (array of parameters, collected for this action from user)

object (InternalInfo)

Internal info

Responses

Request samples

Content type
{
  • "actionType": "string",
  • "actionName": "string",
  • "integrationId": "string",
  • "actionParams": [
    ],
  • "internal": {
    }
}

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "action": {
    }
}

Delete Integration Action

Authorizations:
Pipe17KeyAuth
path Parameters
IntegrationActionId
required
string
query Parameters
action
string (DeleteAction)
Enum: "hard" "soft"

Delete integration action permanently or not

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Delete Integration Actions

Authorizations:
Pipe17KeyAuth
query Parameters
action
string (ListDeleteAction)
Default: "list"
Enum: "hard" "list" "soft"

Soft/hard delete or list actions to be deleted

actionId
Array of strings

Delete actions by list of actionId

actionType
Array of strings

Delete actions by list of actionType

count
integer <int32>
Default: 100

Max number of actions to delete

deleted
boolean

Delete soft deleted actions

integrationId
Array of strings

Delete actions by list of integrationId

since
string <date-time>

Delete actions created after this date-time

skip
integer <int32>
Default: 0

Number of actions to skip

status
Array of strings

Delete actions by list of statuses

until
string <date-time>

Delete actions created before this date-time

updatedSince
string <date-time>

Delete actions updated after this date-time

updatedUntil
string <date-time>

Delete actions updated before this date-time

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "filters": {
    },
  • "actions": [
    ],
  • "deleted": 0,
  • "pagination": {
    }
}

Fetch Integration Action

Authorizations:
Pipe17KeyAuth
path Parameters
IntegrationActionId
required
string

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "action": {
    }
}

List Integration Actions

Authorizations:
Pipe17KeyAuth
query Parameters
actionId
Array of strings

Fetch actions by list of actionId

actionType
Array of strings

Fetch actions by list of actionType

count
integer <int32>
Default: 100

Max number of actions to return

deleted
boolean

Fetch soft deleted actions

integrationId
Array of strings

Fetch actions by list of integrationId

keys
string
Default: "actionId,actionType,actionName,actionParams,integrationId,createdAt,updatedAt,orgKey,status,progress"

Return these top-level fields

order
string
Default: "createdAt"

Sort by these top-level fields

pagination
string
Value: "disabled"

Exclude pagination info from the response

since
string <date-time>

Fetch actions created after this date-time

skip
integer <int32>
Default: 0

Number of actions to skip

status
Array of strings

Fetch actions by list of action statuses

until
string <date-time>

Fetch actions created before this date-time

updatedSince
string <date-time>

Fetch actions updated after this date-time

updatedUntil
string <date-time>

Fetch actions updated before this date-time

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "filters": {
    },
  • "actions": [
    ]
}

Update Integration Action

Authorizations:
Pipe17KeyAuth
path Parameters
IntegrationActionId
required
string
Request Body schema:
object (InternalInfo)

Internal info

progress
number

Action progress (0-100)

status
string (IntegrationActionStatus)
Enum: "canceled" "completed" "failed" "processing" "submitted"

Integration action status

Responses

Request samples

Content type
{
  • "status": "canceled",
  • "progress": 0,
  • "internal": {
    }
}

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Integrations

Operations about Integrations

Integration Model

integrationName
required
string

Integration Name

Array of objects (IntegrationActionSimple)

List of integration actions

apikey
string

Integration api Key

capability
Array of strings
Items Enum: "arrivals:in" "arrivals:out" "customers:in" "customers:out" "events_outbound_batch" "events_outbound_replay" "fulfillments:in" "fulfillments:out" "inventory:in" "inventory:out" "inventory_incremental" "inventory_requires_products" "labels:in" "labels:out" "locations:in" "locations:out" "locations_multiple" "orders:in" "orders:out" "orders_cancel_in" "orders_cancel_out" "products:in" "products:out" "purchases:in" "purchases:out" "receipts:in" "receipts:out" "refunds:in" "refunds:out" "returns:in" "returns:out" "shipments:in" "shipments:out" "shipments_cancel_in" "shipments_cancel_out" "shipping_methods" "sku_mapping" "suppliers:in" "suppliers:out" "transfers:in" "transfers:out"
object (IntegrationConnection)

3rd party's credentials

connectorId
string

Connector ID (either Name or ID required)

connectorName
string

Connector Name (either Name or ID required)

createdAt
string <date-time>

When the object was created within Pipe17

Array of objects (IntegrationEntity)
environment
string (Env)
Enum: "prod" "test"

Environment ID

errorText
string

Error message

extIntegrationId
string

Unique integration identifier as defined by Connector logic

integrationId
string

Integration Id

object (InternalInfo)

Internal info

linkedConnectorId
string
linkedConnectorName
string
orgKey
string

Organization this object belong to

object (IntegrationSettings)

Connector specific

status
string (IntegrationStatus)
Enum: "configured" "connected" "created" "disabled" "error" "future" "initializing"

Integration Status

updatedAt
string <date-time>

When the object was updated within Pipe17

object
version
string

Integration version

{
  • "apikey": "string",
  • "actions": [
    ],
  • "capability": [
    ],
  • "linkedConnectorId": "string",
  • "linkedConnectorName": "string",
  • "version": "string",
  • "integrationId": "string",
  • "extIntegrationId": "string",
  • "errorText": "string",
  • "status": "configured",
  • "variables": {
    },
  • "integrationName": "string",
  • "connectorName": "string",
  • "connectorId": "string",
  • "environment": "prod",
  • "entities": [
    ],
  • "settings": {
    },
  • "connection": {
    },
  • "internal": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "orgKey": "string"
}

Create Integration

Uniqueness constraints within organization:

  • integration.integrationName
Authorizations:
Pipe17KeyAuth
Request Body schema:
integrationName
required
string

Integration Name

object (IntegrationConnection)

3rd party's credentials

connectorId
string

Connector ID (either Name or ID required)

connectorName
string

Connector Name (either Name or ID required)

Array of objects (IntegrationEntity)
environment
string (Env)
Enum: "prod" "test"

Environment ID

object (InternalInfo)

Internal info

object (IntegrationSettings)

Connector specific

Responses

Request samples

Content type
{
  • "integrationName": "string",
  • "connectorName": "string",
  • "connectorId": "string",
  • "environment": "prod",
  • "entities": [
    ],
  • "settings": {
    },
  • "connection": {
    },
  • "internal": {
    }
}

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "integration": {
    }
}

Delete Integration

Authorizations:
Pipe17KeyAuth
path Parameters
IntegrationId
required
string

Integration Id to delete

query Parameters
action
string (DeleteAction)
Enum: "hard" "soft"

Delete integration permanently or not

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Fetch Integration

Authorizations:
Pipe17KeyAuth
path Parameters
IntegrationId
required
string

Integration Id to fetch

query Parameters
keys
string
Default: "*"

Return these top-level fields

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "integration": {
    }
}

Fetch Integration Variable(s)

Authorizations:
Pipe17KeyAuth
path Parameters
IntegrationId
required
string

Integration Id to update

query Parameters
name
Array of strings

Retrieve variables by list of their names

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "variables": {
    }
}

List Integrations

Authorizations:
Pipe17KeyAuth
query Parameters
capability
Array of strings (IntegrationCapability)
Items Enum: "arrivals:in" "arrivals:out" "customers:in" "customers:out" "events_outbound_batch" "events_outbound_replay" "fulfillments:in" "fulfillments:out" "inventory:in" "inventory:out" "inventory_incremental" "inventory_requires_products" "labels:in" "labels:out" "locations:in" "locations:out" "locations_multiple" "orders:in" "orders:out" "orders_cancel_in" "orders_cancel_out" "products:in" "products:out" "purchases:in" "purchases:out" "receipts:in" "receipts:out" "refunds:in" "refunds:out" "returns:in" "returns:out" "shipments:in" "shipments:out" "shipments_cancel_in" "shipments_cancel_out" "shipping_methods" "sku_mapping" "suppliers:in" "suppliers:out" "transfers:in" "transfers:out"

Retrieve connectors by list of capabilities

connectorId
Array of strings

Retrieve integrations by connector Id(s)

connectorName
Array of strings

Retrieve integrations by list of connector names

count
integer <int32>
Default: 100

Return at most this many integrations

extIntegrationId
Array of strings

Retrieve by list of extIntegrationId

integrationId
Array of strings

Retrieve by list of integrationId

keys
string
Default: "version,integrationId,integrationName,status,connectorName,connectorId,entities,settings,connection,createdAt,updatedAt,orgKey"

Return these top-level fields

order
string
Default: "createdAt"

Sort by these top-level fields

pagination
string
Value: "disabled"

Exclude pagination info from the response

since
string <date-time>

Integrations created after this date-time

skip
integer <int32>
Default: 0

Skip this many integrations

status
Array of strings (IntegrationStatus)
Items Enum: "configured" "connected" "created" "disabled" "error" "future" "initializing"

Retrieve integrations by status

until
string <date-time>

Integrations created before this date-time

updatedSince
string <date-time>

Integrations updated after this date-time

updatedUntil
string <date-time>

Integrations updated before this date-time

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "filters": {
    },
  • "integrations": [
    ],
  • "pagination": {
    }
}

Update Integration

Uniqueness constraints within organization:

  • integration.integrationName
Authorizations:
Pipe17KeyAuth
path Parameters
IntegrationId
required
string

Integration Id to update

Request Body schema:
apikey
boolean

Update integration api key

object (IntegrationConnection)

3rd party's credentials

Array of objects (IntegrationEntity)
errorText
string or null

Error message

extIntegrationId
string

Unique integration identifier as defined by Connector logic

integrationName
string

Integration Name

object (InternalInfo)

Internal info

object (IntegrationSettings)

Connector specific

status
string (IntegrationStatus)
Enum: "configured" "connected" "created" "disabled" "error" "future" "initializing"

Integration Status

object or null

Responses

Request samples

Content type
{
  • "status": "configured",
  • "apikey": true,
  • "integrationName": "string",
  • "extIntegrationId": "string",
  • "entities": [
    ],
  • "variables": {
    },
  • "settings": {
    },
  • "connection": {
    },
  • "errorText": "string",
  • "internal": {
    }
}

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Update Integration Variable(s)

Authorizations:
Pipe17KeyAuth
path Parameters
IntegrationId
required
string

Integration Id to update

Request Body schema:
object or null

Responses

Request samples

Content type
{
  • "variables": {
    }
}

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Upgrade Integration

Authorizations:
Pipe17KeyAuth
path Parameters
IntegrationId
required
string

Integration Id to upgrade

Request Body schema:
version
string

Connector version

Responses

Request samples

Content type
{
  • "version": "string"
}

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Mappings

Operations about Mappings

Mapping Model

description
required
string

Description

isPublic
required
boolean

Public mapping indicator

apikeyId
string

Id of apikey modified mapping

connectorId
string

Connector that uses this mapping

createdAt
string <date-time>

When the object was created within Pipe17

documentationURLs
Array of strings
object (InternalInfo)

Internal info

mappingId
string

Mapping ID

Array of objects (MappingRule)
orgKey
string

Organization this object belong to

originId
string
readme
string
updatedAt
string <date-time>

When the object was updated within Pipe17

userId
string

Id of user modified mapping

uuid
string

UUID (generated if not provided)

version
number

Mapping version

{
  • "mappingId": "string",
  • "connectorId": "string",
  • "version": 0,
  • "userId": "string",
  • "apikeyId": "string",
  • "isPublic": true,
  • "description": "string",
  • "mappings": [
    ],
  • "uuid": "string",
  • "originId": "string",
  • "documentationURLs": [
    ],
  • "readme": "string",
  • "internal": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "orgKey": "string"
}

Create Mapping

Uniqueness constraints:

  • maping.uuid
Authorizations:
Pipe17KeyAuth
Request Body schema:
description
required
string

Description

isPublic
required
boolean

Public mapping indicator

documentationURLs
Array of strings
object (InternalInfo)

Internal info

Array of objects (MappingRule)
originId
string
readme
string
uuid
string

UUID (generated if not provided)

Responses

Request samples

Content type
{
  • "isPublic": true,
  • "description": "string",
  • "mappings": [
    ],
  • "uuid": "string",
  • "originId": "string",
  • "documentationURLs": [
    ],
  • "readme": "string",
  • "internal": {
    }
}

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "mapping": {
    }
}

Delete Mapping

Authorizations:
Pipe17KeyAuth
path Parameters
MappingId
required
string

ID or uuid:{uuid} of mapping to delete

query Parameters
action
string (DeleteAction)
Enum: "hard" "soft"

Delete mapping permanently or not

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Fetch Mapping

Authorizations:
Pipe17KeyAuth
path Parameters
MappingId
required
string

ID or uuid:{uuid} of mapping to fetch

query Parameters
merge
string (MappingsMergeMode)
Enum: "none" "origin"

Mapping merge mode

version
string

ID of mapping rules version to retrieve

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "mapping": {
    }
}

List Mappings

Authorizations:
Pipe17KeyAuth
query Parameters
connectorId
Array of strings

Mappings by list of connectorId

count
integer <int32>
Default: 100

Return at most this many mappings

desc
string

Fetch mappings by description (strings "/{pattern}/" and "/{pattern}/i" are interpreted as regexps)

keys
string
Default: "mappingId,connectorId,uuid,description,createdAt,updatedAt,orgKey,isPublic,originId,documentationURLs,readme"

Return these top-level fields

mappingId
Array of strings

Mappings by list of mappingId

order
string
Default: "createdAt"

Sort by these top-level fields

originId
Array of strings

Mappings by list of originId

pagination
string
Value: "disabled"

Exclude pagination info from the response

since
string <date-time>

Mappings created after this date-time

skip
integer <int32>
Default: 0

Skip this many mappings

until
string <date-time>

Mappings created before this date-time

updatedSince
string <date-time>

Mappings updated after this date-time

updatedUntil
string <date-time>

Mappings updated before this date-time

uuid
Array of strings

Mappings by list of UUIDs

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "filters": {
    },
  • "mappings": [
    ],
  • "pagination": {
    }
}

Update Mapping

Uniqueness constraints:

  • mapping.uuid
Authorizations:
Pipe17KeyAuth
path Parameters
MappingId
required
string

ID or uuid:{uuid} of mapping to update

Request Body schema:
description
string

Description

documentationURLs
Array of strings or null
object (InternalInfo)

Internal info

isPublic
boolean

Public mapping indicator

Array of objects (MappingUpdateRule)
originId
string
readme
string or null

Responses

Request samples

Content type
{
  • "isPublic": true,
  • "description": "string",
  • "mappings": [
    ],
  • "originId": "string",
  • "documentationURLs": [
    ],
  • "readme": "string",
  • "internal": {
    }
}

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Notes

Operations about Notes

Note Model

changeSource
required
string (NoteChangeSource)
Enum: "api" "other" "ui"

Change source

changeType
required
string (NoteChangeType)
Enum: "comment" "config" "other"

Change type

entityId
required
string

Target entity ID

entityType
required
string

Target entity type

action
string (NoteAction)
Enum: "create" "delete" "update"

Action enum

createdAt
string <date-time>

When the object was created within Pipe17

eventId
string

Event ID associated with note

extEntityId
string

Target entity external ID

generatedText
string

Generated summary of changes

object (InternalInfo)

Internal info

isPublic
boolean

Public note indicator (default - true)

noteId
string

Note Id

orgKey
string

Organization this object belong to

postValue
object

Value of target entity after change

preValue
object

Value of target entity before change

reference
string
relatedEntityId
string

Related entity ID

relatedEntityType
string

Related entity type

relatedReference
string
severity
string (NoteSeverity)
Enum: "high" "low" "normal"

Note severity

status
string (NoteStatus)
Value: "valid"

Note status

tags
Array of strings (EntityTags)

Tags assigned to entity

text
string

Note content

updatedAt
string <date-time>

When the object was updated within Pipe17

userId
string

Author Id

{
  • "noteId": "string",
  • "userId": "string",
  • "entityId": "string",
  • "entityType": "string",
  • "extEntityId": "string",
  • "relatedEntityId": "string",
  • "relatedEntityType": "string",
  • "eventId": "string",
  • "isPublic": true,
  • "text": "string",
  • "severity": "high",
  • "status": "valid",
  • "tags": [
    ],
  • "changeSource": "api",
  • "changeType": "comment",
  • "preValue": { },
  • "postValue": { },
  • "generatedText": "string",
  • "internal": {
    },
  • "reference": "string",
  • "relatedReference": "string",
  • "action": "create",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "orgKey": "string"
}

Create Note

Authorizations:
Pipe17KeyAuth
Request Body schema:
changeSource
required
string (NoteChangeSource)
Enum: "api" "other" "ui"

Change source

changeType
required
string (NoteChangeType)
Enum: "comment" "config" "other"

Change type

entityId
required
string

Target entity ID

entityType
required
string

Target entity type

action
string (NoteAction)
Enum: "create" "delete" "update"

Action enum

eventId
string

Event ID associated with note

extEntityId
string

Target entity external ID

generatedText
string

Generated summary of changes

object (InternalInfo)

Internal info

isPublic
boolean

Public note indicator (default - true)

postValue
object

Value of target entity after change

preValue
object

Value of target entity before change

reference
string
relatedEntityId
string

Related entity ID

relatedEntityType
string

Related entity type

relatedReference
string
severity
string (NoteSeverity)
Enum: "high" "low" "normal"

Note severity

status
string (NoteStatus)
Value: "valid"

Note status

tags
Array of strings (EntityTags)

Tags assigned to entity

text
string

Note content

Responses

Request samples

Content type
{
  • "entityId": "string",
  • "entityType": "string",
  • "extEntityId": "string",
  • "relatedEntityId": "string",
  • "relatedEntityType": "string",
  • "eventId": "string",
  • "isPublic": true,
  • "text": "string",
  • "severity": "high",
  • "status": "valid",
  • "tags": [
    ],
  • "changeSource": "api",
  • "changeType": "comment",
  • "preValue": { },
  • "postValue": { },
  • "generatedText": "string",
  • "internal": {
    },
  • "reference": "string",
  • "relatedReference": "string",
  • "action": "create"
}

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "note": {
    }
}

Delete Note

Authorizations:
Pipe17KeyAuth
path Parameters
NoteId
required
string

Note Id to delete

query Parameters
action
string (DeleteAction)
Enum: "hard" "soft"

Delete note permanently or not

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Fetch Note

Authorizations:
Pipe17KeyAuth
path Parameters
NoteId
required
string

Note Id to fetch

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "note": {
    }
}

List Notes

Authorizations:
Pipe17KeyAuth
query Parameters
count
integer <int32>
Default: 100

Return at most this many Notes

entityId
Array of strings

Retrieve notes by entityId list

entityType
Array of strings

Retrieve notes by entityType list

eventId
Array of strings

Retrieve notes by eventId list

keys
string
Default: "changeSource,changeType,text,generatedText,noteId,entityId,entityType,extEntityId,relatedEntityId,relatedEntityType,eventId,isPublic,severity,tags,userId,createdAt,updatedAt,orgKey,status"

Return these top-level fields

noteId
Array of strings

Retrieve notes by noteId list

order
string
Default: "createdAt"

Sort by these top-level fields

pagination
string
Value: "disabled"

Exclude pagination info from the response

severity
Array of strings (NoteSeverity)
Items Enum: "high" "low" "normal"

Retrieve notes by severity list

since
string <date-time>

Notes created after this date-time

skip
integer <int32>
Default: 0

Skip this many Notes

status
Array of strings (NoteStatus)
Items Value: "valid"

Retrieve notes by status list

tags
Array of strings (EntityTags)

Tags assigned to entity

until
string <date-time>

Notes created before this date-time

updatedSince
string <date-time>

Notes updated after this date-time

updatedUntil
string <date-time>

Notes updated before this date-time

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "filters": {
    },
  • "notes": [
    ],
  • "pagination": {
    }
}

Update Note

Authorizations:
Pipe17KeyAuth
path Parameters
NoteId
required
string

Note Id to update

Request Body schema:
action
string (NoteAction)
Enum: "create" "delete" "update"

Action enum

generatedText
string or null

Generated summary of changes

object (InternalInfo)

Internal info

postValue
object or null

Value of target entity after change

preValue
object or null

Value of target entity before change

reference
string
relatedEntityId
string

Related entity ID

relatedEntityType
string

Related entity type

relatedReference
string
severity
string (NoteSeverity)
Enum: "high" "low" "normal"

Note severity

status
string (NoteStatus)
Value: "valid"

Note status

tags
Array of strings (EntityTags)

Tags assigned to entity

text
string

Note content

Responses

Request samples

Content type
{
  • "relatedEntityId": "string",
  • "relatedEntityType": "string",
  • "text": "string",
  • "severity": "high",
  • "status": "valid",
  • "tags": [
    ],
  • "preValue": { },
  • "postValue": { },
  • "generatedText": "string",
  • "internal": {
    },
  • "reference": "string",
  • "relatedReference": "string",
  • "action": "create"
}

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

References

Entity field values

List distinct values of a field in entity collection

Authorizations:
Pipe17KeyAuth
query Parameters
field
required
string (EntityFieldRef)
Enum: "orders.orderSource" "products.integration" "products.sku" "products.vendor"

Entity field reference, in "entityType.fieldPath" format

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "code": 200,
  • "filters": {
    },
  • "values": [
    ]
}

Webhooks

Operations about Webhooks

Webhook Model

apikey
required
string

Webhook api key

topics
required
Array of strings (WebhookTopics)
Items Enum: "arrivals" "exceptions" "fulfillments" "integration_actions" "integrations" "inventory" "labels" "locations" "orders" "products" "purchases" "receipts" "refunds" "returns" "shipments" "suppliers" "trackings" "transfers"

Webhook topics

url
required
string

Webhook URL

connectorId
string

Connector ID

createdAt
string <date-time>

When the object was created within Pipe17

integration
string

Integration ID

object (InternalInfo)

Internal info

orgKey
string

Organization this object belong to

updatedAt
string <date-time>

When the object was updated within Pipe17

webhookId
string

Webhook ID

{
  • "webhookId": "string",
  • "integration": "string",
  • "connectorId": "string",
  • "url": "string",
  • "apikey": "string",
  • "topics": [
    ],
  • "internal": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "orgKey": "string"
}

Create Webhook

Authorizations:
Pipe17KeyAuth
Request Body schema:
apikey
required
string

Webhook api key

topics
required
Array of strings (WebhookTopics)
Items Enum: "arrivals" "exceptions" "fulfillments" "integration_actions" "integrations" "inventory" "labels" "locations" "orders" "products" "purchases" "receipts" "refunds" "returns" "shipments" "suppliers" "trackings" "transfers"

Webhook topics

url
required
string

Webhook URL

object (InternalInfo)

Internal info

Responses

Request samples

Content type
{
  • "url": "string",
  • "apikey": "string",
  • "topics": [
    ],
  • "internal": {
    }
}

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "webhook": {
    }
}

Delete Webhook

Authorizations:
Pipe17KeyAuth
path Parameters
WebhookId
required
string

Webhook ID to delete

query Parameters
action
string (DeleteAction)
Enum: "hard" "soft"

Delete webhook permanently or not

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Fetch Webhook

Authorizations:
Pipe17KeyAuth
path Parameters
WebhookId
required
string

Webhook ID to fetch

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "webhook": {
    }
}

List Webhooks

Authorizations:
Pipe17KeyAuth
query Parameters
count
integer <int32>
Default: 100

Return at most this many webhooks

keys
string
Default: "createdAt,orgKey,topics,updatedAt,webhookId"

Return these top-level fields

order
string
Default: "createdAt"

Sort by these top-level fields

pagination
string
Value: "disabled"

Exclude pagination info from the response

related
boolean

Include related webhooks

since
string <date-time>

Webhooks created after this date-time

skip
integer <int32>
Default: 0

Skip this many webhooks

topic
string (WebhookTopics)
Enum: "arrivals" "exceptions" "fulfillments" "integration_actions" "integrations" "inventory" "labels" "locations" "orders" "products" "purchases" "receipts" "refunds" "returns" "shipments" "suppliers" "trackings" "transfers"

Webhooks for this topic

until
string <date-time>

Webhooks created before this date-time

updatedSince
string <date-time>

Webhooks updated after this date-time

updatedUntil
string <date-time>

Webhooks updated before this date-time

webhookId
Array of strings

Webhooks by list of webhookId

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "filters": {
    },
  • "webhooks": [
    ],
  • "pagination": {
    }
}

Update Webhook

Authorizations:
Pipe17KeyAuth
path Parameters
WebhookId
required
string

Webhook ID to update

Request Body schema:
apikey
string

Webhook api key

object (InternalInfo)

Internal info

topics
Array of strings (WebhookTopics)
Items Enum: "arrivals" "exceptions" "fulfillments" "integration_actions" "integrations" "inventory" "labels" "locations" "orders" "products" "purchases" "receipts" "refunds" "returns" "shipments" "suppliers" "trackings" "transfers"

Webhook Topics

url
string

Webhook URL

Responses

Request samples

Content type
{
  • "url": "string",
  • "apikey": "string",
  • "topics": [
    ],
  • "internal": {
    }
}

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Accounts

Operations about Accounts

Account Model

activationKey
string

Account Activation Key

object (Branding)

Branding information

Array of objects (AccountContact)
createdAt
string <date-time>

When the object was created within Pipe17

deletedAt
string <date-time>
enforceMFA
string (AccountEnforceMFA)
Enum: "all" "primary" "selected"
expirationDate
string <date>
integrations
Array of strings

Account Integrations

object (InternalInfo)

Internal info

isMultiOrgAllowed
boolean

Indicates whether customer allowed to create secondary orgs

isRebrandingAllowed
boolean

Indicates whether customer allowed to re-brand app dashboard

orgKey
string

Organization this object belong to

pausedAt
string <date-time>
object (AccountPayment)
roleIds
Array of strings

Account Role IDs

secondaryOrgLimit
number

Defines maximum number of secondary orgs allowed for account

status
string (AccountStatusWithDeleted)
Enum: "active" "deleted" "disabled" "paused" "pending" "retired"

Account's Status

updatedAt
string <date-time>

When the object was updated within Pipe17

userId
string

Account User ID

{
  • "status": "active",
  • "userId": "string",
  • "roleIds": [
    ],
  • "integrations": [
    ],
  • "activationKey": "string",
  • "expirationDate": "2019-08-24",
  • "isRebrandingAllowed": true,
  • "isMultiOrgAllowed": true,
  • "secondaryOrgLimit": 0,
  • "payment": {
    },
  • "branding": {
    },
  • "pausedAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "internal": {
    },
  • "contacts": [
    ],
  • "enforceMFA": "all",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "orgKey": "string"
}

Create Account

Authorizations:
Pipe17KeyAuth
Request Body schema:
required
object (AccountAddress)
email
required
string

Account Owner email

ownerFirstName
required
string

Account Owner First Name

ownerLastName
required
string

Account Owner Last Name

password
required
string

Account Owner password

phone
required
string

Account Phone

timeZone
required
string

Account Time Zone

accountName
string

Account Name

companyName
string

Company Name

Array of objects (AccountContact)
enforceMFA
string (AccountEnforceMFA)
Enum: "all" "primary" "selected"
integrations
Array of strings

Account Integrations

object (InternalInfo)

Internal info

isMultiOrgAllowed
boolean

Indicates whether customer allowed to create secondary orgs

isRebrandingAllowed
boolean

Indicates whether customer allowed to re-brand app dashboard

logoUrl
string

Logo URL

object (AccountPayment)
secondaryOrgLimit
number

Defines maximum number of secondary orgs allowed for account

Responses

Request samples

Content type
{
  • "email": "string",
  • "ownerFirstName": "string",
  • "ownerLastName": "string",
  • "accountName": "string",
  • "companyName": "string",
  • "phone": "string",
  • "timeZone": "string",
  • "logoUrl": "string",
  • "address": {
    },
  • "integrations": [
    ],
  • "payment": {
    },
  • "isRebrandingAllowed": true,
  • "isMultiOrgAllowed": true,
  • "secondaryOrgLimit": 0,
  • "internal": {
    },
  • "contacts": [
    ],
  • "enforceMFA": "all",
  • "password": "string"
}

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "account": {
    },
  • "activationKey": "string"
}

Delete Account

Authorizations:
Pipe17KeyAuth
path Parameters
OrgKeyOrActivationKey
required
string

Account OrgKey to delete

query Parameters
action
string (DeleteAction)
Enum: "hard" "soft"

Delete account permanently or not

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Fetch Account

Authorizations:
Pipe17KeyAuth
path Parameters
OrgKeyOrActivationKey
required
string

Account OrgKey to fetch

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "account": {
    }
}

List Accounts

Authorizations:
Pipe17KeyAuth
query Parameters
billingStatus
Array of strings (AccountBillingStatus)
Items Enum: "discontinued" "paid" "paidCanceled" "pastDue" "trial" "unknown" "unpaid"

Accounts by list of billingStatus

count
integer <int32>
Default: 100

Return at most this many accounts

deletedSince
string <date-time>

Accounts with deletedAt after this date-time

deletedUntil
string <date-time>

Accounts with deletedAt before this date-time

expirationSince
string <date-time>

Accounts with expiration after this date-time

expirationUntil
string <date-time>

Accounts with expiration before this date-time

isMultiOrgAllowed
boolean

Accounts by isMultiOrgAllowed

keys
string
Default: "activationKey,expirationDate,integrations,payment,roleIds,userId,orgKey,status,isMultiOrgAllowed,secondaryOrgLimit,isRebrandingAllowed,createdAt,updatedAt"

Return these top-level fields

order
string
Default: "createdAt"

Sort by these top-level fields

orgKey
Array of strings

Accounts by list of orgKey

pagination
string
Value: "disabled"

Exclude pagination info from the response

pausedSince
string <date-time>

Accounts with pausedAt after this date-time

pausedUntil
string <date-time>

Accounts with pausedAt before this date-time

renewalSince
string <date-time>

Accounts with renewalDate after this date-time

renewalUntil
string <date-time>

Accounts with renewalDate before this date-time

since
string <date-time>

Accounts created after this date-time

skip
integer <int32>
Default: 0

Skip this many accounts

status
Array of strings (AccountStatusWithDeleted)
Items Enum: "active" "deleted" "disabled" "paused" "pending" "retired"

Accounts by list of status

until
string <date-time>

Accounts created before this date-time

updatedSince
string <date-time>

Accounts updated after this date-time

updatedUntil
string <date-time>

Accounts updated before this date-time

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "filters": {
    },
  • "accounts": [
    ],
  • "pagination": {
    }
}

Update Account

Authorizations:
Pipe17KeyAuth
path Parameters
OrgKeyOrActivationKey
required
string

Account Activation key

Request Body schema:
Array of objects or null (AccountContact)
enforceMFA
string (AccountEnforceMFA)
Enum: "all" "primary" "selected"
expirationDate
string <date>
object (InternalInfo)

Internal info

isMultiOrgAllowed
boolean

Indicates whether customer allowed to create secondary orgs

isRebrandingAllowed
boolean

Indicates whether customer allowed to re-brand app dashboard

object or null (AccountPaymentUpdate)
secondaryOrgLimit
number

Defines maximum number of secondary orgs allowed for account

status
string (AccountStatus)
Enum: "active" "disabled" "paused" "pending" "retired"

Account's Status

Responses

Request samples

Content type
{
  • "status": "active",
  • "expirationDate": "2019-08-24",
  • "isRebrandingAllowed": true,
  • "isMultiOrgAllowed": true,
  • "secondaryOrgLimit": 0,
  • "payment": {
    },
  • "internal": {
    },
  • "contacts": [
    ],
  • "enforceMFA": "all"
}

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Organizations

Operations about Organizations

Organization Model

required
object (OrganizationAddress)
email
required
string

Organization Contact email

name
required
string

Organization Name

phone
required
string

Organization Contact Phone

tier
required
string (OrganizationServiceTier)
Enum: "basic" "enterprise" "free"

Organization Service Tier

timeZone
required
string (Timezone)
Enum: "Africa/Algiers" "Africa/Cairo" "Africa/Casablanca" "Africa/Harare" "Africa/Johannesburg" "Africa/Monrovia" "Africa/Nairobi" "America/Argentina/Buenos_Aires" "America/Bogota" "America/Caracas" "America/Chicago" "America/Chihuahua" "America/Denver" "America/Godthab" "America/Guatemala" "America/Guyana" "America/Halifax" "America/Indiana/Indianapolis" "America/Juneau" "America/La_Paz" "America/Lima" "America/Los_Angeles" "America/Mazatlan" "America/Mexico_City" "America/Monterrey" "America/Montevideo" "America/New_York" "America/Phoenix" "America/Puerto_Rico" "America/Regina" "America/Santiago" "America/Sao_Paulo" "America/St_Johns" "America/Tijuana" "Asia/Almaty" "Asia/Baghdad" "Asia/Baku" "Asia/Bangkok" "Asia/Chongqing" "Asia/Colombo" "Asia/Dhaka" "Asia/Hong_Kong" "Asia/Irkutsk" "Asia/Jakarta" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kathmandu" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuala_Lumpur" "Asia/Kuwait" "Asia/Magadan" "Asia/Muscat" "Asia/Novosibirsk" "Asia/Rangoon" "Asia/Riyadh" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Srednekolymsk" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Tokyo" "Asia/Ulaanbaatar" "Asia/Urumqi" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Cape_Verde" "Atlantic/South_Georgia" "Australia/Adelaide" "Australia/Brisbane" "Australia/Darwin" "Australia/Hobart" "Australia/Melbourne" "Australia/Perth" "Australia/Sydney" "Etc/UTC" "Europe/Amsterdam" "Europe/Athens" "Europe/Belgrade" "Europe/Berlin" "Europe/Bratislava" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Copenhagen" "Europe/Dublin" "Europe/Helsinki" "Europe/Istanbul" "Europe/Kaliningrad" "Europe/Kiev" "Europe/Lisbon" "Europe/Ljubljana" "Europe/London" "Europe/Madrid" "Europe/Minsk" "Europe/Moscow" "Europe/Paris" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/Sarajevo" "Europe/Skopje" "Europe/Sofia" "Europe/Stockholm" "Europe/Tallinn" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zagreb" "Europe/Zurich" "Pacific/Apia" "Pacific/Auckland" "Pacific/Chatham" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Majuro" "Pacific/Midway" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Port_Moresby" "Pacific/Tongatapu"

Timezone

accountId
string

Parent account Id

object (Branding)

Branding information

Array of objects (OrganizationContact)
createdAt
string <date-time>

When the object was created within Pipe17

object (InternalInfo)

Internal info

isHoldingOrg
boolean

Marks organization as holding, i.e. parent org with no access to business objects.

logoUrl
string

Logo URL

orgKey
string

Organization this object belong to

orgMode
string (OrganizationMode)
Enum: "demo" "production" "test"

Organization Mode

Array of objects (OrganizationSetting)

Organization level settings

status
string (OrganizationStatus)
Enum: "active" "disabled" "pending"

Organization Account Status

updatedAt
string <date-time>

When the object was updated within Pipe17

{
  • "status": "active",
  • "accountId": "string",
  • "isHoldingOrg": true,
  • "branding": {
    },
  • "name": "string",
  • "tier": "basic",
  • "email": "string",
  • "phone": "string",
  • "timeZone": "Africa/Algiers",
  • "logoUrl": "string",
  • "address": {
    },
  • "orgMode": "demo",
  • "settings": [
    ],
  • "internal": {
    },
  • "contacts": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "orgKey": "string"
}

Cleanup organization

Authorizations:
Pipe17KeyAuth
path Parameters
OrgKey
required
string

orgKey to cleanup

Request Body schema:
orgModes
required
Array of strings (OrganizationMode)
Items Enum: "demo" "production" "test"

Only cleanup entities assigned this orgModes

entityTypes
Array of strings (EntityName)
Items Enum: "accounts" "arrivals" "automation_rules" "automation_runs" "automations" "connectors" "customers" "entity_filters" "exceptions" "fulfillments" "inventory" "inventoryrules" "labels" "locations" "order_regions" "order_routings" "orders" "products" "purchases" "receipts" "refunds" "returns" "shipment_boxes" "shipment_logs" "shipments" "shipping_methods" "statement_transactions" "statements" "suppliers" "trackings" "transfers" "usagedata" "usageplans"

Only cleanup entities of these types

hardDelete
boolean

Use hard delete for data cleanup

Responses

Request samples

Content type
{
  • "orgModes": [
    ],
  • "entityTypes": [
    ],
  • "hardDelete": true
}

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Create Organization

Authorizations:
Pipe17KeyAuth
query Parameters
ownerMode
string
Enum: "both" "owner" "primary"
Request Body schema:
required
object (OrganizationAddress)
email
required
string

Organization Contact email

name
required
string

Organization Name

phone
required
string

Organization Contact Phone

tier
required
string (OrganizationServiceTier)
Enum: "basic" "enterprise" "free"

Organization Service Tier

timeZone
required
string (Timezone)
Enum: "Africa/Algiers" "Africa/Cairo" "Africa/Casablanca" "Africa/Harare" "Africa/Johannesburg" "Africa/Monrovia" "Africa/Nairobi" "America/Argentina/Buenos_Aires" "America/Bogota" "America/Caracas" "America/Chicago" "America/Chihuahua" "America/Denver" "America/Godthab" "America/Guatemala" "America/Guyana" "America/Halifax" "America/Indiana/Indianapolis" "America/Juneau" "America/La_Paz" "America/Lima" "America/Los_Angeles" "America/Mazatlan" "America/Mexico_City" "America/Monterrey" "America/Montevideo" "America/New_York" "America/Phoenix" "America/Puerto_Rico" "America/Regina" "America/Santiago" "America/Sao_Paulo" "America/St_Johns" "America/Tijuana" "Asia/Almaty" "Asia/Baghdad" "Asia/Baku" "Asia/Bangkok" "Asia/Chongqing" "Asia/Colombo" "Asia/Dhaka" "Asia/Hong_Kong" "Asia/Irkutsk" "Asia/Jakarta" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kathmandu" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuala_Lumpur" "Asia/Kuwait" "Asia/Magadan" "Asia/Muscat" "Asia/Novosibirsk" "Asia/Rangoon" "Asia/Riyadh" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Srednekolymsk" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Tokyo" "Asia/Ulaanbaatar" "Asia/Urumqi" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Cape_Verde" "Atlantic/South_Georgia" "Australia/Adelaide" "Australia/Brisbane" "Australia/Darwin" "Australia/Hobart" "Australia/Melbourne" "Australia/Perth" "Australia/Sydney" "Etc/UTC" "Europe/Amsterdam" "Europe/Athens" "Europe/Belgrade" "Europe/Berlin" "Europe/Bratislava" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Copenhagen" "Europe/Dublin" "Europe/Helsinki" "Europe/Istanbul" "Europe/Kaliningrad" "Europe/Kiev" "Europe/Lisbon" "Europe/Ljubljana" "Europe/London" "Europe/Madrid" "Europe/Minsk" "Europe/Moscow" "Europe/Paris" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/Sarajevo" "Europe/Skopje" "Europe/Sofia" "Europe/Stockholm" "Europe/Tallinn" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zagreb" "Europe/Zurich" "Pacific/Apia" "Pacific/Auckland" "Pacific/Chatham" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Majuro" "Pacific/Midway" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Port_Moresby" "Pacific/Tongatapu"

Timezone

Array of objects (OrganizationContact)
object (InternalInfo)

Internal info

logoUrl
string

Logo URL

orgMode
string (OrganizationMode)
Enum: "demo" "production" "test"

Organization Mode

Array of objects (OrganizationSetting)

Organization level settings

Responses

Request samples

Content type
{
  • "name": "string",
  • "tier": "basic",
  • "email": "string",
  • "phone": "string",
  • "timeZone": "Africa/Algiers",
  • "logoUrl": "string",
  • "address": {
    },
  • "orgMode": "demo",
  • "settings": [
    ],
  • "internal": {
    },
  • "contacts": [
    ]
}

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "organization": {
    }
}

Delete Organization

Authorizations:
Pipe17KeyAuth
path Parameters
OrganizationId
required
string

Organization Id to delete

query Parameters
action
string (DeleteAction)
Enum: "hard" "soft"

Delete organization permanently or not

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Detach secondary organization into separate account

Authorizations:
Pipe17KeyAuth
path Parameters
OrgKey
required
string

orgKey to detach

Request Body schema:
object (OrganizationDetachRequest)

Responses

Request samples

Content type
{ }

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Fetch Organization

Authorizations:
Pipe17KeyAuth
path Parameters
OrganizationId
required
string

Organization Id to fetch

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "organization": {
    }
}

List Organizations

Authorizations:
Pipe17KeyAuth
query Parameters
accountId
Array of strings

Organizations by list of accountId

count
integer <int32>
Default: 100

Return at most this many organizations

deleted
boolean

Fetch only soft-deleted organizations (ignore status)

email
string

Organizations by email (strings "/{pattern}/" and "/{pattern}/i" are interpreted as regexps)

keys
string
Default: "orgKey,accountId,name,tier,status,isHoldingOrg,createdAt,updatedAt"

Return these top-level fields

name
string

Organizations by name (strings "/{pattern}/" and "/{pattern}/i" are interpreted as regexps)

order
string
Default: "createdAt"

Sort by these top-level fields

orgKey
Array of strings

Organizations by list of orgKey

orgMode
Array of strings (OrganizationMode)
Items Enum: "demo" "production" "test"

Organizations by list of modes

pagination
string
Value: "disabled"

Exclude pagination info from the response

phone
string

Organizations by phone (strings "/{pattern}/" and "/{pattern}/i" are interpreted as regexps)

since
string <date-time>

Organizations created after this date-time

skip
integer <int32>
Default: 0

Skip this many organizations

status
Array of strings (OrganizationStatus)
Items Enum: "active" "disabled" "pending"

Organizations by list of statuses

until
string <date-time>

Organizations created before this date-time

updatedSince
string <date-time>

Organizations updated after this date-time

updatedUntil
string <date-time>

Organizations updated before this date-time

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "filters": {
    },
  • "organizations": [
    ],
  • "pagination": {
    }
}

Move organization to another account

Authorizations:
Pipe17KeyAuth
path Parameters
OrgKey
required
string

orgKey to move

Request Body schema:
accountId
required
string

Target account ID

Responses

Request samples

Content type
{
  • "accountId": "string"
}

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Switch organization mode

Authorizations:
Pipe17KeyAuth
path Parameters
OrgKey
required
string

orgKey to switch

Request Body schema:
orgMode
required
string (OrganizationMode)
Enum: "demo" "production" "test"

Organization Mode

Responses

Request samples

Content type
{
  • "orgMode": "demo"
}

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Update Organization

Authorizations:
Pipe17KeyAuth
path Parameters
OrganizationId
required
string

Organization Id to update

Request Body schema:
object (OrganizationUpdateAddress)
object (Branding)

Branding information

Array of objects or null (OrganizationContact)
email
string

Organization Contact email

object (InternalInfo)

Internal info

isHoldingOrg
boolean

Marks organization as holding, i.e. parent org with no access to business objects.

logoUrl
string

Logo URL

name
string

Organization Name

phone
string

Organization Contact Phone

Array of objects (OrganizationSetting)

Organization level settings

status
string (OrganizationStatus)
Enum: "active" "disabled" "pending"

Organization Account Status

tier
string (OrganizationServiceTier)
Enum: "basic" "enterprise" "free"

Organization Service Tier

timeZone
string (Timezone)
Enum: "Africa/Algiers" "Africa/Cairo" "Africa/Casablanca" "Africa/Harare" "Africa/Johannesburg" "Africa/Monrovia" "Africa/Nairobi" "America/Argentina/Buenos_Aires" "America/Bogota" "America/Caracas" "America/Chicago" "America/Chihuahua" "America/Denver" "America/Godthab" "America/Guatemala" "America/Guyana" "America/Halifax" "America/Indiana/Indianapolis" "America/Juneau" "America/La_Paz" "America/Lima" "America/Los_Angeles" "America/Mazatlan" "America/Mexico_City" "America/Monterrey" "America/Montevideo" "America/New_York" "America/Phoenix" "America/Puerto_Rico" "America/Regina" "America/Santiago" "America/Sao_Paulo" "America/St_Johns" "America/Tijuana" "Asia/Almaty" "Asia/Baghdad" "Asia/Baku" "Asia/Bangkok" "Asia/Chongqing" "Asia/Colombo" "Asia/Dhaka" "Asia/Hong_Kong" "Asia/Irkutsk" "Asia/Jakarta" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kathmandu" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuala_Lumpur" "Asia/Kuwait" "Asia/Magadan" "Asia/Muscat" "Asia/Novosibirsk" "Asia/Rangoon" "Asia/Riyadh" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Srednekolymsk" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Tokyo" "Asia/Ulaanbaatar" "Asia/Urumqi" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Cape_Verde" "Atlantic/South_Georgia" "Australia/Adelaide" "Australia/Brisbane" "Australia/Darwin" "Australia/Hobart" "Australia/Melbourne" "Australia/Perth" "Australia/Sydney" "Etc/UTC" "Europe/Amsterdam" "Europe/Athens" "Europe/Belgrade" "Europe/Berlin" "Europe/Bratislava" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Copenhagen" "Europe/Dublin" "Europe/Helsinki" "Europe/Istanbul" "Europe/Kaliningrad" "Europe/Kiev" "Europe/Lisbon" "Europe/Ljubljana" "Europe/London" "Europe/Madrid" "Europe/Minsk" "Europe/Moscow" "Europe/Paris" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/Sarajevo" "Europe/Skopje" "Europe/Sofia" "Europe/Stockholm" "Europe/Tallinn" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zagreb" "Europe/Zurich" "Pacific/Apia" "Pacific/Auckland" "Pacific/Chatham" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Majuro" "Pacific/Midway" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Port_Moresby" "Pacific/Tongatapu"

Timezone

Responses

Request samples

Content type
{
  • "name": "string",
  • "tier": "basic",
  • "email": "string",
  • "phone": "string",
  • "timeZone": "Africa/Algiers",
  • "logoUrl": "string",
  • "address": {
    },
  • "status": "active",
  • "settings": [
    ],
  • "isHoldingOrg": true,
  • "branding": {
    },
  • "internal": {
    },
  • "contacts": [
    ]
}

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Pricing

Operations about Pricing

Pricing Model

activeUntil
required
string <date-time> (PricingActiveUntil)

When the plan is active until in the pricing catalog, if date is in the past, the plan is a legacy plan

annualAmount
required
number <float>

Payment, USD, when paying annualy

excess
required
number <float>

USD, per order, for orders over included number

included
required
number <int32>

Number of orders included in plan per year

monthlyAmount
required
number <float>

Payment, USD, when paying monthly

name
required
string

Name of pricing Plan

rank
required
number <float>

Rank of pricing plan, higher has more features

sources
required
Array of strings (PricingSources)
Items Enum: "app" "shopify" "shopify-mcf"

Plan is available through these sources

api
boolean

If true, plan includes use of API

bundles
boolean

If true, plan includes use of bundles

categories
Array of strings
createdAt
string <date-time>

When the object was created within Pipe17

cutOver
number

when exceeding this number of orders in a year, recommend higher ranked plan

description
string

Pricing plan description

includedMonthly
number <int32>

Number of orders included in plan per month

object (InternalInfo)

Internal info

max3pl
number

Number of fulfillment integrations allowed in plan

maxERP
number

Number of ERP integrations allowed in plan

maxIntg
number

Number of integrations allowed in plan

maxSub
number

Number of secondary organizations allowed in plan

orgKey
string

Organization this object belong to

poto
boolean

If true, plan includes use Purchase / Transfer orders

pricingId
string

Pricing ID

routing
boolean

If true, plan includes order routing

updatedAt
string <date-time>

When the object was updated within Pipe17

{
  • "pricingId": "string",
  • "name": "string",
  • "description": "string",
  • "rank": 0,
  • "monthlyAmount": 0,
  • "annualAmount": 0,
  • "included": 0,
  • "includedMonthly": 0,
  • "excess": 0,
  • "cutOver": 0,
  • "maxIntg": 0,
  • "maxERP": 0,
  • "max3pl": 0,
  • "maxSub": 0,
  • "routing": true,
  • "bundles": true,
  • "api": true,
  • "activeUntil": "2019-08-24T14:15:22Z",
  • "poto": true,
  • "sources": [
    ],
  • "categories": [
    ],
  • "internal": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "orgKey": "string"
}

Fetch a Pricing plan

Authorizations:
Pipe17KeyAuth
path Parameters
PricingId
required
string

Id or name:{name} of pricing plan to fetch

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "Pricing": {
    }
}

List Pricing plans

Authorizations:
Pipe17KeyAuth
query Parameters
active
boolean

Pricing plans that are active

api
boolean

Pricing plans allowing use of API

bundles
boolean

Pricing plans allowing use of bundles

categories
Array of strings

Pricing plans allowing use of all of these connector categories

count
integer <int32>
Default: 100

Return at most this many pricing plans

keys
string
Default: "pricingId,name,description,rank,monthlyAmount,annualAmount,included,includedMonthly,excess,cutOver,max3pl,maxERP,maxIntg,maxSub,routing,bundles,api,poto,categories,activeUntil,sources,createdAt,updatedAt"

Return these top-level fields

min3pl
integer <int32>
Default: 0

Pricing plans allowing at least this many 3pl integrations

minIncluded
integer <int32>
Default: 0

Pricing plans including at least this many orders a year

order
string
Default: "createdAt"

Sort by these top-level fields

pagination
string
Value: "disabled"

Exclude pagination info from the response

poto
boolean

Pricing plans allowing use of Purchase / Transfer orders

routing
boolean

Pricing plans allowing use of order routing

since
string <date-time>

Pricing plans created after this date-time

skip
integer <int32>
Default: 0

Skip this many pricing plans

sources
Array of strings (PricingSources)
Items Enum: "app" "shopify" "shopify-mcf"

Pricing plans available through these billing sources

until
string <date-time>

Pricing plans created before this date-time

updatedSince
string <date-time>

Pricing plans updated after this date-time

updatedUntil
string <date-time>

Pricing plans updated before this date-time

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "filters": {
    },
  • "Pricing": [
    ],
  • "pagination": {
    }
}

Roles

Operations about User Roles

User Role Model

name
required
string

Role Name

createdAt
string <date-time>

When the object was created within Pipe17

description
string

Role's description

object (InternalInfo)

Internal info

isPublic
boolean

Global role indicator

object (Methods)

Access Methods Allowed

orgKey
string

Organization this object belong to

roleId
string

Role ID

status
string (RoleStatus)
Enum: "active" "disabled"

Role status

updatedAt
string <date-time>

When the object was updated within Pipe17

{
  • "roleId": "string",
  • "status": "active",
  • "isPublic": true,
  • "name": "string",
  • "description": "string",
  • "methods": {
    },
  • "internal": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "orgKey": "string"
}

Create Role

Uniqueness constraints within organization:

  • role.name
Authorizations:
Pipe17KeyAuth
Request Body schema:
name
required
string

Role Name

description
string

Role's description

object (InternalInfo)

Internal info

isPublic
boolean

Global role indicator

object (Methods)

Access Methods Allowed

Responses

Request samples

Content type
{
  • "isPublic": true,
  • "name": "string",
  • "description": "string",
  • "methods": {
    },
  • "internal": {
    }
}

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "role": {
    }
}

Delete Role

Authorizations:
Pipe17KeyAuth
path Parameters
RoleId
required
string

Role Id to delete

query Parameters
action
string (DeleteAction)
Enum: "hard" "soft"

Delete role permanently or not

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Fetch Role

Authorizations:
Pipe17KeyAuth
path Parameters
RoleId
required
string

Role Id to fetch

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "role": {
    }
}

List Roles

Authorizations:
Pipe17KeyAuth
query Parameters
count
integer <int32>
Default: 100

Return at most this many roles

keys
string
Default: "isPublic,roleId,name,status,createdAt,updatedAt,orgKey"

Return these top-level fields

name
string

Roles by name (strings "/{pattern}/" and "/{pattern}/i" are interpreted as regexps)

order
string
Default: "createdAt"

Sort by these top-level fields

pagination
string
Value: "disabled"

Exclude pagination info from the response

roleId
Array of strings

Roles by list of roleId

since
string <date-time>

Roles created after this date-time

skip
integer <int32>
Default: 0

Skip this many roles

status
Array of strings (RoleStatus)
Items Enum: "active" "disabled"

Roles by list of statuses

until
string <date-time>

Roles created before this date-time

updatedSince
string <date-time>

Roles updated after this date-time

updatedUntil
string <date-time>

Roles updated before this date-time

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "filters": {
    },
  • "roles": [
    ],
  • "pagination": {
    }
}

Update Role

Uniqueness constraints within organization:

  • role.name
Authorizations:
Pipe17KeyAuth
path Parameters
RoleId
required
string

Role Id to update

Request Body schema:
description
string

Role's description

object (InternalInfo)

Internal info

object (MethodsUpdateData)

Access Methods Allowed

name
string

Role Name

status
string (RoleStatus)
Enum: "active" "disabled"

Role status

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "methods": {
    },
  • "status": "active",
  • "internal": {
    }
}

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Users

Operations about Users

User Model

email
required
string

User email

name
required
string

User Name

roles
required
Array of strings

User named Role(s)

object (UserAddress)
createdAt
string <date-time>

When the object was created within Pipe17

description
string

User Description

object (InternalInfo)

Internal info

object (UserLoginInfo)
object (Methods)

Access Methods Allowed

orgKey
string

Organization this object belong to

phone
string

User Phone

status
string (UserStatus)
Enum: "active" "disabled" "pending"

User Status

timeZone
string

User Time Zone

updatedAt
string <date-time>

When the object was updated within Pipe17

userId
string

User ID

{
  • "userId": "string",
  • "loginInfo": {
    },
  • "status": "active",
  • "methods": {
    },
  • "name": "string",
  • "email": "string",
  • "roles": [
    ],
  • "phone": "string",
  • "timeZone": "string",
  • "description": "string",
  • "address": {
    },
  • "internal": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "orgKey": "string"
}

Create User

Uniqueness constraints within organization:

  • user.email
Authorizations:
Pipe17KeyAuth
Request Body schema:
email
required
string

User email

name
required
string

User Name

password
required
string

User password

roles
required
Array of strings

User named Role(s)

object (UserAddress)
description
string

User Description

object (InternalInfo)

Internal info

phone
string

User Phone

timeZone
string

User Time Zone

Responses

Request samples

Content type
{
  • "name": "string",
  • "email": "string",
  • "roles": [
    ],
  • "phone": "string",
  • "timeZone": "string",
  • "description": "string",
  • "address": {
    },
  • "internal": {
    },
  • "password": "string"
}

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "user": {
    }
}

Delete User

Authorizations:
Pipe17KeyAuth
path Parameters
UserId
required
string

User ID to delete

query Parameters
action
string (DeleteAction)
Enum: "hard" "soft"

Delete user permanently or not

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Fetch User

Authorizations:
Pipe17KeyAuth
path Parameters
UserId
required
string

User ID or me

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "user": {
    }
}

List Users

Authorizations:
Pipe17KeyAuth
query Parameters
count
integer <int32>
Default: 100

Return at most this many users

email
string

Users by email (strings "/{pattern}/" and "/{pattern}/i" are interpreted as regexps)

keys
string
Default: "userId,address,description,name,email,phone,roles,status,timeZone,createdAt,updatedAt,orgKey"

Return these top-level fields

name
string

Users by name (strings "/{pattern}/" and "/{pattern}/i" are interpreted as regexps)

order
string
Default: "createdAt"

Sort by these top-level fields

organizations
string

Return users of all organizations

pagination
string
Value: "disabled"

Exclude pagination info from the response

since
string <date-time>

Users created after this date-time

skip
integer <int32>
Default: 0

Skip this many users

status
Array of strings (UserStatus)
Items Enum: "active" "disabled" "pending"

Users by list of statuses

until
string <date-time>

Users created before this date-time

updatedSince
string <date-time>

Users updated after this date-time

updatedUntil
string <date-time>

Users updated before this date-time

userId
Array of strings

Users by list of userId

Responses

Response samples

Content type
{
  • "success": true,
  • "code": 200,
  • "filters": {
    },
  • "users": [
    ],
  • "pagination": {
    }
}

Reset user's password

Authorizations:
Pipe17KeyAuth
path Parameters
UserId
required
string
Request Body schema:
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Send verification email to user

Authorizations:
Pipe17KeyAuth
path Parameters
UserId
required
string
Request Body schema:
object

Responses

Request samples

Content type
{ }

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Update User

Uniqueness constraints within organization:

  • user.email
Authorizations:
Pipe17KeyAuth
path Parameters
UserId
required
string

User ID to update

Request Body schema:
object (UserAddress)
description
string

User Description

object (InternalInfo)

Internal info

name
string

User Name

password
string

User password

phone
string

User Phone

roles
Array of strings

User named Role(s)

status
string
Enum: "active" "disabled"
timeZone
string

User Time Zone

Responses

Request samples

Content type
{
  • "name": "string",
  • "roles": [
    ],
  • "phone": "string",
  • "timeZone": "string",
  • "description": "string",
  • "address": {
    },
  • "status": "active",
  • "password": "string",
  • "internal": {
    }
}

Response samples

Content type
{
  • "success": true,
  • "code": 200
}

Convert

Convert a source object to target using specified mapping rules

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
object
source
required
object

Source object to convert

Responses

Request samples

Content type
application/json
{
  • "rules": {
    },
  • "source": { }
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "result": {
    }
}