Flexe (Preview)
Flexe is a dynamic, flexible warehousing and fulfillment network that meets demand. Connect to Flexe to retrieve and update fulfilment-related information.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | Microsoft Dynamics |
| URL | https://dynamics.microsoft.com/en-us/support/ |
| iomdri@microsoft.com |
| Connector Metadata | |
|---|---|
| Publisher | Microsoft |
| Website | https://www.flexe.com/ |
| Privacy policy | https://www.flexe.com/privacy-policy |
| Categories | Productivity |
This connector was specifically developed to be used for Dynamics 365 Intelligent Order Management's Flexe provider integration.
Prerequisites
A Flexe developer account is required. If you don't have one you can create it at https://developer-sandbox.flexe.com. Note: It is recommended to use this connector specifically to set up the Dynamics 365 Intelligent Order Management Flexe provider.
How to get credentials
Flexe requires an API token for authentication. You can generate a token https://developer-sandbox.flexe.com/tokens and use that to configure the connector.
Getting started with your connector
Configure the connection with the API keys. To learn more about Flexe's API's read the public documentation: https://developer-sandbox.flexe.com/doc/public
Known issues and limitations
This connector was specifically developed to be used for Dynamics 365 Intelligent Order Management's Flexe provider integration. Support for usecases outside of Dynamics 365 Intelligent Order Management will be limited.
Creating a connection
The connector supports the following authentication types:
| Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description | Required |
|---|---|---|---|
| API Key | securestring | The API Key for this api | True |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Cancel an outbound order line |
Cancel an outbound order line. |
| Create an order attachment |
Create an order attachment. |
| Create an outbound order line |
Create an outbound order line. |
| Create retail fulfillment order |
Create retail fulfillment order. |
| Creates a single order |
Creates a single order. |
| Get inbound shipments containing non-palletized products |
Get inbound shipments containing non-palletized products. |
| Notify warehouse of an inbound shipment containing non-palletized products |
Notify warehouse of an inbound shipment containing non-palletized products. |
| Request a count of inventory by SKU from Flexe |
Request a count of inventory by SKU from Flexe. |
| Retrieve allocation errors for an outbound order |
Retrieve allocation errors for an outbound order. |
| Retrieve allocation errors for an outbound order line |
Retrieve allocation errors for an outbound order line. |
| Retrieve an outbound order by its Id |
Retrieve an outbound order by its Id. |
| Retrieve an outbound order line by order Id and line Id |
Retrieve an outbound order line by order Id and line Id. |
| Retrieve lines for an outbound order |
Retrieve lines for an outbound order. |
| Retrieve outbound order lines |
Retrieve outbound order lines. |
| Retrieve outbound orders |
Retrieve outbound orders. |
| Update an order |
Update an order. |
| Update existing retail fulfillment order |
Update existing retail fulfillment order. |
| Write a file to the specified key |
Write a file to the specified key. |
Cancel an outbound order line
Cancel an outbound order line.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Order ID
|
orderId | True | string |
The order Id used to cancel outbound orders line. |
|
Line ID
|
lineId | True | string |
The line Id used to cancel outbound orders line. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
quantity
|
quantity | integer | |
|
unitOfMeasure
|
unitOfMeasure | string | |
|
externalId
|
externalId | string | |
|
sku
|
sku | string | |
|
key
|
labels.key | string | |
|
id
|
id | string | |
|
orderId
|
orderId | string | |
|
createdAt
|
createdAt | string | |
|
updatedAt
|
updatedAt | string | |
|
cancelledAt
|
cancelledAt | string | |
|
completelyShippedAt
|
completelyShippedAt | string | |
|
percentAllocated
|
percentAllocated | integer | |
|
percentShipped
|
percentShipped | integer | |
|
hasErrors
|
hasErrors | boolean | |
|
shipmentIds
|
shipmentIds | array of string |
shipmentIds |
|
allocatedQuantity
|
allocatedQuantity | integer | |
|
shippedQuantity
|
shippedQuantity | integer |
Create an order attachment
Create an order attachment.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Order ID
|
orderId | True | string |
The ID of the order the attachment is being created for. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
externalUrl
|
externalUrl | string | |
|
orderId
|
orderId | string | |
|
documentType
|
documentType | string | |
|
displayName
|
displayName | string | |
|
cancelledAt
|
cancelledAt | string | |
|
externalId
|
externalId | string | |
|
fileKey
|
fileKey | string | |
|
type
|
type | string | |
|
key
|
labels.key | string | |
|
barcodeText
|
barcodeText | string | |
|
createdAt
|
createdAt | string | |
|
id
|
id | string | |
|
fileGroup
|
fileGroup | string | |
|
trackingNumber
|
trackingNumber | string |
Create an outbound order line
Create an outbound order line.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Order ID
|
orderId | True | string |
The order Id used to create outbound orders line. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
quantity
|
quantity | integer | |
|
unitOfMeasure
|
unitOfMeasure | string | |
|
externalId
|
externalId | string | |
|
sku
|
sku | string | |
|
key
|
labels.key | string | |
|
id
|
id | string | |
|
orderId
|
orderId | string | |
|
createdAt
|
createdAt | string | |
|
updatedAt
|
updatedAt | string | |
|
cancelledAt
|
cancelledAt | string | |
|
completelyShippedAt
|
completelyShippedAt | string | |
|
percentAllocated
|
percentAllocated | integer | |
|
percentShipped
|
percentShipped | integer | |
|
hasErrors
|
hasErrors | boolean | |
|
shipmentIds
|
shipmentIds | array of string |
shipmentIds |
|
allocatedQuantity
|
allocatedQuantity | integer | |
|
shippedQuantity
|
shippedQuantity | integer |
Create retail fulfillment order
Create retail fulfillment order.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string | |
|
type
|
type | True | string | |
|
customerUUID
|
customerUUID | True | string | |
|
value
|
value | True | string | |
|
value
|
value | True | string | |
|
sku
|
sku | True | string | |
|
value
|
value | string | ||
|
addressLine1
|
addressLine1 | True | string | |
|
country
|
country | True | string | |
|
locality
|
locality | True | string | |
|
name
|
name | True | string | |
|
postcode
|
postcode | True | string | |
|
region
|
region | True | string | |
|
addressLine2
|
addressLine2 | string | ||
|
addressLine3
|
addressLine3 | string | ||
|
phone
|
phone | string | ||
|
email
|
string | |||
|
end
|
end | True | string | |
|
start
|
start | True | string | |
|
shipmentType
|
shipmentType | string | ||
|
type
|
type | True | string | |
|
shipmentMethod
|
shipmentMethod | string | ||
|
purchaseOrder
|
purchaseOrder | string | ||
|
routeBy
|
routeBy | string | ||
|
instructions
|
instructions | string | ||
|
carrier
|
carrier | string | ||
|
carrierServiceType
|
carrierServiceType | string | ||
|
carrierBillingAccountId
|
carrierBillingAccountId | string | ||
|
number
|
number | string | ||
|
value
|
value | string | ||
|
value
|
value | string | ||
|
type
|
type | string | ||
|
routingDetailsId
|
routingDetailsId | string | ||
|
destinationType
|
destinationType | string | ||
|
destinationRetailer
|
destinationRetailer | string | ||
|
correlationId
|
correlationId | True | string |
Returns
Creates a single order
Creates a single order.
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | string | |
|
createdAt
|
createdAt | string | |
|
updatedAt
|
updatedAt | string | |
|
state
|
state | string | |
|
hasErrors
|
hasErrors | boolean | |
|
externalId
|
externalId | string | |
|
key
|
labels.key | string | |
|
reservationId
|
reservationId | string | |
|
name
|
recipient.name | string | |
|
phone
|
recipient.phone | string | |
|
email
|
recipient.email | string | |
|
line1
|
recipient.address.line1 | string | |
|
line2
|
recipient.address.line2 | string | |
|
line3
|
recipient.address.line3 | string | |
|
city
|
recipient.address.city | string | |
|
region
|
recipient.address.region | string | |
|
postcode
|
recipient.address.postcode | string | |
|
country
|
recipient.address.country | string | |
|
instructions
|
shipping.instructions | string | |
|
serviceType
|
shipping.serviceType | string | |
|
carrierBillingAccountId
|
shipping.carrierBillingAccountId | string | |
|
signatureConfirmation
|
shipping.signatureConfirmation | string | |
|
labelReference1
|
shipping.labelReference1 | string | |
|
labelReference2
|
shipping.labelReference2 | string |
Get inbound shipments containing non-palletized products
Get inbound shipments containing non-palletized products.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Continuation token
|
continuationToken | True | string |
The continuation token used to retrieve next page inbound shipments when more pages are still available. |
|
Page size
|
pageSize | True | string |
The page size used to retrieve inbound shipments. |
|
State
|
state | True | string |
The state used to retrieve inbound shipments. |
|
Created At From
|
createdAtFrom | True | string |
The created at from used to retrieve inbound shipments. |
|
Created At To
|
createdAtTo | True | string |
The created at to used to retrieve inbound shipments. |
|
Updated At From
|
updatedAtFrom | True | string |
The updated at from used to retrieve inbound shipments. |
|
Updated At To
|
updatedAtTo | True | string |
The updated at to used to retrieve inbound shipments. |
|
Customer UUID
|
customerUUID | True | string |
The customer UUID used to retrieve inbound shipments. |
|
Purchase Order
|
purchaseOrder | True | string |
The purchase order used to retrieve inbound shipments. |
|
Reservations
|
reservations | True | string |
The reservations used to retrieve inbound shipments. |
Returns
Notify warehouse of an inbound shipment containing non-palletized products
Notify warehouse of an inbound shipment containing non-palletized products.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
billOfLading
|
billOfLading | string | ||
|
amount
|
amount | True | integer | |
|
unit
|
unit | True | string | |
|
sku
|
sku | string | ||
|
expectedInboundShipmentType
|
expectedInboundShipmentType | string | ||
|
customerUUID
|
customerUUID | True | string | |
|
containerNumber
|
containerNumber | string | ||
|
amount
|
amount | True | string | |
|
unit
|
unit | True | string | |
|
purchaseOrderId
|
purchaseOrderId | True | string | |
|
dropoffDate
|
dropoffDate | True | string | |
|
containerSealNumber
|
containerSealNumber | string | ||
|
id
|
id | True | string | |
|
type
|
type | True | string | |
|
suplierOrVendor
|
suplierOrVendor | string | ||
|
id
|
id | string | ||
|
customReference1
|
customReference1 | string | ||
|
lotCode
|
lotCode | string | ||
|
asnNumber
|
asnNumber | string | ||
|
manufactureDate
|
manufactureDate | string | ||
|
key
|
key | string | ||
|
countryOfOrigin
|
countryOfOrigin | string | ||
|
poNumber
|
poNumber | string | ||
|
originSite
|
originSite | string | ||
|
customReference2
|
customReference2 | string | ||
|
expirationDate
|
expirationDate | string | ||
|
label
|
label | string | ||
|
unit
|
unit | string | ||
|
quantity
|
quantity | integer | ||
|
sku
|
sku | string | ||
|
correlationId
|
correlationId | True | string |
Returns
Request a count of inventory by SKU from Flexe
Request a count of inventory by SKU from Flexe.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Reservation ID
|
reservation_id | string |
Filter inventory available at a specific warehouse assigned to reservation. |
|
|
Client Request ID
|
client_request_id | string |
A key that will be sent back to the client in the response object so clients may use to identify the originating call. |
|
|
Continuation Token
|
continuation_token | string |
Get the next page of data. Page size is 3000 skus. Value is provided in the previous response. |
|
|
Ever In Use
|
ever_in_use | string |
Boolean, where true gets all inventories ever stored while false gets all inventories currently stored. Defaults to true. |
|
|
In Use Since
|
in_use_since | string |
Optional String, ISO8601 date. E.g., "2019-09-01". If populated, only return inventory that has been used on or after this date. Not valid unless 'ever_in_use' is also set. Defaults to nil. |
|
|
Item IDs
|
item_ids[] | string |
Filter on details of items with specific ids. If populated, ever_in_use and skus filter options will be disregarded. |
|
|
Skus
|
skus[] | string |
Filter on details of items with specific skus. If populated, ever_in_use filter option will be disregarded. |
Returns
Retrieve allocation errors for an outbound order
Retrieve allocation errors for an outbound order.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Page Size
|
pageSize | True | string |
The page size used to retrieve outbound order errors. |
|
Continuation Token
|
continuationToken | True | string |
The continuation token used to retrieve next page outbound order errors. |
|
Order ID
|
orderId | True | string |
The order Id used to retrieve outbound order errors. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
total
|
total | integer | |
|
continuationToken
|
continuationToken | string | |
|
allocationErrors
|
allocationErrors | array of object |
allocationErrors |
|
orderExternalId
|
allocationErrors.orderExternalId | string | |
|
createdAt
|
allocationErrors.createdAt | string | |
|
code
|
allocationErrors.code | string | |
|
orderId
|
allocationErrors.orderId | string | |
|
lineExternalId
|
allocationErrors.lineExternalId | string | |
|
details
|
allocationErrors.details | string | |
|
orderLineId
|
allocationErrors.orderLineId | string | |
|
key
|
allocationErrors.labels.key | string |
Retrieve allocation errors for an outbound order line
Retrieve allocation errors for an outbound order line.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Page Size
|
pageSize | True | string |
The page size used to retrieve outbound order line errors. |
|
Continuation Token
|
continuationToken | True | string |
The continuation token used to retrieve next page outbound order line errors. |
|
Order ID
|
orderId | True | string |
The order Id used to retrieve outbound orders line errors. |
|
Line ID
|
lineId | True | string |
The line Id used to retrieve outbound orders line errors. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
total
|
total | integer | |
|
continuationToken
|
continuationToken | string | |
|
allocationErrors
|
allocationErrors | array of object |
allocationErrors |
|
orderExternalId
|
allocationErrors.orderExternalId | string | |
|
createdAt
|
allocationErrors.createdAt | string | |
|
code
|
allocationErrors.code | string | |
|
orderId
|
allocationErrors.orderId | string | |
|
lineExternalId
|
allocationErrors.lineExternalId | string | |
|
details
|
allocationErrors.details | string | |
|
orderLineId
|
allocationErrors.orderLineId | string | |
|
key
|
allocationErrors.labels.key | string |
Retrieve an outbound order by its Id
Retrieve an outbound order by its Id.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Order ID
|
orderId | True | string |
The order Id used to retrieve outbound order. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
property1
|
labels.property1 | string | |
|
property2
|
labels.property2 | string | |
|
externalId
|
externalId | string | |
|
reservationId
|
reservationId | string | |
|
country
|
recipient.address.country | string | |
|
city
|
recipient.address.city | string | |
|
postcode
|
recipient.address.postcode | string | |
|
line3
|
recipient.address.line3 | string | |
|
region
|
recipient.address.region | string | |
|
line2
|
recipient.address.line2 | string | |
|
line1
|
recipient.address.line1 | string | |
|
phone
|
recipient.phone | string | |
|
name
|
recipient.name | string | |
|
email
|
recipient.email | string | |
|
serviceType
|
shipping.serviceType | string | |
|
instructions
|
shipping.instructions | string | |
|
labelReference1
|
shipping.labelReference1 | string | |
|
labelReference2
|
shipping.labelReference2 | string | |
|
carrierBillingAccountId
|
shipping.carrierBillingAccountId | string | |
|
signatureConfirmation
|
shipping.signatureConfirmation | string | |
|
id
|
id | string | |
|
createdAt
|
createdAt | string | |
|
updatedAt
|
updatedAt | string | |
|
state
|
state | string | |
|
hasErrors
|
hasErrors | boolean | |
|
shipmentIds
|
shipmentIds | array of string |
shipmentIds |
Retrieve an outbound order line by order Id and line Id
Retrieve an outbound order line by order Id and line Id.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Order ID
|
orderId | True | string |
The order Id used to retrieve outbound orders line. |
|
Line ID
|
lineId | True | string |
The line Id used to retrieve outbound orders line. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
quantity
|
quantity | integer | |
|
unitOfMeasure
|
unitOfMeasure | string | |
|
externalId
|
externalId | string | |
|
sku
|
sku | string | |
|
key
|
labels.key | string | |
|
id
|
id | string | |
|
orderId
|
orderId | string | |
|
createdAt
|
createdAt | string | |
|
updatedAt
|
updatedAt | string | |
|
cancelledAt
|
cancelledAt | string | |
|
completelyShippedAt
|
completelyShippedAt | string | |
|
percentAllocated
|
percentAllocated | integer | |
|
percentShipped
|
percentShipped | integer | |
|
hasErrors
|
hasErrors | boolean | |
|
shipmentIds
|
shipmentIds | array of string |
shipmentIds |
|
allocatedQuantity
|
allocatedQuantity | integer | |
|
shippedQuantity
|
shippedQuantity | integer |
Retrieve lines for an outbound order
Retrieve lines for an outbound order.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Page Size
|
pageSize | True | string |
The page size used to retrieve outbound order lines. |
|
Continuation Token
|
continuationToken | True | string |
The continuation token used to retrieve next page outbound order lines. |
|
Created At From
|
createdAtFrom | True | string |
The created at from used to retrieve outbound order lines. |
|
Created At To
|
createdAtTo | True | string |
The created at to used to retrieve outbound order lines. |
|
External IDs
|
externalIds | True | string |
The external Ids used to retrieve outbound order lines. |
|
Skus
|
skus | True | string |
The skus used to retrieve outbound order lines. |
|
Line IDs
|
lineIds | True | string |
The line Ids used to retrieve outbound orders lines. |
|
Labels
|
labels | True | string |
The labels used to retrieve outbound orders lines. |
|
Order ID
|
orderId | True | string |
The order Id used to retrieve outbound orders lines. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
total
|
total | integer | |
|
continuationToken
|
continuationToken | string | |
|
lines
|
lines | array of object |
lines |
|
id
|
lines.id | string | |
|
key
|
lines.labels.key | string | |
|
externalId
|
lines.externalId | string | |
|
sku
|
lines.sku | string | |
|
quantity
|
lines.quantity | integer | |
|
unitOfMeasure
|
lines.unitOfMeasure | string | |
|
orderId
|
lines.orderId | string | |
|
createdAt
|
lines.createdAt | string | |
|
updatedAt
|
lines.updatedAt | string | |
|
cancelledAt
|
lines.cancelledAt | string | |
|
completelyShippedAt
|
lines.completelyShippedAt | string | |
|
percentAllocated
|
lines.percentAllocated | integer | |
|
percentShipped
|
lines.percentShipped | integer | |
|
hasErrors
|
lines.hasErrors | boolean | |
|
shipmentIds
|
lines.shipmentIds | array of string |
shipmentIds |
|
allocatedQuantity
|
lines.allocatedQuantity | integer | |
|
shippedQuantity
|
lines.shippedQuantity | integer |
Retrieve outbound order lines
Retrieve outbound order lines.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Page Size
|
pageSize | True | string |
The page size used to retrieve outbound order lines. |
|
Continuation Token
|
continuationToken | True | string |
The continuation token used to retrieve next page outbound order lines. |
|
Created At From
|
createdAtFrom | True | string |
The created at from used to retrieve outbound order lines. |
|
Created At To
|
createdAtTo | True | string |
The created at to used to retrieve outbound order lines. |
|
External IDs
|
externalIds | True | string |
The external Ids used to retrieve outbound order lines. |
|
Skus
|
skus | True | string |
The skus used to retrieve outbound order lines. |
|
Labels
|
labels | True | string |
The labels used to retrieve outbound orders lines. |
|
Order IDs
|
orderIds | True | string |
The order Ids used to retrieve outbound orders lines. |
|
Line IDs
|
lineIds | True | string |
The line Ids used to retrieve outbound orders lines. |
|
Has Errors
|
hasErrors | True | string |
The has errors used to retrieve outbound orders lines. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
total
|
total | integer | |
|
continuationToken
|
continuationToken | string | |
|
lines
|
lines | array of object |
lines |
|
id
|
lines.id | string | |
|
key
|
lines.labels.key | string | |
|
externalId
|
lines.externalId | string | |
|
sku
|
lines.sku | string | |
|
quantity
|
lines.quantity | integer | |
|
unitOfMeasure
|
lines.unitOfMeasure | string | |
|
orderId
|
lines.orderId | string | |
|
createdAt
|
lines.createdAt | string | |
|
updatedAt
|
lines.updatedAt | string | |
|
cancelledAt
|
lines.cancelledAt | string | |
|
completelyShippedAt
|
lines.completelyShippedAt | string | |
|
percentAllocated
|
lines.percentAllocated | integer | |
|
percentShipped
|
lines.percentShipped | integer | |
|
hasErrors
|
lines.hasErrors | boolean | |
|
shipmentIds
|
lines.shipmentIds | array of string |
shipmentIds |
|
allocatedQuantity
|
lines.allocatedQuantity | integer | |
|
shippedQuantity
|
lines.shippedQuantity | integer |
Retrieve outbound orders
Retrieve outbound orders.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Continuation Token
|
continuationToken | True | string |
The continuation token used to retrieve next page outbound orders. |
|
IDs
|
ids | True | string |
The Ids used to retrieve outbound orders. |
|
External IDs
|
externalIds | True | string |
The external Ids used to retrieve outbound orders. |
|
Page Size
|
pageSize | True | string |
The page size used to retrieve outbound orders. |
|
Created At From
|
createdAtFrom | True | string |
The created at from used to retrieve outbound orders. |
|
Created At To
|
createdAtTo | True | string |
The created at to used to retrieve outbound orders. |
|
Labels
|
labels | True | string |
The labels used to retrieve outbound orders. |
|
Has Errors
|
hasErrors | True | string |
The has errors used to retrieve outbound orders. |
|
State
|
state | True | string |
The state used to retrieve outbound orders. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
total
|
total | integer | |
|
continuationToken
|
continuationToken | string | |
|
outboundOrders
|
outboundOrders | array of object |
outboundOrders |
|
id
|
outboundOrders.id | string | |
|
createdAt
|
outboundOrders.createdAt | string | |
|
updatedAt
|
outboundOrders.updatedAt | string | |
|
state
|
outboundOrders.state | string | |
|
hasErrors
|
outboundOrders.hasErrors | boolean | |
|
externalId
|
outboundOrders.externalId | string | |
|
key
|
outboundOrders.labels.key | string | |
|
reservationId
|
outboundOrders.reservationId | string | |
|
name
|
outboundOrders.recipient.name | string | |
|
phone
|
outboundOrders.recipient.phone | string | |
|
email
|
outboundOrders.recipient.email | string | |
|
line1
|
outboundOrders.recipient.address.line1 | string | |
|
line2
|
outboundOrders.recipient.address.line2 | string | |
|
line3
|
outboundOrders.recipient.address.line3 | string | |
|
city
|
outboundOrders.recipient.address.city | string | |
|
region
|
outboundOrders.recipient.address.region | string | |
|
postcode
|
outboundOrders.recipient.address.postcode | string | |
|
country
|
outboundOrders.recipient.address.country | string | |
|
instructions
|
outboundOrders.shipping.instructions | string | |
|
serviceType
|
outboundOrders.shipping.serviceType | string | |
|
carrierBillingAccountId
|
outboundOrders.shipping.carrierBillingAccountId | string | |
|
signatureConfirmation
|
outboundOrders.shipping.signatureConfirmation | string | |
|
labelReference1
|
outboundOrders.shipping.labelReference1 | string | |
|
labelReference2
|
outboundOrders.shipping.labelReference2 | string |
Update an order
Update an order.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Order ID
|
orderId | True | string |
The order Id used to update an order. |
|
labels
|
labels | string | ||
|
city
|
city | True | string | |
|
country
|
country | True | string | |
|
line1
|
line1 | True | string | |
|
postcode
|
postcode | True | string | |
|
region
|
region | True | string | |
|
line2
|
line2 | string | ||
|
line3
|
line3 | string | ||
|
name
|
name | True | string | |
|
phone
|
phone | string | ||
|
email
|
string | |||
|
instructions
|
instructions | string | ||
|
serviceType
|
serviceType | string | ||
|
carrierBillingAccountId
|
carrierBillingAccountId | string | ||
|
signatureConfirmation
|
signatureConfirmation | string | ||
|
labelReference1
|
labelReference1 | string | ||
|
labelReference2
|
labelReference2 | string | ||
|
reservationId
|
reservationId | string |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
property1
|
labels.property1 | string | |
|
property2
|
labels.property2 | string | |
|
externalId
|
externalId | string | |
|
reservationId
|
reservationId | string | |
|
country
|
recipient.address.country | string | |
|
city
|
recipient.address.city | string | |
|
postcode
|
recipient.address.postcode | string | |
|
line3
|
recipient.address.line3 | string | |
|
region
|
recipient.address.region | string | |
|
line2
|
recipient.address.line2 | string | |
|
line1
|
recipient.address.line1 | string | |
|
phone
|
recipient.phone | string | |
|
name
|
recipient.name | string | |
|
email
|
recipient.email | string | |
|
serviceType
|
shipping.serviceType | string | |
|
instructions
|
shipping.instructions | string | |
|
labelReference1
|
shipping.labelReference1 | string | |
|
labelReference2
|
shipping.labelReference2 | string | |
|
carrierBillingAccountId
|
shipping.carrierBillingAccountId | string | |
|
signatureConfirmation
|
shipping.signatureConfirmation | string | |
|
id
|
id | string | |
|
createdAt
|
createdAt | string | |
|
updatedAt
|
updatedAt | string | |
|
state
|
state | string | |
|
hasErrors
|
hasErrors | boolean | |
|
shipmentIds
|
shipmentIds | array of string |
shipmentIds |
Update existing retail fulfillment order
Update existing retail fulfillment order.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Shipment ID
|
shipmentId | True | string |
The shipment Id used to retrieve retail fulfillment order. |
|
state
|
state | string | ||
|
scac
|
scac | string | ||
|
bolNumber
|
bolNumber | string | ||
|
meta
|
meta | string |
Returns
Write a file to the specified key
Write a file to the specified key.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Key
|
key | True | string |
A unique key used to identify a file and prevent duplicates. |
|
Name
|
name | string |
The name of the file. The name does not have to be unique and can be used to track a filename. |
|
|
body
|
body | True | binary |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
createdAt
|
createdAt | string | |
|
deletedAt
|
deletedAt | string | |
|
size
|
size | integer | |
|
name
|
name | string | |
|
contentType
|
contentType | string | |
|
key
|
key | string | |
|
key
|
labels.key | string | |
|
updatedAt
|
updatedAt | string |
Triggers
| Listen to webhook |
Establish a webhook that receive transactions from Flexe. |
Listen to webhook
Establish a webhook that receive transactions from Flexe.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
name
|
name | True | string |