Pipe17 logo
API docs by Redocly

Pipe17 API (3.0.409)

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

exceptionCategories
Array of strings

References to categories of exceptions related to the arrival

exceptions
Array of strings

Types of exceptions related to the arrival

expectedArrivalDate
string <date-time>

Expected Arrival Date

extArrivalApiId
string

External System Arrival API ID

extArrivalId
string

Reference to arrival on external system (vendor)

extOrderId
string

External TO or PO ID

extReferenceId
string

Reference ID

extShipmentId
string

External shipment ID

object (Address)
fromLocationId
string

Sender Location ID (for TO)

fulfillmentId
string

Fulfillment ID

holdUntil
string <date-time>
incoterms
string

International Commercial Terms

integration
string

Reference to integration that created arrival

object (InternalInfo)

Internal info

Array of objects (ArrivalLineItem)
orderIntegration
string

Reference to integration that created order tied to arrival

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: "draft" "shipped" "expected" "partialReceived" "received" "canceled" "failed"

Arrival notification Status

tags
Array of strings (EntityTags)

Tags assigned to entity

Array of objects (ArrivalChangelogEntry)

Timeline of updates

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",
  • "exceptionCategories": [
    ],
  • "exceptions": [
    ],
  • "integration": "string",
  • "orderIntegration": "string",
  • "status": "draft",
  • "timeline": [
    ],
  • "senderName": "string",
  • "toLocationId": "string",
  • "customFields": [
    ],
  • "expectedArrivalDate": "2019-08-24T14:15:22Z",
  • "extArrivalApiId": "string",
  • "extArrivalId": "string",
  • "extOrderId": "string",
  • "extReferenceId": "string",
  • "extShipmentId": "string",
  • "fromAddress": {
    },
  • "fromLocationId": "string",
  • "fulfillmentId": "string",
  • "holdUntil": "2019-08-24T14:15:22Z",
  • "incoterms": "string",
  • "internal": {
    },
  • "lineItems": [
    ],
  • "purchaseId": "string",
  • "shippingCarrier": "string",
  • "shippingMethod": "string",
  • "shippingNote": "string",
  • "sourceDoc": {
    },
  • "tags": [
    ],
  • "totalWeight": "string",
  • "trackingNumber": "string",
  • "transferId": "string",
  • "transport": {
    },
  • "weightUnit": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "orgKey": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

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)
  • arrival.extArrivalApiId, arrival.integration (when extArrivalApiId defined)
  • arrival.extReferenceId, arrival.integration (when extReferenceId 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

extArrivalApiId
string

External System Arrival API ID

extArrivalId
string

Reference to arrival on external system (vendor)

extOrderId
string

External TO or PO ID

extReferenceId
string

Reference ID

extShipmentId
string

External shipment ID

object (Address)
fromLocationId
string

Sender Location ID (for TO)

fulfillmentId
string

Fulfillment ID

holdUntil
string <date-time>
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: "draft" "shipped" "expected" "partialReceived" "received" "canceled" "failed"

Arrival notification Status

tags
Array of strings (EntityTags)

Tags assigned to entity

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
{
  • "code": 200,
  • "success": true,
  • "arrivals": [
    ]
}

Delete Arrival

Authorizations:
Pipe17KeyAuth
path Parameters
ArrivalId
required
string

Id, ext:{extArrivalId}, api:{extArrivalApiId}, or ref:{extReferenceId} of arrival to delete

query Parameters
nested
boolean

Delete nested entities

Responses

Response samples

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

Delete Multiple Arrivals

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

Return the list of what to delete, or delete softly

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)

extReferenceId
Array of strings

Delete arrivals by extReferenceId list

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: "sandbox" "production" "internal" "demo"

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: "draft" "shipped" "expected" "partialReceived" "received" "canceled" "failed"

Delete arrivals in specific status

tags
Array of strings (EntityTags)

Tags assigned to entity

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
{
  • "code": 200,
  • "success": true,
  • "arrivals": [
    ],
  • "deleted": 0,
  • "filters": {
    },
  • "pagination": {
    }
}

Fetch Arrival Notification

Authorizations:
Pipe17KeyAuth
path Parameters
ArrivalId
required
string

Id, ext:{extArrivalId}, api:{extArrivalApiId}, or ref:{extReferenceId} 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

withTimeline
boolean

Include timeline of updates when available

Responses

Response samples

Content type
{
  • "code": 200,
  • "success": true,
  • "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

Arrivals by list of types of the arrival related exceptions ({exceptionType} | {entityType}_{exceptionType})

extArrivalId
Array of strings

Arrivals by list extArrivalId

extOrderId
Array of strings

Arrivals by list external orders (PO or TO)

extReferenceId
Array of strings

Arrivals by extReferenceId list

fromLocationId
Array of strings

Arrivals by list fromLocationId

fulfillmentId
Array of strings

Arrivals by list fulfillmentId

hasSourceDoc
boolean

Arrivals containing a source document

integration
Array of strings

Arrivals of these integrations.

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: "draft" "shipped" "expected" "partialReceived" "received" "canceled" "failed"

Arrivals in specific status

tags
Array of strings (EntityTags)

Tags assigned to entity

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
{
  • "code": 200,
  • "success": true,
  • "arrivals": [
    ],
  • "filters": {
    },
  • "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
{
  • "code": 200,
  • "success": true
}

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)
  • arrival.extArrivalApiId, arrival.integration (when extArrivalApiId defined)
  • arrival.extReferenceId, arrival.integration (when extReferenceId defined)
Authorizations:
Pipe17KeyAuth
path Parameters
ArrivalId
required
string

Id, ext:{extArrivalId}, api:{extArrivalApiId}, or ref:{extReferenceId} of arrival to update

query Parameters
keys
string
Default: ""

Comma-separated fields to be returned ("*" - all)

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)

extReferenceId
string

Reference ID

object (Address)
fromLocationId
string

Sender Location ID (for TO)

holdUntil
string or null <date-time>
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: "draft" "shipped" "expected" "partialReceived" "received" "canceled" "failed"

Arrival notification Status

tags
Array of strings (EntityTags)

Tags assigned to entity

toLocationId
string

Arrival Location ID

totalWeight
string

Total Weight

trackingNumber
string

Tracking number

object (ArrivalTransport)
weightUnit
string

Weight Unit

Responses

Request samples

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

Response samples

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

Catalog Products

Operations about Catalog Products

Catalog Product Model

catalogId
required
string
sku
required
string
status
required
string (CatalogProductStatus)
Enum: "included" "excluded"

Catalog Product Status

catalogProductId
string

Auto Generated

createdAt
string <date-time>

When the object was created within Pipe17

Array of objects (NameValue)

Custom Fields

exceptionCategories
Array of strings

References to categories of exceptions related to the catalog product

exceptions
Array of strings

Types of exceptions related to the catalog product

integration
string

Reference to integration that created the catalog product

object (InternalInfo)

Internal info

orgKey
string

Organization this object belong to

object (CatalogProductPriceRule)
object (CatalogProductQuantityRule)
object (SourceDoc)

Vendor source document

tags
Array of strings (EntityTags)

Tags assigned to entity

updatedAt
string <date-time>

When the object was updated within Pipe17

