UPS Paperless Document Virtual Sandbox

Upload and manage international shipping trade documents for paperless processing.

The UPS Paperless Documents API enables the digital submission of trade documents such as commercial invoices, certificates of origin, and export licenses. It supports uploading document files and images, as well as deleting previously uploaded records to streamline international shipping workflows.

Use this hosted sandbox to simulate UPS Paperless Document APIs without authentication, API keys, or extra dependencies. Point your code or SDK to the Beeceptor base URL, preferably through an environment variable or feature flag, and switch back to the production API when ready. This keeps your integration code consistent across local development, QA, demos, and production.

Use cases:

Use this sandbox to validate document upload payloads, verify file format handling, test document type mapping, and simulate error responses for invalid document metadata before integrating with UPS production shipping systems.

UPS Paperless Document virtual sandbox is up and running!

Use this sandbox URL as the API base in your code to simulate UPS Paperless Document responses instantly.

`https://ups-paperless-docs.mock.beeceptor.com`

Paperless(6 operations)

POST

/paperlessdocuments/{version}/upload

The Paperless Document API web service allows the users to upload,delete and push to image repository their own customized trade documents for customs clearance to Forms History.

Header Name	Example
`transId`	`"pariatur in"`
`transactionSrc`	`"pariatur incididunt"`
`ShipperNumber`*	`"aute sed"`

Request Payload

{
  "UploadRequest": {
    "Request": {
      "TransactionReference": {
        "CustomerContext": ""
      }
    },
    "UserCreatedForm": {
      "UserCreatedFormFileName": "TestFile.txt",
      "UserCreatedFormFileFormat": "txt",
      "UserCreatedFormDocumentType": "013",
      "UserCreatedFormFile": "Tm90aWNlDQpJbiBhbGwgY29tbXVuaWNhdGlvbnMgd2l0aCBVUFMgY29uY2VybmluZyB0aGlzIGRvY3VtZW50LCBwbGVhc2UgcmVmZXIgdG8gdGhlIGRvY3VtZW50IGRhdGUgbG9jYXRlZCBvbiB0aGUgY292ZXIuDQpDb3B5cmlnaHQNClRoZSB1c2UsIGRpc2Nsb3N1cmUsIHJlcHJvZHVjdGlvbiwgbW9kaWZpY2F0aW9uLCB0cmFuc2Zlciwgb3IgdHJhbnNtaXR0YWwgb2YgdGhpcyB3b3JrIGZvciBhbnkgcHVycG9zZSBpbiBhbnkgZm9ybSBvciBieSBhbnkgbWVhbnMgd2l0aG91dCB0aGUgd3JpdHRlbiBwZXJtaXNzaW9uIG9mIFVuaXRlZCBQYXJjZWwgU2VydmljZSBpcyBzdHJpY3RseSBwcm9oaWJpdGVkLg0KwqkgQ29weXJpZ2h0IDIwMTYgVW5pdGVkIFBhcmNlbCBTZXJ2aWNlIG9mIEFtZXJpY2EsIEluYy4gQWxsIFJpZ2h0cyBSZXNlcnZlZC4NClRyYWRlbWFya3MNClVQUyBPbkxpbmXCriBpcyBhIHJlZ2lzdGVyZWQgdHJhZGVtYXJrIG9mIFVuaXRlZCBQYXJjZWwgU2VydmljZSBvZiBBbWVyaWNhLCBJbmMuIEFsbCBvdGhlciB0cmFkZW1hcmtzIGFyZSB0aGUgcHJvcGVydHkgb2YgdGhlaXIgcmVzcGVjdGl2ZSBvd25lcnMuDQpTb21lIG9mIHRoZSBVUFMgY29ycG9yYXRlIGFwcGxpY2F0aW9ucyB1c2UgVS5TLiBjaXR5LCBzdGF0ZSwgYW5kIHBvc3RhbCBjb2RlIGluZm9ybWF0aW9uIG9idGFpbmVkIGJ5IFVuaXRlZCBQYXJjZWwgU2VydmljZSBvZiBBbWVyaWNhLCBJbmMuIHVuZGVyIGEgbm9uLWV4Y2x1c2l2ZSBsaWNlbnNlIGZyb20gdGhlIFVuaXRlZCBTdGF0ZXMgUG9zdGFsIFNlcnZpY2UuIA0K"
    }
  }
}

Response Payload

{
  "UploadResponse": {
    "FormsHistoryDocumentID": {
      "DocumentID": [
        "doc-001",
        "doc-002"
      ]
    },
    "Response": {
      "Alert": [
        {
          "Code": "4",
          "Description": "System timeout"
        },
        {
          "Code": "2",
          "Description": "Permission denied"
        }
      ],
      "ResponseStatus": {
        "Code": "0",
        "Description": "Failure"
      },
      "TransactionReference": {
        "CustomerContext": "9c2d4b47-33aa-4e04-ae70-73c4b1159f3c"
      }
    }
  }
}

