sid required | string |
authorization | string |
name | string or null |
{- "name": "string"
}
{- "sid": "string",
- "name": "string",
- "created": "string",
- "updated": "string"
}
organizationSid | string or null |
pageToken | string or null |
pageSize | integer or null |
authorization | string |
{- "users": [
- {
- "sid": "string",
- "created": "string",
- "updated": "string",
- "email": "string",
- "organizationSid": "string",
- "firstName": "string",
- "lastName": "string",
- "phoneNumber": "string",
- "employee": true,
- "password": true
}
], - "page": {
- "previousPageToken": "string",
- "nextPageToken": "string"
}
}
sidOrEmail required | string |
authorization | string |
{- "sid": "string",
- "created": "string",
- "updated": "string",
- "email": "string",
- "organizationSid": "string",
- "firstName": "string",
- "lastName": "string",
- "phoneNumber": "string",
- "employee": true,
- "password": true
}
sidOrEmail required | string |
authorization | string |
firstName | string or null first name of the user |
lastName | string or null last name of the user |
phoneNumber | string or null optional phone number for the user |
newPassword | string or null the new password to be used for the account |
currentPassword | string or null the user's current password, must be provided if user is changing their password and has a current password |
{- "firstName": "string",
- "lastName": "string",
- "phoneNumber": "string",
- "newPassword": "string",
- "currentPassword": "string"
}
{- "sid": "string",
- "created": "string",
- "updated": "string",
- "email": "string",
- "organizationSid": "string",
- "firstName": "string",
- "lastName": "string",
- "phoneNumber": "string",
- "employee": true,
- "password": true
}
organizationSid | string or null |
pageToken | string or null |
pageSize | integer or null |
authorization | string |
{- "orders": [
- {
- "sid": "string",
- "created": "string",
- "updated": "string",
- "vendorSid": "string",
- "vendorName": "string",
- "organizationSid": "string",
- "uniqueName": "string",
- "title": "string"
}
], - "page": {
- "previousPageToken": "string",
- "nextPageToken": "string"
}
}
authorization | string |
sid | string or null |
vendorSid | string or null selling factor organization sid. at least one of vendorSid or vendorName is required |
vendorName | string or null the name of the company the order is placed with. at least one of vendorSid or vendorName is required |
uniqueName | string or null an optional uniqueName that is unique per organization. this can act as the order's external unique id, or more friendly uniqueName than the sid |
title | string or null an optional title that can be used if uniqueName is not unique across your organization (e.g. if you want to have orders with the same title across multiple vendors) |
{- "sid": "string",
- "vendorSid": "string",
- "vendorName": "string",
- "uniqueName": "string",
- "title": "string"
}
{- "sid": "string",
- "created": "string",
- "updated": "string",
- "vendorSid": "string",
- "vendorName": "string",
- "organizationSid": "string",
- "uniqueName": "string",
- "title": "string"
}
sidOrUniqueName required | string the order sid or order unique name |
authorization | string |
{- "sid": "string",
- "created": "string",
- "updated": "string",
- "vendorSid": "string",
- "vendorName": "string",
- "organizationSid": "string",
- "uniqueName": "string",
- "title": "string"
}
sidOrUniqueName required | string the order sid or order unique name |
authorization | string |
uniqueName | string or null |
title | string or null an optional title that can be used if uniqueName is not unique across your organization (e.g. if you want to have orders with the same title across multiple vendors) |
{- "uniqueName": "string",
- "title": "string"
}
{- "sid": "string",
- "created": "string",
- "updated": "string",
- "vendorSid": "string",
- "vendorName": "string",
- "organizationSid": "string",
- "uniqueName": "string",
- "title": "string"
}
sidOrUniqueName required | string the order sid or order unique name |
eventTimeOnOrAfter | string or null |
pageToken | string or null |
pageSize | integer or null |
authorization | string |
{- "orderEvents": [
- {
- "id": "string",
- "eventTime": "string",
- "orderSid": "string",
- "eventType": "string",
- "event": { }
}
], - "page": {
- "previousPageToken": "string",
- "nextPageToken": "string"
}
}
messageThreadSid | string or null required for all users of the application, an employee app would not need to supply this |
pageToken | string or null |
pageSize | integer or null |
authorization | string |
[- {
- "orderMembers": [
- {
- "sid": "string",
- "orderSid": "string",
- "memberSid": "string"
}
], - "page": {
- "previousPageToken": "string",
- "nextPageToken": "string"
}
}
]
authorization | string |
sid | string |
orderSid | string |
memberSid | string a UserSid |
{- "sid": "string",
- "orderSid": "string",
- "memberSid": "string"
}
{- "sid": "string",
- "orderSid": "string",
- "memberSid": "string"
}
orderSid | string or null |
string or null | |
pageToken | string or null |
pageSize | integer or null |
authorization | string |
{- "orderInvites": [
- {
- "sid": "string",
- "created": "string",
- "updated": "string",
- "orderSid": "string",
- "email": "string",
- "inviterSid": "string",
- "expiration": "string",
- "firstName": "string",
- "lastName": "string",
- "organizationName": "string",
- "phoneNumber": "string",
- "messageTemplate": "string",
- "note": "string",
- "emailSent": "string"
}
], - "page": {
- "previousPageToken": "string",
- "nextPageToken": "string"
}
}
buyerSid | string or null only show items from orders that have this buyer sid |
vendorSid | string or null only show items from orders that have this vendor sid |
orderSid | string or null |
pageToken | string or null |
pageSize | integer or null |
authorization | string |
{- "items": [
- {
- "sid": "string",
- "created": "string",
- "updated": "string",
- "orderSid": "string",
- "uniqueName": "string",
- "title": "string",
- "status": "active",
- "quantity": "string",
- "pricePerUnit": "string",
- "nonRecurringCost": "string",
- "leadTime": 0,
- "shipTime": 0,
- "organizationSid": "string"
}
], - "page": {
- "previousPageToken": "string",
- "nextPageToken": "string"
}
}
authorization | string |
uniqueName | string or null an identifier that is unique within an order |
title | string or null an optional non-unique description if the unique is not descriptive enough |
orderSid | string or null the factor sid for the order. at least one of orderSid and orderUniqueName must be present. if both are provided they must refer to the same object |
orderUniqueName | string or null the unique name for the order. at least one of orderSid and orderUniqueName must be present. if both are provided they must refer to the same object |
sid | string or null optional item sid as idempotency token |
status | string or null optional item status which indicates if active or canceled |
quantity | string |
pricePerUnit | string or null |
nonRecurringCost | string or null |
leadTime | integer or null |
shipTime | integer or null |
{- "uniqueName": "string",
- "title": "string",
- "orderSid": "string",
- "orderUniqueName": "string",
- "sid": "string",
- "status": "string",
- "quantity": "string",
- "pricePerUnit": "string",
- "nonRecurringCost": "string",
- "leadTime": 0,
- "shipTime": 0
}
{- "sid": "string",
- "created": "string",
- "updated": "string",
- "orderSid": "string",
- "uniqueName": "string",
- "title": "string",
- "status": "active",
- "quantity": "string",
- "pricePerUnit": "string",
- "nonRecurringCost": "string",
- "leadTime": 0,
- "shipTime": 0,
- "organizationSid": "string"
}
sidOrUniqueName required | string |
orderSid | string or null order the item is from if supplying item unique name in the path. this is not needed if using item sid in the path |
orderUniqueName | string or null order the item is from if supplying item unique name in the path. this is not needed if using item sid in the path |
authorization | string |
{- "sid": "string",
- "created": "string",
- "updated": "string",
- "orderSid": "string",
- "uniqueName": "string",
- "title": "string",
- "status": "active",
- "quantity": "string",
- "pricePerUnit": "string",
- "nonRecurringCost": "string",
- "leadTime": 0,
- "shipTime": 0,
- "organizationSid": "string"
}
sidOrUniqueName required | string |
orderSid | string or null order the item is from if supplying item unique name in the path. this is not needed if using item sid in the path |
orderUniqueName | string or null order the item is from if supplying item unique name in the path. this is not needed if using item sid in the path |
authorization | string |
uniqueName | string or null the new unique name. supply null to remove the unique name |
title | string or null an optional non-unique description if the unique name is not descriptive enough. supply null to remove the title |
status | integer or null |
quantity | string or null |
pricePerUnit | string or null |
nonRecurringCost | string or null |
leadTime | integer or null |
shipTime | integer or null |
{- "uniqueName": "string",
- "title": "string",
- "status": 0,
- "quantity": "string",
- "pricePerUnit": "string",
- "nonRecurringCost": "string",
- "leadTime": 0,
- "shipTime": 0
}
{- "sid": "string",
- "created": "string",
- "updated": "string",
- "orderSid": "string",
- "uniqueName": "string",
- "title": "string",
- "status": "active",
- "quantity": "string",
- "pricePerUnit": "string",
- "nonRecurringCost": "string",
- "leadTime": 0,
- "shipTime": 0,
- "organizationSid": "string"
}
sidOrUniqueName required | string |
orderSid | string or null order the item is from if supplying item unique name in the path. this is not needed if using item sid in the path |
orderUniqueName | string or null order the item is from if supplying item unique name in the path. this is not needed if using item sid in the path |
authorization | string |
{- "code": "string",
- "message": "string"
}
sidOrUniqueName required | string |
eventTimeOnOrAfter | string or null |
pageToken | string or null |
pageSize | integer or null |
orderSid | string or null order the item is from if supplying item unique name in the path. this is not needed if using item sid in the path |
orderUniqueName | string or null order the item is from if supplying item unique name in the path. this is not needed if using item sid in the path |
authorization | string |
{- "itemEvents": [
- {
- "id": "string",
- "eventTime": "string",
- "itemSid": "string",
- "eventType": "string",
- "event": { }
}
], - "page": {
- "previousPageToken": "string",
- "nextPageToken": "string"
}
}
itemSid | string or null |
statusNot | string or null If provided, return item groups whose status are not equal to this value |
title | string or null the item name that corresponds to the item group |
pageToken | string or null |
pageSize | integer or null |
authorization | string |
{- "itemGroups": [
- {
- "sid": "string",
- "created": "string",
- "updated": "string",
- "itemSid": "string",
- "quantity": "string",
- "dueDate": "string",
- "shipDate": "string",
- "deliveryDate": "string",
- "shipped": true,
- "delivered": true,
- "trackingNumber": "string",
- "version": 0,
- "lastUpdateDate": "string",
- "estimatedArrivalDate": "string",
- "uniqueName": "string",
- "orderSid": "string",
- "organizationSid": "string",
- "status": "active"
}
], - "page": {
- "previousPageToken": "string",
- "nextPageToken": "string"
}
}
authorization | string |
sid | string or null optional order item sid as idempotency token |
itemSid | string or null the factor sid for the item this item group belongs to. when creating item groups a unique reference to an item must be supplied. unique item references include itemSid, orderSid + itemUniqueName, or orderUniqueName + itemUniqueName. if multiple item references are provided they all must be consistent |
itemUniqueName | string or null the unique name of the item this item group belongs to. when creating item groups a unique reference to an item must be supplied. unique item references include itemSid, orderSid + itemUniqueName, or orderUniqueName + itemUniqueName. if multiple item references are provided they all must be consistent |
orderSid | string or null the factor sid for the order. when creating item groups a unique reference to an item must be supplied. unique item references include itemSid, orderSid + itemUniqueName, or orderUniqueName + itemUniqueName. if multiple item references are provided they all must be consistent |
orderUniqueName | string or null the unique name for the order. when creating item groups a unique reference to an item must be supplied. unique item references include itemSid, orderSid + itemUniqueName, or orderUniqueName + itemUniqueName. if multiple item references are provided they all must be consistent |
quantity | string how many quantity from the line item are in this group |
dueDate | string or null the most recent agreed upon date of delivery between buyer and seller |
shipDate | string or null estimated or actual ship date |
deliveryDate | string or null estimated or actual delivery date |
shipped | boolean has this shipped? |
delivered | boolean has this been delivered? |
trackingNumber | string or null |
lastUpdateDate | string or null last time item group was updated or confirmed |
uniqueName | string or null optional identifier that is unique within the item |
status | string or null optional identifier denoting item group status of either active or canceled |
organizationSid | string or null only used with Internal Robots to search for orders by order unique name. will throw an exception if it finds any other auth using this |
{- "sid": "string",
- "itemSid": "string",
- "itemUniqueName": "string",
- "orderSid": "string",
- "orderUniqueName": "string",
- "quantity": "string",
- "dueDate": "string",
- "shipDate": "string",
- "deliveryDate": "string",
- "shipped": true,
- "delivered": true,
- "trackingNumber": "string",
- "lastUpdateDate": "string",
- "uniqueName": "string",
- "status": "string",
- "organizationSid": "string"
}
{- "sid": "string",
- "created": "string",
- "updated": "string",
- "itemSid": "string",
- "quantity": "string",
- "dueDate": "string",
- "shipDate": "string",
- "deliveryDate": "string",
- "shipped": true,
- "delivered": true,
- "trackingNumber": "string",
- "version": 0,
- "lastUpdateDate": "string",
- "estimatedArrivalDate": "string",
- "uniqueName": "string",
- "orderSid": "string",
- "organizationSid": "string",
- "status": "active"
}
sidOrUniqueName required | string |
orderSid | string or null order the item is from if supplying item unique name in the path. this is not needed if using item sid in the path |
orderUniqueName | string or null order the item is from if supplying item unique name in the path. this is not needed if using item sid in the path |
itemSid | string or null item the item group is from if supplying item group unique name in the path. this is not needed if using item group sid in the path |
itemUniqueName | string or null item the item group is from if supplying item group unique name in the path. this is not needed if using item group sid in the path |
authorization | string |
{- "sid": "string",
- "created": "string",
- "updated": "string",
- "itemSid": "string",
- "quantity": "string",
- "dueDate": "string",
- "shipDate": "string",
- "deliveryDate": "string",
- "shipped": true,
- "delivered": true,
- "trackingNumber": "string",
- "version": 0,
- "lastUpdateDate": "string",
- "estimatedArrivalDate": "string",
- "uniqueName": "string",
- "orderSid": "string",
- "organizationSid": "string",
- "status": "active"
}
sidOrUniqueName required | string |
orderSid | string or null order the item is from if supplying item unique name in the path. this is not needed if using item sid in the path |
orderUniqueName | string or null order the item is from if supplying item unique name in the path. this is not needed if using item sid in the path |
itemSid | string or null item the item group is from if supplying item group unique name in the path. this is not needed if using item group sid in the path |
itemUniqueName | string or null item the item group is from if supplying item group unique name in the path. this is not needed if using item group sid in the path |
authorization | string |
quantity | string or null optional: new quantity value |
trackingNumber | string or null optional: new tracking number value. can be provided as null to remove tracking number |
dueDate | string or null optional: most recent agreed upon date of delivery between buyer and seller. can be provided as null to remove due date |
shipDate | string or null optional: estimated or actual ship date. can be provided as null to remove ship date |
shipped | boolean or null optional: controls whether the item has been shipped or not; should override ship date |
deliveryDate | string or null optional: estimated or actual delivery date. can be provided as null to remove delivery date |
delivered | boolean or null optional: controls whether the item has been delivered or not; takes precedence over delivery date if delivery date is null |
lastUpdateDate | string or null optional: last time item group was updated or confirmed. can be provided as null to remove last update date |
uniqueName | string or null optional: new unique name. can be provided as null to remove unique name |
confirmed | boolean or null Default: false allows callers to confirm dates are accurate without providing new dates |
{- "quantity": "string",
- "trackingNumber": "string",
- "dueDate": "string",
- "shipDate": "string",
- "shipped": true,
- "deliveryDate": "string",
- "delivered": true,
- "lastUpdateDate": "string",
- "uniqueName": "string",
- "confirmed": false
}
{- "sid": "string",
- "created": "string",
- "updated": "string",
- "itemSid": "string",
- "quantity": "string",
- "dueDate": "string",
- "shipDate": "string",
- "deliveryDate": "string",
- "shipped": true,
- "delivered": true,
- "trackingNumber": "string",
- "version": 0,
- "lastUpdateDate": "string",
- "estimatedArrivalDate": "string",
- "uniqueName": "string",
- "orderSid": "string",
- "organizationSid": "string",
- "status": "active"
}
sidOrUniqueName required | string |
orderSid | string or null order the item is from if supplying item unique name in the path. this is not needed if using item sid in the path |
orderUniqueName | string or null order the item is from if supplying item unique name in the path. this is not needed if using item sid in the path |
itemSid | string or null item the item group is from if supplying item group unique name in the path. this is not needed if using item group sid in the path |
itemUniqueName | string or null item the item group is from if supplying item group unique name in the path. this is not needed if using item group sid in the path |
authorization | string |
{- "code": "string",
- "message": "string"
}
authorization | string |
sid | string item group sid |
quantity | string or null optional: new quantity value |
trackingNumber | string or null optional: new tracking number value. can be provided as null to remove tracking number |
dueDate | string or null the most recent agreed upon date of delivery between buyer and seller |
shipDate | string or null optional: estimated or actual ship date. can be provided as null to remove ship date |
shipped | boolean or null optional: controls whether the item has been shipped or not; should override ship date |
deliveryDate | string or null optional: estimated or actual delivery date. can be provided as null to remove delivery date |
delivered | boolean or null optional: controls whether the item has been delivered or not; takes precedence over delivery date if delivery date is null |
lastUpdateDate | string or null optional: last time item group was updated or confirmed. can be provided as null to remove last update date |
uniqueName | string or null optional: new unique name. can be provided as null to remove unique name |
confirmed | boolean or null Default: false allows callers to confirm dates are accurate without providing new dates |
[- {
- "sid": "string",
- "quantity": "string",
- "trackingNumber": "string",
- "dueDate": "string",
- "shipDate": "string",
- "shipped": true,
- "deliveryDate": "string",
- "delivered": true,
- "lastUpdateDate": "string",
- "uniqueName": "string",
- "confirmed": false
}
]
[- {
- "sid": "string",
- "created": "string",
- "updated": "string",
- "itemSid": "string",
- "quantity": "string",
- "dueDate": "string",
- "shipDate": "string",
- "deliveryDate": "string",
- "shipped": true,
- "delivered": true,
- "trackingNumber": "string",
- "version": 0,
- "lastUpdateDate": "string",
- "estimatedArrivalDate": "string",
- "uniqueName": "string",
- "orderSid": "string",
- "organizationSid": "string",
- "status": "active"
}
]
sidOrUniqueName required | string |
eventTimeOnOrAfter | string or null |
pageToken | string or null |
pageSize | integer or null |
orderSid | string or null order the item is from if supplying item unique name in the path. this is not needed if using item sid in the path |
orderUniqueName | string or null order the item is from if supplying item unique name in the path. this is not needed if using item sid in the path |
itemSid | string or null item the item group is from if supplying item group unique name in the path. this is not needed if using item group sid in the path |
itemUniqueName | string or null item the item group is from if supplying item group unique name in the path. this is not needed if using item group sid in the path |
authorization | string |
{- "itemGroupEvents": [
- {
- "id": "string",
- "eventTime": "string",
- "itemGroupSid": "string",
- "eventType": "string",
- "event": { }
}
], - "page": {
- "previousPageToken": "string",
- "nextPageToken": "string"
}
}
pageToken | string or null |
pageSize | integer or null |
authorization | string |
{- "openOrderUploads": [
- {
- "sid": "string",
- "created": "string",
- "updated": "string",
- "organization": "string",
- "status": "processing",
- "fileSid": "string",
- "fieldMappingSid": "string",
- "orderMemberUserSids": [
- "string"
], - "orderMemberEmails": [
- "string"
], - "forceItemGroupsNotPresentDelivered": true,
- "rowCountSuccess": 0,
- "rowCountFailure": 0,
- "fileType": "string"
}
], - "page": {
- "previousPageToken": "string",
- "nextPageToken": "string"
}
}
authorization | string |
sid | string or null optionally include a sid as an idempotency token |
file | string <binary> file content |
fieldMappingSid | string or null optional field mapping sid to support custom csv columns |
orderMemberEmails | string or null list of emails that should be added as order members or order invites |
orderMemberSids | string or null list of user sids that should be added as order members |
forceItemGroupsNotPresentDelivered | boolean or null nullable value, default is false. if true, item groups not present in upload will be marked as delivered |
fileType | string or null file type of order upload. may be csv, xlsx, or xls. csv by default |
{- "sid": "string",
- "created": "string",
- "updated": "string",
- "organization": "string",
- "status": "processing",
- "fileSid": "string",
- "fieldMappingSid": "string",
- "orderMemberUserSids": [
- "string"
], - "orderMemberEmails": [
- "string"
], - "forceItemGroupsNotPresentDelivered": true,
- "rowCountSuccess": 0,
- "rowCountFailure": 0,
- "fileType": "string"
}
sid required | string open order upload sid |
authorization | string |
{- "sid": "string",
- "created": "string",
- "updated": "string",
- "organization": "string",
- "status": "processing",
- "fileSid": "string",
- "fieldMappingSid": "string",
- "orderMemberUserSids": [
- "string"
], - "orderMemberEmails": [
- "string"
], - "forceItemGroupsNotPresentDelivered": true,
- "rowCountSuccess": 0,
- "rowCountFailure": 0,
- "fileType": "string"
}
openOrderUploadSid required | string open order upload sid, optional for internal. required for public api identities |
pageToken | string or null |
pageSize | integer or null |
authorization | string |
{- "openOrderUploadLogs": [
- {
- "sid": "string",
- "created": "string",
- "updated": "string",
- "openOrderUploadSid": "string",
- "level": "debug",
- "message": "string",
- "openOrderUploadAttemptSid": "string"
}
], - "page": {
- "previousPageToken": "string",
- "nextPageToken": "string"
}
}
itemGroupSid | Array of strings |
status | string or null |
flag | string or null |
pageToken | string or null |
pageSize | integer or null |
authorization | string |
{- "flags": [
- {
- "sid": "string",
- "created": "string",
- "updated": "string",
- "dismissed": "string",
- "status": "active",
- "itemGroupSid": "string",
- "itemSid": "string",
- "orderSid": "string",
- "message": "string",
- "type": "newDelay"
}
], - "page": {
- "previousPageToken": "string",
- "nextPageToken": "string"
}
}
sid required | string |
authorization | string |
{- "sid": "string",
- "created": "string",
- "updated": "string",
- "dismissed": "string",
- "status": "active",
- "itemGroupSid": "string",
- "itemSid": "string",
- "orderSid": "string",
- "message": "string",
- "type": "newDelay"
}
sid required | string |
authorization | string |
message | string or null |
status | string or null |
dismissed | string or null dismissed date time in RFC3339 format |
{- "message": "string",
- "status": "string",
- "dismissed": "string"
}
{- "sid": "string",
- "created": "string",
- "updated": "string",
- "dismissed": "string",
- "status": "active",
- "itemGroupSid": "string",
- "itemSid": "string",
- "orderSid": "string",
- "message": "string",
- "type": "newDelay"
}
itemGroupSid | string or null get the update requests for this itemGroupSid |
organizationSid | string or null only used with Robots. will throw an exception if it finds any other auth using this. |
sortOrder | string or null maps to Factor enum type Sort |
pageToken | string or null |
pageSize | integer or null |
authorization | string |
{- "updateRequests": [
- {
- "sid": "string",
- "created": "string",
- "updated": "string",
- "itemGroupSid": "string",
- "organizationSid": "string",
- "note": "string"
}
], - "page": {
- "previousPageToken": "string",
- "nextPageToken": "string"
}
}
authorization | string |
itemGroupSid | string the item this update request maps to |
note | string or null the note corresponding to this update request |
{- "itemGroupSid": "string",
- "note": "string"
}
{- "sid": "string",
- "created": "string",
- "updated": "string",
- "itemGroupSid": "string",
- "organizationSid": "string",
- "note": "string"
}
nextUpdateOnOrBefore | string or null |
pageToken | string or null |
pageSize | integer or null |
authorization | string |
{- "updateRequestConfigs": [
- {
- "sid": "string",
- "created": "string",
- "updated": "string",
- "itemGroupSid": "string",
- "organizationSid": "string",
- "startDate": "string",
- "nextUpdate": "string",
- "cadenceSid": "string"
}
], - "page": {
- "previousPageToken": "string",
- "nextPageToken": "string"
}
}
authorization | string |
itemGroupSid | string the item this update request configuration maps to |
nextUpdate | string the date for the next time we perform an update request |
startDate | string or null the date for when the automatic update request cycle begins |
cadenceSid | string or null the cadence sid corresponding to this update request |
{- "itemGroupSid": "string",
- "nextUpdate": "string",
- "startDate": "string",
- "cadenceSid": "string"
}
{- "sid": "string",
- "created": "string",
- "updated": "string",
- "itemGroupSid": "string",
- "organizationSid": "string",
- "startDate": "string",
- "nextUpdate": "string",
- "cadenceSid": "string"
}
sid required | string can either be a UpdateRequestConfigSid or an ItemGroupSid |
authorization | string |
{- "sid": "string",
- "created": "string",
- "updated": "string",
- "itemGroupSid": "string",
- "organizationSid": "string",
- "startDate": "string",
- "nextUpdate": "string",
- "cadenceSid": "string"
}
sid required | string |
authorization | string |
nextUpdate | string or null the date for the next time we perform an update request |
startDate | string or null the date for when the automatic update request cycle begins |
cadenceSid | string or null the cadence sid corresponding to this update request |
{- "nextUpdate": "string",
- "startDate": "string",
- "cadenceSid": "string"
}
{- "sid": "string",
- "created": "string",
- "updated": "string",
- "itemGroupSid": "string",
- "organizationSid": "string",
- "startDate": "string",
- "nextUpdate": "string",
- "cadenceSid": "string"
}
itemSid required | string |
pageToken | string or null |
pageSize | integer or null |
authorization | string |
{- "itemCustomFields": [
- {
- "sid": "string",
- "created": "string",
- "updated": "string",
- "itemSid": "string",
- "name": "string",
- "value": "string"
}
], - "page": {
- "previousPageToken": "string",
- "nextPageToken": "string"
}
}
authorization | string |
sid | string or null optional sid as idempotency token |
itemSid | string |
name | string name must be unique for an item |
value | string |
{- "sid": "string",
- "itemSid": "string",
- "name": "string",
- "value": "string"
}
{- "sid": "string",
- "created": "string",
- "updated": "string",
- "itemSid": "string",
- "name": "string",
- "value": "string"
}
authorization | string |
sid | string or null optional user sid as idempotency token |
content | string |
orderSids | Array of strings or null |
itemSids | Array of strings or null |
itemGroupSids | Array of strings or null |
{- "sid": "string",
- "content": "string",
- "orderSids": [
- "string"
], - "itemSids": [
- "string"
], - "itemGroupSids": [
- "string"
]
}
{- "sid": "string",
- "organizationSid": "string",
- "outboundEmailReplySid": "string",
- "created": "string",
- "updated": "string",
- "author": "string",
- "content": "string"
}
sid required | string |
authorization | string |
{- "sid": "string",
- "organizationSid": "string",
- "outboundEmailReplySid": "string",
- "created": "string",
- "updated": "string",
- "author": "string",
- "content": "string"
}
sidOrUniqueName required | string |
pageToken | string or null |
pageSize | integer or null |
authorization | string |
{- "messages": [
- {
- "sid": "string",
- "organizationSid": "string",
- "outboundEmailReplySid": "string",
- "created": "string",
- "updated": "string",
- "author": "string",
- "content": "string"
}
], - "page": {
- "previousPageToken": "string",
- "nextPageToken": "string"
}
}
sidOrUniqueName required | string |
pageToken | string or null |
pageSize | integer or null |
orderSid | string or null order the item is from if supplying item unique name in the path. this is not needed if using item sid in the path |
orderUniqueName | string or null order the item is from if supplying item unique name in the path. this is not needed if using item sid in the path |
authorization | string |
{- "messages": [
- {
- "sid": "string",
- "organizationSid": "string",
- "outboundEmailReplySid": "string",
- "created": "string",
- "updated": "string",
- "author": "string",
- "content": "string"
}
], - "page": {
- "previousPageToken": "string",
- "nextPageToken": "string"
}
}
sidOrUniqueName required | string |
pageToken | string or null |
pageSize | integer or null |
orderSid | string or null order the item is from if supplying item unique name in the path. this is not needed if using item sid in the path |
orderUniqueName | string or null order the item is from if supplying item unique name in the path. this is not needed if using item sid in the path |
itemSid | string or null item the item group is from if supplying item group unique name in the path. this is not needed if using item group sid in the path |
itemUniqueName | string or null item the item group is from if supplying item group unique name in the path. this is not needed if using item group sid in the path |
authorization | string |
{- "messages": [
- {
- "sid": "string",
- "organizationSid": "string",
- "outboundEmailReplySid": "string",
- "created": "string",
- "updated": "string",
- "author": "string",
- "content": "string"
}
], - "page": {
- "previousPageToken": "string",
- "nextPageToken": "string"
}
}
eventTimeOnOrAfter | string or null |
pageToken | string or null |
pageSize | integer or null |
authorization | string |
{- "events": [
- {
- "sid": "string",
- "eventTime": "string",
- "organizationSid": "string",
- "eventType": "string",
- "event": { }
}
], - "page": {
- "previousPageToken": "string",
- "nextPageToken": "string"
}
}
pageToken | string or null |
pageSize | integer or null |
authorization | string |
{- "fileExports": [
- {
- "sid": "string",
- "created": "string",
- "updated": "string",
- "deleteAfter": "string",
- "status": "string",
- "fileType": "string",
- "fieldMappingSid": "string",
- "query": {
- "orders": [
- {
- "name": "string",
- "values": [
- "string"
]
}
], - "items": [
- {
- "name": "string",
- "values": [
- "string"
]
}
], - "itemGroups": [
- {
- "name": "string",
- "values": [
- "string"
]
}
]
}
}
], - "page": {
- "previousPageToken": "string",
- "nextPageToken": "string"
}
}
authorization | string |
sid | string or null optional sid to use as an idempotency token |
object (FileExportQuery) selections for the data | |
fieldMappingSid | string or null optional field mapping sid to support custom csv columns |
{- "sid": "string",
- "query": {
- "orders": [
- {
- "name": "string",
- "values": [
- "string"
]
}
], - "items": [
- {
- "name": "string",
- "values": [
- "string"
]
}
], - "itemGroups": [
- {
- "name": "string",
- "values": [
- "string"
]
}
]
}, - "fieldMappingSid": "string"
}
{- "sid": "string",
- "created": "string",
- "updated": "string",
- "deleteAfter": "string",
- "status": "string",
- "fileType": "string",
- "fieldMappingSid": "string",
- "query": {
- "orders": [
- {
- "name": "string",
- "values": [
- "string"
]
}
], - "items": [
- {
- "name": "string",
- "values": [
- "string"
]
}
], - "itemGroups": [
- {
- "name": "string",
- "values": [
- "string"
]
}
]
}
}
sid required | string file export sid |
authorization required | string |
{- "sid": "string",
- "created": "string",
- "updated": "string",
- "deleteAfter": "string",
- "status": "string",
- "fileType": "string",
- "fieldMappingSid": "string",
- "query": {
- "orders": [
- {
- "name": "string",
- "values": [
- "string"
]
}
], - "items": [
- {
- "name": "string",
- "values": [
- "string"
]
}
], - "itemGroups": [
- {
- "name": "string",
- "values": [
- "string"
]
}
]
}
}
pageToken | string or null |
pageSize | integer or null |
authorization | string |
{- "fieldMappings": [
- {
- "sid": "string",
- "created": "string",
- "updated": "string",
- "organizationSid": "string",
- "name": "string",
- "importAllowed": true,
- "exportAllowed": true
}
], - "page": {
- "previousPageToken": "string",
- "nextPageToken": "string"
}
}
authorization | string |
sid | string or null optional sid as idempotency token |
name | string or null optional name of the mapping group |
importAllowed | boolean or null when true this field map can be used to import data into factor |
exportAllowed | boolean or null when true this field map can be used to export data from factor |
{- "sid": "string",
- "name": "string",
- "importAllowed": true,
- "exportAllowed": true
}
{- "sid": "string",
- "created": "string",
- "updated": "string",
- "organizationSid": "string",
- "name": "string",
- "importAllowed": true,
- "exportAllowed": true
}
sid required | string field mapping sid |
authorization | string |
{- "sid": "string",
- "created": "string",
- "updated": "string",
- "organizationSid": "string",
- "name": "string",
- "importAllowed": true,
- "exportAllowed": true
}
fieldMappingSid | string or null |
pageToken | string or null |
pageSize | integer or null |
authorization | string |
{- "mappedFields": [
- {
- "sid": "string",
- "created": "string",
- "updated": "string",
- "fieldMappingSid": "string",
- "name": "string",
- "mappedFieldType": "string"
}
], - "page": {
- "previousPageToken": "string",
- "nextPageToken": "string"
}
}
authorization | string |
sid | string or null optional sid as idempotency token |
fieldMappingSid | string |
name | string the column name as it exists in the customer's csv |
mappedFieldType | string the column's meaning when it is imported into factor |
{- "sid": "string",
- "fieldMappingSid": "string",
- "name": "string",
- "mappedFieldType": "string"
}
{- "sid": "string",
- "created": "string",
- "updated": "string",
- "fieldMappingSid": "string",
- "name": "string",
- "mappedFieldType": "string"
}
sid required | string mapped field sid |
authorization | string |
{- "sid": "string",
- "created": "string",
- "updated": "string",
- "fieldMappingSid": "string",
- "name": "string",
- "mappedFieldType": "string"
}
sid | Array of strings or null a repeatable query param to fetch one or many boms by sid. this is a fast way to do a bulk fetch. max allowed is 100 |
uniqueName | Array of strings or null a repeatable query param to fetch one or many boms by unique name. this is a fast way to do a bulk fetch. max allowed is 100 |
ctbLessThanEqualTo | string or null optional parameter that will return boms that have associated clear to builds with today's date with a build quantity less than or equal to the given integer |
pageToken | string or null |
pageSize | integer or null |
authorization required | string |
{- "boms": [
- {
- "sid": "string",
- "created": "string",
- "updated": "string",
- "uniqueName": "string",
- "version": "string"
}
], - "page": {
- "previousPageToken": "string",
- "nextPageToken": "string"
}
}
authorization required | string |
sid | string or null optional sid to use as an idempotency token |
uniqueName | string a unique name for this bom |
{- "sid": "string",
- "uniqueName": "string"
}
{- "sid": "string",
- "created": "string",
- "updated": "string",
- "uniqueName": "string",
- "version": "string"
}
sidOrUniqueName required | string bom sid or unique name |
authorization required | string |
{- "sid": "string",
- "created": "string",
- "updated": "string",
- "uniqueName": "string",
- "version": "string"
}
bomSid | string or null |
includeTotalCount | boolean or null |
orderBy | string or null order the list by any one of the following values: ctb, requiredQuantity, orderedQuantity, inventoryQuantity |
sortOrder | string or null order of the result set: 'Asc' or 'Desc'. default 'Asc' |
uniqueName | string or null the unique name of the bom line |
inventoryCountLessThanEqualTo | string or null inventory count equals or less than |
orderedQuantityLessThanEqualTo | string or null ordered quantity equals or less than |
pageToken | string or null |
pageSize | integer or null |
authorization required | string |
{- "bomLines": [
- {
- "sid": "string",
- "created": "string",
- "updated": "string",
- "bomSid": "string",
- "uniqueName": "string",
- "requiredQuantity": "string",
- "version": "string"
}
], - "page": {
- "previousPageToken": "string",
- "nextPageToken": "string"
}
}
authorization required | string |
sid | string bom line sid |
bomSid | string or null the factor sid for the bom. at least one of bomSid and bomUniqueName must be present. if both are provided they must refer to the same object |
uniqueName | string unique name of bom line |
requiredQuantity | string the required quantity of this bom line to make the bom |
{- "sid": "string",
- "bomSid": "string",
- "uniqueName": "string",
- "requiredQuantity": "string"
}
{- "sid": "string",
- "created": "string",
- "updated": "string",
- "bomSid": "string",
- "uniqueName": "string",
- "requiredQuantity": "string",
- "version": "string"
}
sidOrUniqueName required | string |
bomSid | string or null bom the bom line is from if supplying bom line unique name in the path. this is not needed if using bom line sid in the path |
bomUniqueName | string or null unique name of the bom the bom line is from if supplying bom line unique name in the path. this is not needed if using bom line sid in the path |
authorization required | string |
{- "sid": "string",
- "created": "string",
- "updated": "string",
- "bomSid": "string",
- "uniqueName": "string",
- "requiredQuantity": "string",
- "version": "string"
}
sidOrUniqueName required | string |
bomSid | string or null Bom the bom line is from if supplying bom unique name in the path. This is not needed if using bom sid in the path |
bomUniqueName | string or null unique name of the bom the bom line is from if supplying bom line unique name in the path. this is not needed if using bom line sid in the path |
authorization required | string |
requiredQuantity | string the required quantity of this bom line to make the bom |
{- "requiredQuantity": "string"
}
{- "sid": "string",
- "created": "string",
- "updated": "string",
- "bomSid": "string",
- "uniqueName": "string",
- "requiredQuantity": "string",
- "version": "string"
}
sidOrUniqueName required | string |
bomSid | string or null Bom the bom line is from if supplying bom unique name in the path. This is not needed if using bom sid in the path |
bomUniqueName | string or null unique name of the bom the bom line is from if supplying bom line unique name in the path. this is not needed if using bom line sid in the path |
authorization required | string |
{- "code": "string",
- "message": "string"
}
organizationSid | string or null grabs inventory counts for all parts within an org |
dateBefore | string or null grabs inventory counts for all parts with recording dates on or before this date |
dateAfter | string or null grabs inventory counts for all parts with recording dates after this date |
pageToken | string or null |
pageSize | integer or null |
authorization required | string |
{- "inventoryCounts": [
- {
- "sid": "string",
- "created": "string",
- "recordingDate": "string",
- "count": 0,
- "uniqueName": "string",
- "title": "string"
}
], - "page": {
- "previousPageToken": "string",
- "nextPageToken": "string"
}
}
authorization required | string |
sid | string or null optional inventory count sid as idempotency token |
recordingDate | string or null date of the recording of this part in RFC3339 format. if nullable, current time will be assumed |
count | integer the number of this particular part that's in inventory |
uniqueName | string a unique name for this part that's in inventory |
title | string or null a non-unique name referring to the inventory count |
{- "sid": "string",
- "recordingDate": "string",
- "count": 0,
- "uniqueName": "string",
- "title": "string"
}
{- "sid": "string",
- "created": "string",
- "recordingDate": "string",
- "count": 0,
- "uniqueName": "string",
- "title": "string"
}
sidOrName required | string inventory count sid or unique name |
authorization required | string |
{- "sid": "string",
- "created": "string",
- "recordingDate": "string",
- "count": 0,
- "uniqueName": "string",
- "title": "string"
}
organizationSid | string or null the organization that owns the clear to build |
startDate | string or null grabs clear to builds on or after this date |
endDate | string or null grabs clear to builds on or before this date |
sid | Array of strings or null a repeatable query param to fetch one or many clear to builds by bom or bom line sid. this is a fast way to do a bulk fetch. max allowed is 100 |
buildQuantityLessThanEqualTo | string or null optional parameter that will return clear to builds with a build quantity less than or equal to the given integer |
pageToken | string or null |
pageSize | integer or null |
authorization required | string |
{- "clearToBuilds": [
- {
- "sid": "string",
- "created": "string",
- "updated": "string",
- "organizationSid": "string",
- "referenceSid": "string",
- "buildDate": "string",
- "buildQuantity": "string",
- "type": "string"
}
], - "page": {
- "previousPageToken": "string",
- "nextPageToken": "string"
}
}
authorization required | string |
sid | string or null optional clear to build sid as idempotency token |
organizationSid | string organization that owns the clear to build |
referenceSid | string bom or bom line the clear to build reflects |
buildDate | string the date the boms or bom lines can be built in RFC3339 format |
buildQuantity | string the number of boms or bom lines that can be built |
type | string denotes the type of clear to build, expected or actual |
{- "sid": "string",
- "organizationSid": "string",
- "referenceSid": "string",
- "buildDate": "string",
- "buildQuantity": "string",
- "type": "string"
}
{- "sid": "string",
- "created": "string",
- "updated": "string",
- "organizationSid": "string",
- "referenceSid": "string",
- "buildDate": "string",
- "buildQuantity": "string",
- "type": "string"
}
sid required | string |
authorization required | string |
buildQuantity | string the number of boms or bom lines that can be built |
{- "buildQuantity": "string"
}
{- "sid": "string",
- "created": "string",
- "updated": "string",
- "organizationSid": "string",
- "referenceSid": "string",
- "buildDate": "string",
- "buildQuantity": "string",
- "type": "string"
}
organizationSid | string or null |
pageToken | string or null |
pageSize | integer or null |
authorization required | string |
{- "bomUploads": [
- {
- "sid": "string",
- "created": "string",
- "updated": "string",
- "version": "string",
- "organizationSid": "string",
- "fieldMappingSid": "string",
- "status": "string",
- "fileType": "string",
- "rowCountSuccess": 0,
- "rowCountFailure": 0,
- "rowCountTotal": 0
}
], - "page": {
- "previousPageToken": "string",
- "nextPageToken": "string"
}
}
sid required | string bom upload sid |
authorization required | string |
{- "sid": "string",
- "created": "string",
- "updated": "string",
- "version": "string",
- "organizationSid": "string",
- "fieldMappingSid": "string",
- "status": "string",
- "fileType": "string",
- "rowCountSuccess": 0,
- "rowCountFailure": 0,
- "rowCountTotal": 0
}
authorization required | string due to difficulties in uploading files in api gateway this route supports public api auth headers in addition to internal auth headers |
sid | string or null optionally include a sid as an idempotency token |
file | string <binary> file content |
organizationSid | string or null optional org sid, only used for internal applications / phoenix users. all other user types take the org from the auth header |
fieldMappingSid | string or null optional field mapping map sid to support custom csv columns |
fileType | string or null file type of order upload. may be csv, xlsx, or xls. csv by default |
{- "sid": "string",
- "created": "string",
- "updated": "string",
- "version": "string",
- "organizationSid": "string",
- "fieldMappingSid": "string",
- "status": "string",
- "fileType": "string",
- "rowCountSuccess": 0,
- "rowCountFailure": 0,
- "rowCountTotal": 0
}