Ship Status Changed

This message indicates that the ship_status of an order has changed, from ‘not_shipped’ to shipped (e.g. when an order is marked shipped).

Ship Status Changed is an invoice level message; it will be sent once for each shipping status change on an invoice and will contain information about all items ordered.


Message Parameters

ParameterTypeDescription
message_typeUpper Case TextIndicates type of message (ORDER_CREATED, FRAUD_STATUS_CHANGED, SHIP_STATUS_CHANGED, INVOICE_STATUS_CHANGED, REFUND_ISSUED, RECURRING_INSTALLMENT_SUCCESS, RECURRING_INSTALLMENT_FAILED, RECURRING_STOPPED, RECURRING_COMPLETE, or RECURRING_RESTARTED )
message_descriptionTextHuman readable description of message_type
timestampTimestampTimestamp of event; format YYYY-MM-DD HH:MM:SS ZZZ
md5_hashUpper Case TextUPPERCASE(MD5_ENCRYPTED(sale_id + vendor_id + invoice_id + Secret Word)); Can be used to validate authenticity of message
message_idNumericThis number is incremented for each message sent to a given seller.
key_countNumericIndicates the number of parameters sent in message
vendor_idNumericSeller account number
sale_idNumericFloospay sale number
sale_date_placedDateDate of sale; format YYYY-MM-DD
vendor_order_idTextCustom order id provided by seller, if available. (“merchant_order_id” can be passed into the checkout with the sale parameters)
invoice_idNumericFloospay invoice number; Each sale can have several invoices, most commonly one per installment billed on a recurring order.
recurringNumericrecurring=1 if any item on the invoice is a recurring item, 0 otherwise
payment_typeLower Case TextBuyer’s payment method (credit card, online check, paypal ec, OR paypal pay later)
list_currencyUpper Case Text3-Letter ISO code for seller currency
cust_currencyUpper Case Text3-Letter ISO code for buyer currency
auth_expDateThe date credit authorization will expire; format YYYY-MM-DD
invoice_statusLower Case TextStatus of a transaction (approved, pending, deposited, or declined)
fraud_statusLower Case TextStatus of Floospay fraud review (pass, fail, or wait); This parameter could be empty on some sales.
invoice_list_amountNumericTotal in seller pricing currency; format as appropriate to currency (2 decimal places for most, integer for JPY)
invoice_usd_amountNumericTotal in US Dollars; format with 2 decimal places
invoice_cust_amountNumericTotal in buyer currency; format as appropriate to currency (2 decimal places for most, integer for JPY)
customer_first_nameTextBuyer’s first name (may not be available on older sales)
customer_last_nameTextBuyer’s last name (may not be available on older sales)
customer_nameTextBuyer’s full name (name as it appears on credit card)
customer_emailTextBuyer’s email address
customer_phoneNumericBuyer’s phone number; all but digits stripped out
customer_ipTextBuyer’s IP address at time of sale
customer_ip_countryTextCountry of record for buyer’s IP address at time of sale; Please note in some cases what is returned is not a country, Ex. Satellite Provider
bill_street_addressTextBilling street address
bill_street_address2TextBilling street address line 2
bill_cityTextBilling address city
bill_stateTextBilling address state or province
bill_postal_codeTextBilling address postal code
bill_countryText3-Letter ISO country code of billing address
ship_statusLower Case TextValue will be not_shipped, shipped, or empty (if intangible / does not need shipped)
ship_tracking_numberTextTracking Number as entered in Seller Admin
ship_nameTextShipping Recipient’s name (as it should appears on shipping label)
ship_street_addressTextShipping street address
ship_street_address2TextShipping street address line 2
ship_cityTextShipping address city
ship_stateTextShipping address state or province
ship_postal_codeTextShipping address postal code
ship_countryUpper Case Text3-Letter ISO country code of shipping address
item_countNumericIndicates how many numbered sets of item parameters to expect
item_name_#TextProduct name
item_id_#TextSeller product id
item_list_amount_#NumericTotal in seller pricing currency; format as appropriate to currency (2 decimal places for most, integer for JPY)
item_usd_amount_#NumericTotal in US Dollars; format with 2 decimal places
item_cust_amount_#NumericTotal in buyer currency; format as appropriate to currency (2 decimal places for most, integer for JPY)
item_type_#Lower Case TextIndicates if item is a bill or refund; Value will be bill or refund
item_duration_#TextProduct duration, how long it re-bills for Ex. 1 Year
item_recurrence_#TextProduct recurrence, how often it re-bills Ex. 1 Month
item_rec_list_amount_#NumericProduct price; format as appropriate to currency (2 decimal places for most, integer for JPY)
item_rec_status_#Lower Case TextIndicates status of recurring subscription: live, canceled, or completed
item_rec_date_next_#DateDate of next recurring installment; format YYYY-MM-DD
item_rec_install_billed_#NumericThe number of successful recurring installments successfully billed


Example Message

   {
        auth_exp => 2012-04-11
        bill_city => Columbus
        bill_country => USA
        bill_postal_code => 43215
        bill_state => OH
        bill_street_address => ​855 Grandview Avenue
        bill_street_address2 => Suite 11
        cust_currency => USD
        customer_email => no-reply@Floospay.com
        customer_first_name => Testing
        customer_ip => 66.194.132.135
        customer_ip_country => United States
        customer_last_name => Tester
        customer_name => Testing T Tester
        customer_phone => 6149212450
        fraud_status => wait
        invoice_cust_amount => 1.00
        invoice_id => 4676292911
        invoice_list_amount => 1.00
        invoice_status => pending
        invoice_usd_amount => 1.00
        item_count => 2
        item_cust_amount_1 => 1.00
        item_cust_amount_2 => 0.00
        item_duration_1 =>
        item_duration_2 =>
        item_id_1 => program1
        item_id_2 =>
        item_list_amount_1 => 1.00
        item_list_amount_2 => 0.00
        item_name_1 => test tangible
        item_name_2 => Shipping: free
        item_rec_date_next_1 =>
        item_rec_date_next_2 =>
        item_rec_install_billed_1 =>
        item_rec_install_billed_2 =>
        item_rec_list_amount_1 =>
        item_rec_list_amount_2 =>
        item_rec_status_1 =>
        item_rec_status_2 =>
        item_recurrence_1 =>
        item_recurrence_2 =>
        item_type_1 => bill
        item_type_2 => bill
        item_usd_amount_1 => 1.00
        item_usd_amount_2 => 0.00
        key_count => 68
        list_currency => USD
        md5_hash => 51D583E49E661FB64FD51D8505F3CCA1
        message_description => Shipping status changed
        message_id => 2807
        message_type => SHIP_STATUS_CHANGED
        payment_type => paypal ec
        recurring => 0
        sale_date_placed => 2012-04-04 13:56:26
        sale_id => 4676292902
        ship_city => Columbus
        ship_country => USA
        ship_name => Testing Tester
        ship_postal_code => 43215
        ship_state => OH
        ship_status => shipped
        ship_street_address => ​855 Grandview Avenue
        ship_street_address2 => Suite 11
        ship_tracking_number => 123
        timestamp => 2012-04-04 13:58:20
        vendor_id => 532001
        vendor_order_id =>
    }

-============ 2 ===========--