{
  "response": {
    "errors": [
      {
        "code": "8",
        "message": "Internal server error"
      },
      {
        "code": "0",
        "message": "Not found"
      },
      {
        "code": "4",
        "message": "Not found"
      },
      {
        "code": "0",
        "message": "Unauthorized"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "4",
        "message": "Internal server error"
      },
      {
        "code": "1",
        "message": "Unauthorized"
      },
      {
        "code": "8",
        "message": "Not found"
      },
      {
        "code": "5",
        "message": "Invalid request"
      },
      {
        "code": "5",
        "message": "Internal server error"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "8",
        "message": "Not found"
      },
      {
        "code": "6",
        "message": "Not found"
      },
      {
        "code": "5",
        "message": "Invalid request"
      },
      {
        "code": "1",
        "message": "Invalid request"
      },
      {
        "code": "2",
        "message": "Unauthorized"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "4",
        "message": "Invalid request"
      },
      {
        "code": "5",
        "message": "Unauthorized"
      },
      {
        "code": "1",
        "message": "Internal server error"
      }
    ]
  }
}

POST

/paperlessdocuments/{version}/image

The Paperless Document API web service allows the users to upload their own customized trade documents for customs clearance to Forms History.

Header Name	Example
`transId`	`"et nostrud Lorem ut"`
`transactionSrc`	`"enim laboris"`
`ShipperNumber`*	`"Lorem et Ut elit"`

Request Payload

{
  "PushToImageRepositoryRequest": {
    "Request": {
      "TransactionReference": {
        "CustomerContext": "Your Customer Context"
      }
    },
    "FormsHistoryDocumentID": {
      "DocumentID": "2016-01-18-11.01.07.589501"
    },
    "ShipmentIdentifier": "Your Package Shipment Identifier",
    "ShipmentDateAndTime": "2016-01-18-11.01.07",
    "ShipmentType": "1",
    "TrackingNumber": "Your Package Tracking Number"
  }
}

Response Payload

{
  "PushToImageRepositoryResponse": {
    "FormsGroupID": "ba75e43e-2790-48f6-9470-cb",
    "Response": {
      "Alert": [
        {
          "Code": "9",
          "Description": "System timeout"
        }
      ],
      "ResponseStatus": {
        "Code": "0",
        "Description": "Success"
      },
      "TransactionReference": {
        "CustomerContext": "77b09eb0-8bfc-4d08-af11-7f4a92c71e70"
      }
    }
  }
}

{
  "response": {
    "errors": [
      {
        "code": "4",
        "message": "Invalid request"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "5",
        "message": "Invalid request"
      },
      {
        "code": "2",
        "message": "Internal server error"
      },
      {
        "code": "9",
        "message": "Unauthorized"
      },
      {
        "code": "5",
        "message": "Invalid request"
      },
      {
        "code": "5",
        "message": "Internal server error"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "8",
        "message": "Internal server error"
      },
      {
        "code": "8",
        "message": "Invalid request"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "8",
        "message": "Invalid request"
      },
      {
        "code": "6",
        "message": "Unauthorized"
      },
      {
        "code": "9",
        "message": "Unauthorized"
      },
      {
        "code": "5",
        "message": "Internal server error"
      },
      {
        "code": "0",
        "message": "Internal server error"
      }
    ]
  }
}

DELETE

/paperlessdocuments/{version}/DocumentId/ShipperNumber

The Paperless Document API web service allows the users to upload their own customized trade documents for customs clearance to Forms History.

Header Name	Example
`transId`	`"minim"`
`transactionSrc`	`"ut minim ipsum proident adipisicing"`
`ShipperNumber`*	`"sint"`
`DocumentId`*	`"tempor esse dolor"`

Request Payload

Response Payload

{
  "DeleteResponse": {
    "Response": {
      "Alert": [
        {
          "Code": "2",
          "Description": "Invalid document ID"
        },
        {
          "Code": "5",
          "Description": "Invalid document ID"
        },
        {
          "Code": "3",
          "Description": "Permission denied"
        },
        {
          "Code": "5",
          "Description": "Invalid document ID"
        },
        {
          "Code": "5",
          "Description": "Permission denied"
        }
      ],
      "ResponseStatus": {
        "Code": "1",
        "Description": "Failure"
      },
      "TransactionReference": {
        "CustomerContext": "f90889d0-335b-4883-b201-fbba114bacc4"
      }
    }
  }
}

