Cover sheets

GenerateCoversheetCall

Generates a cover sheet for sending in documents to Shoeboxed. Each cover sheet belongs to a particular user, and identifies which account the documents should be added to. The user may re-use the same cover sheet for multiple envelopes.

Parameters

Parameter Description
ApiUserToken See authentication.
SbxUserToken See authentication.
TargetUserId Optional. Used for multiseat accounts; administrators of multiseat accounts can create cover sheets for sub-users.

Request

<?xml version="1.0" encoding="utf-8"?>
<Request xmlns="urn:sbx:apis:SbxBaseComponents">
    <RequesterCredentials>
        <ApiUserToken>Ifa7nyQsrnSmkWiLqexFxpHWQkczZDuC5DDeP4RHXbXdibTgjA</ApiUserToken>
        <SbxUserToken>6f9d5eb8bfedff96bfcaa3f24764e9b5</SbxUserToken>
    </RequesterCredentials>
    <GenerateCoversheetCall>
        <TargetUserId>12834</TargetUserId>
    </GenerateCoversheetCall>
</Request>

Response

<?xml version="1.0" encoding="utf-8"?>
<GenerateCoversheetCallResponse>
    <Barcode>https://app.shoeboxed.com/barcodeGenerator.jpeg?data=HECE4WEN</Barcode>
    <URL>https://app.shoeboxed.com/api/coversheet/19289384/118c1482bd777cf8c637c5d84e900835</URL>
</GenerateCoversheetCallResponse>

Errors

<?xml version="1.0" encoding="utf-8"?>
<GenerateCoversheetCallResponse>
    <Error code="20" description="You cannot create a coversheet for a user you do not administer."/>
</GenerateCoversheetCallResponse>

<?xml version="1.0" encoding="utf-8"?>
<GenerateCoversheetCallResponse>
    <Error code="20" description="Cannot create coversheet. User is DIY and may not mail in documents."/>
</GenerateCoversheetCallResponse>