Unfortunately, this feature is not supported on mobile devices. For the best experience, please use a computer.

project44 REST API (4.0.0)

Version 4.0.0 of project44's API

Download OpenAPI description
api.json
api.yaml
Overview
License © 2024 project44 - Terms of Use
Languages
Servers
Mock server
https://developers.project44.com/_mock/guides/shippers/other/order-visibility/api/
API endpoint for project44 tenants created in NA region
https://na12.api.project44.com/
API endpoint for project44 tenants created in EU region
https://eu12.api.project44.com/
API endpoint for project44 tenants created in the Sandbox environment
https://na12.api.sandbox.p-44.com/

Manage Client Applications

Operations

Generate Tokens

Operations

Orders Visibility

Operations

Create an item.

Request

InventoryItem should be passed without populating the id field. A unique id will be generated and returned in the response. This id will be used to identify the item across all other methods. This method will return 202 Accepted when the item has been queued for creation. The item is created asynchronously.

Bodyapplication/jsonrequired

item

consumeByDateTimestring
Example: "yyyy-MM-dd'T'HH:mm:ssZ"
descriptionstring
idstring
inventoryDimensionalWeightobject(DimensionalWeight)
inventoryIdentifiersArray of objects(InventoryIdentifier)
lineItemHazmatDetailobject(LineItemHazmatDetail)

Provides important information about the hazardous materials to be transported, as required by the US Department of Transportation (DOT). Only required for shipment requests.

manufacturedDateTimestring
Example: "yyyy-MM-dd'T'HH:mm:ssZ"
orderIdsArray of strings
packagedDateTimestring
Example: "yyyy-MM-dd'T'HH:mm:ssZ"
perUnitCostobject(MonetaryValue)

A monetary value expressing amount and currency type.

perUnitRetailValueobject(MonetaryValue)

A monetary value expressing amount and currency type.

perishableboolean
promotionalDateTimeWindowobject(OffsetDateTimeWindow)

A date and time range, with time zone offset.

sellByDateTimestring
Example: "yyyy-MM-dd'T'HH:mm:ssZ"
serialNumberstring
shipmentIdsArray of strings(uuid)
stockKeepingUnitstring
taxableboolean
universalProductCodestring
curl -i -X POST \
  https://developers.project44.com/_mock/guides/shippers/other/order-visibility/api/api/v4/inventory/items \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "consumeByDateTime": "yyyy-MM-dd'\''T'\''HH:mm:ssZ",
    "description": "string",
    "id": "string",
    "inventoryDimensionalWeight": {
      "cubicDimension": {
        "length": 0,
        "width": 0,
        "height": 0
      },
      "lengthUnit": "IN",
      "packageType": "BAG",
      "quantity": 0,
      "weight": {
        "weight": 0,
        "weightUnit": "LB"
      }
    },
    "inventoryIdentifiers": [
      {
        "description": "string",
        "type": "DEPARTMENT",
        "value": "string"
      }
    ],
    "lineItemHazmatDetail": {
      "identificationNumber": "string",
      "properShippingName": "string",
      "hazardClass": "string",
      "packingGroup": "I"
    },
    "manufacturedDateTime": "yyyy-MM-dd'\''T'\''HH:mm:ssZ",
    "orderIds": [
      "string"
    ],
    "packagedDateTime": "yyyy-MM-dd'\''T'\''HH:mm:ssZ",
    "perUnitCost": {
      "currency": "USD",
      "amount": 0
    },
    "perUnitRetailValue": {
      "currency": "USD",
      "amount": 0
    },
    "perishable": true,
    "promotionalDateTimeWindow": {
      "startDateTime": "2019-08-24T14:15:22Z",
      "endDateTime": "2019-08-24T14:15:22Z"
    },
    "sellByDateTime": "yyyy-MM-dd'\''T'\''HH:mm:ssZ",
    "serialNumber": "string",
    "shipmentIds": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "stockKeepingUnit": "string",
    "taxable": true,
    "universalProductCode": "string"
  }'

Responses

Accepted

Body
idstring
Response
{
  "id": "string"
}

Get an item by project44 id.

Request

Use the id returned from createItem to retrieve the InventoryItem.

Path
idstringrequired

The project44-generated id of the item you wish to query.

curl -i -X GET \
  'https://developers.project44.com/_mock/guides/shippers/other/order-visibility/api/api/v4/inventory/items/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Body
consumeByDateTimestring
Example: "yyyy-MM-dd'T'HH:mm:ssZ"
descriptionstring
idstring
inventoryDimensionalWeightobject(DimensionalWeight)
inventoryIdentifiersArray of objects(InventoryIdentifier)
lineItemHazmatDetailobject(LineItemHazmatDetail)

Provides important information about the hazardous materials to be transported, as required by the US Department of Transportation (DOT). Only required for shipment requests.

manufacturedDateTimestring
Example: "yyyy-MM-dd'T'HH:mm:ssZ"
orderIdsArray of strings
packagedDateTimestring
Example: "yyyy-MM-dd'T'HH:mm:ssZ"
perUnitCostobject(MonetaryValue)

A monetary value expressing amount and currency type.

perUnitRetailValueobject(MonetaryValue)

A monetary value expressing amount and currency type.

perishableboolean
promotionalDateTimeWindowobject(OffsetDateTimeWindow)

A date and time range, with time zone offset.

