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`	`"mollit"`
`transactionSrc`	`"pariatur"`
`ShipperNumber`*	`"qui velit labore voluptate"`

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": "Document already exists"
        },
        {
          "Code": "2",
          "Description": "System timeout"
        },
        {
          "Code": "2",
          "Description": "System timeout"
        }
      ],
      "ResponseStatus": {
        "Code": "0",
        "Description": "Failure"
      },
      "TransactionReference": {
        "CustomerContext": "54cb63ca-27e0-4f23-b11a-edebce4c2479"
      }
    }
  }
}

{
  "response": {
    "errors": [
      {
        "code": "4",
        "message": "Not found"
      },
      {
        "code": "6",
        "message": "Unauthorized"
      }
    ]
  }
}

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

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

{
  "response": {
    "errors": [
      {
        "code": "0",
        "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`	`"veniam qui officia"`
`transactionSrc`	`"cillum"`
`ShipperNumber`*	`"commodo mollit dolor consectetur officia"`

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": "27a3c187-1c4e-4f5e-82c5-d9",
    "Response": {
      "Alert": [
        {
          "Code": "4",
          "Description": "Permission denied"
        },
        {
          "Code": "8",
          "Description": "System timeout"
        },
        {
          "Code": "8",
          "Description": "Invalid document ID"
        },
        {
          "Code": "8",
          "Description": "Document already exists"
        },
        {
          "Code": "1",
          "Description": "System timeout"
        }
      ],
      "ResponseStatus": {
        "Code": "1",
        "Description": "Failure"
      },
      "TransactionReference": {
        "CustomerContext": "9101efad-a176-498a-a968-a812e2afaff5"
      }
    }
  }
}

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

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

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

{
  "response": {
    "errors": [
      {
        "code": "6",
        "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`	`"in aliquip adipisicing"`
`transactionSrc`	`"enim ullamco fugiat ad sunt"`
`ShipperNumber`*	`"laborum"`
`DocumentId`*	`"in nulla ad"`

Request Payload

Response Payload

{
  "DeleteResponse": {
    "Response": {
      "Alert": [
        {
          "Code": "4",
          "Description": "Document already exists"
        },
        {
          "Code": "2",
          "Description": "Permission denied"
        },
        {
          "Code": "5",
          "Description": "Permission denied"
        },
        {
          "Code": "2",
          "Description": "Invalid document ID"
        }
      ],
      "ResponseStatus": {
        "Code": "1",
        "Description": "Success"
      },
      "TransactionReference": {
        "CustomerContext": "53856583-d96b-43d8-a9aa-95037bc1927c"
      }
    }
  }
}

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

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

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

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

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`	`"in aliqua deserunt mollit ipsum"`
`transactionSrc`	`"sed laboris deserunt Excepteur"`
`ShipperNumber`*	`"in"`

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": "6",
          "Description": "Invalid document ID"
        }
      ],
      "ResponseStatus": {
        "Code": "1",
        "Description": "Success"
      },
      "TransactionReference": {
        "CustomerContext": "4fe8338a-6d2f-4448-b3a9-11e7edd9bde8"
      }
    }
  }
}

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

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

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

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

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`	`"veniam pariatur enim officia id"`
`transactionSrc`	`"sunt consequat"`
`ShipperNumber`*	`"tempor est exercitation"`

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": "ad4d44eb-5987-458d-8818-64",
    "Response": {
      "Alert": [
        {
          "Code": "5",
          "Description": "Permission denied"
        },
        {
          "Code": "9",
          "Description": "Permission denied"
        },
        {
          "Code": "0",
          "Description": "Document already exists"
        }
      ],
      "ResponseStatus": {
        "Code": "1",
        "Description": "Success"
      },
      "TransactionReference": {
        "CustomerContext": "5dcb5783-d939-4693-b83f-30d15c996884"
      }
    }
  }
}

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

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

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

{
  "response": {
    "errors": [
      {
        "code": "3",
        "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`	`"ut magna Lorem voluptate est"`
`transactionSrc`	`"cillum Excepteur ex pariatur"`
`ShipperNumber`*	`"in deserunt irure culpa incididunt"`
`DocumentId`*	`"fugiat ipsum quis dolore"`

Request Payload

Response Payload

{
  "DeleteResponse": {
    "Response": {
      "Alert": [
        {
          "Code": "6",
          "Description": "System timeout"
        },
        {
          "Code": "6",
          "Description": "Permission denied"
        },
        {
          "Code": "1",
          "Description": "System timeout"
        },
        {
          "Code": "8",
          "Description": "Document already exists"
        },
        {
          "Code": "3",
          "Description": "Permission denied"
        }
      ],
      "ResponseStatus": {
        "Code": "1",
        "Description": "Failure"
      },
      "TransactionReference": {
        "CustomerContext": "d8080772-9845-4037-ad86-298dc86d9146"
      }
    }
  }
}

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

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

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

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

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

upsshippinglogisticspaperlessdocuments