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`	`"voluptate occaecat officia esse"`
`transactionSrc`	`"labore cupidatat"`
`ShipperNumber`*	`"Lorem ad anim"`

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": "0",
          "Description": "Document already exists"
        },
        {
          "Code": "3",
          "Description": "Invalid document ID"
        },
        {
          "Code": "4",
          "Description": "Invalid document ID"
        }
      ],
      "ResponseStatus": {
        "Code": "1",
        "Description": "Failure"
      },
      "TransactionReference": {
        "CustomerContext": "181dd2b5-afd3-4d07-80bd-722a078dfb66"
      }
    }
  }
}

{
  "response": {
    "errors": [
      {
        "code": "8",
        "message": "Not found"
      }
    ]
  }
}

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

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

{
  "response": {
    "errors": [
      {
        "code": "9",
        "message": "Unauthorized"
      },
      {
        "code": "2",
        "message": "Invalid request"
      },
      {
        "code": "7",
        "message": "Invalid request"
      }
    ]
  }
}

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`	`"do in laborum amet dolor"`
`transactionSrc`	`"irure cillum nostrud voluptate"`
`ShipperNumber`*	`"velit incididunt Ut pariatur proident"`

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": "c3c9c5bf-6fb2-4632-9cca-a0",
    "Response": {
      "Alert": [
        {
          "Code": "4",
          "Description": "Document already exists"
        },
        {
          "Code": "2",
          "Description": "System timeout"
        }
      ],
      "ResponseStatus": {
        "Code": "1",
        "Description": "Success"
      },
      "TransactionReference": {
        "CustomerContext": "d0e973a7-7f1f-4d31-a0e4-46f7e41b1002"
      }
    }
  }
}

{
  "response": {
    "errors": [
      {
        "code": "3",
        "message": "Unauthorized"
      },
      {
        "code": "0",
        "message": "Not found"
      },
      {
        "code": "9",
        "message": "Invalid request"
      },
      {
        "code": "7",
        "message": "Invalid request"
      },
      {
        "code": "8",
        "message": "Not found"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "7",
        "message": "Internal server error"
      },
      {
        "code": "4",
        "message": "Unauthorized"
      },
      {
        "code": "6",
        "message": "Internal server error"
      }
    ]
  }
}

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

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

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`	`"mollit ea"`
`transactionSrc`	`"dolor aute eiusmod"`
`ShipperNumber`*	`"eiusmod ut"`
`DocumentId`*	`"occaecat enim elit"`

Request Payload

Response Payload

{
  "DeleteResponse": {
    "Response": {
      "Alert": [
        {
          "Code": "4",
          "Description": "Permission denied"
        },
        {
          "Code": "7",
          "Description": "Invalid document ID"
        }
      ],
      "ResponseStatus": {
        "Code": "1",
        "Description": "Success"
      },
      "TransactionReference": {
        "CustomerContext": "9130b57d-4537-47b6-92b9-522698be695a"
      }
    }
  }
}

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

{
  "response": {
    "errors": [
      {
        "code": "9",
        "message": "Internal server error"
      },
      {
        "code": "4",
        "message": "Unauthorized"
      }
    ]
  }
}

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

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

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`	`"aliquip eiusmod deserunt culpa"`
`transactionSrc`	`"velit irure Duis ea"`
`ShipperNumber`*	`"reprehenderit officia"`

Request Payload

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

Response Payload

{
  "UploadResponse": {
    "FormsHistoryDocumentID": {
      "DocumentID": [
        "doc-002",
        "doc-001"
      ]
    },
    "Response": {
      "Alert": [
        {
          "Code": "7",
          "Description": "Document already exists"
        },
        {
          "Code": "4",
          "Description": "Invalid document ID"
        },
        {
          "Code": "7",
          "Description": "Document already exists"
        }
      ],
      "ResponseStatus": {
        "Code": "0",
        "Description": "Success"
      },
      "TransactionReference": {
        "CustomerContext": "b8d1c069-4e3a-456e-98bf-891cfa4e6db7"
      }
    }
  }
}

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

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

{
  "response": {
    "errors": [
      {
        "code": "7",
        "message": "Not found"
      },
      {
        "code": "0",
        "message": "Invalid request"
      },
      {
        "code": "3",
        "message": "Unauthorized"
      },
      {
        "code": "6",
        "message": "Unauthorized"
      },
      {
        "code": "4",
        "message": "Not found"
      }
    ]
  }
}

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

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`	`"pariatur ad aliquip"`
`transactionSrc`	`"in cupidatat dolor ex"`
`ShipperNumber`*	`"incididunt elit mollit"`

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": "795990d7-b58d-48fe-be72-c2",
    "Response": {
      "Alert": [
        {
          "Code": "3",
          "Description": "System timeout"
        },
        {
          "Code": "6",
          "Description": "Permission denied"
        }
      ],
      "ResponseStatus": {
        "Code": "0",
        "Description": "Success"
      },
      "TransactionReference": {
        "CustomerContext": "312ebce4-671a-4e3c-8c46-267ef235f002"
      }
    }
  }
}

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

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

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

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

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`	`"ullamco cupidatat in fugiat amet"`
`transactionSrc`	`"dolor mollit"`
`ShipperNumber`*	`"voluptate irure eiusmod exercitation"`
`DocumentId`*	`"ex Ut minim labore velit"`

Request Payload

Response Payload

{
  "DeleteResponse": {
    "Response": {
      "Alert": [
        {
          "Code": "2",
          "Description": "Permission denied"
        }
      ],
      "ResponseStatus": {
        "Code": "1",
        "Description": "Failure"
      },
      "TransactionReference": {
        "CustomerContext": "a2ff8257-3d0e-4f01-9d66-6f40f90ea0bc"
      }
    }
  }
}

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

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

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

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

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

upsshippinglogisticspaperlessdocuments