sellByDateTimestring
Example: "yyyy-MM-dd'T'HH:mm:ssZ"
serialNumberstring
shipmentIdsArray of strings(uuid)
stockKeepingUnitstring
taxableboolean
universalProductCodestring
Response
{
  "consumeByDateTime": "yyyy-MM-dd'T'HH:mm:ssZ",
  "description": "string",
  "id": "string",
  "inventoryDimensionalWeight": {
    "cubicDimension": { … },
    "lengthUnit": "IN",
    "packageType": "BAG",
    "quantity": 0,
    "weight": { … }
  },
  "inventoryIdentifiers": [
    { … }
  ],
  "lineItemHazmatDetail": {
    "identificationNumber": "string",
    "properShippingName": "string",
    "hazardClass": "string",
    "packingGroup": "I"
  },
  "manufacturedDateTime": "yyyy-MM-dd'T'HH:mm:ssZ",
  "orderIds": [
    "string"
  ],
  "packagedDateTime": "yyyy-MM-dd'T'HH:mm:ssZ",
  "perUnitCost": {
    "currency": "USD",
    "amount": 0
  },
  "perUnitRetailValue": {
    "currency": "USD",
    "amount": 0
  },
  "perishable": true,
  "promotionalDateTimeWindow": {
    "startDateTime": "2019-08-24T14:15:22Z",
    "endDateTime": "2019-08-24T14:15:22Z"
  },
  "sellByDateTime": "yyyy-MM-dd'T'HH:mm:ssZ",
  "serialNumber": "string",
  "shipmentIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "stockKeepingUnit": "string",
  "taxable": true,
  "universalProductCode": "string"
}

Update an existing item.

Request

InventoryItem should be passed with the id field populated with the value returned from createItem. InventoryItems returned from the service will have id populated. InventoryItem.id must match the id in the URL. This method will return 202 Accepted when the item has been queued for update. The item is updated asynchronously.


Required Fields

  • id
Path
idstringrequired

The project44-generated id of the item you wish to update.

Bodyapplication/jsonrequired

item

consumeByDateTimestring
Example: "yyyy-MM-dd'T'HH:mm:ssZ"
descriptionstring
idstring
inventoryDimensionalWeightobject(DimensionalWeight)
inventoryIdentifiersArray of objects(InventoryIdentifier)
lineItemHazmatDetailobject(LineItemHazmatDetail)

Provides important information about the hazardous materials to be transported, as required by the US Department of Transportation (DOT). Only required for shipment requests.

manufacturedDateTimestring
Example: "yyyy-MM-dd'T'HH:mm:ssZ"
orderIdsArray of strings
packagedDateTimestring
Example: "yyyy-MM-dd'T'HH:mm:ssZ"
perUnitCostobject(MonetaryValue)

A monetary value expressing amount and currency type.

perUnitRetailValueobject(MonetaryValue)

A monetary value expressing amount and currency type.

perishableboolean
promotionalDateTimeWindowobject(OffsetDateTimeWindow)

A date and time range, with time zone offset.

sellByDateTimestring
Example: "yyyy-MM-dd'T'HH:mm:ssZ"
serialNumberstring
shipmentIdsArray of strings(uuid)
stockKeepingUnitstring
taxableboolean
universalProductCodestring
curl -i -X PUT \
  'https://developers.project44.com/_mock/guides/shippers/other/order-visibility/api/api/v4/inventory/items/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "consumeByDateTime": "yyyy-MM-dd'\''T'\''HH:mm:ssZ",
    "description": "string",
    "id": "string",
    "inventoryDimensionalWeight": {
      "cubicDimension": {
        "length": 0,
        "width": 0,
        "height": 0
      },
      "lengthUnit": "IN",
      "packageType": "BAG",
      "quantity": 0,
      "weight": {
        "weight": 0,
        "weightUnit": "LB"
      }
    },
    "inventoryIdentifiers": [
      {
        "description": "string",
        "type": "DEPARTMENT",
        "value": "string"
      }
    ],
    "lineItemHazmatDetail": {
      "identificationNumber": "string",
      "properShippingName": "string",
      "hazardClass": "string",
      "packingGroup": "I"
    },
    "manufacturedDateTime": "yyyy-MM-dd'\''T'\''HH:mm:ssZ",
    "orderIds": [
      "string"
    ],
    "packagedDateTime": "yyyy-MM-dd'\''T'\''HH:mm:ssZ",
    "perUnitCost": {
      "currency": "USD",
      "amount": 0
    },
    "perUnitRetailValue": {
      "currency": "USD",
      "amount": 0
    },
    "perishable": true,
    "promotionalDateTimeWindow": {
      "startDateTime": "2019-08-24T14:15:22Z",
      "endDateTime": "2019-08-24T14:15:22Z"
    },
    "sellByDateTime": "yyyy-MM-dd'\''T'\''HH:mm:ssZ",
    "serialNumber": "string",
    "shipmentIds": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "stockKeepingUnit": "string",
    "taxable": true,
    "universalProductCode": "string"
  }'

Responses

Accepted

Body
idstring
Response
{
  "id": "string"
}

Delete an item.

Request

Use InventoryItem.id to delete the InventoryItem.

Path
idstringrequired

The project44-generated id of the item you wish to delete.

curl -i -X DELETE \
  'https://developers.project44.com/_mock/guides/shippers/other/order-visibility/api/api/v4/inventory/items/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Accepted

Body
Response
{
  "httpStatusCode": 0,
  "httpMessage": "string",
  "errorMessage": "string",
  "errors": [
    { … }
  ],
  "supportReferenceId": "string"
}

createItems

Request

Bodyapplication/jsonrequired

items

