{"note":"OpenAPI conversion -- returning structured metadata","name":"ebay-com-sell-fulfillment","description":"Fulfillment API","version":"v1.20.7","base_url":"https://api.ebay.com/sell/fulfillment/v1","endpoints":15,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Fulfillment API\n@base https://api.ebay.com/sell/fulfillment/v1\n@version v1.20.7\n@auth OAuth2\n@endpoints 15\n@toc order(6), payment_dispute(8), payment_dispute_summary(1)\n\n@group order\n@endpoint GET /order/{orderId}\n@desc Use this call to retrieve the contents of an order based on its unique identifier, orderId. This value was returned in the  getOrders call's orders.orderId field when you searched for orders by creation date, modification date, or fulfillment status. Include the optional fieldGroups query parameter set to TAX_BREAKDOWN to return a breakdown of the taxes and fees.  The returned Order object contains information you can use to create and process fulfillments, including:  Information about the buyer and seller Information about the order's line items  The plans for packaging, addressing and shipping the order The status of payment, packaging, addressing, and shipping the order A summary of monetary amounts specific to the order such as pricing, payments, and shipping costs A summary of applied taxes and fees, and optionally a breakdown of each\n@required {orderId: str # This path parameter is used to specify the unique identifier of the order being retrieved. Use the getOrders method to retrieve order IDs. Order ID values are also shown in My eBay/Seller Hub.Note: getOrders can return orders up to two years old. Do not provide the orderId for an order created more than two years in the past.}\n@optional {fieldGroups: str # This parameter lets you control what is returned in the response.Note: The only presently supported value is TAX_BREAKDOWN. This field group adds addition fields to the response that return a breakdown of taxes and fees.}\n@returns(200) {buyer: map{buyerRegistrationAddress: map{companyName: str, contactAddress: map{addressLine1: str, addressLine2: str, city: str, countryCode: str, county: str, postalCode: str, stateOrProvince: str}, email: str, fullName: str, primaryPhone: map{phoneNumber: str}}, taxAddress: map{city: str, countryCode: str, postalCode: str, stateOrProvince: str}, taxIdentifier: map{taxpayerId: str, taxIdentifierType: str, issuingCountry: str}, username: str}, buyerCheckoutNotes: str, cancelStatus: map{cancelledDate: str, cancelRequests: [map], cancelState: str}, creationDate: str, ebayCollectAndRemitTax: bool, fulfillmentHrefs: [str], fulfillmentStartInstructions: [map], lastModifiedDate: str, lineItems: [map], orderFulfillmentStatus: str, orderId: str, orderPaymentStatus: str, paymentSummary: map{payments: [map], refunds: [map], totalDueSeller: map{convertedFromCurrency: str, convertedFromValue: str, currency: str, value: str}}, pricingSummary: map{adjustment: map{convertedFromCurrency: str, convertedFromValue: str, currency: str, value: str}, deliveryCost: map{convertedFromCurrency: str, convertedFromValue: str, currency: str, value: str}, deliveryDiscount: map{convertedFromCurrency: str, convertedFromValue: str, currency: str, value: str}, fee: map{convertedFromCurrency: str, convertedFromValue: str, currency: str, value: str}, priceDiscount: map{convertedFromCurrency: str, convertedFromValue: str, currency: str, value: str}, priceSubtotal: map{convertedFromCurrency: str, convertedFromValue: str, currency: str, value: str}, tax: map{convertedFromCurrency: str, convertedFromValue: str, currency: str, value: str}, total: map{convertedFromCurrency: str, convertedFromValue: str, currency: str, value: str}}, program: map{authenticityVerification: map{outcomeReason: str, status: str}, ebayShipping: map{shippingLabelProvidedBy: str}, ebayVault: map{fulfillmentType: str}, ebayInternationalShipping: map{returnsManagedBy: str}, fulfillmentProgram: map{fulfilledBy: str}}, salesRecordReference: str, sellerId: str, totalFeeBasisAmount: map{convertedFromCurrency: str, convertedFromValue: str, currency: str, value: str}, totalMarketplaceFee: map{convertedFromCurrency: str, convertedFromValue: str, currency: str, value: str}} # Success\n@errors {400: Bad Request, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /order\n@desc Use this method to search for and retrieve one or more orders based on their creation date, last modification date, or fulfillment status using the filter parameter. You can alternatively specify a list of orders using the orderIds parameter. Include the optional fieldGroups query parameter set to TAX_BREAKDOWN to return a breakdown of the taxes and fees. By default, when no filters are used this call returns all orders created within the last 90 days.  The returned Order objects contain information you can use to create and process fulfillments, including:  Information about the buyer and seller Information about the order's line items The plans for packaging, addressing and shipping the order The status of payment, packaging, addressing, and shipping the order A summary of monetary amounts specific to the order such as pricing, payments, and shipping costs A summary of applied taxes and fees, and optionally a breakdown of each   Important: In this call, the cancelStatus.cancelRequests array is returned but is always empty. Use the getOrder call instead, which returns this array fully populated with information about any cancellation requests.\n@optional {fieldGroups: str # This parameter lets you control what is returned in the response.Note: The only presently supported value is TAX_BREAKDOWN. This field group adds addition fields to the response that return a breakdown of taxes and fees., filter: str # One or more comma-separated criteria for narrowing down the collection of orders returned by this call. These criteria correspond to specific fields in the response payload. Multiple filter criteria combine to further restrict the results. Note: getOrders can return orders up to two years old. Do not set the creationdate filter to a date beyond two years in the past.Note: If the orderIds parameter is included in the request, the filter parameter will be ignored.The available criteria are as follows:  creationdate The time period during which qualifying orders were created (the orders.creationDate field). In the URI, this is expressed as a starting timestamp, with or without an ending timestamp (in brackets). The timestamps are in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock.For example:  creationdate:[2016-02-21T08:25:43.511Z..] identifies orders created on or after the given timestamp. creationdate:[2016-02-21T08:25:43.511Z..2016-04-21T08:25:43.511Z] identifies orders created between the given timestamps, inclusive.   lastmodifieddate The time period during which qualifying orders were last modified (the orders.modifiedDate field).  In the URI, this is expressed as a starting timestamp, with or without an ending timestamp (in brackets). The timestamps are in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock.For example:  lastmodifieddate:[2016-05-15T08:25:43.511Z..] identifies orders modified on or after the given timestamp. lastmodifieddate:[2016-05-15T08:25:43.511Z..2016-05-31T08:25:43.511Z] identifies orders modified between the given timestamps, inclusive.  Note: If creationdate and lastmodifieddate are both included, only creationdate is used.  orderfulfillmentstatus The degree to which qualifying orders have been shipped (the orders.orderFulfillmentStatus field). In the URI, this is expressed as one of the following value combinations:  orderfulfillmentstatus:{NOT_STARTED|IN_PROGRESS} specifies orders for which no shipping fulfillments have been started, plus orders for which at least one shipping fulfillment has been started but not completed. orderfulfillmentstatus:{FULFILLED|IN_PROGRESS} specifies orders for which all shipping fulfillments have been completed, plus orders for which at least one shipping fulfillment has been started but not completed.  Note: The values NOT_STARTED, IN_PROGRESS, and FULFILLED can be used in various combinations, but only the combinations shown here are currently supported.   Here is an example of a getOrders call using all of these filters:  GET https://api.ebay.com/sell/v1/order?filter=creationdate:%5B2016-03-21T08:25:43.511Z..2016-04-21T08:25:43.511Z%5D,lastmodifieddate:%5B2016-05-15T08:25:43.511Z..%5D,orderfulfillmentstatus:%7BNOT_STARTED%7CIN_PROGRESS%7D  Note: This call requires that certain special characters in the URI query string be percent-encoded:      [ = %5B       ] = %5D       { = %7B       | = %7C       } = %7D  This query filter example uses these codes. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/fulfillment/types/api:FilterField, limit: str # The number of orders to return per page of the result set. Use this parameter in conjunction with the offset parameter to control the pagination of the output. For example, if offset is set to 10 and limit is set to 10, the call retrieves orders 11 thru 20 from the result set.  If a limit is not set, the limit defaults to 50 and returns up to 50 orders. If a requested limit is more than 200, the call fails and returns an error. Note: This feature employs a zero-based list, where the first item in the list has an offset of 0. If the orderIds parameter is included in the request, this parameter will be ignored.  Maximum: 200  Default: 50, offset: str # Specifies the number of orders to skip in the result set before returning the first order in the paginated response.  Combine offset with the limit query parameter to control the items returned in the response. For example, if you supply an offset of 0 and a limit of 10, the first page of the response contains the first 10 items from the complete list of items retrieved by the call. If offset is 10 and limit is 20, the first page of the response contains items 11-30 from the complete result set. Default: 0, orderIds: str # A comma-separated list of the unique identifiers of the orders to retrieve (maximum 50). If one or more order ID values are specified through the orderIds query parameter, all other query parameters will be ignored.Note: getOrders can return orders up to two years old. Do not provide the orderId for an order created more than two years in the past.}\n@returns(200) {href: str, limit: int(int32), next: str, offset: int(int32), orders: [map], prev: str, total: int(int32), warnings: [map]} # Success\n@errors {400: Bad Request, 500: Internal Server Error}\n\n@endpoint POST /order/{order_id}/issue_refund\n@desc Issue Refund\n@required {order_id: str # This path parameter is used to specify the unique identifier of the order associated with a refund.Use the getOrders method to retrieve order IDs., Content-Type: str # This header indicates the format of the request body provided by the client. Its value should be set to application/json.  For more information, refer to HTTP request headers.}\n@optional {reasonForRefund: str # The enumeration value passed into this field indicates the reason for the refund. One of the defined enumeration values in the ReasonForRefundEnum type must be used.This field is required, and it is highly recommended that sellers use the correct refund reason, especially in the case of a buyer-requested cancellation or 'buyer remorse' return to indicate that there was nothing wrong with the item(s) or with the shipment of the order.Note: If issuing refunds for more than one order line item, keep in mind that the refund reason must be the same for each of the order line items. If the refund reason is different for one or more order line items in an order, the seller would need to make separate issueRefund calls, one for each refund reason.  For implementation help, refer to eBay API documentation, comment: str # This free-text field allows the seller to clarify why the refund is being issued to the buyer.Max Length: 100, refundItems: [map{refundAmount: map, lineItemId: str, legacyReference: map}] # The refundItems array is only required if the seller is issuing a refund for one or more individual order line items in a multiple line item order. Otherwise, the seller just uses the orderLevelRefundAmount container to specify the amount of the refund for the entire order., orderLevelRefundAmount: map{currency: str, value: str} # This type defines the monetary value of the payment dispute, and the currency used.}\n@returns(200) {refundId: str, refundStatus: str} # OK\n@errors {400: Bad Request, 403: Access Forbidden, 404: Resource Not found, 409: Conflict, 500: Internal Server Error}\n\n@endpoint GET /order/{orderId}/shipping_fulfillment\n@desc Use this call to retrieve the contents of all fulfillments currently defined for a specified order based on the order's unique identifier, orderId. This value is returned in the getOrders call's members.orderId field when you search for orders by creation date or shipment status.\n@required {orderId: str # This path parameter is used to specify the unique identifier of the order associated with the shipping fulfillments being retrieved.Use the getOrders method to retrieve order IDs. Order ID values are also shown in My eBay/Seller Hub.}\n@returns(200) {fulfillments: [map], total: int(int32), warnings: [map]} # Success\n@errors {400: Bad Request, 500: Internal Server Error}\n\n@endpoint POST /order/{orderId}/shipping_fulfillment\n@desc When you group an order's line items into one or more packages, each package requires a corresponding plan for handling, addressing, and shipping; this is a shipping fulfillment. For each package, execute this call once to generate a shipping fulfillment associated with that package.  Note: A single line item in an order can consist of multiple units of a purchased item, and one unit can consist of multiple parts or components. Although these components might be provided by the manufacturer in separate packaging, the seller must include all components of a given line item in the same package. Before using this call for a given package, you must determine which line items are in the package. If the package has been shipped, you should provide the date of shipment in the request. If not provided, it will default to the current date and time.\n@required {orderId: str # This path parameter is used to specify the unique identifier of the order associated with the shipping fulfillment being created. Use the getOrders method to retrieve order IDs., Content-Type: str # This header indicates the format of the request body provided by the client. Its value should be set to application/json.  For more information, refer to HTTP request headers.}\n@optional {lineItems: [map{lineItemId: str, quantity: int(int32)}] # This array contains a list of or more line items and the quantity that will be shipped in the same package., shippedDate: str # This is the actual date and time that the fulfillment package was shipped. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock. The seller should use the actual date/time that the package was shipped, but if this field is omitted, it will default to the current date/time.Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2015-08-04T19:09:02.768ZDefault: The current date and time., shippingCarrierCode: str # The unique identifier of the shipping carrier being used to ship the line item(s). Technically, the shippingCarrierCode and trackingNumber fields are optional, but generally these fields will be provided if the shipping carrier and tracking number are known. Note: Use the Trading API's GeteBayDetails call to retrieve the latest shipping carrier enumeration values. When making the GeteBayDetails call, include the DetailName field in the request payload and set its value to ShippingCarrierDetails. Each valid shipping carrier enumeration value is returned in a ShippingCarrierDetails.ShippingCarrier field in the response payload., trackingNumber: str # The tracking number provided by the shipping carrier for this fulfillment. The seller should be careful that this tracking number is accurate since the buyer will use this tracking number to track shipment, and eBay has no way to verify the accuracy of this number.This field and the shippingCarrierCode field are mutually dependent. If you include one, you must also include the other.Note: If you include trackingNumber (and shippingCarrierCode) in the request, the resulting fulfillment's ID (returned in the HTTP location response header) is the tracking number. If you do not include shipment tracking information, the resulting fulfillment ID will default to an arbitrary number such as 999.Note: Only alphanumeric characters are supported for shipment tracking numbers. Spaces, hyphens, and all other special characters are not supported. Do not include a space in the tracking number even if a space appears in the tracking number on the shipping label.}\n@returns(201) Created. The call also returns the following location response header: {ENV}/sell/fulfillment/v1/order/{ORDERID}/shipping_fulfillment/{FULFILLMENTID} The ENV string is the HTTPS path to the same eBay supported environment in which this call was issued. The ORDERID parameter is the unique identifier of the order addressed by this call; for example, 01-03955-36441. The FULFILLMENTID parameter identifies the newly created fulfillment; for example, 9405509699937003457459. Use this Get Fulfillment URI to retrieve the contents of the new fulfillment.\n@errors {400: Bad Request, 409: Conflict, 500: Internal Server Error}\n\n@endpoint GET /order/{orderId}/shipping_fulfillment/{fulfillmentId}\n@desc Use this call to retrieve the contents of a fulfillment based on its unique identifier, fulfillmentId (combined with the associated order's orderId). The fulfillmentId value was originally generated by the createShippingFulfillment call, and is returned by the getShippingFulfillments call in the members.fulfillmentId field.\n@required {fulfillmentId: str # This path parameter is used to specify the unique identifier of the shipping fulfillment being retrieved.Use the getShippingFulfillments method to retrieved fulfillment IDs., orderId: str # This path parameter is used to specify the unique identifier of the order associated with the shipping fulfillment being retrieved. Use the getOrders method to retrieve order IDs. Order ID values are also shown in My eBay/Seller Hub.}\n@returns(200) {fulfillmentId: str, lineItems: [map], shipmentTrackingNumber: str, shippedDate: str, shippingCarrierCode: str} # Success\n@errors {400: Bad Request, 404: Not Found, 500: Internal Server Error}\n\n@endgroup\n\n@group payment_dispute\n@endpoint GET /payment_dispute/{payment_dispute_id}\n@desc Get Payment Dispute Details\n@required {payment_dispute_id: str # This parameter is used to specify the unique identifier of the payment dispute being retrieved. Use the getPaymentDisputeSummaries method to retrieve payment dispute IDs.}\n@returns(200) {amount: map{currency: str, value: str}, availableChoices: [str], buyerProvided: map{contentOnHold: bool, note: str, returnShipmentTracking: [map]}, buyerUsername: str, closedDate: str, evidence: [map], evidenceRequests: [map], lineItems: [map], monetaryTransactions: [map], note: str, openDate: str, orderId: str, paymentDisputeId: str, paymentDisputeStatus: str, reason: str, resolution: map{fees: map{currency: str, value: str}, protectedAmount: map{currency: str, value: str}, protectionStatus: str, reasonForClosure: str, recoupAmount: map{currency: str, value: str}, totalFeeCredit: map{currency: str, value: str}}, respondByDate: str, returnAddress: map{addressLine1: str, addressLine2: str, city: str, country: str, county: str, fullName: str, postalCode: str, primaryPhone: map{countryCode: str, number: str}, stateOrProvince: str}, revision: int(int32), sellerResponse: str} # Success\n@errors {400: Bad Request, 404: Invalid Payment Dispute Id, 500: Internal Server Error}\n\n@endpoint GET /payment_dispute/{payment_dispute_id}/fetch_evidence_content\n@desc Get Payment Dispute Evidence File\n@required {payment_dispute_id: str # This path parameter is used to specify the unique identifier of the payment dispute associated with the evidence file being retrieved. Use the getPaymentDisputeSummaries method to retrieve payment dispute IDs., evidence_id: str # This query parameter is used to specify the unique identifier of the evidential file set.The identifier of an evidential file set for a payment dispute is returned under the evidence array in the getPaymentDispute response., file_id: str # This query parameter is used to specify the unique identifier of an evidential file. This file must belong to the evidential file set identified through the evidence_id query parameter.The identifier of each evidential file is returned under the evidence.files array in the getPaymentDispute response.}\n@returns(200) Success\n@errors {400: Bad Request, 404: Invalid Payment Dispute Id, 500: Internal Server Error}\n\n@endpoint GET /payment_dispute/{payment_dispute_id}/activity\n@desc Get Payment Dispute Activity\n@required {payment_dispute_id: str # This parameter is used to specify the unique identifier of the payment dispute associated with the activity log being retrieved. Use the getPaymentDisputeSummaries method to retrieve payment dispute IDs.}\n@returns(200) {activity: [map]} # Success\n@errors {400: Bad Request, 404: Invalid Payment Dispute Id, 500: Internal Server Error}\n\n@endgroup\n\n@group payment_dispute_summary\n@endpoint GET /payment_dispute_summary\n@desc Search Payment Dispute by Filters\n@optional {order_id: str # This filter is used if the seller wishes to retrieve one or more payment disputes filed against a specific order. It is possible that there can be more than one dispute filed against an order if the order has multiple line items. If this filter is used, any other filters are ignored.Use the getOrders method to retrieve order IDs. Order ID values are also shown in My eBay/Seller Hub., buyer_username: str # This filter is used if the seller wishes to retrieve one or more payment disputes opened by a specific buyer. The string that is passed in to this query parameter is the eBay user ID of the buyer., open_date_from: str # The open_date_from and/or open_date_to date filters are used if the seller wishes to retrieve payment disputes opened within a specific date range. A maximum date range that may be set with the open_date_from and/or open_date_to filters is 90 days. These date filters use the ISO-8601 24-hour date and time format, and time zone used is Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu.The open_date_from field sets the beginning date of the date range, and can be set as far back as 18 months from the present time. If a open_date_from field is used, but a open_date_to field is not used, the open_date_to value will default to 90 days after the date specified in the open_date_from field, or to the present time if less than 90 days in the past.The ISO-8601 format looks like this: yyyy-MM-ddThh:mm.ss.sssZ. An example would be 2019-08-04T19:09:02.768Z., open_date_to: str # The open_date_from and/or open_date_to date filters are used if the seller wishes to retrieve payment disputes opened within a specific date range. A maximum date range that may be set with the open_date_from and/or open_date_to filters is 90 days. These date filters use the ISO-8601 24-hour date and time format, and the time zone used is Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu.The open_date_to field sets the ending date of the date range, and can be set up to 90 days from the date set in the open_date_from field. The ISO-8601 format looks like this: yyyy-MM-ddThh:mm.ss.sssZ. An example would be 2019-08-04T19:09:02.768Z., payment_dispute_status: str # This filter is used if the seller wishes to only retrieve payment disputes in one or more specific states. To filter by more than one status value, a separate payment_dispute_status filter must be used for each value, as shown below:https://apiz.ebay.com/sell/fulfillment/v1/payment_dispute_summary?payment_dispute_status=OPEN&payment_dispute_status=ACTION_NEEDED If no payment_dispute_status filter is used, payment disputes in all states are returned in the response.See DisputeStatusEnum type for supported values., limit: str # The value passed in this query parameter sets the maximum number of payment disputes to return per page of data. The value passed in this field should be an integer from 1 to 200. If this query parameter is not set, up to 200 records will be returned on each page of results.Min: 1 Max: 200Default: 200, offset: str # This field is used to specify the number of records to skip in the result set before returning the first payment dispute in the paginated response. A zero-based index is used, so if you set the offset value to 0 (default value), the first payment dispute in the result set appears at the top of the response. Combine offset with the limit parameter to control the payment disputes returned in the response. For example, if you supply an offset value of 0 and a limit value of 10, the response will contain the first 10 payment disputes from the result set that matches the input criteria. If you supply an offset value of 10 and a limit value of 20, the response will contain payment disputes 11-30 from the result set that matches the input criteria.Min: 0 Default: 0}\n@returns(200) {href: str, limit: int(int32), next: str, offset: int(int32), paymentDisputeSummaries: [map], prev: str, total: int(int32)} # Success\n@errors {400: Bad Request, 500: Internal Server Error}\n\n@endgroup\n\n@group payment_dispute\n@endpoint POST /payment_dispute/{payment_dispute_id}/contest\n@desc Contest Payment Dispute\n@required {payment_dispute_id: str # This parameter is used to specify the unique identifier of the payment dispute being contested.  Use the getPaymentDisputeSummaries method to retrieve payment dispute IDs., Content-Type: str # This header indicates the format of the request body provided by the client. Its value should be set to application/json.  For more information, refer to HTTP request headers.}\n@optional {note: str # This field shows information that the seller provides about the dispute, such as the basis for the dispute, any relevant evidence, tracking numbers, and so forth.Max Length: 1000 characters., returnAddress: map{addressLine1: str, addressLine2: str, city: str, country: str, county: str, fullName: str, postalCode: str, primaryPhone: map, stateOrProvince: str} # This type is used by the payment dispute methods, and is relevant if the buyer will be returning the item to the seller., revision: int(int32) # This integer value indicates the revision number of the payment dispute. This field is required. The current revision number for a payment dispute can be retrieved with the getPaymentDispute method. Each time an action is taken against a payment dispute, this integer value increases by 1.}\n@returns(204) Success\n@errors {400: Bad Request, 404: Not Found, 409: Conflict, 500: Internal Server Error}\n\n@endpoint POST /payment_dispute/{payment_dispute_id}/accept\n@desc Accept Payment Dispute\n@required {payment_dispute_id: str # This parameter is used to specify the unique identifier of the payment dispute being accepted.  Use the getPaymentDisputeSummaries method to retrieve payment dispute IDs., Content-Type: str # This header indicates the format of the request body provided by the client. Its value should be set to application/json.  For more information, refer to HTTP request headers.}\n@optional {returnAddress: map{addressLine1: str, addressLine2: str, city: str, country: str, county: str, fullName: str, postalCode: str, primaryPhone: map, stateOrProvince: str} # This type is used by the payment dispute methods, and is relevant if the buyer will be returning the item to the seller., revision: int(int32) # This integer value indicates the revision number of the payment dispute. This field is required. The current revision number for a payment dispute can be retrieved with the getPaymentDispute method. Each time an action is taken against a payment dispute, this integer value increases by 1.}\n@returns(204) Success\n@errors {400: Bad Request, 404: Not Found, 409: Conflict, 500: Internal Server Error}\n\n@endpoint POST /payment_dispute/{payment_dispute_id}/upload_evidence_file\n@desc Upload an Evidence File\n@required {payment_dispute_id: str # This parameter is used to specify the unique identifier of the contested payment dispute for which the user intends to upload an evidence file. Use the getPaymentDisputeSummaries method to retrieve payment dispute IDs., Content-Type: str # This header indicates the format of the request body provided by the client. Its value should be set to multipart/form-data.  For more information, refer to HTTP request headers.}\n@returns(200) {fileId: str} # Success\n@errors {400: Bad Request, 404: Not Found, 409: Conflict, 500: Internal Server Error}\n\n@endpoint POST /payment_dispute/{payment_dispute_id}/add_evidence\n@desc Add an Evidence File\n@required {payment_dispute_id: str # This parameter is used to specify the unique identifier of the contested payment dispute for which the seller wishes to add evidence files.  Use the getPaymentDisputeSummaries method to retrieve payment dispute IDs., Content-Type: str # This header indicates the format of the request body provided by the client. Its value should be set to application/json.  For more information, refer to HTTP request headers.}\n@optional {evidenceType: str # This field is used to indicate the type of evidence being provided through one or more evidence files. All evidence files (if more than one) should be associated with the evidence type passed in this field.See the EvidenceTypeEnum type for the supported evidence types. For implementation help, refer to eBay API documentation, files: [map{fileId: str}] # This array is used to specify one or more evidence files that will become part of a new evidence set associated with a payment dispute. At least one evidence file must be specified in the files array., lineItems: [map{itemId: str, lineItemId: str}] # This array identifies the order line item(s) for which the evidence file(s) will be applicable.These values are returned under the evidenceRequests.lineItems array in the getPaymentDispute response.}\n@returns(200) {evidenceId: str} # Success\n@errors {400: Bad Request, 404: Not Found, 409: Conflict, 500: Internal Server Error}\n\n@endpoint POST /payment_dispute/{payment_dispute_id}/update_evidence\n@desc Update evidence\n@required {payment_dispute_id: str # This parameter is used to specify the unique identifier of the contested payment dispute for which the user plans to update the evidence set. Use the getPaymentDisputeSummaries method to retrieve payment dispute IDs., Content-Type: str # This header indicates the format of the request body provided by the client. Its value should be set to application/json.  For more information, refer to HTTP request headers.}\n@optional {evidenceId: str # The unique identifier of the evidence set that is being updated with new evidence files. This ID is returned under the evidence array in the getPaymentDispute response., evidenceType: str # This field is used to indicate the type of evidence being provided through one or more evidence files. All evidence files (if more than one) should be associated with the evidence type passed in this field.See the EvidenceTypeEnum type for the supported evidence types. For implementation help, refer to eBay API documentation, files: [map{fileId: str}] # This array is used to specify one or more evidence files that will be added to the evidence set associated with a payment dispute. At least one evidence file must be specified in the files array. The unique identifier of an evidence file is returned in the response payload of the uploadEvidence method., lineItems: [map{itemId: str, lineItemId: str}] # This required array identifies the order line item(s) for which the evidence file(s) will be applicable. These values are returned under the evidenceRequests.lineItems array in the getPaymentDispute response. Note: Both the itemId and lineItemID fields are needed to identify each order line item.}\n@returns(204) Success\n@errors {400: Bad Request, 404: Not Found, 409: Conflict, 500: Internal Server Error}\n\n@endgroup\n\n@end\n"}