{"method":"GET","path":"https://api.revcent.com/v2/paypal_disputes","summary":"Get PayPal Disputes","description":"Returns a list of PayPal disputes previously created. Important: For counting, aggregations, metrics, data mining or document property search, use the BigQueryRunQuery operation instead. For bulk exports, refer to the bulk export utility guide at https://kb.revcent.com/en/revcent-account/bulk-export for more information. The date_start, date_end, page and limit URL parameters are required. The difference between date_start and date_end cannot exceed a 90 day period.","operationId":"GetPayPalDisputes","parameters":[{"description":"The date range start date as a unix timestamp in seconds.","in":"query","name":"date_start","required":true,"schema":{"type":"integer","format":"unix-time"},"style":"form"},{"description":"The date range end date as a unix timestamp in seconds.","in":"query","name":"date_end","required":true,"schema":{"type":"integer","format":"unix-time"},"style":"form"},{"description":"A limit on the number of objects to be returned. Limit can range between 1 and 25, and the default is 25.","in":"query","name":"limit","required":true,"schema":{"type":"integer","format":"int32","minimum":1,"maximum":25},"style":"form"},{"description":"Used for pagination, i.e. to skip to specific page of results.","in":"query","name":"page","required":true,"schema":{"type":"integer","format":"int32"},"style":"form"},{"name":"campaign_filter","in":"query","description":"To filter items based on one or more associated campaigns.","required":false,"schema":{"type":"array","items":{"type":"string","title":"Campaign ID","description":"A 20 character campaign ID.","minLength":20,"maxLength":20}},"style":"form","explode":true},{"name":"currency_filter","in":"query","description":"To filter items based on the three digit ISO 4217 currency code.","required":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"shop_filter","in":"query","description":"To filter items based on one or more associated shops.","required":false,"schema":{"type":"array","items":{"type":"string","description":"A 20 character user shop ID.","minLength":20,"maxLength":20}},"style":"form","explode":true},{"name":"paypal_account_filter","in":"query","description":"To filter items based on one or more associated PayPal accounts.","required":false,"schema":{"type":"array","items":{"type":"string","description":"A 20 character PayPal account ID.","minLength":20,"maxLength":20}},"style":"form","explode":true},{"name":"paypal_dispute_reason_filter","in":"query","description":"To filter based on the PayPal dispute reason in PayPal.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["MERCHANDISE_OR_SERVICE_NOT_RECEIVED","MERCHANDISE_OR_SERVICE_NOT_AS_DESCRIBED","UNAUTHORISED","CREDIT_NOT_PROCESSED","DUPLICATE_TRANSACTION","INCORRECT_AMOUNT","PAYMENT_BY_OTHER_MEANS","CANCELED_RECURRING_BILLING","PROBLEM_WITH_REMITTANCE","OTHER"]}},"style":"form","explode":true},{"name":"paypal_dispute_status_filter","in":"query","description":"To filter based on the PayPal dispute status in PayPal.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["OPEN","WAITING_FOR_BUYER_RESPONSE","WAITING_FOR_SELLER_RESPONSE","UNDER_REVIEW","RESOLVED","OTHER"]}},"style":"form","explode":true},{"description":"To filter only items which are related to a specific customer, using the customer ID.","in":"query","name":"customer_id","required":false,"schema":{"type":"string"},"style":"form"}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"encoding":{},"schema":{"additionalProperties":false,"properties":{},"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"description":"","properties":{"api_call_id":{"type":"string","description":"A 20 character API call ID.","minLength":20,"maxLength":20},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time"},"code":{"description":"API call response code.","type":"integer","format":"int32","enum":[1]},"current_count":{"description":"The current number of items in the results.","type":"integer"},"current_page":{"description":"The current page for the items in the results.","type":"integer"},"results":{"items":{"allOf":[{"type":"object","additionalProperties":false,"properties":{"created_date_unix":{"description":"The unix timestamp of when the item was created.","type":"integer","format":"unix-time"},"paypal_dispute_created_date_unix":{"description":"The unix timestamp of when the item was created in PayPal.","type":"integer","format":"unix-time"},"id":{"type":"string","description":"A 20 character PayPal dispute ID.","minLength":20,"maxLength":20},"paypal_dispute_id":{"description":"The dispute ID generated by PayPal.","type":"string"},"paypal_dispute_amount":{"description":"The PayPal dispute amount.","type":"number","format":"float"},"campaign_id":{"type":"string","title":"Campaign ID","description":"A 20 character campaign ID.","minLength":20,"maxLength":20},"campaign_name":{"type":"string","description":"The campaign name."},"customer":{"type":"object","description":"The customer response object contains the details of the customer related to the item.","additionalProperties":false,"properties":{"address_line_1":{"type":"string","description":"The customer first address line."},"address_line_2":{"type":"string","description":"The customer second address line."},"blocked":{"type":"boolean","description":"Whether the customer is blocked."},"city":{"type":"string","description":"The customer city."},"company":{"type":"string","description":"The customer company."},"country":{"type":"string","description":"The customer country in three letter ISO 3166-1 alpha-3 format."},"email":{"type":"string","format":"email","description":"The customer email."},"first_name":{"type":"string","description":"The customer first name."},"internal_id":{"type":"string","description":"An internal ID given by the user for the customer."},"last_name":{"type":"string","description":"The customer last name."},"phone":{"type":"string","description":"The customer phone."},"state":{"type":"string","description":"The customer state."},"zip":{"type":"string","description":"The customer ZIP and or postal code."},"created_date_unix":{"description":"The unix timestamp of when the item was created.","type":"integer","format":"unix-time"},"id":{"title":"Customer ID","type":"string","description":"A 20 character customer ID.","minLength":20,"maxLength":20},"enabled":{"type":"boolean","description":"Whether the customer is enabled."},"metadata":{"items":{"additionalProperties":false,"properties":{"name":{"type":"string","description":"A name paired to the value for the metadata object. Limited to 100 characters in length.","minLength":1,"maxLength":100},"value":{"type":"string","description":"A value paired to the name for the metadata object. Limited to 255 characters in length.","minLength":1,"maxLength":255}},"type":"object","required":["name","value"]},"type":"array","description":"An array of metadata objects, each metadata object being a name and value pair."},"updated_date_unix":{"description":"The unix timestamp of when the item was last updated.","type":"integer","format":"unix-time"}}},"iso_currency":{"type":"string","description":"The ISO currency code for the dispute."},"paypal_account":{"description":"The PayPal account associated with the dispute.","type":"object","additionalProperties":false,"properties":{"id":{"type":"string","description":"A 20 character PayPal account ID.","minLength":20,"maxLength":20},"name":{"description":"The PayPal account name.","type":"string"},"paypal_account_email":{"description":"The email associated with the PayPal account.","type":"string"}}},"paypal_status":{"description":"The current PayPal status of the dispute.","type":"string"},"paypal_reason":{"description":"The PayPal reason for the dispute.","type":"string"},"paypal_dispute_outcome":{"description":"The outcome of the PayPal dispute in PayPal.","type":"string"},"paypal_details_response":{"description":"The raw stringified JSON response from the PayPal API.","type":"string"},"paypal_messages":{"type":"array","description":"The messages from the PayPal API associated with the dispute.","items":{"type":"object","additionalProperties":false,"properties":{"time_posted":{"description":"The date and time when the message was posted in ISO8601 format.","type":"string","format":"date-time"},"posted_by":{"description":"The party within PayPal who posted the message.","type":"string"},"content":{"description":"The content of the message.","type":"string"}}}},"third_party_shop":{"description":"The originating user shop, if applicable.","additionalProperties":false,"properties":{"id":{"type":"string","description":"A 20 character user shop ID.","minLength":20,"maxLength":20},"name":{"description":"The user shop name.","type":"string"}},"type":"object"},"updated_date_unix":{"description":"The unix timestamp of when the item was last updated.","type":"integer","format":"unix-time"},"paypal_dispute_updated_date_unix":{"description":"The unix timestamp of when the item was last updated in PayPal.","type":"integer","format":"unix-time"}}},{"properties":{"sales":{"items":{"type":"string","description":"A 20 character sale ID.","minLength":20,"maxLength":20},"type":"array","description":"An array containing the ID's of all sales related to the item, each item in the array being a sale_id. Retrieve the details of each sale_id using the GetSale operation."},"product_sales":{"items":{"type":"string","description":"A 20 character product sale ID.","minLength":20,"maxLength":20},"type":"array","description":"An array containing the ID's of all product sales related to the item, each item in the array being a product_sale_id. Retrieve the details of each product_sale_id using the GetProductSale operation."},"shipping":{"items":{"type":"string","description":"A 20 character shipping ID.","minLength":20,"maxLength":20},"type":"array","description":"An array containing the ID's of all shipments related to the item, each item in the array being a shipping_id. Retrieve the details of each shipping_id using the GetShipment operation."},"tax":{"items":{"type":"string","description":"A 20 character tax ID.","minLength":20,"maxLength":20},"type":"array","description":"An array containing the ID's of all tax related to the item, each item in the array being a tax_id. Retrieve the details of each tax_id using the GetTax operation."},"discounts":{"items":{"type":"string","description":"A 20 character discount ID.","minLength":20,"maxLength":20},"type":"array","description":"An array containing the ID's of all discounts related to the item, each item in the array being a discount_id. Retrieve the details of each discount_id using the GetDiscount operation."},"trials":{"items":{"type":"string","description":"A 20 character trial ID.","minLength":20,"maxLength":20},"type":"array","description":"An array containing the ID's of all trials related to the item, each item in the array being a trial_id. Retrieve the details of each trial_id using the GetTrial operation."},"subscriptions":{"items":{"type":"string","description":"A 20 character subscription ID.","minLength":20,"maxLength":20},"type":"array","description":"An array containing the ID's of all subscriptions related to the item, each item in the array being a subscription_id. Retrieve the details of each subscription_id using the GetSubscription operation."},"subscription_renewals":{"items":{"type":"string","description":"A 20 character subscription renewal ID.","minLength":20,"maxLength":20},"type":"array","description":"An array containing the ID's of all subscription renewals related to the item, each item in the array being a subscription_renewal_id. Retrieve the details of each subscription_renewal_id using the GetSubscriptionRenewal operation."},"invoices":{"items":{"type":"string","description":"A 20 character invoice ID.","minLength":20,"maxLength":20},"type":"array","description":"An array containing the ID's of all invoices related to the item, each item in the array being an invoice_id. Retrieve the details of each invoice_id using the GetInvoice operation."},"transactions":{"items":{"type":"string","description":"A 20 character transaction ID.","minLength":20,"maxLength":20},"type":"array","description":"An array containing the ID's of all credit card transactions related to the item, each item in the array being a transaction_id. Retrieve the details of each transaction_id using the GetTransaction operation."},"ai_threads":{"items":{"type":"string","title":"AI Thread ID","description":"A 20 character AI Thread ID.","minLength":20,"maxLength":20},"type":"array","description":"An array containing the ID's of all AI Threads related to the item, each item in the array being an ai_thread_id. Retrieve the details of each ai_thread_id using the GetAIThread operation."},"ai_assistants":{"items":{"type":"string","title":"AI Assistant ID","description":"A 20 character AI Assistant ID.","minLength":20,"maxLength":20},"type":"array","description":"An array containing the ID's of all AI Assistants related to the item, each item in the array being an ai_assistant_id. Retrieve the details of each ai_assistant_id using the GetAIAssistant operation."},"paypal_transactions":{"items":{"type":"string","description":"A 20 character PayPal transaction ID.","minLength":20,"maxLength":20},"type":"array","description":"An array containing the ID's of all PayPal transactions related to the item, each item in the array being a paypal_transaction_id. Retrieve the details of each paypal_transaction_id using the GetPayPalTransaction operation."},"offline_payments":{"items":{"type":"string","description":"A 20 character offline payment ID.","minLength":20,"maxLength":20},"type":"array","description":"An array containing the ID's of all offline payments related to the item, each item in the array being a offline_payment_id. Retrieve the details of each offline_payment_id using the GetOfflinePayment operation."},"check_directs":{"items":{"type":"string","description":"A 20 character check direct ID.","minLength":20,"maxLength":20},"type":"array","description":"An array containing the ID's of all checks related to the item, each item in the array being a check_direct_id. Retrieve the details of each check_direct_id using the GetCheckDirect operation."},"salvage_transactions":{"items":{"type":"string","description":"A 20 character salvage transaction ID.","minLength":20,"maxLength":20},"type":"array","description":"An array containing the ID's of all salvage transactions related to the item, each item in the array being a salvage_transaction_id. Retrieve the details of each salvage_transaction_id using the GetSalvageTransaction operation."},"pending_refunds":{"items":{"type":"string","description":"A 20 character pending refund ID.","minLength":20,"maxLength":20},"type":"array","description":"An array containing the ID's of all pending refunds related to the item, each item in the array being a pending_refund_id. Retrieve the details of each pending_refund_id using the GetPendingRefund operation."},"chargebacks":{"items":{"type":"string","description":"A 20 character chargeback ID.","minLength":20,"maxLength":20},"type":"array","description":"An array containing the ID's of all chargebacks related to the item, each item in the array being a chargeback_id. Retrieve the details of each chargeback_id using the GetChargeback operation."},"fraud_detections":{"items":{"type":"string","description":"A 20 character fraud detection ID.","minLength":20,"maxLength":20},"type":"array","description":"An array containing the ID's of all fraud detections related to the item, each item in the array being a fraud_detection_id. Retrieve the details of each fraud_detection_id using the GetFraudDetection operation."},"api_calls":{"items":{"type":"string","description":"A 20 character API call ID.","minLength":20,"maxLength":20},"type":"array","description":"An array containing the ID's of all API calls related to the item, each item in the array being an api_call_id. Retrieve the details of each api_call_id using the GetAPICall operation."}},"type":"object","additionalProperties":false}]},"type":"array"},"total_count":{"description":"The total number of items found given the date_start and date_end query parameters.","type":"integer"},"total_pages":{"description":"The total number of pages given the date_start, date_end and limit query parameters.","type":"integer"}},"type":"object","additionalProperties":false}}},"description":"Successful response."},"default":{"content":{"application/json":{"schema":{"description":"","properties":{"api_call_id":{"type":"string","description":"A 20 character API call ID.","minLength":20,"maxLength":20},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time"},"code":{"description":"This value indicates that there is an error. Will always be 0.","type":"integer","enum":[0]},"error_code":{"description":"The specific error code.","type":"string"},"message":{"description":"A human readable description of the error.","type":"string"},"result":{"description":"A description of the API call result.","type":"string"}},"title":"APIStandardErrors","type":"object","additionalProperties":false}}},"description":"Error response."}}}