itemsArray of objects(InventoryItem)
curl -i -X POST \
  https://developers.project44.com/_mock/guides/shippers/other/order-visibility/api/api/v4/inventory/items/bulk \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "items": [
      {
        "consumeByDateTime": "yyyy-MM-dd'\''T'\''HH:mm:ssZ",
        "description": "string",
        "id": "string",
        "inventoryDimensionalWeight": {
          "cubicDimension": {
            "length": 0,
            "width": 0,
            "height": 0
          },
          "lengthUnit": "IN",
          "packageType": "BAG",
          "quantity": 0,
          "weight": {
            "weight": 0,
            "weightUnit": "LB"
          }
        },
        "inventoryIdentifiers": [
          {
            "description": "string",
            "type": "DEPARTMENT",
            "value": "string"
          }
        ],
        "lineItemHazmatDetail": {
          "identificationNumber": "string",
          "properShippingName": "string",
          "hazardClass": "string",
          "packingGroup": "I"
        },
        "manufacturedDateTime": "yyyy-MM-dd'\''T'\''HH:mm:ssZ",
        "orderIds": [
          "string"
        ],
        "packagedDateTime": "yyyy-MM-dd'\''T'\''HH:mm:ssZ",
        "perUnitCost": {
          "currency": "USD",
          "amount": 0
        },
        "perUnitRetailValue": {
          "currency": "USD",
          "amount": 0
        },
        "perishable": true,
        "promotionalDateTimeWindow": {
          "startDateTime": "2019-08-24T14:15:22Z",
          "endDateTime": "2019-08-24T14:15:22Z"
        },
        "sellByDateTime": "yyyy-MM-dd'\''T'\''HH:mm:ssZ",
        "serialNumber": "string",
        "shipmentIds": [
          "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        ],
        "stockKeepingUnit": "string",
        "taxable": true,
        "universalProductCode": "string"
      }
    ]
  }'

Responses

OK

Body
idsArray of objects(InventoryId)
Response
{
  "ids": [
    { … }
  ]
}

Search for items.

Request

Use the BasicInventoryItemSearchCriteria, page number, page size and sort field to perform Inventory Item search

Query
pageinteger(int32)

Page number valid range: [1, 50]

sizeinteger(int32)

Page size valid range: [1, 100]

sortstring

Inventory Sortable Fields: [stockKeepingUnit, description, universalProductCode, inventoryIdentifiers.type, manufacturedDateTime, packagedDateTime, sellByDateTime, consumeByDateTime, lineItemHazmatDetail.hazardClass]

Default "stockKeepingUnit:ASC"
Bodyapplication/jsonrequired

criteria

consumeByDateTimeRangeobject(OffsetDateTimeRangeFilter)

A date and time range filter, with time zone offset.

hazardClassesArray of strings
idsArray of strings
inventoryIdentifiersArray of objects(InventoryIdentifier)
manufacturedDateTimeRangeobject(OffsetDateTimeRangeFilter)

A date and time range filter, with time zone offset.

orderIdsArray of strings
packagedDateTimeRangeobject(OffsetDateTimeRangeFilter)

A date and time range filter, with time zone offset.

perUnitCostobject(MonetaryValueRangeFilter)
perUnitRetailValueobject(MonetaryValueRangeFilter)
perishableboolean
searchTextstring
sellByDateTimeRangeobject(OffsetDateTimeRangeFilter)

A date and time range filter, with time zone offset.

shipmentIdsArray of strings(uuid)
skusArray of strings
taxableboolean
upcsArray of strings
curl -i -X POST \
  'https://developers.project44.com/_mock/guides/shippers/other/order-visibility/api/api/v4/inventory/items/search?page=0&size=0&sort=stockKeepingUnit%3AASC' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "consumeByDateTimeRange": {
      "startDateTime": "2019-08-24T14:15:22Z",
      "startDateTimeInclusive": true,
      "endDateTime": "2019-08-24T14:15:22Z",
      "endDateTimeInclusive": true
    },
    "hazardClasses": [
      "string"
    ],
    "ids": [
      "string"
    ],
    "inventoryIdentifiers": [
      {
        "description": "string",
        "type": "DEPARTMENT",
        "value": "string"
      }
    ],
    "manufacturedDateTimeRange": {
      "startDateTime": "2019-08-24T14:15:22Z",
      "startDateTimeInclusive": true,
      "endDateTime": "2019-08-24T14:15:22Z",
      "endDateTimeInclusive": true
    },
    "orderIds": [
      "string"
    ],
    "packagedDateTimeRange": {
      "startDateTime": "2019-08-24T14:15:22Z",
      "startDateTimeInclusive": true,
      "endDateTime": "2019-08-24T14:15:22Z",
      "endDateTimeInclusive": true
    },
    "perUnitCost": {
      "minimumValue": {
        "currency": "USD",
        "amount": 0
      },
      "minimumValueInclusive": true,
      "maximumValue": {
        "currency": "USD",
        "amount": 0
      },
      "maximumValueInclusive": true
    },
    "perUnitRetailValue": {
      "minimumValue": {
        "currency": "USD",
        "amount": 0
      },
      "minimumValueInclusive": true,
      "maximumValue": {
        "currency": "USD",
        "amount": 0
      },
      "maximumValueInclusive": true
    },
    "perishable": true,
    "searchText": "string",
    "sellByDateTimeRange": {
      "startDateTime": "2019-08-24T14:15:22Z",
      "startDateTimeInclusive": true,
      "endDateTime": "2019-08-24T14:15:22Z",
      "endDateTimeInclusive": true
    },
    "shipmentIds": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "skus": [
      "string"
    ],
    "taxable": true,
    "upcs": [
      "string"
    ]
  }'

Responses

OK

Body
paginationInfoobject(PaginationInfo)

Pagination information about a collection of resources.

resultsArray of objects(InventoryItem)

List of resources contained on this page.

Response
{
  "paginationInfo": {
    "total": 0,
    "pageSize": 0,
    "pageNumber": 0
  },
  "results": [
    { … }
  ]
}

Create an order.

Request

InventoryOrder should be passed without populating the id field. A unique id will be generated and returned in the response. This id will be used to identify the order across all other methods. This method will return 202 Accepted when the order has been queued for creation. The order is created asynchronously.


Required Fields

  • orderIdentifier
Bodyapplication/jsonrequired

