Error response

Learn how errors are returned
Updated 4 months ago

This article will provide details of failure scenarios and how they will surface in the API.

Error in processing an API call will be indicated by the status code returned. A 500 status code indicates a system failure by Fulfill Engine. No specific error details will be returned in the response body in this case. Please reach out to your account representative for support in this case. Having the request URL and body available will be helpful in troubleshooting.

A 400 status code indicates a problem on your end. This could be due to malformed fields, missing fields, or business rules that will prevent the request from processing.  Along with the status code, the response body will provide some level of detail as to what was wrong. Below is the body format for an error response:

{
  "errors": [
    {
      "errorCode": "InvalidRequestBody",
      "errorMessage": "Invalid request body."
    }
  ]
}

As you can see, the response contains an array of one or more errors. Each error includes an errorCode field which can drive handling logic in your system. It also includes a more friendly / dynamic errorMessage field which could possibly be shown to the user or logged as additional information.  Below is a list of known error codes that you may encounter.

  • Error Codes

InvalidRequestBody,
MissingAccountId,
MissingCampaignId,
MissingOrderRequest,
MissingOrderItem,
MissingShipment,
MissingOrderId,
MissingSKU,
MissingEmbroideryMetadata,
MissingCatalogProductId,
InvalidDesign,
InvalidSKU,
InvalidScope,
InvalidCampaignProductId,
InvalidCatalogProductId,
InvalidGTIN,
InvalidQuantity,
InvalidAddress,
InvalidOrderItemGroupId,
InvalidWarehouse,
InvalidShippingOptions,
InvalidShippingTier,
InvalidThreadColor,
InvalidState,
InvalidCountryOfOrigin,
InvalidHTSCode,
InvalidDescription,
InvalidCustomization,
InvalidPriority,
InvalidThreadCount,
InvalidArtwork,
InvalidShippingRatesCollectionId,
AccountDisabled,
CampaignDisabled,
UnableToDetermineSKU,
CampaignInvalidForAccount,
GiftMessagesNotAllowed,
TooManyOrderRequests,
OrderFulfilled,
OrderBeingFulfilled,
ModifiedInvalidField,
PhysicalSizeNotAllowed,
TooManyItemsRequested,
MultipleArtworksAtPrintLocation,
SKUMissingHTSCode,
InvalidPrepurchaseId,
PrepurchaseAlreadyRedeemed,
PrepurposeInvalidForOrder,
UnsupportedStitchCount,
PriorityNotAllowed

Did this answer your question?