Skip to main content

Preview Order

Preview prospecting campaign order pricing.

Request Body
card_id integer — REQUIRED

ID of card

country string — REQUIRED

United States or Canada

insert_id integer

ID of the insert

message string — REQUIRED

Handwrytten message on the card

must_deliver_by string

Format: MM/DD/YYYY

records integer — REQUIRED

Number of cards to send

return_address_id integer — REQUIRED

ID of the return address

shipping_address_id integer

ID of the shipping address

shipping_method_id integer

Possible values: [1, 2, 3, 4, 5, 6]

Shipping method.

  • 1: Mail Normally
  • 2: Ship: Address, Seal, Stamp
  • 3: Ship: Cards Only (no envelope)
  • 4: Ship: Cards Only (blank envelope unsealed)
  • 5: Ship: Addressed & Unsealed
  • 6: Ship: Addressed & Sealed
shipping_rate_id integer

Possible values: [1, 2, 3, 4]

Shipping rate.

  • 1: Ground
  • 2: 2-Day
  • 3: Overnight
  • 4: Overnight Priority
Responses
200

OK

Schema — OPTIONAL
httpCode integer — OPTIONAL

Possible values: [200]

status string — OPTIONAL

Possible values: [ok]

prices object — OPTIONAL
tax number — OPTIONAL

Taxes

card_price number — OPTIONAL

Total cards cost

postage_price number — OPTIONAL

Postage cost

insert_price number — OPTIONAL

Inserts cost

shipping_price number — OPTIONAL

Shipping cost

without_tax number — OPTIONAL

Total order cost

total number — OPTIONAL

Total order cost with taxes

quantity integer — OPTIONAL

Number of cards

400

Bad Request

Schema — OPTIONAL
httpCode integer — OPTIONAL

Possible values: [400]

status string — OPTIONAL

Possible values: [error]

message string — OPTIONAL
440

Login Timeout

Schema — OPTIONAL
httpCode integer — OPTIONAL

Possible values: [440]

status string — OPTIONAL

Possible values: [error]

message string — OPTIONAL

Possible values: [Session has been expired.]

Error message