order

additionalOrderIdentifiersArray of objects(InventoryOrderIdentifier)
attributesArray of objects(OrderCustomAttribute)
billToLocationobject(InventoryLocation)
derivedOrderHealthobject(DerivedOrderHealth)
destinationLocationobject(InventoryLocation)
freightTermsobject(FreightTerms)
idstring
launchDateTimestring
Example: "yyyy-MM-dd'T'HH:mm:ssZ"
orderIdentifierstring
orderIdentifierAuthoritystring
orderSubmissionDateTimestring
Example: "yyyy-MM-dd'T'HH:mm:ssZ"
orderTagsArray of objects(InventoryOrderTag)
orderTypestring
Enum"PURCHASE_ORDER""SALES_ORDER""WAREHOUSE_MOVEMENT_ORDER""ADVANCED_SHIPMENT_NOTICE""INVOICE"
originLocationobject(InventoryLocation)
originalDeliveryDateTimeWindowobject(OffsetDateTimeWindow)

A date and time range, with time zone offset.

relatedOrderIdsArray of strings
shipmentIdsArray of strings(uuid)
statusCodestring
Enum"SUBMITTED""RECEIVED""PROCESSING""ACCEPTED""FULFILLED""REJECTED""CANCELED"
statusCodeDateTimestring
Example: "yyyy-MM-dd'T'HH:mm:ssZ"
subjectstring
supplierReadyDateTimeWindowobject(OffsetDateTimeWindow)

A date and time range, with time zone offset.

totalCostobject(MonetaryValue)

A monetary value expressing amount and currency type.

totalRetailValueobject(MonetaryValue)

A monetary value expressing amount and currency type.

vendorLocationobject(InventoryLocation)
curl -i -X POST \
  https://developers.project44.com/_mock/guides/shippers/other/order-visibility/api/api/v4/inventory/orders \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "additionalOrderIdentifiers": [
      {
        "type": "CONTRACT",
        "value": "string"
      }
    ],
    "attributes": [
      {
        "name": "string",
        "values": [
          "string"
        ]
      }
    ],
    "billToLocation": {
      "additionalContacts": [
        {
          "companyName": "string",
          "contactName": "string",
          "contactType": "PRIMARY",
          "email": "string",
          "faxNumber": "string",
          "faxNumberCountryCode": "string",
          "phoneNumber": "string",
          "phoneNumber2": "string",
          "phoneNumber2CountryCode": "string",
          "phoneNumberCountryCode": "string"
        }
      ],
      "address": {
        "postalCode": "string",
        "addressLines": [
          "str"
        ],
        "city": "string",
        "state": "string",
        "country": "US"
      },
      "contact": {
        "companyName": "string",
        "contactName": "string",
        "contactType": "PRIMARY",
        "email": "string",
        "faxNumber": "string",
        "faxNumberCountryCode": "string",
        "phoneNumber": "string",
        "phoneNumber2": "string",
        "phoneNumber2CountryCode": "string",
        "phoneNumberCountryCode": "string"
      },
      "id": "string",
      "name": "string",
      "suppliedId": "string"
    },
    "derivedOrderHealth": {
      "arrivalStatus": {
        "code": "UNKNOWN",
        "duration": {
          "unit": "UNKNOWN",
          "amount": 0
        }
      },
      "estimatedTimeOfArrival": "yyyy-MM-dd'\''T'\''HH:mm:ssZ"
    },
    "destinationLocation": {
      "additionalContacts": [
        {
          "companyName": "string",
          "contactName": "string",
          "contactType": "PRIMARY",
          "email": "string",
          "faxNumber": "string",
          "faxNumberCountryCode": "string",
          "phoneNumber": "string",
          "phoneNumber2": "string",
          "phoneNumber2CountryCode": "string",
          "phoneNumberCountryCode": "string"
        }
      ],
      "address": {
        "postalCode": "string",
        "addressLines": [
          "str"
        ],
        "city": "string",
        "state": "string",
        "country": "US"
      },
      "contact": {
        "companyName": "string",
        "contactName": "string",
        "contactType": "PRIMARY",
        "email": "string",
        "faxNumber": "string",
        "faxNumberCountryCode": "string",
        "phoneNumber": "string",
        "phoneNumber2": "string",
        "phoneNumber2CountryCode": "string",
        "phoneNumberCountryCode": "string"
      },
      "id": "string",
      "name": "string",
      "suppliedId": "string"
    },
    "freightTerms": {
      "freightOwnershipType": "PREPAID",
      "transportationPaymentType": "ORIGIN"
    },
    "id": "string",
    "launchDateTime": "yyyy-MM-dd'\''T'\''HH:mm:ssZ",
    "orderIdentifier": "string",
    "orderIdentifierAuthority": "string",
    "orderSubmissionDateTime": "yyyy-MM-dd'\''T'\''HH:mm:ssZ",
    "orderTags": [
      {
        "description": "string",
        "type": "ANALYST",
        "value": "string"
      }
    ],
    "orderType": "PURCHASE_ORDER",
    "originLocation": {
      "additionalContacts": [
        {
          "companyName": "string",
          "contactName": "string",
          "contactType": "PRIMARY",
          "email": "string",
          "faxNumber": "string",
          "faxNumberCountryCode": "string",
          "phoneNumber": "string",
          "phoneNumber2": "string",
          "phoneNumber2CountryCode": "string",
          "phoneNumberCountryCode": "string"
        }
      ],
      "address": {
        "postalCode": "string",
        "addressLines": [
          "str"
        ],
        "city": "string",
        "state": "string",
        "country": "US"
      },
      "contact": {
        "companyName": "string",
        "contactName": "string",
        "contactType": "PRIMARY",
        "email": "string",
        "faxNumber": "string",
        "faxNumberCountryCode": "string",
        "phoneNumber": "string",
        "phoneNumber2": "string",
        "phoneNumber2CountryCode": "string",
        "phoneNumberCountryCode": "string"
      },
      "id": "string",
      "name": "string",
      "suppliedId": "string"
    },
    "originalDeliveryDateTimeWindow": {
      "startDateTime": "2019-08-24T14:15:22Z",
      "endDateTime": "2019-08-24T14:15:22Z"
    },
    "relatedOrderIds": [
      "string"
    ],
    "shipmentIds": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "statusCode": "SUBMITTED",
    "statusCodeDateTime": "yyyy-MM-dd'\''T'\''HH:mm:ssZ",
    "subject": "string",
    "supplierReadyDateTimeWindow": {
      "startDateTime": "2019-08-24T14:15:22Z",
      "endDateTime": "2019-08-24T14:15:22Z"
    },
    "totalCost": {
      "currency": "USD",
      "amount": 0
    },
    "totalRetailValue": {
      "currency": "USD",
      "amount": 0
    },
    "vendorLocation": {
      "additionalContacts": [
        {
          "companyName": "string",
          "contactName": "string",
          "contactType": "PRIMARY",
          "email": "string",
          "faxNumber": "string",
          "faxNumberCountryCode": "string",
          "phoneNumber": "string",
          "phoneNumber2": "string",
          "phoneNumber2CountryCode": "string",
          "phoneNumberCountryCode": "string"
        }
      ],
      "address": {
        "postalCode": "string",
        "addressLines": [
          "str"
        ],
        "city": "string",
        "state": "string",
        "country": "US"
      },
      "contact": {
        "companyName": "string",
        "contactName": "string",
        "contactType": "PRIMARY",
        "email": "string",
        "faxNumber": "string",
        "faxNumberCountryCode": "string",
        "phoneNumber": "string",
        "phoneNumber2": "string",
        "phoneNumber2CountryCode": "string",
        "phoneNumberCountryCode": "string"
      },
      "id": "string",
      "name": "string",
      "suppliedId": "string"
    }
  }'