{
  "response": {
    "errors": [
      {
        "code": "6",
        "message": "Not found"
      },
      {
        "code": "4",
        "message": "Internal server error"
      },
      {
        "code": "6",
        "message": "Internal server error"
      },
      {
        "code": "3",
        "message": "Invalid request"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "3",
        "message": "Invalid request"
      },
      {
        "code": "4",
        "message": "Internal server error"
      },
      {
        "code": "7",
        "message": "Internal server error"
      },
      {
        "code": "9",
        "message": "Not found"
      },
      {
        "code": "9",
        "message": "Not found"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "7",
        "message": "Internal server error"
      },
      {
        "code": "1",
        "message": "Unauthorized"
      },
      {
        "code": "3",
        "message": "Not found"
      },
      {
        "code": "7",
        "message": "Not found"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "6",
        "message": "Invalid request"
      }
    ]
  }
}

POST

/paperlessdocuments/{deprecatedVersion}/upload

The Paperless Document API web service allows the users to upload,delete and push to image repository their own customized trade documents for customs clearance to Forms History.

Header Name	Example
`transId`	`"cillum dolore nisi quis"`
`transactionSrc`	`"elit dolor cillum"`
`ShipperNumber`*	`"exercitation aliqua"`

Request Payload

{
  "UploadRequest": {
    "Request": {
      "TransactionReference": {
        "CustomerContext": ""
      }
    },
    "UserCreatedForm": {
      "UserCreatedFormFileName": "TestFile.txt",
      "UserCreatedFormFileFormat": "txt",
      "UserCreatedFormDocumentType": "013",
      "UserCreatedFormFile": "Tm90aWNlDQpJbiBhbGwgY29tbXVuaWNhdGlvbnMgd2l0aCBVUFMgY29uY2VybmluZyB0aGlzIGRvY3VtZW50LCBwbGVhc2UgcmVmZXIgdG8gdGhlIGRvY3VtZW50IGRhdGUgbG9jYXRlZCBvbiB0aGUgY292ZXIuDQpDb3B5cmlnaHQNClRoZSB1c2UsIGRpc2Nsb3N1cmUsIHJlcHJvZHVjdGlvbiwgbW9kaWZpY2F0aW9uLCB0cmFuc2Zlciwgb3IgdHJhbnNtaXR0YWwgb2YgdGhpcyB3b3JrIGZvciBhbnkgcHVycG9zZSBpbiBhbnkgZm9ybSBvciBieSBhbnkgbWVhbnMgd2l0aG91dCB0aGUgd3JpdHRlbiBwZXJtaXNzaW9uIG9mIFVuaXRlZCBQYXJjZWwgU2VydmljZSBpcyBzdHJpY3RseSBwcm9oaWJpdGVkLg0KwqkgQ29weXJpZ2h0IDIwMTYgVW5pdGVkIFBhcmNlbCBTZXJ2aWNlIG9mIEFtZXJpY2EsIEluYy4gQWxsIFJpZ2h0cyBSZXNlcnZlZC4NClRyYWRlbWFya3MNClVQUyBPbkxpbmXCriBpcyBhIHJlZ2lzdGVyZWQgdHJhZGVtYXJrIG9mIFVuaXRlZCBQYXJjZWwgU2VydmljZSBvZiBBbWVyaWNhLCBJbmMuIEFsbCBvdGhlciB0cmFkZW1hcmtzIGFyZSB0aGUgcHJvcGVydHkgb2YgdGhlaXIgcmVzcGVjdGl2ZSBvd25lcnMuDQpTb21lIG9mIHRoZSBVUFMgY29ycG9yYXRlIGFwcGxpY2F0aW9ucyB1c2UgVS5TLiBjaXR5LCBzdGF0ZSwgYW5kIHBvc3RhbCBjb2RlIGluZm9ybWF0aW9uIG9idGFpbmVkIGJ5IFVuaXRlZCBQYXJjZWwgU2VydmljZSBvZiBBbWVyaWNhLCBJbmMuIHVuZGVyIGEgbm9uLWV4Y2x1c2l2ZSBsaWNlbnNlIGZyb20gdGhlIFVuaXRlZCBTdGF0ZXMgUG9zdGFsIFNlcnZpY2UuIA0K"
    }
  }
}

Response Payload

{
  "UploadResponse": {
    "FormsHistoryDocumentID": {
      "DocumentID": [
        "doc-001",
        "doc-002"
      ]
    },
    "Response": {
      "Alert": [
        {
          "Code": "9",
          "Description": "Document already exists"
        },
        {
          "Code": "2",
          "Description": "System timeout"
        }
      ],
      "ResponseStatus": {
        "Code": "0",
        "Description": "Success"
      },
      "TransactionReference": {
        "CustomerContext": "0317be2f-a352-4b38-a2ab-b5feb15dcf6e"
      }
    }
  }
}