Array of objects (CatalogProductVolumePricing)
{
  • "catalogProductId": "string",
  • "exceptionCategories": [
    ],
  • "exceptions": [
    ],
  • "integration": "string",
  • "catalogId": "string",
  • "sku": "string",
  • "status": "included",
  • "customFields": [
    ],
  • "internal": {
    },
  • "priceRule": {
    },
  • "quantityRule": {
    },
  • "sourceDoc": {
    },
  • "tags": [
    ],
  • "volumePricing": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "orgKey": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Create Catalog Products

Uniqueness constraints within organization:

  • catalogProduct.catalogId, catalogProduct.sku
Authorizations:
Pipe17KeyAuth
Request Body schema:
Array (<= 10 items)
catalogId
required
string
sku
required
string
status
required
string (CatalogProductStatus)
Enum: "included" "excluded"

Catalog Product Status

Array of objects (NameValue)

Custom Fields

object (InternalInfo)

Internal info

object (CatalogProductPriceRule)
object (CatalogProductQuantityRule)
object (SourceDoc)

Vendor source document

tags
Array of strings (EntityTags)

Tags assigned to entity

Array of objects (CatalogProductVolumePricing)

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

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

Delete Catalog Product

Authorizations:
Pipe17KeyAuth
path Parameters
CatalogProductId
required
string

Catalog Product Id to delete

Responses

Response samples

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

Fetch Catalog Product

Authorizations:
Pipe17KeyAuth
path Parameters
CatalogProductId
required
string

Catalog Product 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
{
  • "code": 200,
  • "success": true,
  • "catalog_product": {
    }
}

List Catalog Products

Authorizations:
Pipe17KeyAuth
query Parameters
catalogId
Array of strings

Select catalog products by catalogId list

catalogProductId
Array of strings

Select catalog products by catalogProductId list

count
integer <int32>
Default: 100

Return at most this many catalog products

deleted
boolean

Select the soft deleted catalog products

exceptionCategoryId
Array of strings

Select catalog products by list of categories of the product related exceptions

exceptionType
Array of strings

Select catalog products by list of types of the product related exceptions ({exceptionType} | {entityType}_{exceptionType})

hasSourceDoc
boolean

Select catalog products containing a source document

integration
Array of strings

Select catalog products of these integrations.

keys
string
Default: "catalogProductId,catalogId,sku,status,priceRule,quantityRule,volumePricing,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>

Select catalog products created after this date-time

skip
integer <int32>
Default: 0

Skip this many catalog products

sku
Array of strings

Select catalog products by sku list

status
Array of strings (CatalogProductStatus)
Items Enum: "included" "excluded"

Select catalog products by status list

tags
Array of strings (EntityTags)

Tags assigned to entity

until
string <date-time>

Select catalog products created before this date-time

updatedSince
string <date-time>

Select catalog products updated after this date-time

updatedUntil
string <date-time>

Select catalog products updated before this date-time

Responses

Response samples

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

Update Catalog Product

Authorizations:
Pipe17KeyAuth
path Parameters
CatalogProductId
required
string

Catalog Id to update

query Parameters
keys
string
Default: ""

Comma-separated fields to be returned ("*" - all)

Request Body schema:
catalogId
string
Array of objects (NameValue)

Custom Fields

object (InternalInfo)

Internal info

object (CatalogProductPriceRule)
object (CatalogProductQuantityRule)
sku
string
object (SourceDoc)

Vendor source document

status
string (CatalogProductStatus)
Enum: "included" "excluded"

Catalog Product Status

tags
Array of strings (EntityTags)

Tags assigned to entity

Array of objects (CatalogProductVolumePricing)

Responses

Request samples

Content type
{
  • "catalogId": "string",
  • "customFields": [
    ],
  • "internal": {
    },
  • "priceRule": {
    },
  • "quantityRule": {
    },
  • "sku": "string",
  • "sourceDoc": {
    },
  • "status": "included",
  • "tags": [
    ],
  • "volumePricing": [
    ]
}

Response samples

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

Catalogs

Operations about Catalogs

Catalog Model

currency
required
string

Currency code

name
required
string
catalogId
string

Auto Generated

createdAt
string <date-time>

When the object was created within Pipe17

Array of objects (NameValue)

Custom Fields

description
string
exceptionCategories
Array of strings

References to categories of exceptions related to the catalog

exceptions
Array of strings

Types of exceptions related to the catalog

extCatalogId
string
includeAll
boolean
integration
string

Reference to integration that created the catalog

object (InternalInfo)

Internal info

orgKey
string

Organization this object belong to

object (CatalogPriceRule)
object (SourceDoc)

Vendor source document

status
string (CatalogStatus)
Default: "draft"
Enum: "draft" "active" "inactive"

Catalog Status

tags
Array of strings (EntityTags)

Tags assigned to entity

type
string (CatalogType)
Default: "other"
Enum: "b2b" "market" "collection" "other"

Catalog Type

updatedAt
string <date-time>

When the object was updated within Pipe17

{
  • "catalogId": "string",
  • "exceptionCategories": [
    ],
  • "exceptions": [
    ],
  • "integration": "string",
  • "currency": "string",
  • "name": "string",
  • "customFields": [
    ],
  • "description": "string",
  • "extCatalogId": "string",
  • "includeAll": true,
  • "internal": {
    },
  • "priceRule": {
    },
  • "sourceDoc": {
    },
  • "status": "draft",
  • "tags": [
    ],
  • "type": "b2b",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "orgKey": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Create Catalogs

Uniqueness constraints within organization:

  • catalog.extCatalogId, if the extCatalogId is defined
Authorizations:
Pipe17KeyAuth
Request Body schema:
Array (<= 10 items)
currency
required
string

Currency code

name
required
string
Array of objects (NameValue)

Custom Fields

description
string
extCatalogId
string
includeAll
boolean
object (InternalInfo)

Internal info

object (CatalogPriceRule)
object (SourceDoc)

Vendor source document

status
string (CatalogStatus)
Default: "draft"
Enum: "draft" "active" "inactive"

Catalog Status

tags
Array of strings (EntityTags)

Tags assigned to entity

type
string (CatalogType)
Default: "other"
Enum: "b2b" "market" "collection" "other"

Catalog Type

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

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

Delete Catalog

Authorizations:
Pipe17KeyAuth
path Parameters
CatalogId
required
string

Catalog Id to delete

Responses

Response samples

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

Fetch Catalog

Authorizations:
Pipe17KeyAuth
path Parameters
CatalogId
required
string

Catalog 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
{
  • "code": 200,
  • "success": true,
  • "catalog": {
    }
}

List Catalogs

Authorizations:
Pipe17KeyAuth
query Parameters
catalogId
Array of strings

Select catalogs by catalogId list

count
integer <int32>
Default: 100

Return at most this many catalogs

deleted
boolean

Select the soft deleted catalogs

exceptionCategoryId
Array of strings

Select catalogs by list of categories of the catalog related exceptions

exceptionType
Array of strings

Select catalogs by list of types of the catalog related exceptions ({exceptionType} | {entityType}_{exceptionType})

extCatalogId
Array of strings

Select catalogs by extCatalogId list

hasSourceDoc
boolean

Select catalogs containing a source document

integration
Array of strings

Select catalogs of these integrations.

keys
string
Default: "catalogId,extCatalogId,name,status,type,currency,priceRule,includeAll,createdAt,updatedAt,orgKey"

Return these top-level fields

name
Array of strings

Select catalogs by name list

order
string
Default: "-createdAt"

Sort by these top-level fields

pagination
string
Value: "disabled"

Exclude pagination info from the response

since
string <date-time>

Select catalogs created after this date-time

skip
integer <int32>
Default: 0

Skip this many catalogs

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

Select catalogs by status list

tags
Array of strings (EntityTags)

Tags assigned to entity

type
Array of strings (CatalogType)
Items Enum: "b2b" "market" "collection" "other"

Select catalogs by type list

until
string <date-time>

Select catalogs created before this date-time

updatedSince
string <date-time>

Select catalogs updated after this date-time

updatedUntil
string <date-time>

Select catalogs updated before this date-time

Responses

Response samples

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

Update Catalog

Authorizations:
Pipe17KeyAuth
path Parameters
CatalogId
required
string

Catalog Id to update

query Parameters
keys
string
Default: ""

Comma-separated fields to be returned ("*" - all)

Request Body schema:
currency
string

Currency code

Array of objects (NameValue)

Custom Fields

description
string
extCatalogId
string
includeAll
boolean
object (InternalInfo)

Internal info

name
string
object (CatalogPriceRule)
object (SourceDoc)

Vendor source document

status
string (CatalogStatus)
Default: "draft"
Enum: "draft" "active" "inactive"

Catalog Status

tags
Array of strings (EntityTags)

Tags assigned to entity

type
string (CatalogType)
Default: "other"
Enum: "b2b" "market" "collection" "other"

Catalog Type

Responses

Request samples

Content type
{
  • "currency": "string",
  • "customFields": [
    ],
  • "description": "string",
  • "extCatalogId": "string",
  • "includeAll": true,
  • "internal": {
    },
  • "name": "string",
  • "priceRule": {
    },
  • "sourceDoc": {
    },
  • "status": "draft",
  • "tags": [
    ],
  • "type": "b2b"
}

Response samples

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

Contacts

Operations about contacts

Contact Model

required
object (Address)
contactId
string

Contact ID

createdAt
string <date-time>

When the object was created within Pipe17

Array of objects (ContactCustomField)
exceptionCategories
Array of strings

References to categories of exceptions related to the contact

exceptions
Array of strings

Types of exceptions related to the contact

extContactId
string

Contact external ID

object (InternalInfo)

Internal info

name
string

Contact name

orgKey
string

Organization this object belong to

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

Contact status

tags
Array of strings (EntityTags)

Tags assigned to entity

updatedAt
string <date-time>

When the object was updated within Pipe17

{
  • "contactId": "string",
  • "exceptionCategories": [
    ],
  • "exceptions": [
    ],
  • "status": "active",
  • "shippingAddress": {
    },
  • "customFields": [
    ],
  • "extContactId": "string",
  • "internal": {
    },
  • "name": "string",
  • "tags": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "orgKey": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Create Contact

Uniqueness constraints within organization:

  • contact.extContactId (when defined)
Authorizations:
Pipe17KeyAuth
Request Body schema:
required
object (Address)
Array of objects (ContactCustomField)
extContactId
string

Contact external ID

object (InternalInfo)

Internal info

name
string

Contact name

tags
Array of strings (EntityTags)

Tags assigned to entity

Responses

Request samples

Content type
{
  • "shippingAddress": {
    },
  • "customFields": [
    ],
  • "extContactId": "string",
  • "internal": {
    },
  • "name": "string",
  • "tags": [
    ]
}

Response samples

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

Delete Contact

Authorizations:
Pipe17KeyAuth
path Parameters
ContactId
required
string

ID or ext:{extContactId} of contact to delete

Responses

Response samples

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

Fetch Contact

Authorizations:
Pipe17KeyAuth
path Parameters
ContactId
required
string

ID or ext:{extContactId} of contact 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
{
  • "code": 200,
  • "success": true,
  • "contact": {
    }
}

List Contacts

Authorizations:
Pipe17KeyAuth
query Parameters
contactId
Array of strings

Retrieve by list of contactId

count
integer <int32>
Default: 100

Return at most this many contacts

emailAddr
Array of strings

Retrieve by list of shippingAddress.email

exceptionCategoryId
Array of strings

Retrieve contacts by list of categories of the contact related exceptions

exceptionType
Array of strings

Retrieve contacts by list of types of the contact related exceptions ({exceptionType} | {entityType}_{exceptionType})

extContactId
Array of strings

Retrieve by list of extContactId

keys
string
Default: "contactId,status,extContactId,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>

Retrieve contacts created after this date-time

skip
integer <int32>
Default: 0

Skip this many contacts

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

Retrieve by status

tags
Array of strings (EntityTags)

Tags assigned to entity

until
string <date-time>

Retrieve contacts created before this date-time

updatedSince
string <date-time>

Retrieve contacts updated after this date-time

updatedUntil
string <date-time>

Retrieve contacts updated before this date-time

Responses

Response samples

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

Update Contact

Uniqueness constraints within organization:

  • contact.extContactId (when defined)
Authorizations:
Pipe17KeyAuth
path Parameters
ContactId
required
string

ID or ext:{extContactId} of contact to update

query Parameters
keys
string
Default: ""

Comma-separated fields to be returned ("*" - all)

Request Body schema:
Array of objects or null (ContactCustomField)
extContactId
string

Contact external ID

object (InternalInfo)

Internal info

name
string

Contact name

object (AddressUpdateData)
tags
Array of strings (EntityTags)

Tags assigned to entity

Responses

Request samples

Content type
{
  • "customFields": [
    ],
  • "extContactId": "string",
  • "internal": {
    },
  • "name": "string",
  • "shippingAddress": {
    },
  • "tags": [
    ]
}

Response samples

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

Custom Objects

Operations with Custom Objects

Custom Object Model

extEntityId
required
string
type
required
string

Type of the object

createdAt
string <date-time>

When the object was created within Pipe17

customObjectId
string

Custom Object ID

data
object

Custom data

exceptionCategories
Array of strings

References to categories of exceptions related to the object

exceptions
Array of strings

Types of exceptions related to the object

integration
string

ID of integration that created the object

orgKey
string

Organization this object belong to

relatedEntityId
string
relatedEntityType
string (EntityName)
Enum: "accounts" "arrivals" "automations" "automation_rules" "automation_runs" "changelog" "connectors" "customers" "custom_objects" "contacts" "entity_filters" "exceptions" "fulfillments" "functions" "inventory" "inventory_groups" "inventoryrules" "invoices" "labels" "locations" "lookup_objects" "metrics" "orders" "order_regions" "order_routings" "catalogs" "catalog_products" "products" "purchases" "receipts" "refunds" "returns" "shipments" "shipment_boxes" "shipping_methods" "statements" "statement_transactions" "suppliers" "transfers" "trackings" "usagedata" "usageplans" "vendor_schemas"

Entity Name

tags
Array of strings (EntityTags)

Tags assigned to entity

updatedAt
string <date-time>

When the object was updated within Pipe17

{
  • "customObjectId": "string",
  • "exceptionCategories": [
    ],
  • "exceptions": [
    ],
  • "integration": "string",
  • "extEntityId": "string",
  • "type": "string",
  • "data": { },
  • "relatedEntityId": "string",
  • "relatedEntityType": "accounts",
  • "tags": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "orgKey": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Create Custom Objects

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

Type of the object

data
object

Custom data

relatedEntityId
string
relatedEntityType
string (EntityName)
Enum: "accounts" "arrivals" "automations" "automation_rules" "automation_runs" "changelog" "connectors" "customers" "custom_objects" "contacts" "entity_filters" "exceptions" "fulfillments" "functions" "inventory" "inventory_groups" "inventoryrules" "invoices" "labels" "locations" "lookup_objects" "metrics" "orders" "order_regions" "order_routings" "catalogs" "catalog_products" "products" "purchases" "receipts" "refunds" "returns" "shipments" "shipment_boxes" "shipping_methods" "statements" "statement_transactions" "suppliers" "transfers" "trackings" "usagedata" "usageplans" "vendor_schemas"

Entity Name

tags
Array of strings (EntityTags)

Tags assigned to entity

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

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

Delete Custom Object

Authorizations:
Pipe17KeyAuth
path Parameters
CustomObjectId
required
string

Responses

Response samples

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

Fetch Custom Object

Authorizations:
Pipe17KeyAuth
path Parameters
CustomObjectId
required
string

Responses

Response samples

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

List Custom Objects

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

Return at most this many objects

customObjectId
Array of strings

Select by 'customObjectId' list

exceptionCategoryId
Array of strings

Select by list of categories of the object related exceptions

exceptionType
Array of strings

Select by list of types of the object related exceptions ({exceptionType} | {entityType}_{exceptionType})

extEntityId
Array of strings

Select by 'extEntityId' list

integration
Array of strings

Select by 'integration' list

keys
string
Default: "customObjectId,extEntityId,relatedEntityId,relatedEntityType,type,createdAt,updatedAt,orgKey,integration"

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

Select by 'relatedEntityId' list

relatedEntityType
Array of strings (EntityName)
Items Enum: "accounts" "arrivals" "automations" "automation_rules" "automation_runs" "changelog" "connectors" "customers" "custom_objects" "contacts" "entity_filters" "exceptions" "fulfillments" "functions" "inventory" "inventory_groups" "inventoryrules" "invoices" "labels" "locations" "lookup_objects" "metrics" "orders" "order_regions" "order_routings" "catalogs" "catalog_products" "products" "purchases" "receipts" "refunds" "returns" "shipments" "shipment_boxes" "shipping_methods" "statements" "statement_transactions" "suppliers" "transfers" "trackings" "usagedata" "usageplans" "vendor_schemas"

Select by 'relatedEntityType' list

since
string <date-time>

Select objects created after this date-time

skip
integer <int32>
Default: 0

Skip this many objects

tags
Array of strings (EntityTags)

Tags assigned to entity

type
Array of strings

Select by 'type' list

until
string <date-time>

Select objects created before this date-time

updatedSince
string <date-time>

Select objects updated after this date-time

updatedUntil
string <date-time>

Select objects updated before this date-time

Responses

Response samples

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

Update Custom Object

Authorizations:
Pipe17KeyAuth
path Parameters
CustomObjectId
required
string
query Parameters
keys
string
Default: ""

Fields of the updated object that should be returned (- comma separated string, "*" - all)

Request Body schema:
data
object or null

Custom data

extEntityId
string
relatedEntityId
string
relatedEntityType
string (EntityName)
Enum: "accounts" "arrivals" "automations" "automation_rules" "automation_runs" "changelog" "connectors" "customers" "custom_objects" "contacts" "entity_filters" "exceptions" "fulfillments" "functions" "inventory" "inventory_groups" "inventoryrules" "invoices" "labels" "locations" "lookup_objects" "metrics" "orders" "order_regions" "order_routings" "catalogs" "catalog_products" "products" "purchases" "receipts" "refunds" "returns" "shipments" "shipment_boxes" "shipping_methods" "statements" "statement_transactions" "suppliers" "transfers" "trackings" "usagedata" "usageplans" "vendor_schemas"

Entity Name

tags
Array of strings (EntityTags)

Tags assigned to entity

type
string

Type of the object

Responses

Request samples

Content type
{
  • "data": { },
  • "extEntityId": "string",
  • "relatedEntityId": "string",
  • "relatedEntityType": "accounts",
  • "tags": [
    ],
  • "type": "string"
}

Response samples

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

Customers

Operations about customers

Customer Model

Array of objects (CustomerAddress)
object (CustomerBillingAddress)
catalogIds
Array of strings
object (CustomerCheckoutSettings)

Customer checkout settings

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

exceptionCategories
Array of strings

References to categories of exceptions related to the customer

exceptions
Array of strings

Types of exceptions related to the customer

extCustomerId
string

Customer external ID

firstName
string

Customer first name

object (InternalInfo)

Internal info

lastName
string

Customer last name

Array of objects (CustomerLink)

References to parent customer objects(s) and assigned role(s) of individual in parent customer

notes
string
orgKey
string

Organization this object belong to

object (CustomerPaymentTerms)

Customer payment terms

phone
string

Customer phone

object (CustomerShippingAddress)
object (SourceDoc)

Vendor source document

status
string
Enum: "active" "inactive" "deleted"

Customer status

tags
Array of strings (EntityTags)

Tags assigned to entity

object (CustomerTaxOptions)

Customer tax options

type
string (CustomerType)
Enum: "individual" "company" "company_location" "other"

Customer type

updatedAt
string <date-time>

When the object was updated within Pipe17

{
  • "customerId": "string",
  • "exceptionCategories": [
    ],
  • "exceptions": [
    ],
  • "status": "active",
  • "addresses": [
    ],
  • "billingAddress": {
    },
  • "catalogIds": [
    ],
  • "checkoutSettings": {
    },
  • "company": "string",
  • "customFields": [
    ],
  • "displayName": "string",
  • "email": "string",
  • "extCustomerId": "string",
  • "firstName": "string",
  • "internal": {
    },
  • "lastName": "string",
  • "linkedCustomers": [
    ],
  • "notes": "string",
  • "paymentTerms": {
    },
  • "phone": "string",
  • "shippingAddress": {
    },
  • "sourceDoc": {
    },
  • "tags": [
    ],
  • "taxOptions": {
    },
  • "type": "individual",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "orgKey": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Create Customer

Uniqueness constraints within organization:

  • customer.extCustomerId (when defined)
Authorizations:
Pipe17KeyAuth
Request Body schema:
Array of objects (CustomerAddress)
object (CustomerBillingAddress)
catalogIds
Array of strings
object (CustomerCheckoutSettings)

Customer checkout settings

company
string

Customer company name

Array of objects (CustomerCustomField)
displayName
string

Customer display name

email
string

Customer email

extCustomerId
string

Customer external ID

firstName
string

Customer first name

object (InternalInfo)

Internal info

lastName
string

Customer last name

Array of objects (CustomerLink)

References to parent customer objects(s) and assigned role(s) of individual in parent customer

notes
string
object (CustomerPaymentTerms)

Customer payment terms

phone
string

Customer phone

object (CustomerShippingAddress)
object (SourceDoc)

Vendor source document

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

Customer status

tags
Array of strings (EntityTags)

Tags assigned to entity

object (CustomerTaxOptions)

Customer tax options

type
string (CustomerType)
Enum: "individual" "company" "company_location" "other"

Customer type

Responses

Request samples

Content type
{
  • "addresses": [
    ],
  • "billingAddress": {
    },
  • "catalogIds": [
    ],
  • "checkoutSettings": {
    },
  • "company": "string",
  • "customFields": [
    ],
  • "displayName": "string",
  • "email": "string",
  • "extCustomerId": "string",
  • "firstName": "string",
  • "internal": {
    },
  • "lastName": "string",
  • "linkedCustomers": [
    ],
  • "notes": "string",
  • "paymentTerms": {
    },
  • "phone": "string",
  • "shippingAddress": {
    },
  • "sourceDoc": {
    },
  • "status": "active",
  • "tags": [
    ],
  • "taxOptions": {
    },
  • "type": "individual"
}

Response samples

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

Delete Customer

Authorizations:
Pipe17KeyAuth
path Parameters
CustomerId
required
string

ID or ext:{extCustomerId} of customer to delete

Responses

Response samples

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

Delete Multiple Customers

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

Return the list of what to delete, or delete softly

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: "sandbox" "production" "internal" "demo"

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" "inactive" "deleted"

Delete by status

tags
Array of strings (EntityTags)

Tags assigned to entity

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
{
  • "code": 200,
  • "success": true,
  • "customers": [
    ],
  • "deleted": 0,
  • "filters": {
    },
  • "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
{
  • "code": 200,
  • "success": true,
  • "customer": {
    }
}

List Customers

Authorizations:
Pipe17KeyAuth
query Parameters
catalogIds
Array of strings

Retrieve by list of assigned catalog Ids

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)

emailAddr
Array of strings

Retrieve by list of billing/shippingAddress.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

Retrieve customers by list of types of the customer related exceptions ({exceptionType} | {entityType}_{exceptionType})

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)

linkedCustomerId
Array of strings

Retrieve by list of linked customerId

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" "inactive" "deleted"

Retrieve by status

tags
Array of strings (EntityTags)

Tags assigned to entity

type
string (CustomerType)
Enum: "individual" "company" "company_location" "other"

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
{
  • "code": 200,
  • "success": true,
  • "customers": [
    ],
  • "filters": {
    },
  • "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
{
  • "code": 200,
  • "success": true
}

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

query Parameters
keys
string
Default: ""

Comma-separated fields to be returned ("*" - all)

Request Body schema:
Array of objects or null (CustomerAddress)
object (CustomerBillingAddress)
catalogIds
Array of strings or null
object (CustomerCheckoutSettings)

Customer checkout settings

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

Array of objects or null (CustomerLink)

References to parent customer objects(s) and assigned role(s) of individual in parent customer

notes
string
object (CustomerPaymentTerms)

Customer payment terms

phone
string

Customer phone

object (CustomerShippingAddress)
object (SourceDoc)

Vendor source document

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

Customer status

tags
Array of strings (EntityTags)

Tags assigned to entity

object (CustomerTaxOptions)

Customer tax options

Responses

Request samples

Content type
{
  • "addresses": [
    ],
  • "billingAddress": {
    },
  • "catalogIds": [
    ],
  • "checkoutSettings": {
    },
  • "company": "string",
  • "customFields": [
    ],
  • "displayName": "string",
  • "email": "string",
  • "extCustomerId": "string",
  • "internal": {
    },
  • "linkedCustomers": [
    ],
  • "notes": "string",
  • "paymentTerms": {
    },
  • "phone": "string",
  • "shippingAddress": {
    },
  • "sourceDoc": {
    },
  • "status": "active",
  • "tags": [
    ],
  • "taxOptions": {
    }
}

Response samples

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

Fulfillments

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

Fulfillment Model

Array of objects (FulfillmentAcknowledgment)

Integrations acknowledgement info for this fulfillment

object

...???...

actualShipDate
string <date-time>

Actual ship date

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

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:

  • initialPending: the automation engine will process this entity in the first time.
  • 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.
billOfLading
string
createdAt
string <date-time>

When the object was created within Pipe17

Array of objects (NameValue)

Custom Fields

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

Dimensions UOM

exceptionCategories
Array of strings

References to categories of exceptions related to the fulfillment

exceptions
Array of strings

Types of 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

orderId
string

Pipe17 Internal Order's ID

orderIntegration
string

Reference to integration that created order tied to an item

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

Type of Pipe17 Internal Order

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

Array of objects (FulfillmentChangelogEntry)

Timeline of updates

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: "lb" "oz" "kg" "g"

Weight unit

width
number <float>

Width

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

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
{
  • "code": 200,
  • "success": true
}

Create Fulfillments

Uniqueness constraints within organization:

  • fulfillment.extFulfillmentId (when defined)
Authorizations:
Pipe17KeyAuth
Request Body schema:
Array (<= 10 items)
required
Array of objects (FulfillmentItem)
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" "in" "ft"

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

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: "lb" "oz" "kg" "g"

Weight unit

width
number <float>

Width

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

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

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

withTimeline
boolean

Include timeline of updates when available

Responses

Response samples

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

List Fulfillments

Authorizations:
Pipe17KeyAuth
query Parameters
acknowledgedBy
Array of strings

Fulfillments by list of acknowledged integrations

autoEngUpdateStatus
Array of strings (AutoEngUpdateStatus)
Items Enum: "initialPending" "pending" "updated" "none"
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

Fulfillments by list of types of the fulfillment related exceptions ({exceptionType} | {entityType}_{exceptionType})

extFulfillmentId
Array of strings

Fulfillments by list of extFulfillmentId

extOrderId
Array of strings

Fulfillments by list of extOrderId

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

tags
Array of strings (EntityTags)

Tags assigned to entity

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
{
  • "code": 200,
  • "success": true,
  • "fulfillments": [
    ],
  • "filters": {
    },
  • "pagination": {
    }
}

Sync Fulfillments

Trigger the fulfillments sync

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

Reset autoEngUpdateStatus

Responses

Request samples

Content type
{
  • "syncAE": true
}

Response samples

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

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

damaged
integer <int32>
entityId
string

Related entity ID

entityType
string

Related entity ID's type

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

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.
future
integer <int32>

Number of items that can be sold for pre-order

hold
integer <int32>
incoming
integer <int32>

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

integration
string

Reference to integration that created an item

object (InternalInfo)

Internal info

inventoryId
string

Inventory ID

inventoryNotTracked
boolean

Disables the inventory tracking

label
string
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

tags
Array of strings (EntityTags)

Tags assigned to entity

type
string
Enum: "virtual" "physical"

Inventory type (undefined value indicates a physical inventory)

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

{
  • "available": 0,
  • "availableToPromise": 0,
  • "commitShip": 0,
  • "commitXfer": 0,
  • "committed": 0,
  • "committedFuture": 0,
  • "damaged": 0,
  • "entityId": "string",
  • "entityType": "string",
  • "event": "ingest",
  • "future": 0,
  • "hold": 0,
  • "incoming": 0,
  • "integration": "string",
  • "internal": {
    },
  • "inventoryId": "string",
  • "inventoryNotTracked": true,
  • "label": "string",
  • "locationId": "string",
  • "onHand": 0,
  • "orderId": "string",
  • "orderType": "string",
  • "quantity": 0,
  • "sku": "string",
  • "tags": [
    ],
  • "type": "virtual",
  • "unavailable": 0,
  • "user": "string",
  • "vendorSKU": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "orgKey": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

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: "ingest" "adjust"

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: "wms" "ims" "oms" "portal"

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)

damaged
integer <int32>
future
integer <int32>

Number of items that can be sold for pre-order

hold
integer <int32>
incoming
integer <int32>

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

object (InternalInfo)

Internal info

inventoryNotTracked
boolean

Disables the inventory tracking (default - false)

tags
Array of strings (EntityTags)

Tags assigned to entity

type
string
Enum: "virtual" "physical"

Inventory type

unavailable
integer <int32>

Number of unavailable items

vendorSKU
string

Item vendor SKU

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

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

Fetch Inventory Log Item

Authorizations:
Pipe17KeyAuth
path Parameters
InventoryId
required
string

Inventory Item ID to fetch

Responses

Response samples

Content type
{
  • "code": 200,
  • "success": true,
  • "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

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

Fetch inventory by event list (- allowed only with 'ledger' flag)

integration
Array of strings

Fetch inventory by integrations id list (- ignored in 'totals' queries)

inventoryId
Array of strings

Inventory items by list of inventoryId

inventoryNotTracked
boolean

Fetch inventory by the inventoryNotTracked value (- ignored in 'totals' queries)

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

requestorId
string

Id of the inventory totals requestor (- used to select availble locations; forcibly replaced with integration ID if the request came from an integration)

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

tags
Array of strings (EntityTags)

Fetch inventory by tags (- disallowed with 'ledger' or 'totals' flag)

totals
boolean

Return inventory totals across all locations

type
string
Enum: "virtual" "physical"

'virtual' - fetch virtual inventory status, 'physical' - not virtual (it is unallowable parameter when used with 'ledger' or 'totals' flag)

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
{
  • "code": 200,
  • "success": true,
  • "filters": {
    },
  • "inventory": [
    ],
  • "locationId": [
    ],
  • "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
{
  • "code": 200,
  • "success": true
}

Update Inventory

Uniqueness constraints:

  • inventory.event, inventory.entityId, inventory.sku (when entityId and materialEvent defined)
Authorizations:
Pipe17KeyAuth
query Parameters
keys
string
Default: ""

Comma-separated fields to be returned ("*" - all)

Request Body schema:
event
required
string
Enum: "ship" "fulfill" "xferout" "xferfulfill" "xferin" "receive" "futureShip" "release" "shipCancel" "shipCancelRestock" "futureShipCancel" "virtualCommit" "touch" "POSOrder" "custom" "revise"

Event updating inventory

locationId
required
string

Location Id of item

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

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" "receipts" "shipments" "orders"

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

infinite
boolean

Set if item location has "infinite" availability

object (InternalInfo)

Internal info

inventoryNotTracked
boolean or null

Disables the inventory tracking

label
string
orderId
string

Pipe17 internal order id that initiated this inventory change

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

Type of order that initiated this inventory change

tags
Array of strings (EntityTags)

Tags assigned to entity

type
string
Enum: "virtual" "physical"

Inventory type

vendorSKU
string

Item vendor SKU

Responses

Request samples

Content type
{
  • "event": "ship",
  • "locationId": "string",
  • "ptype": "wms",
  • "quantity": 0,
  • "sku": "string",
  • "entityId": "string",
  • "entityType": "arrivals",
  • "infinite": true,
  • "internal": {
    },
  • "inventoryNotTracked": true,
  • "label": "string",
  • "orderId": "string",
  • "orderType": "sales",
  • "tags": [
    ],
  • "type": "virtual",
  • "vendorSKU": "string"
}

Response samples

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

Inventory Rules

Operations about Inventory Rules

Inventory Rule Model

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

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: "wms" "ims" "oms" "portal"

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": "ingest",
  • "rule": "string",
  • "description": "string",
  • "integration": "string",
  • "internal": {
    },
  • "partner": "string",
  • "ptype": "wms",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "orgKey": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Create Inventory Rule

Uniqueness constraints:

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

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: "wms" "ims" "oms" "portal"

Event source partner type

Responses

Request samples

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

Response samples

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

Delete Inventory Rule

Authorizations:
Pipe17KeyAuth
path Parameters
RuleId
required
string

Rule ID to delete

Responses

Response samples

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

Delete Multiple InventoryRules

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

Return the list of what to delete, or delete softly

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: "sandbox" "production" "internal" "demo"

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
{
  • "code": 200,
  • "success": true,
  • "deleted": 0,
  • "filters": {
    },
  • "pagination": {
    },
  • "rules": [
    ]
}

Fetch Inventory Rule

Authorizations:
Pipe17KeyAuth
path Parameters
RuleId
required
string

Rule ID to fetch

Responses

Response samples

Content type
{
  • "code": 200,
  • "success": true,
  • "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: "ingest" "adjust" "custom" "revise" "ship" "fulfill" "xferin" "xferout" "return" "receive" "xferfulfill" "futureShip" "release" "shipCancel" "shipCancelRestock" "futureShipCancel" "virtualCommit" "touch" "POSOrder"

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: "wms" "ims" "oms" "portal"

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
{
  • "code": 200,
  • "success": true,
  • "filters": {
    },
  • "pagination": {
    },
  • "rules": [
    ]
}

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
{
  • "code": 200,
  • "success": true
}

Update Inventory Rule

Uniqueness constraints:

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

Rule ID to update

query Parameters
keys
string
Default: ""

Comma-separated fields to be returned ("*" - all)

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
{
  • "rule": "string",
  • "description": "string",
  • "internal": {
    }
}

Response samples

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

Invoices

Operations with Invoices

Invoice Model

extInvoiceId
required
string

External Invoice ID

Array of objects (InvoiceAdditionalCharge)

Additional charges

object (Address)
createdAt
string <date-time>

When the object was created within Pipe17

currency
string

Invoice currency code

object (InvoiceCustomer)
Array of objects (NameValue)

Custom Fields

Array of objects (InvoiceDiscount)

Discounts

dueAt
string <date-time>

Invoice due date

exceptionCategories
Array of strings

References to categories of exceptions related to the invoice

exceptions
Array of strings

Types of exceptions related to the invoice

extInvoiceApiId
string

External System Invoice API ID

extInvoiceCreatedAt
string <date-time>

When the invoice was created at source

extInvoiceUpdatedAt
string <date-time>

When the invoice was updated at source

extInvoiceUrl
string

Invoice Url in External System

extOrderId
string

Reference to order

extReferenceId
string

Reference ID

integration
string

Reference to integration that created the invoice

object (InternalInfo)

Internal info

invoiceDiscount
number <float>

Invoice Discount

invoiceId
string

Auto Generated

invoiceNote
string

Invoice Notes

invoiceTax
number <float>

Invoice Tax

invoiceType
string (InvoiceType)
Enum: "bill" "invoice" "debitMemo" "creditMemo" "cashSale" "cashReturn"

Invoice Type

Array of objects (InvoiceLineItem)
orderId
string

Reference to order

orderIntegrations
Array of strings

Integrations that created orders related to the invoice

orgKey
string

Organization this object belong to

paidAt
string <date-time>

Invoice paid date

Array of objects (InvoicePayment)

Payments

paymentStatus
string

status of the payment

object (SourceDoc)

Vendor source document

status
string (InvoiceStatus)
Enum: "draft" "new" "reviewRequired" "posted" "partialPaid" "paid" "canceled" "closed"

Invoice Status

subTotalPrice
number <float>

Sub Total Price

tags
Array of strings (EntityTags)

Tags assigned to entity

term
string
totalPrice
number <float>

Total Price

updatedAt
string <date-time>

When the object was updated within Pipe17

{
  • "exceptionCategories": [
    ],
  • "exceptions": [
    ],
  • "integration": "string",
  • "invoiceId": "string",
  • "orderIntegrations": [
    ],
  • "extInvoiceId": "string",
  • "additionalCharges": [
    ],
  • "billingAddress": {
    },
  • "currency": "string",
  • "customFields": [
    ],
  • "customer": {
    },
  • "discounts": [
    ],
  • "dueAt": "2019-08-24T14:15:22Z",
  • "extInvoiceApiId": "string",
  • "extInvoiceCreatedAt": "2019-08-24T14:15:22Z",
  • "extInvoiceUpdatedAt": "2019-08-24T14:15:22Z",
  • "extInvoiceUrl": "string",
  • "extOrderId": "string",
  • "extReferenceId": "string",
  • "internal": {
    },
  • "invoiceDiscount": 0,
  • "invoiceNote": "string",
  • "invoiceTax": 0,
  • "invoiceType": "bill",
  • "lineItems": [
    ],
  • "orderId": "string",
  • "paidAt": "2019-08-24T14:15:22Z",
  • "paymentStatus": "string",
  • "payments": [
    ],
  • "sourceDoc": {
    },
  • "status": "draft",
  • "subTotalPrice": 0,
  • "tags": [
    ],
  • "term": "string",
  • "totalPrice": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "orgKey": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Create Invoices

Uniqueness constraints within organization:

  • invoice.extInvoiceId, invoice.integration
  • invoice.extInvoiceApiId, invoice.integration
  • invoice.extReferenceId, invoice.integration
Authorizations:
Pipe17KeyAuth
Request Body schema:
Array (<= 10 items)
extInvoiceId
required
string

External Invoice ID

Array of objects (InvoiceAdditionalCharge)

Additional charges

object (Address)
currency
string

Invoice currency code

object (InvoiceCustomer)
Array of objects (NameValue)

Custom Fields

Array of objects (InvoiceDiscount)

Discounts

dueAt
string <date-time>

Invoice due date

extInvoiceApiId
string

External System Invoice API ID

extInvoiceCreatedAt
string <date-time>

When the invoice was created at source

extInvoiceUpdatedAt
string <date-time>

When the invoice was updated at source

extInvoiceUrl
string

Invoice Url in External System

extOrderId
string

Reference to order

extReferenceId
string

Reference ID

object (InternalInfo)

Internal info

invoiceDiscount
number <float>

Invoice Discount

invoiceNote
string

Invoice Notes

invoiceTax
number <float>

Invoice Tax

invoiceType
string (InvoiceType)
Enum: "bill" "invoice" "debitMemo" "creditMemo" "cashSale" "cashReturn"

Invoice Type

Array of objects (InvoiceLineItem)
orderId
string

Reference to order

paidAt
string <date-time>

Invoice paid date

Array of objects (InvoicePayment)

Payments

paymentStatus
string

status of the payment

object (SourceDoc)

Vendor source document

status
string (InvoiceStatus)
Enum: "draft" "new" "reviewRequired" "posted" "partialPaid" "paid" "canceled" "closed"

Invoice Status

subTotalPrice
number <float>

Sub Total Price

tags
Array of strings (EntityTags)

Tags assigned to entity

term
string
totalPrice
number <float>

Total Price

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

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

Delete Invoice

Authorizations:
Pipe17KeyAuth
path Parameters
InvoiceId
required
string

Invoice identifier - invoiceId, ext:{extInvoiceId}, api:{extInvoiceApiId}, or ref:{extReferenceId}

Responses

Response samples

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

Delete Multiple Invoices

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

Return the list of what to delete, or delete softly

count
integer <int32>
Default: 100

Delete at most this many invoices

deleted
boolean

Select soft deleted invoices

extInvoiceId
Array of strings

Select invoices by extInvoiceId list

extOrderId
Array of strings

Select invoices by extOrderId list

extReferenceId
Array of strings

Select invoices by extReferenceId list

integration
Array of strings

Select invoices of these integrations

invoiceId
Array of strings

Select invoices by invoiceId list

orderId
Array of strings

Select invoices by orderId list

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

Select invoices assigned these orgModes.

pagination
string
Value: "disabled"

Exclude pagination info from the response

since
string <date-time>

Select invoices created after this date-time

skip
integer <int32>
Default: 0

Skip this many invoices

status
Array of strings

Select invoices by status list

tags
Array of strings (EntityTags)

Tags assigned to entity

until
string <date-time>

Select invoices created before this date-time

updatedSince
string <date-time>

Select invoices updated after this date-time

updatedUntil
string <date-time>

Select invoices updated before this date-time

Responses

Response samples

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

Fetch Invoice

Authorizations:
Pipe17KeyAuth
path Parameters
InvoiceId
required
string

Invoice identifier - invoiceId, ext:{extInvoiceId}, api:{extInvoiceApiId}, or ref:{extReferenceId}

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
{
  • "code": 200,
  • "success": true,
  • "invoice": {
    }
}

List Invoices

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

Return at most this many invoices

deleted
boolean

Select soft deleted invoices

emailAddr
Array of strings

Select invoices by 'billingAddress.email' list

exceptionCategoryId
Array of strings

Select invoices by list of categories of the invoice related exceptions

exceptionType
Array of strings

Select invoices by list of types of the invoice related exceptions ({exceptionType} | {entityType}_{exceptionType})

extInvoiceApiId
Array of strings
extInvoiceId
Array of strings

Select invoices by extInvoiceApiId list

extOrderId
Array of strings

Select invoices by extOrderId list

extReferenceId
Array of strings

Select invoices by extReferenceId list

hasSourceDoc
boolean

Select invoices containing a source document

integration
Array of strings

Select invoices of these integrations

invoiceId
Array of strings

Select invoices by invoiceId list

keys
string
Default: "invoiceId,extInvoiceId,extInvoiceApiId,extReferenceId,integration,status,tags,createdAt,updatedAt,orgKey"

Return these top-level fields

order
string
Default: "-extOrderCreatedAt"

Sort by these top-level fields

orderId
Array of strings

Select invoices by orderId list

pagination
string
Value: "disabled"

Exclude pagination info from the response

since
string <date-time>

Select invoices created after this date-time

skip
integer <int32>
Default: 0

Skip this many invoices

status
Array of strings

Select invoices by status list

tags
Array of strings (EntityTags)

Tags assigned to entity

until
string <date-time>

Select invoices created before this date-time

updatedSince
string <date-time>

Select invoices updated after this date-time

updatedUntil
string <date-time>

Select invoices updated before this date-time

Responses

Response samples

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

Sync Invoices

Trigger the invoice sync

Authorizations:
Pipe17KeyAuth
path Parameters
InvoiceId
required
Array of strings

Comma-separated invoiceId list

Request Body schema:
object

Responses

Request samples

Content type
{ }

Response samples

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

Update Invoice

Uniqueness constraints within organization:

  • invoice.extInvoiceId, invoice.integration
  • invoice.extInvoiceApiId, invoice.integration
  • invoice.extReferenceId, invoice.integration
Authorizations:
Pipe17KeyAuth
path Parameters
InvoiceId
required
string

Invoice identifier - invoiceId, ext:{extInvoiceId}, api:{extInvoiceApiId}, or ref:{extReferenceId}

query Parameters
keys
string
Default: ""

Comma-separated fields to be returned ("*" - all)

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

Additional charges

object (Address)
currency
string

Invoice currency code

object (InvoiceCustomer)
Array of objects (NameValue)

Custom Fields

Array of objects or null (InvoiceDiscount)

Discounts

dueAt
string <date-time>

Invoice due date

extInvoiceApiId
string

External System Invoice API ID

extInvoiceUpdatedAt
string <date-time>

When the invoice was updated at source

extInvoiceUrl
string

Invoice Url in External System

extReferenceId
string

Reference ID

object (InternalInfo)

Internal info

invoiceDiscount
number or null <float>

Invoice Discount

invoiceNote
string or null

Invoice Notes

invoiceTax
number or null <float>

Invoice Tax

invoiceType
string (InvoiceType)
Enum: "bill" "invoice" "debitMemo" "creditMemo" "cashSale" "cashReturn"

Invoice Type

Array of objects (InvoiceUpdateLineItem)
paidAt
string <date-time>

Invoice paid date

Array of objects or null (InvoicePayment)

Payments

paymentStatus
string or null

status of the payment

object (SourceDoc)

Vendor source document

status
string (InvoiceStatus)
Enum: "draft" "new" "reviewRequired" "posted" "partialPaid" "paid" "canceled" "closed"

Invoice Status

subTotalPrice
number or null <float>

Sub Total Price

tags
Array of strings (EntityTags)

Tags assigned to entity

term
string
totalPrice
number or null <float>

Total Price

Responses

Request samples

Content type
{
  • "additionalCharges": [
    ],
  • "billingAddress": {
    },
  • "currency": "string",
  • "customFields": [
    ],
  • "customer": {
    },
  • "discounts": [
    ],
  • "dueAt": "2019-08-24T14:15:22Z",
  • "extInvoiceApiId": "string",
  • "extInvoiceUpdatedAt": "2019-08-24T14:15:22Z",
  • "extInvoiceUrl": "string",
  • "extReferenceId": "string",
  • "internal": {
    },
  • "invoiceDiscount": 0,
  • "invoiceNote": "string",
  • "invoiceTax": 0,
  • "invoiceType": "bill",
  • "lineItems": [
    ],
  • "paidAt": "2019-08-24T14:15:22Z",
  • "paymentStatus": "string",
  • "payments": [
    ],
  • "sourceDoc": {
    },
  • "status": "draft",
  • "subTotalPrice": 0,
  • "tags": [
    ],
  • "term": "string",
  • "totalPrice": 0
}

Response samples

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

Jobs

Long-running jobs operations

Job Model

subType
required
string (JobSubType)
Enum: "inventory" "replenishment" "oos_sku_on_order" "open_orders" "purchases" "transfers" "arrivals" "receipts" "products" "organizations" "orders" "shipments" "fulfillments" "locations" "shipping_methods" "returns" "exceptions" "lookup_objects" "statements" "users"

Job sub-type

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

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: "submitted" "processing" "completed" "canceled" "failed"

Job status

tags
Array of strings (EntityTags)

Tags assigned to entity

timeout
number <int32>

Job timeout (in milliseconds)

updatedAt
string <date-time>

When the object was updated within Pipe17

{
  • "createdBy": "string",
  • "jobId": "string",
  • "progress": 100,
  • "status": "submitted",
  • "subType": "inventory",
  • "type": "report",
  • "contentType": "string",
  • "internal": {
    },
  • "params": { },
  • "state": { },
  • "tags": [
    ],
  • "timeout": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "orgKey": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Create long-running job

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

Job sub-type

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

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.

tags
Array of strings (EntityTags)

Tags assigned to entity

timeout
number <int32>

Job timeout (in milliseconds)

Responses

Request samples

Content type
{
  • "subType": "inventory",
  • "type": "report",
  • "contentType": "string",
  • "internal": {
    },
  • "params": { },
  • "state": { },
  • "tags": [
    ],
  • "timeout": 0
}

Response samples

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

Delete (cancel) long-running job

Authorizations:
Pipe17KeyAuth
path Parameters
JobId
required
string

Responses

Response samples

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

Delete Multiple Jobs

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

Return the list of what to delete, or delete softly

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: "sandbox" "production" "internal" "demo"

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: "submitted" "processing" "completed" "canceled" "failed"

Delete items with given status

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

Delete items with given sub-type

tags
Array of strings (EntityTags)

Tags assigned to entity

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

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
{
  • "code": 200,
  • "success": true,
  • "deleted": 0,
  • "filters": {
    },
  • "jobs": [
    ],
  • "pagination": {
    }
}

Fetch long-running job

Authorizations:
Pipe17KeyAuth
path Parameters
JobId
required
string

Responses

Response samples

Content type
{
  • "code": 200,
  • "success": true,
  • "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: "submitted" "processing" "completed" "canceled" "failed"

Fetch items with given status

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

Fetch items with given sub-type

tags
Array of strings (EntityTags)

Tags assigned to entity

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

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
{
  • "code": 200,
  • "success": true,
  • "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
{
  • "code": 200,
  • "success": true
}

Update job

Authorizations:
Pipe17KeyAuth
path Parameters
JobId
required
string

Job ID

query Parameters
keys
string
Default: ""

Comma-separated fields to be returned ("*" - all)

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: "submitted" "processing" "completed" "canceled" "failed"

Job status

tags
Array of strings (EntityTags)

Tags assigned to entity

Responses

Request samples

Content type
{
  • "internal": {
    },
  • "progress": 100,
  • "resultURL": "http://example.com",
  • "state": { },
  • "status": "submitted",
  • "tags": [
    ]
}

Response samples

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

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

exceptionCategories
Array of strings

References to categories of exceptions related to the label

exceptions
Array of strings

Types of exceptions related to the label

object (InternalInfo)

Internal info

labelId
string

Label ID

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

Label type

orgKey
string

Organization this object belong to

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

Label status

tags
Array of strings (EntityTags)

Tags assigned to entity

trackingNumber
string
updatedAt
string <date-time>

When the object was updated within Pipe17

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

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: "shippingLabel" "packingSlip"

Label type

shippingMethod
string
tags
Array of strings (EntityTags)

Tags assigned to entity

trackingNumber
string

Responses

Request samples

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

Response samples

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

Delete Label

Authorizations:
Pipe17KeyAuth
path Parameters
LabelId
required
string

Responses

Response samples

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

Delete Labels

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

Return the list of what to delete, or delete softly

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: "sandbox" "production" "internal" "demo"

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

tags
Array of strings (EntityTags)

Tags assigned to entity

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
{
  • "code": 200,
  • "success": true,
  • "deleted": 0,
  • "filters": {
    },
  • "labels": [
    ],
  • "pagination": {
    }
}

Download Label Content

Authorizations:
Pipe17KeyAuth
path Parameters
LabelId
required
string

Responses

Response samples

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

Fetch Label

Authorizations:
Pipe17KeyAuth
path Parameters
LabelId
required
string

Responses

Response samples

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

List Labels

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

Max number of items to return

deleted
boolean

Fetch soft deleted items

exceptionCategoryId
Array of strings

Fetch items by list of categories of the item related exceptions

exceptionType
Array of strings

Fetch items by list of types of the item related exceptions ({exceptionType} | {entityType}_{exceptionType})

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

tags
Array of strings (EntityTags)

Tags assigned to entity

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
{
  • "code": 200,
  • "success": true,
  • "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
{
  • "code": 200,
  • "success": true
}

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
{
  • "code": 200,
  • "success": true
}

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

exceptionCategories
Array of strings

References to categories of exceptions related to the location

exceptions
Array of strings

Types of exceptions related to the location

excludeFromTotals
boolean

Set to exclude location from calculating inventory totals

excludeFromTotalsFor
Array of strings

Requestors of inventory totals for whom the location should be excluded from calculating 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

routingPaused
boolean

Indicates the location is paused from routing

Array of objects (TimeRange)

Time intervals during which routing is paused

object (SourceDoc)

Vendor source document

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

Location status

tags
Array of strings (EntityTags)

Tags assigned to entity

updatedAt
string <date-time>

When the object was updated within Pipe17

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

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

excludeFromTotalsFor
Array of strings

Requestors of inventory totals for whom the location should be excluded from calculating 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

routingPaused
boolean

Indicates the location is paused from routing

Array of objects (TimeRange)

Time intervals during which routing is paused

object (SourceDoc)

Vendor source document

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

Location status

tags
Array of strings (EntityTags)

Tags assigned to entity

Responses

Request samples

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

Response samples

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

Delete Location

Authorizations:
Pipe17KeyAuth
path Parameters
LocationId
required
string

Location ID to delete

Responses

Response samples

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

Delete Multiple Locations

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

Return the list of what to delete, or delete softly

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: "sandbox" "production" "internal" "demo"

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" "inactive" "pending" "merged" "deleted"

Delete by list of location statuses

tags
Array of strings (EntityTags)

Tags assigned to entity

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
{
  • "code": 200,
  • "success": true,
  • "deleted": 0,
  • "filters": {
    },
  • "locations": [
    ],
  • "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
{
  • "code": 200,
  • "success": true,
  • "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

Locations by list of types of the location related exceptions ({exceptionType} | {entityType}_{exceptionType})

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

integration
Array of strings
inventoryNotTracked
boolean

Retrieve locations by inventoryNotTracked value (default - any)

keys
string
Default: "inventoryNotTracked,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" "inactive" "pending" "merged" "deleted"

Retrieve by list of location statuses

tags
Array of strings (EntityTags)

Tags assigned to entity

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
{
  • "code": 200,
  • "success": true,
  • "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
{
  • "code": 200,
  • "success": true
}

Update Location

Uniqueness constraints within organization:

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

Location ID to update

query Parameters
keys
string
Default: ""

Comma-separated fields to be returned ("*" - all)

Request Body schema:
object (LocationUpdateAddress)
excludeFromTotals
boolean

Set to exclude location from calculating inventory totals

excludeFromTotalsFor
Array of strings or null

Requestors of inventory totals for whom the location should be excluded from calculating 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

routingPaused
boolean or null

Indicates the location is paused from routing

Array of objects or null (TimeRange)

Time intervals during which routing is paused

object (SourceDoc)

Vendor source document

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

Location status

tags
Array of strings (EntityTags)

Tags assigned to entity

Responses

Request samples

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

Response samples

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

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

exceptionCategories
Array of strings

References to categories of exceptions related to the transaction

exceptions
Array of strings

Types of exceptions related to the transaction

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: "new" "draft" "pending" "reported"

Transaction status

Array of objects (Fee)
transactionId
string

Transaction ID

updatedAt
string <date-time>

When the object was updated within Pipe17

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

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: "new" "draft" "pending" "reported"

Transaction status

Array of objects (Fee)

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

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

Delete Transaction

Authorizations:
Pipe17KeyAuth
path Parameters
TransactionId
required
string

Transaction Id to delete

Responses

Response samples

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

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
{
  • "code": 200,
  • "success": true,
  • "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

exceptionCategoryId
Array of strings

Retrieve transactions by list of categories of the transaction related exceptions

exceptionType
Array of strings

Retrieve transactions by list of types of the transaction related exceptions ({exceptionType} | {entityType}_{exceptionType})

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: "new" "draft" "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
{
  • "code": 200,
  • "success": true,
  • "filters": {
    },
  • "pagination": {
    },
  • "transactions": [
    ]
}

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
{
  • "code": 200,
  • "success": true
}

Update Transaction

Authorizations:
Pipe17KeyAuth
path Parameters
TransactionId
required
string

Transaction Id to update

query Parameters
keys
string
Default: ""

Comma-separated fields to be returned ("*" - all)

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

Custom Fields

object (InternalInfo)

Internal info

object (SourceDoc)

Vendor source document

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

Transaction status

Array of objects (Fee)

Responses

Request samples

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

Response samples

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

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

exceptionCategories
Array of strings

References to categories of exceptions related to the statement

exceptions
Array of strings

Types of exceptions related to the statement

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: "new" "draft" "pending" "paid" "reported"

Statement status

tags
Array of strings (EntityTags)

Tags assigned to entity

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

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

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: "new" "draft" "pending" "paid" "reported"

Statement status

tags
Array of strings (EntityTags)

Tags assigned to entity

Array of objects (Fee)

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

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

Delete Statement

Authorizations:
Pipe17KeyAuth
path Parameters
StatementId
required
string

Statement Id to delete

Responses

Response samples

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

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
{
  • "code": 200,
  • "success": true,
  • "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

depositSince
string <date-time>

Statements where (extStatementDepositDate >= depositSince)

depositUntil
string <date-time>

Statements where (extStatementDepositDate < depositUntil)

endPeriodSince
string <date-time>

Statements where (extStatementEndDate >= endPeriodSince)

endPeriodUntil
string <date-time>

Statements where (extStatementEndDate < endPeriodUntil)

exceptionCategoryId
Array of strings

Retrieve statements by list of categories of the statement related exceptions

exceptionType
Array of strings

Retrieve statements by list of types of the statement related exceptions ({exceptionType} | {entityType}_{exceptionType})

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,extStatementDepositDate,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

startPeriodSince
string <date-time>

Statements where (extStatementStartDate >= startPeriodSince)

startPeriodUntil
string <date-time>

Statements where (extStatementStartDate < startPeriodUntil)

statementId
Array of strings

Retrieve statements by statementId list

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

Retrieve statements by status list

tags
Array of strings (EntityTags)

Tags assigned to entity

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
{
  • "code": 200,
  • "success": true,
  • "filters": {
    },
  • "pagination": {
    },
  • "statements": [
    ]
}

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
{
  • "code": 200,
  • "success": true
}

Update Statement

Authorizations:
Pipe17KeyAuth
path Parameters
StatementId
required
string

Statement Id to update

query Parameters
keys
string
Default: ""

Comma-separated fields to be returned ("*" - all)

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: "new" "draft" "pending" "paid" "reported"

Statement status

tags
Array of strings (EntityTags)

Tags assigned to entity

Array of objects (Fee)

Responses

Request samples

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

Response samples

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

Orders

Operations about Orders

Order Model

extOrderId
required
string

External Order ID

Array of objects (AdditionalCharge)

Additional charges

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

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:

  • initialPending: the automation engine will process this entity in the first time.
  • 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)
customerPONumber
string or null
Array of objects (NameValue)

Custom Fields

disableShipmentsReuse
boolean

Hint to whether shipmentId should be re-used, or not

Array of objects (Discount)

Discounts

disposition
Array of strings (OrderDispositionType)
Items Enum: "partiallyRouted" "routed" "partiallySent" "sent" "partiallyFulfilled" "fulfilled" "partiallyCanceled" "canceled" "partiallyFailed" "failed" "partiallyRejected" "rejected" "partiallyUnrouted" "unrouted" "partiallyUnsent" "unsent" "partiallyUnfulfilled" "unfulfilled"

Order disposition

Array of objects (OrderLineDisposition)

Disposition of line items

exceptionCategories
Array of strings

References to categories of exceptions related to the order

exceptions
Array of strings

Types of 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

holdUntil
string <date-time>
incoterms
string

International Commercial Terms

integration
string

Reference to integration that created an item

object (InternalInfo)

Internal info

isMultiAddress
boolean

Indicates the order is a multi address destination order (default - false)

isMultiDestination
boolean

Multi-destination order indicator

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

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: "online" "pos" "wholesale" "edi" "other" "b2b"

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

object (OrderPaymentTerms)

order payment terms

preferredLocationGroupId
Array of strings

List of location-group IDs

privacyPolicy
Array of strings (PrivacyPolicy)
Items Value: "amazon"
Array of objects (OrderRefund)

Additional charges

requireShippingLabels
boolean

Indicates if fetching of shipping labels is required

respectLocationId
boolean

Use locationId if defined on order level or lineItems level as valid item origin for shipment (pre-route).

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

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, 2nd Priority

shippingClass
string

Required with ShippingCarrier, 2nd Priority

shippingCode
string

1st Priority

Array of objects (Destination)
shippingNote
string

Shipping Notes

shippingPrice
number <float>

Shipping price

object (SourceDoc)

Vendor source document

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

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

{
  • "extOrderId": "string",
  • "additionalCharges": [
    ],
  • "billingAddress": {
    },
  • "currency": "string",
  • "customFields": [
    ],
  • "customer": {
    },
  • "customerPONumber": "string",
  • "disableShipmentsReuse": true,
  • "discounts": [
    ],
  • "expectedDeliveryDate": "2019-08-24T14:15:22Z",
  • "extOrderApiId": "string",
  • "extOrderCreatedAt": "2019-08-24T14:15:22Z",
  • "extOrderUpdatedAt": "2019-08-24T14:15:22Z",
  • "extOrderUrl": "string",
  • "fulfillmentStatus": "string",
  • "giftNote": "string",
  • "holdUntil": "2019-08-24T14:15:22Z",
  • "incoterms": "string",
  • "internal": {
    },
  • "isMultiAddress": true,
  • "lastRerunRoutingTrigger": "manual",
  • "lastRoutedAt": "2019-08-24T14:15:22Z",
  • "lineItems": [
    ],
  • "locationId": "string",
  • "orderDiscount": 0,
  • "orderNote": "string",
  • "orderSource": "string",
  • "orderSourceType": "online",
  • "orderTax": 0,
  • "paymentStatus": "string",
  • "paymentTerms": {
    },
  • "payments": [
    ],
  • "preferredLocationGroupId": [
    ],
  • "privacyPolicy": [
    ],
  • "refunds": [
    ],
  • "requireShippingLabels": true,
  • "respectLocationId": true,
  • "routingStatus": "disabled",
  • "shipAfterDate": "2019-08-24T14:15:22Z",
  • "shipByDate": "2019-08-24T14:15:22Z",
  • "shipCancelByDate": "2019-08-24T14:15:22Z",
  • "shippingAddress": {
    },
  • "shippingCarrier": "string",
  • "shippingClass": "string",
  • "shippingCode": "string",
  • "shippingDestinations": [
    ],
  • "shippingNote": "string",
  • "shippingPrice": 0,
  • "sourceDoc": {
    },
  • "status": "draft",
  • "subTotalPrice": 0,
  • "tags": [
    ],
  • "timestamp": "2019-08-24T14:15:22Z",
  • "totalPrice": 0,
  • "autoEngUpdateStatus": "initialPending",
  • "autoEngUpdateStatusUpdatedAt": "2019-08-24T14:15:22Z",
  • "disposition": [
    ],
  • "dispositions": [
    ],
  • "exceptionCategories": [
    ],
  • "exceptions": [
    ],
  • "integration": "string",
  • "isMultiDestination": true,
  • "orderId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "orgKey": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

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)
customerPONumber
string or null
Array of objects (NameValue)

Custom Fields

disableShipmentsReuse
boolean

Hint to whether shipmentId should be re-used, or not

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

holdUntil
string <date-time>
incoterms
string

International Commercial Terms

object (InternalInfo)

Internal info

isMultiAddress
boolean

Indicates the order is a multi address destination order (default - false)

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

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: "online" "pos" "wholesale" "edi" "other" "b2b"

Order Type (online, pos, etc)

orderTax
number <float>

Order Tax

Array of objects (Payment)

Payments

paymentStatus
string

status of the payment

object (OrderPaymentTerms)

order payment terms

preferredLocationGroupId
Array of strings

List of location-group IDs

privacyPolicy
Array of strings (PrivacyPolicy)
Items Value: "amazon"
Array of objects (OrderRefund)

Additional charges

requireShippingLabels
boolean

Indicates if fetching of shipping labels is required

respectLocationId
boolean

Use locationId if defined on order level or lineItems level as valid item origin for shipment (pre-route).

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

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, 2nd Priority

shippingClass
string

Required with ShippingCarrier, 2nd Priority

shippingCode
string

1st Priority

Array of objects (Destination)
shippingNote
string

Shipping Notes

shippingPrice
number <float>

Shipping price

object (SourceDoc)

Vendor source document

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

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
{
  • "code": 200,
  • "success": true,
  • "orders": [
    ]
}

Delete Multiple Orders

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

Return the list of what to delete, or delete softly

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: "online" "pos" "wholesale" "edi" "other" "b2b"

Delete orders by list of order types

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

Delete orders assigned these orgModes.

pagination
string
Value: "disabled"

Exclude pagination info from the response

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

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: "draft" "new" "onHold" "toBeValidated" "reviewRequired" "readyForFulfillment" "sentToFulfillment" "partialFulfillment" "fulfilled" "inTransit" "partialReceived" "received" "canceled" "returned" "refunded" "archived" "closed"

Delete orders by list of statuses

tags
Array of strings (EntityTags)

Tags assigned to entity

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
{
  • "code": 200,
  • "success": true,
  • "deleted": 0,
  • "filters": {
    },
  • "orders": [
    ],
  • "pagination": {
    }
}

Delete Order

Authorizations:
Pipe17KeyAuth
path Parameters
OrderId
required
string

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

query Parameters
nested
boolean

Delete nested entities

Responses

Response samples

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

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
{
  • "code": 200,
  • "success": true,
  • "order": {
    }
}

List Orders

Authorizations:
Pipe17KeyAuth
query Parameters
autoEngUpdateStatus
Array of strings (AutoEngUpdateStatus)
Items Enum: "initialPending" "pending" "updated" "none"
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

disposition
Array of strings (OrderDispositionType)
Items Enum: "partiallyRouted" "routed" "partiallySent" "sent" "partiallyFulfilled" "fulfilled" "partiallyCanceled" "canceled" "partiallyFailed" "failed" "partiallyRejected" "rejected" "partiallyUnrouted" "unrouted" "partiallyUnsent" "unsent" "partiallyUnfulfilled" "unfulfilled"

Fetch orders by list of order disposition types

email
string

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

emailAddr
Array of strings

Retrieve orders by list of billing/shippingAddress.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

Fetch orders by list of types of the order related exceptions ({exceptionType} | {entityType}_{exceptionType})

extOrderId
Array of strings

Fetch orders by list of extOrderId

hasSourceDoc
boolean

Orders containing a source document

holdUntilSince
string <date-time>

Fetch all orders with holdUntil after or at this date-time. Rounded down to the nearest minute

holdUntilUntil
string <date-time>

Fetch all orders with holdUntil before or at this date-time. Rounded down to the nearest minute

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: "manual" "auto"

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: "online" "pos" "wholesale" "edi" "other" "b2b"

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: "disabled" "pending" "ready" "acknowledged" "failed" "excluded" "pendingInventory"

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: "draft" "new" "onHold" "toBeValidated" "reviewRequired" "readyForFulfillment" "sentToFulfillment" "partialFulfillment" "fulfilled" "inTransit" "partialReceived" "received" "canceled" "returned" "refunded" "archived" "closed"

Fetch orders by list of statuses

tags
Array of strings (EntityTags)

Tags assigned to entity

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
{
  • "code": 200,
  • "success": true,
  • "orders": [
    ],
  • "filters": {
    },
  • "pagination": {
    }
}

Sync Orders

Trigger the orders sync

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

Reset autoEngUpdateStatus

Responses

Request samples

Content type
{
  • "syncAE": true
}

Response samples

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

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
keys
string
Default: ""

Comma-separated fields to be returned ("*" - all)

withTransform
boolean

Enable order transformation engine for this request

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

Additional charges

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

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:

  • initialPending: the automation engine will process this entity in the first time.
  • 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)
customerPONumber
string or null
Array of objects (NameValue)

Custom Fields

disableShipmentsReuse
boolean or null

Hint to whether shipmentId should be re-used, or not

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

holdUntil
string or null <date-time>
object (InternalInfo)

Internal info

isMultiAddress
boolean or null

Indicates the order is a multi address destination order (default - false)

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

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 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: "online" "pos" "wholesale" "edi" "other" "b2b"

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

object (OrderPaymentTerms)

order payment terms

preferredLocationGroupId
Array of strings or null

List of location-group IDs

privacyPolicy
Array of strings or null (PrivacyPolicy)
Value: "amazon"
Array of objects or null (OrderRefund)

Order refunds

requireShippingLabels
boolean or null

Indicates if fetching of shipping labels is required

respectLocationId
boolean or null

Use locationId if defined on order level or lineItems level as valid item origin for shipment (pre-route).

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

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, 2nd Priority

shippingClass
string or null

Required with ShippingCarrier, 2nd Priority

shippingCode
string or null

1st Priority

Array of objects (Destination)
shippingNote
string or null

Shipping Notes

shippingPrice
number or null <float>
object (SourceDoc)

Vendor source document

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

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
{
  • "additionalCharges": [
    ],
  • "autoEngUpdateStatus": "initialPending",
  • "billingAddress": {
    },
  • "currency": "string",
  • "customFields": [
    ],
  • "customer": {
    },
  • "customerPONumber": "string",
  • "disableShipmentsReuse": true,
  • "discounts": [
    ],
  • "expectedDeliveryDate": "2019-08-24T14:15:22Z",
  • "extOrderApiId": "string",
  • "extOrderCreatedAt": "2019-08-24T14:15:22Z",
  • "extOrderId": "string",
  • "extOrderUpdatedAt": "2019-08-24T14:15:22Z",
  • "extOrderUrl": "string",
  • "fulfillmentStatus": "string",
  • "giftNote": "string",
  • "holdUntil": "2019-08-24T14:15:22Z",
  • "internal": {
    },
  • "isMultiAddress": true,
  • "lastRerunRoutingTrigger": "manual",
  • "lastRoutedAt": "2019-08-24T14:15:22Z",
  • "lineItems": [
    ],
  • "locationId": "string",
  • "orderDiscount": 0,
  • "orderNote": "string",
  • "orderSource": "string",
  • "orderSourceType": "online",
  • "orderTax": 0,
  • "paymentStatus": "string",
  • "paymentTerms": {
    },
  • "payments": [
    ],
  • "preferredLocationGroupId": [
    ],
  • "privacyPolicy": [
    ],
  • "refunds": [
    ],
  • "requireShippingLabels": true,
  • "respectLocationId": true,
  • "routingStatus": "disabled",
  • "shipAfterDate": "2019-08-24T14:15:22Z",
  • "shipByDate": "2019-08-24T14:15:22Z",
  • "shipCancelByDate": "2019-08-24T14:15:22Z",
  • "shippingAddress": {
    },
  • "shippingCarrier": "string",
  • "shippingClass": "string",
  • "shippingCode": "string",
  • "shippingDestinations": [
    ],
  • "shippingNote": "string",
  • "shippingPrice": 0,
  • "sourceDoc": {
    },
  • "status": "draft",
  • "subTotalPrice": 0,
  • "tags": [
    ],
  • "timestamp": "2019-08-24T14:15:22Z",
  • "totalPrice": 0
}

Response samples

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

Products

Operations about Products

Product Model

name
required
string

Display Name

sku
required
string

Product SKU

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

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:

  • initialPending: the automation engine will process this entity in the first time.
  • 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

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" "in" "ft"

Dimensions UOM

exceptionCategories
Array of strings

References to categories of exceptions related to the product

exceptions
Array of strings

Types of 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: "simple" "bundle" "bundleItem" "child" "parent"

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: "lb" "oz" "kg" "g"

Weight UOM

width
number <float>

Width

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

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" "in" "ft"

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: "simple" "bundle" "bundleItem" "child" "parent"

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: "lb" "oz" "kg" "g"

Weight UOM

width
number <float>

Width

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

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

Delete Multiple Products

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

Return the list of what to delete, or delete softly

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: "sandbox" "production" "internal" "demo"

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

tags
Array of strings (EntityTags)

Tags assigned to entity

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

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
{
  • "code": 200,
  • "success": true,
  • "deleted": 0,
  • "filters": {
    },
  • "pagination": {
    },
  • "products": [
    ]
}

Delete Product

Authorizations:
Pipe17KeyAuth
path Parameters
ProductId
required
string

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

Responses

Response samples

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

List Products

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

Fetch all products with autoEngUpdateStatus updated after this date-time

autoEngUpdateStatusUpdatedUntil
string <date-time>

Fetch all products with autoEngUpdateStatus updated before this date-time

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

Retrieve products by list of types of the product related exceptions ({exceptionType} | {entityType}_{exceptionType})

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

integration
Array of strings

Retrieve products of these integrations

inventoryNotTracked
boolean

Retrieve products by inventoryNotTracked value (default - any)

keys
string
Default: "inventoryNotTracked,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: "tobepublished" "published" "tobeunpublished" "unpublished" "disabled"

Retrieve all products with published status

requestorId
string

Requestor Id (- forcibly replaced with integration ID if the request came from an integration)

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

tags
Array of strings (EntityTags)

Tags assigned to entity

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

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
{
  • "code": 200,
  • "success": true,
  • "products": [
    ],
  • "filters": {
    },
  • "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
{
  • "code": 200,
  • "success": true,
  • "product": {
    }
}

Sync Products

Trigger the products sync

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

Reset autoEngUpdateStatus

Responses

Request samples

Content type
{
  • "syncAE": true
}

Response samples

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

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

query Parameters
keys
string
Default: ""

Comma-separated fields to be returned ("*" - all)

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

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:

  • initialPending: the automation engine will process this entity in the first time.
  • 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.
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" "in" "ft"

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: "simple" "bundle" "bundleItem" "child" "parent"

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: "lb" "oz" "kg" "g"

Weight UOM

width
number or null <float>

Width

Responses

Request samples

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

Response samples

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

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

disableShipmentsReuse
boolean

Hint to whether shipmentId should be re-used, or not

employeeName
string

Purchase order created by

exceptionCategories
Array of strings

References to categories of exceptions related to the purchase

exceptions
Array of strings

Types of exceptions related to the purchase

expectedArrivalDate
string <date-time>

Expected Arrival Date

extOrderApiId
string

External System Purchase Order API ID

extReferenceId
string

Reference ID

holdUntil
string <date-time>
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: "draft" "new" "onHold" "toBeValidated" "reviewRequired" "readyForFulfillment" "sentToFulfillment" "partialFulfillment" "fulfilled" "inTransit" "partialReceived" "received" "canceled" "returned" "refunded" "archived" "closed"

Purchase Status

subTotalPrice
number <float>

Sub Total Price

tags
Array of strings (EntityTags)

Tags assigned to entity

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)
{
  • "exceptionCategories": [
    ],
  • "exceptions": [
    ],
  • "integration": "string",
  • "purchaseId": "string",
  • "extOrderId": "string",
  • "actualArrivalDate": "2019-08-24T14:15:22Z",
  • "billingAddress": {
    },
  • "costs": [
    ],
  • "currency": "string",
  • "customFields": [
    ],
  • "disableShipmentsReuse": true,
  • "employeeName": "string",
  • "expectedArrivalDate": "2019-08-24T14:15:22Z",
  • "extOrderApiId": "string",
  • "extReferenceId": "string",
  • "holdUntil": "2019-08-24T14:15:22Z",
  • "incoterms": "string",
  • "internal": {
    },
  • "lineItems": [
    ],
  • "purchaseNotes": "string",
  • "purchaseOrderDate": "2019-08-24T14:15:22Z",
  • "purchaseTax": 0,
  • "referenceNumber": "string",
  • "shipByDate": "2019-08-24T14:15:22Z",
  • "shippingCarrier": "string",
  • "shippingNotes": "string",
  • "shippingService": "string",
  • "sourceDoc": {
    },
  • "status": "draft",
  • "subTotalPrice": 0,
  • "tags": [
    ],
  • "timestamp": "2019-08-24T14:15:22Z",
  • "toAddress": {
    },
  • "toLocationId": "string",
  • "totalPrice": 0,
  • "vendorAddress": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "orgKey": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Create Purchases

Uniqueness constraints within organization:

  • purchase.extOrderId
  • purchase.extOrderApiId, purchase.inegration (when extOrderApiId defined)
  • purchase.extReferenceId, purchase.integration (when extReferenceId defined)
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

disableShipmentsReuse
boolean

Hint to whether shipmentId should be re-used, or not

employeeName
string

Purchase order created by

expectedArrivalDate
string <date-time>

Expected Arrival Date

extOrderApiId
string

External System Purchase Order API ID

extReferenceId
string

Reference ID

holdUntil
string <date-time>
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: "draft" "new" "onHold" "toBeValidated" "reviewRequired" "readyForFulfillment" "sentToFulfillment" "partialFulfillment" "fulfilled" "inTransit" "partialReceived" "received" "canceled" "returned" "refunded" "archived" "closed"

Purchase Status

subTotalPrice
number <float>

Sub Total Price

tags
Array of strings (EntityTags)

Tags assigned to entity

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
{
  • "code": 200,
  • "success": true,
  • "purchases": [
    ]
}

Delete Multiple Purchases

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

Return the list of what to delete, or delete softly

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

extReferenceId
Array of strings

Delete purchases by extReferenceId list

integration
Array of strings

Delete purchases of these integrations

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

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: "draft" "new" "onHold" "toBeValidated" "reviewRequired" "readyForFulfillment" "sentToFulfillment" "partialFulfillment" "fulfilled" "inTransit" "partialReceived" "received" "canceled" "returned" "refunded" "archived" "closed"

Delete purchases by list of statuses

tags
Array of strings (EntityTags)

Tags assigned to entity

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
{
  • "code": 200,
  • "success": true,
  • "deleted": 0,
  • "filters": {
    },
  • "pagination": {
    },
  • "purchases": [
    ]
}

Delete Purchase

Authorizations:
Pipe17KeyAuth
path Parameters
PurchaseId
required
string

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

query Parameters
nested
boolean

Delete nested entities

Responses

Response samples

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

Fetch Purchase

Authorizations:
Pipe17KeyAuth
path Parameters
PurchaseId
required
string

Id, ext:{extOrderId}, api:{extOrderApiId}, or ref:{extReferenceId} 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
{
  • "code": 200,
  • "success": true,
  • "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

Retrieve purchases by list of types of the purchase related exceptions ({exceptionType} | {entityType}_{exceptionType})

extOrderId
Array of strings

Retrieve by list of external purchase IDs

extReferenceId
Array of strings

Retrieve by extReferenceId list

hasSourceDoc
boolean

Retrieve purchases containing a source document

integration
Array of strings

Retrieve purchases of these integrations

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: "draft" "new" "onHold" "toBeValidated" "reviewRequired" "readyForFulfillment" "sentToFulfillment" "partialFulfillment" "fulfilled" "inTransit" "partialReceived" "received" "canceled" "returned" "refunded" "archived" "closed"

Retrieve by list of statuses

tags
Array of strings (EntityTags)

Tags assigned to entity

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
{
  • "code": 200,
  • "success": true,
  • "purchases": [
    ],
  • "filters": {
    },
  • "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
{
  • "code": 200,
  • "success": true
}

Update Purchase

Uniqueness constraints within organization:

  • purchase.extOrderId
  • purchase.extOrderApiId, purchase.inegration (when extOrderApiId defined)
  • purchase.extReferenceId, purchase.integration (when extReferenceId defined)
Authorizations:
Pipe17KeyAuth
path Parameters
PurchaseId
required
string

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

query Parameters
keys
string
Default: ""

Comma-separated fields to be returned ("*" - all)

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

disableShipmentsReuse
boolean or null

Hint to whether shipmentId should be re-used, or not

employeeName
string or null

Purchase order created by

expectedArrivalDate
string or null <date-time>

Expected Arrival Date

extReferenceId
string

Reference ID

holdUntil
string or null <date-time>
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: "draft" "new" "onHold" "toBeValidated" "reviewRequired" "readyForFulfillment" "sentToFulfillment" "partialFulfillment" "fulfilled" "inTransit" "partialReceived" "received" "canceled" "returned" "refunded" "archived" "closed"

Purchase 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

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
{
  • "actualArrivalDate": "2019-08-24T14:15:22Z",
  • "billingAddress": {
    },
  • "costs": [
    ],
  • "currency": "string",
  • "customFields": [
    ],
  • "disableShipmentsReuse": true,
  • "employeeName": "string",
  • "expectedArrivalDate": "2019-08-24T14:15:22Z",
  • "extReferenceId": "string",
  • "holdUntil": "2019-08-24T14:15:22Z",
  • "internal": {
    },
  • "lineItems": [
    ],
  • "purchaseNotes": "string",
  • "purchaseTax": 0,
  • "referenceNumber": "string",
  • "shipByDate": "2019-08-24T14:15:22Z",
  • "shippingCarrier": "string",
  • "shippingNotes": "string",
  • "shippingService": "string",
  • "sourceDoc": {
    },
  • "status": "draft",
  • "subTotalPrice": 0,
  • "tags": [
    ],
  • "timestamp": "2019-08-24T14:15:22Z",
  • "toAddress": {
    },
  • "toLocationId": "string",
  • "totalPrice": 0,
  • "vendorAddress": {
    }
}

Response samples

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

Receipts

Operations about Receipts

Receipt Model

arrivalId
required
string

Arrival ID

actualArrivalDate
string <date-time>

Actual arrival date

arrivalIntegration
string

Reference to integration that created arrival tied to receipt

createdAt
string <date-time>

When the object was created within Pipe17

currency
string

Currency

Array of objects (NameValue)

Custom Fields

exceptionCategories
Array of strings

References to categories of exceptions related to the receipt

exceptions
Array of strings

Types of exceptions related to the receipt

extArrivalId
string

External arrival ID

extOrderId
string

External Order ID

extReceiptApiId
string

External System Receipt API ID

extReceiptId
string

Reference to receipt on external system (vendor)

integration
string

Reference to integration that created receipt

object (InternalInfo)

Internal info

Array of objects (ReceiptItemWithRefs)
orderIntegration
string

Reference to integration that created order tied to receipt

orgKey
string

Organization this object belong to

receiptId
string

Receipt ID

shippingCarrier
string

Shipping Carrier

shippingClass
string

Shipping Carrier

object (SourceDoc)

Vendor source document

tags
Array of strings (EntityTags)

Tags assigned to entity

Array of objects (ReceiptChangelogEntry)

Timeline of updates

updatedAt
string <date-time>

When the object was updated within Pipe17

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

Create Arrival Receipts

Uniqueness constraints within organization:

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

Arrival ID

required
Array of objects (ReceiptItem)
actualArrivalDate
string <date-time>

Actual arrival date

currency
string

Currency

Array of objects (NameValue)

Custom Fields

extReceiptApiId
string

External System Receipt API ID

extReceiptId
string

Reference to receipt on external system (vendor)

object (InternalInfo)

Internal info

shippingCarrier
string

Shipping Carrier

shippingClass
string

Shipping Carrier

object (SourceDoc)

Vendor source document

tags
Array of strings (EntityTags)

Tags assigned to entity

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

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

Fetch Receipt

Authorizations:
Pipe17KeyAuth
path Parameters
ReceiptId
required
string

Id, ext:{extReceiptId} or api:{extReceiptApiId} 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

withTimeline
boolean

Include timeline of updates when available

Responses

Response samples

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