Responses

Accepted

Body
idstring
Response
{
  "id": "string"
}

Retrieve an order by project44 id.

Request

Use the id returned from createOrder to retrieve the InventoryOrder.

Path
idstringrequired

The project44-generated id of the order you wish to query.

curl -i -X GET \
  'https://developers.project44.com/_mock/guides/shippers/other/order-visibility/api/api/v4/inventory/orders/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Body
additionalOrderIdentifiersArray of objects(InventoryOrderIdentifier)
attributesArray of objects(OrderCustomAttribute)
billToLocationobject(InventoryLocation)
derivedOrderHealthobject(DerivedOrderHealth)
destinationLocationobject(InventoryLocation)
freightTermsobject(FreightTerms)
idstring
launchDateTimestring
Example: "yyyy-MM-dd'T'HH:mm:ssZ"
orderIdentifierstring
orderIdentifierAuthoritystring
orderSubmissionDateTimestring
Example: "yyyy-MM-dd'T'HH:mm:ssZ"
orderTagsArray of objects(InventoryOrderTag)
orderTypestring
Enum"PURCHASE_ORDER""SALES_ORDER""WAREHOUSE_MOVEMENT_ORDER""ADVANCED_SHIPMENT_NOTICE""INVOICE"
originLocationobject(InventoryLocation)
originalDeliveryDateTimeWindowobject(OffsetDateTimeWindow)

A date and time range, with time zone offset.

relatedOrderIdsArray of strings
shipmentIdsArray of strings(uuid)
statusCodestring
Enum"SUBMITTED""RECEIVED""PROCESSING""ACCEPTED""FULFILLED""REJECTED""CANCELED"
statusCodeDateTimestring
Example: "yyyy-MM-dd'T'HH:mm:ssZ"
subjectstring
supplierReadyDateTimeWindowobject(OffsetDateTimeWindow)

A date and time range, with time zone offset.

totalCostobject(MonetaryValue)

A monetary value expressing amount and currency type.

totalRetailValueobject(MonetaryValue)

A monetary value expressing amount and currency type.

vendorLocationobject(InventoryLocation)
Response
{
  "additionalOrderIdentifiers": [
    { … }
  ],
  "attributes": [
    { … }
  ],
  "billToLocation": {
    "additionalContacts": [ … ],
    "address": { … },
    "contact": { … },
    "id": "string",
    "name": "string",
    "suppliedId": "string"
  },
  "derivedOrderHealth": {
    "arrivalStatus": { … },
    "estimatedTimeOfArrival": "yyyy-MM-dd'T'HH:mm:ssZ"
  },
  "destinationLocation": {
    "additionalContacts": [ … ],
    "address": { … },
    "contact": { … },
    "id": "string",
    "name": "string",
    "suppliedId": "string"
  },
  "freightTerms": {
    "freightOwnershipType": "PREPAID",
    "transportationPaymentType": "ORIGIN"
  },
  "id": "string",
  "launchDateTime": "yyyy-MM-dd'T'HH:mm:ssZ",
  "orderIdentifier": "string",
  "orderIdentifierAuthority": "string",
  "orderSubmissionDateTime": "yyyy-MM-dd'T'HH:mm:ssZ",
  "orderTags": [
    { … }
  ],
  "orderType": "PURCHASE_ORDER",
  "originLocation": {
    "additionalContacts": [ … ],
    "address": { … },
    "contact": { … },
    "id": "string",
    "name": "string",
    "suppliedId": "string"
  },
  "originalDeliveryDateTimeWindow": {
    "startDateTime": "2019-08-24T14:15:22Z",
    "endDateTime": "2019-08-24T14:15:22Z"
  },
  "relatedOrderIds": [
    "string"
  ],
  "shipmentIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "statusCode": "SUBMITTED",
  "statusCodeDateTime": "yyyy-MM-dd'T'HH:mm:ssZ",
  "subject": "string",
  "supplierReadyDateTimeWindow": {
    "startDateTime": "2019-08-24T14:15:22Z",
    "endDateTime": "2019-08-24T14:15:22Z"
  },
  "totalCost": {
    "currency": "USD",
    "amount": 0
  },
  "totalRetailValue": {
    "currency": "USD",
    "amount": 0
  },
  "vendorLocation": {
    "additionalContacts": [ … ],
    "address": { … },
    "contact": { … },
    "id": "string",
    "name": "string",
    "suppliedId": "string"
  }
}