{
  "response": {
    "errors": [
      {
        "code": "3",
        "message": "Unauthorized"
      },
      {
        "code": "6",
        "message": "Unauthorized"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "1",
        "message": "Invalid request"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "3",
        "message": "Internal server error"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "1",
        "message": "Unauthorized"
      },
      {
        "code": "8",
        "message": "Internal server error"
      }
    ]
  }
}

POST

/paperlessdocuments/{deprecatedVersion}/image

The Paperless Document API web service allows the users to upload their own customized trade documents for customs clearance to Forms History.

Header Name	Example
`transId`	`"exercitation ad Ut laborum voluptate"`
`transactionSrc`	`"aliqua"`
`ShipperNumber`*	`"ad velit"`

Request Payload

{
  "PushToImageRepositoryRequest": {
    "Request": {
      "TransactionReference": {
        "CustomerContext": "Your Customer Context"
      }
    },
    "FormsHistoryDocumentID": {
      "DocumentID": "2016-01-18-11.01.07.589501"
    },
    "ShipmentIdentifier": "Your Package Shipment Identifier",
    "ShipmentDateAndTime": "2016-01-18-11.01.07",
    "ShipmentType": "1",
    "TrackingNumber": "Your Package Tracking Number"
  }
}

Response Payload

{
  "PushToImageRepositoryResponse": {
    "FormsGroupID": "ee309932-626c-49f6-b27c-75",
    "Response": {
      "Alert": [
        {
          "Code": "7",
          "Description": "Permission denied"
        },
        {
          "Code": "5",
          "Description": "Document already exists"
        },
        {
          "Code": "2",
          "Description": "Invalid document ID"
        },
        {
          "Code": "4",
          "Description": "Document already exists"
        },
        {
          "Code": "6",
          "Description": "System timeout"
        }
      ],
      "ResponseStatus": {
        "Code": "1",
        "Description": "Failure"
      },
      "TransactionReference": {
        "CustomerContext": "a7533909-0981-4871-bbf0-5202fa8175a2"
      }
    }
  }
}

{
  "response": {
    "errors": [
      {
        "code": "2",
        "message": "Unauthorized"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "6",
        "message": "Invalid request"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "3",
        "message": "Not found"
      },
      {
        "code": "4",
        "message": "Invalid request"
      },
      {
        "code": "5",
        "message": "Internal server error"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "8",
        "message": "Internal server error"
      },
      {
        "code": "8",
        "message": "Invalid request"
      },
      {
        "code": "8",
        "message": "Not found"
      }
    ]
  }
}

DELETE

/paperlessdocuments/{deprecatedVersion}/DocumentId/ShipperNumber

The Paperless Document API web service allows the users to upload their own customized trade documents for customs clearance to Forms History.

Header Name	Example
`transId`	`"qui"`
`transactionSrc`	`"et nostrud dolor voluptate amet"`
`ShipperNumber`*	`"laborum quis"`
`DocumentId`*	`"deserunt et"`

Request Payload

Response Payload

{
  "DeleteResponse": {
    "Response": {
      "Alert": [
        {
          "Code": "2",
          "Description": "System timeout"
        },
        {
          "Code": "2",
          "Description": "Permission denied"
        }
      ],
      "ResponseStatus": {
        "Code": "0",
        "Description": "Success"
      },
      "TransactionReference": {
        "CustomerContext": "db0774f8-79ac-47d2-8b45-773341f8e72a"
      }
    }
  }
}

{
  "response": {
    "errors": [
      {
        "code": "3",
        "message": "Unauthorized"
      },
      {
        "code": "5",
        "message": "Unauthorized"
      },
      {
        "code": "8",
        "message": "Not found"
      },
      {
        "code": "1",
        "message": "Unauthorized"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "9",
        "message": "Internal server error"
      },
      {
        "code": "5",
        "message": "Unauthorized"
      },
      {
        "code": "0",
        "message": "Not found"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "3",
        "message": "Unauthorized"
      },
      {
        "code": "9",
        "message": "Unauthorized"
      },
      {
        "code": "5",
        "message": "Unauthorized"
      },
      {
        "code": "5",
        "message": "Not found"
      },
      {
        "code": "1",
        "message": "Invalid request"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "7",
        "message": "Unauthorized"
      },
      {
        "code": "8",
        "message": "Unauthorized"
      },
      {
        "code": "0",
        "message": "Internal server error"
      },
      {
        "code": "5",
        "message": "Internal server error"
      },
      {
        "code": "6",
        "message": "Invalid request"
      }
    ]
  }
}

Service Homepage: github.com/UPS-API/api-documentation/blob/main/Paperless-Ready.yaml

upsshippinglogisticspaperlessdocuments