Update an existing order.

Request

InventoryOrder should be passed with the id field populated with the value returned from createOrder. Orders returned from the service will have id populated. InventoryOrder.id must match the id in the URL. This method will return 202 Accepted when the order has been queued for update. The order is updated asynchronously.


Required Fields

  • id
  • orderIdentifier
Path
idstringrequired

The project44-generated id of the order you wish to update.

Bodyapplication/jsonrequired

order

additionalOrderIdentifiersArray of objects(InventoryOrderIdentifier)
attributesArray of objects(OrderCustomAttribute)
billToLocationobject(InventoryLocation)
derivedOrderHealthobject(DerivedOrderHealth)
destinationLocationobject(InventoryLocation)
freightTermsobject(FreightTerms)
idstring
launchDateTimestring
Example: "yyyy-MM-dd'T'HH:mm:ssZ"
orderIdentifierstring
orderIdentifierAuthoritystring
orderSubmissionDateTimestring
Example: "yyyy-MM-dd'T'HH:mm:ssZ"
orderTagsArray of objects(InventoryOrderTag)
orderTypestring
Enum"PURCHASE_ORDER""SALES_ORDER""WAREHOUSE_MOVEMENT_ORDER""ADVANCED_SHIPMENT_NOTICE""INVOICE"
originLocationobject(InventoryLocation)
originalDeliveryDateTimeWindowobject(OffsetDateTimeWindow)

A date and time range, with time zone offset.

relatedOrderIdsArray of strings
shipmentIdsArray of strings(uuid)
statusCodestring
Enum"SUBMITTED""RECEIVED""PROCESSING""ACCEPTED""FULFILLED""REJECTED""CANCELED"
statusCodeDateTimestring
Example: "yyyy-MM-dd'T'HH:mm:ssZ"
subjectstring
supplierReadyDateTimeWindowobject(OffsetDateTimeWindow)

A date and time range, with time zone offset.

totalCostobject(MonetaryValue)

A monetary value expressing amount and currency type.

totalRetailValueobject(MonetaryValue)

A monetary value expressing amount and currency type.

vendorLocationobject(InventoryLocation)
curl -i -X PUT \
  'https://developers.project44.com/_mock/guides/shippers/other/order-visibility/api/api/v4/inventory/orders/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "additionalOrderIdentifiers": [
      {
        "type": "CONTRACT",
        "value": "string"
      }
    ],
    "attributes": [
      {
        "name": "string",
        "values": [
          "string"
        ]
      }
    ],
    "billToLocation": {
      "additionalContacts": [
        {
          "companyName": "string",
          "contactName": "string",
          "contactType": "PRIMARY",
          "email": "string",
          "faxNumber": "string",
          "faxNumberCountryCode": "string",
          "phoneNumber": "string",
          "phoneNumber2": "string",
          "phoneNumber2CountryCode": "string",
          "phoneNumberCountryCode": "string"
        }
      ],
      "address": {
        "postalCode": "string",
        "addressLines": [
          "str"
        ],
        "city": "string",
        "state": "string",
        "country": "US"
      },
      "contact": {
        "companyName": "string",
        "contactName": "string",
        "contactType": "PRIMARY",
        "email": "string",
        "faxNumber": "string",
        "faxNumberCountryCode": "string",
        "phoneNumber": "string",
        "phoneNumber2": "string",
        "phoneNumber2CountryCode": "string",
        "phoneNumberCountryCode": "string"
      },
      "id": "string",
      "name": "string",
      "suppliedId": "string"
    },
    "derivedOrderHealth": {
      "arrivalStatus": {
        "code": "UNKNOWN",
        "duration": {
          "unit": "UNKNOWN",
          "amount": 0
        }
      },
      "estimatedTimeOfArrival": "yyyy-MM-dd'\''T'\''HH:mm:ssZ"
    },
    "destinationLocation": {
      "additionalContacts": [
        {
          "companyName": "string",
          "contactName": "string",
          "contactType": "PRIMARY",
          "email": "string",
          "faxNumber": "string",
          "faxNumberCountryCode": "string",
          "phoneNumber": "string",
          "phoneNumber2": "string",
          "phoneNumber2CountryCode": "string",
          "phoneNumberCountryCode": "string"
        }
      ],
      "address": {
        "postalCode": "string",
        "addressLines": [
          "str"
        ],
        "city": "string",
        "state": "string",
        "country": "US"
      },
      "contact": {
        "companyName": "string",
        "contactName": "string",
        "contactType": "PRIMARY",
        "email": "string",
        "faxNumber": "string",
        "faxNumberCountryCode": "string",
        "phoneNumber": "string",
        "phoneNumber2": "string",
        "phoneNumber2CountryCode": "string",
        "phoneNumberCountryCode": "string"
      },
      "id": "string",
      "name": "string",
      "suppliedId": "string"
    },
    "freightTerms": {
      "freightOwnershipType": "PREPAID",
      "transportationPaymentType": "ORIGIN"
    },
    "id": "string",
    "launchDateTime": "yyyy-MM-dd'\''T'\''HH:mm:ssZ",
    "orderIdentifier": "string",
    "orderIdentifierAuthority": "string",
    "orderSubmissionDateTime": "yyyy-MM-dd'\''T'\''HH:mm:ssZ",
    "orderTags": [
      {
        "description": "string",
        "type": "ANALYST",
        "value": "string"
      }
    ],
    "orderType": "PURCHASE_ORDER",
    "originLocation": {
      "additionalContacts": [
        {
          "companyName": "string",
          "contactName": "string",
          "contactType": "PRIMARY",
          "email": "string",
          "faxNumber": "string",
          "faxNumberCountryCode": "string",
          "phoneNumber": "string",
          "phoneNumber2": "string",
          "phoneNumber2CountryCode": "string",
          "phoneNumberCountryCode": "string"
        }
      ],
      "address": {
        "postalCode": "string",
        "addressLines": [
          "str"
        ],
        "city": "string",
        "state": "string",
        "country": "US"
      },
      "contact": {
        "companyName": "string",
        "contactName": "string",
        "contactType": "PRIMARY",
        "email": "string",
        "faxNumber": "string",
        "faxNumberCountryCode": "string",
        "phoneNumber": "string",
        "phoneNumber2": "string",
        "phoneNumber2CountryCode": "string",
        "phoneNumberCountryCode": "string"
      },
      "id": "string",
      "name": "string",
      "suppliedId": "string"
    },
    "originalDeliveryDateTimeWindow": {
      "startDateTime": "2019-08-24T14:15:22Z",
      "endDateTime": "2019-08-24T14:15:22Z"
    },
    "relatedOrderIds": [
      "string"
    ],
    "shipmentIds": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "statusCode": "SUBMITTED",
    "statusCodeDateTime": "yyyy-MM-dd'\''T'\''HH:mm:ssZ",
    "subject": "string",
    "supplierReadyDateTimeWindow": {
      "startDateTime": "2019-08-24T14:15:22Z",
      "endDateTime": "2019-08-24T14:15:22Z"
    },
    "totalCost": {
      "currency": "USD",
      "amount": 0
    },
    "totalRetailValue": {
      "currency": "USD",
      "amount": 0
    },
    "vendorLocation": {
      "additionalContacts": [
        {
          "companyName": "string",
          "contactName": "string",
          "contactType": "PRIMARY",
          "email": "string",
          "faxNumber": "string",
          "faxNumberCountryCode": "string",
          "phoneNumber": "string",
          "phoneNumber2": "string",
          "phoneNumber2CountryCode": "string",
          "phoneNumberCountryCode": "string"
        }
      ],
      "address": {
        "postalCode": "string",
        "addressLines": [
          "str"
        ],
        "city": "string",
        "state": "string",
        "country": "US"
      },
      "contact": {
        "companyName": "string",
        "contactName": "string",
        "contactType": "PRIMARY",
        "email": "string",
        "faxNumber": "string",
        "faxNumberCountryCode": "string",
        "phoneNumber": "string",
        "phoneNumber2": "string",
        "phoneNumber2CountryCode": "string",
        "phoneNumberCountryCode": "string"
      },
      "id": "string",
      "name": "string",
      "suppliedId": "string"
    }
  }'

Responses

Accepted

Body
idstring
Response
{
  "id": "string"
}

Delete an order.

Request

Use InventoryOrder.id to delete the InventoryOrder.

Path
idstringrequired

The project44-generated id of the order you wish to delete.

curl -i -X DELETE \
  'https://developers.project44.com/_mock/guides/shippers/other/order-visibility/api/api/v4/inventory/orders/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Accepted

Body
Response
{
  "httpStatusCode": 0,
  "httpMessage": "string",
  "errorMessage": "string",
  "errors": [
    { … }
  ],
  "supportReferenceId": "string"
}

Get related orders.

Request

Use the InventoryOrder.id (project44 generated id) from an existing order to retrieve all related orders.

Path
idstringrequired

The project44-generated id of the order for which you wish to query related orders.

Query
pageinteger(int32)

Page number valid range: [1, 50]

Default 1
sizeinteger(int32)

Page size valid range: [1, 100]

Default 30
sortstring

Order Sortable Fields: [orderType, orderIdentifier, statusCode, orderSubmissionDateTime, supplierReadyDateTimeWindow.startDateTime, supplierReadyDateTimeWindow.endDateTime, originalDeliveryDateTimeWindow.startDateTime,originalDeliveryDateTimeWindow.endDateTime, derivedOrderHealth.estimatedTimeOfArrival]

Default "orderSubmissionDateTime:DESC"
curl -i -X GET \
  'https://developers.project44.com/_mock/guides/shippers/other/order-visibility/api/api/v4/inventory/orders/{id}/related-orders?page=1&size=30&sort=orderSubmissionDateTime%3ADESC' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Body
paginationInfoobject(PaginationInfo)

Pagination information about a collection of resources.

resultsArray of objects(InventoryOrder)

List of resources contained on this page.

Response
{
  "paginationInfo": {
    "total": 0,
    "pageSize": 0,
    "pageNumber": 0
  },
  "results": [
    { … }
  ]
}

Search for orders.

Request

Use the BasicInventoryOrderSearchCriteria, page number, page size and sort field to perform Inventory Order search.

Query
pageinteger(int32)

Page number valid range: [1, 50]

Default 1
sizeinteger(int32)

Page size valid range: [1, 1000]

Default 30
sortstring

Order Sortable Fields: [orderType, orderIdentifier, statusCode, orderSubmissionDateTime, supplierReadyDateTimeWindow.startDateTime, supplierReadyDateTimeWindow.endDateTime, originalDeliveryDateTimeWindow.startDateTime,originalDeliveryDateTimeWindow.endDateTime, derivedOrderHealth.estimatedTimeOfArrival]

Bodyapplication/jsonrequired

criteria

additionalOrderIdentifierCriteriaArray of objects(InventoryOrderIdentifierCriteria)
billToLocationAddressTextstring
destinationLocationAddressTextstring
hasShipmentIdsboolean
idsArray of strings
launchDateTimeobject(OffsetDateTimeRangeFilter)

A date and time range filter, with time zone offset.

orderAttributesArray of objects(InventoryOrderAttributeFilter)
orderHealthCriteriaArray of objects(OrderHealthCriteria)
orderIdentifiersArray of strings
orderSubmissionDateTimeobject(OffsetDateTimeRangeFilter)

A date and time range filter, with time zone offset.

orderTagCriteriaArray of objects(InventoryOrderTagCriteria)
orderTypesArray of strings
Items Enum"PURCHASE_ORDER""SALES_ORDER""WAREHOUSE_MOVEMENT_ORDER""ADVANCED_SHIPMENT_NOTICE""INVOICE"
originLocationAddressTextstring
originalDeliveryDateTimeWindowEndobject(OffsetDateTimeRangeFilter)

A date and time range filter, with time zone offset.

originalDeliveryDateTimeWindowStartobject(OffsetDateTimeRangeFilter)

A date and time range filter, with time zone offset.

paginationobject(PaginationParameters)

Parameters which define a requested page of resources.

relatedOrderIdsArray of strings
searchTextstring
shipmentIdsArray of strings(uuid)
sortArray of objects(InventoryOrderSortField)
statusCodesArray of strings
Items Enum"SUBMITTED""RECEIVED""PROCESSING""ACCEPTED""FULFILLED""REJECTED""CANCELED"
supplierReadyDateTimeWindowEndobject(OffsetDateTimeRangeFilter)

A date and time range filter, with time zone offset.

supplierReadyDateTimeWindowStartobject(OffsetDateTimeRangeFilter)

A date and time range filter, with time zone offset.

vendorLocationAddressTextstring
curl -i -X POST \
  'https://developers.project44.com/_mock/guides/shippers/other/order-visibility/api/api/v4/inventory/orders/search?page=1&size=30&sort=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "additionalOrderIdentifierCriteria": [
      {
        "type": "CONTRACT",
        "value": "string"
      }
    ],
    "billToLocationAddressText": "string",
    "destinationLocationAddressText": "string",
    "hasShipmentIds": true,
    "ids": [
      "string"
    ],
    "launchDateTime": {
      "startDateTime": "2019-08-24T14:15:22Z",
      "startDateTimeInclusive": true,
      "endDateTime": "2019-08-24T14:15:22Z",
      "endDateTimeInclusive": true
    },
    "orderAttributes": [
      {
        "name": "string",
        "operator": "EQUALS",
        "values": [
          "string"
        ]
      }
    ],
    "orderHealthCriteria": [
      {
        "dateRanges": [
          {
            "endDateTime": "string",
            "offsetMinutes": 0,
            "operator": "WITHIN",
            "startDateTime": "string"
          }
        ],
        "deltas": [
          {
            "operator": "MORE_THAN",
            "type": "RUNNING_EARLY",
            "value": 0
          }
        ],
        "durationRange": {
          "fromDuration": {
            "unit": "UNKNOWN",
            "amount": 0
          },
          "fromInclusive": true,
          "toDuration": {
            "unit": "UNKNOWN",
            "amount": 0
          },
          "toInclusive": true
        },
        "shipmentStatus": "UNKNOWN"
      }
    ],
    "orderIdentifiers": [
      "string"
    ],
    "orderSubmissionDateTime": {
      "startDateTime": "2019-08-24T14:15:22Z",
      "startDateTimeInclusive": true,
      "endDateTime": "2019-08-24T14:15:22Z",
      "endDateTimeInclusive": true
    },
    "orderTagCriteria": [
      {
        "type": "ANALYST",
        "value": "string"
      }
    ],
    "orderTypes": [
      "PURCHASE_ORDER"
    ],
    "originLocationAddressText": "string",
    "originalDeliveryDateTimeWindowEnd": {
      "startDateTime": "2019-08-24T14:15:22Z",
      "startDateTimeInclusive": true,
      "endDateTime": "2019-08-24T14:15:22Z",
      "endDateTimeInclusive": true
    },
    "originalDeliveryDateTimeWindowStart": {
      "startDateTime": "2019-08-24T14:15:22Z",
      "startDateTimeInclusive": true,
      "endDateTime": "2019-08-24T14:15:22Z",
      "endDateTimeInclusive": true
    },
    "pagination": {
      "pageSize": 1,
      "pageNumber": 1
    },
    "relatedOrderIds": [
      "string"
    ],
    "searchText": "string",
    "shipmentIds": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "sort": [
      {
        "direction": "ASC",
        "fieldName": "ORDER_TYPE"
      }
    ],
    "statusCodes": [
      "SUBMITTED"
    ],
    "supplierReadyDateTimeWindowEnd": {
      "startDateTime": "2019-08-24T14:15:22Z",
      "startDateTimeInclusive": true,
      "endDateTime": "2019-08-24T14:15:22Z",
      "endDateTimeInclusive": true
    },
    "supplierReadyDateTimeWindowStart": {
      "startDateTime": "2019-08-24T14:15:22Z",
      "startDateTimeInclusive": true,
      "endDateTime": "2019-08-24T14:15:22Z",
      "endDateTimeInclusive": true
    },
    "vendorLocationAddressText": "string"
  }'

Responses

OK

Body
paginationInfoobject(PaginationInfo)

Pagination information about a collection of resources.

resultsArray of objects(InventoryOrder)

List of resources contained on this page.

Response
{
  "paginationInfo": {
    "total": 0,
    "pageSize": 0,
    "pageNumber": 0
  },
  "results": [
    { … }
  ]
}