{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/ecommerce:ebay-sell-fulfillment/get-orders":{"get":{"operationId":"ecommerce_ebay_sell_fulfillment_get_orders","summary":"Use this call to search for and retrieve one or more orders based on their creation date, last modification…","description":"GET /order","tags":["ecommerce"],"parameters":[{"name":"fieldGroups","in":"query","required":false,"description":"The response type associated with the order. The only presently supported value is TAX_BREAKDOWN . This type returns a breakdown of tax…","schema":{"type":"string","description":"The response type associated with the order. The only presently supported value is TAX_BREAKDOWN . This type returns a breakdown of tax…"}},{"name":"filter","in":"query","required":false,"description":"One or more comma-separated criteria for narrowing down the collection of orders returned by this call. These criteria correspond to…","schema":{"type":"string","description":"One or more comma-separated criteria for narrowing down the collection of orders returned by this call. These criteria correspond to…"}},{"name":"limit","in":"query","required":false,"description":"The number of orders to return per page of the result set. Use this parameter in conjunction with the offset parameter to control the…","schema":{"type":"string","description":"The number of orders to return per page of the result set. Use this parameter in conjunction with the offset parameter to control the…"}},{"name":"offset","in":"query","required":false,"description":"Specifies the number of orders to skip in the result set before returning the first order in the paginated response. Combine offset with…","schema":{"type":"string","description":"Specifies the number of orders to skip in the result set before returning the first order in the paginated response. Combine offset with…"}},{"name":"orderIds","in":"query","required":false,"description":"A comma-separated list of the unique identifiers of the orders to retrieve (maximum 50). If one or more order ID values are specified…","schema":{"type":"string","description":"A comma-separated list of the unique identifiers of the orders to retrieve (maximum 50). If one or more order ID values are specified…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-fulfillment/get-order":{"get":{"operationId":"ecommerce_ebay_sell_fulfillment_get_order","summary":"Use this call to retrieve the contents of an order based on its unique identifier, orderId . This value was…","description":"GET /order/{orderId}","tags":["ecommerce"],"parameters":[{"name":"fieldGroups","in":"query","required":false,"description":"The response type associated with the order. The only presently supported value is TAX_BREAKDOWN . This type returns a breakdown of tax…","schema":{"type":"string","description":"The response type associated with the order. The only presently supported value is TAX_BREAKDOWN . This type returns a breakdown of tax…"}},{"name":"orderId","in":"query","required":true,"description":"The unique identifier of the order. Order ID values are shown in My eBay/Seller Hub, and are also returned by the getOrders method in the…","schema":{"type":"string","description":"The unique identifier of the order. Order ID values are shown in My eBay/Seller Hub, and are also returned by the getOrders method in the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-fulfillment/get-shipping-fulfillments":{"get":{"operationId":"ecommerce_ebay_sell_fulfillment_get_shipping_fulfillments","summary":"Use this call to retrieve the contents of all fulfillments currently defined for a specified order based on…","description":"GET /order/{orderId}/shipping_fulfillment","tags":["ecommerce"],"parameters":[{"name":"orderId","in":"query","required":true,"description":"The unique identifier of the order. Order ID values are shown in My eBay/Seller Hub, and are also returned by the getOrders method in the…","schema":{"type":"string","description":"The unique identifier of the order. Order ID values are shown in My eBay/Seller Hub, and are also returned by the getOrders method in the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-fulfillment/create-shipping-fulfillment":{"post":{"operationId":"ecommerce_ebay_sell_fulfillment_create_shipping_fulfillment","summary":"When you group an order's line items into one or more packages, each package requires a corresponding plan…","description":"POST /order/{orderId}/shipping_fulfillment","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["orderId","body"],"properties":{"orderId":{"type":"string","description":"The unique identifier of the order. Order ID values are shown in My eBay/Seller Hub, and are also returned by the getOrders method in the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-fulfillment/get-shipping-fulfillment":{"get":{"operationId":"ecommerce_ebay_sell_fulfillment_get_shipping_fulfillment","summary":"Use this call to retrieve the contents of a fulfillment based on its unique identifier, fulfillmentId…","description":"GET /order/{orderId}/shipping_fulfillment/{fulfillmentId}","tags":["ecommerce"],"parameters":[{"name":"fulfillmentId","in":"query","required":true,"description":"The unique identifier of the fulfillment. This eBay-generated value was created by the Create Shipping Fulfillment call, and returned by…","schema":{"type":"string","description":"The unique identifier of the fulfillment. This eBay-generated value was created by the Create Shipping Fulfillment call, and returned by…"}},{"name":"orderId","in":"query","required":true,"description":"The unique identifier of the order. Order ID values are shown in My eBay/Seller Hub, and are also returned by the getOrders method in the…","schema":{"type":"string","description":"The unique identifier of the order. Order ID values are shown in My eBay/Seller Hub, and are also returned by the getOrders method in the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-fulfillment/issue-refund":{"post":{"operationId":"ecommerce_ebay_sell_fulfillment_issue_refund","summary":"Issue Refund","description":"POST /order/{order_id}/issue_refund","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["order_id"],"properties":{"order_id":{"type":"string","description":"The unique identifier of the order. Order IDs are returned in the getOrders method (and GetOrders call of Trading API). The issueRefund…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-fulfillment/get-payment-dispute":{"get":{"operationId":"ecommerce_ebay_sell_fulfillment_get_payment_dispute","summary":"Get Payment Dispute Details","description":"GET /payment_dispute/{payment_dispute_id}","tags":["ecommerce"],"parameters":[{"name":"payment_dispute_id","in":"query","required":true,"description":"This is the unique identifier of the payment dispute. This path parameter must be passed in at the end of the call URI to identify the…","schema":{"type":"string","description":"This is the unique identifier of the payment dispute. This path parameter must be passed in at the end of the call URI to identify the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-fulfillment/accept-payment-dispute":{"post":{"operationId":"ecommerce_ebay_sell_fulfillment_accept_payment_dispute","summary":"Accept Payment Dispute","description":"POST /payment_dispute/{payment_dispute_id}/accept","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["payment_dispute_id"],"properties":{"payment_dispute_id":{"type":"string","description":"This is the unique identifier of the payment dispute. This path parameter must be passed into the call URI to identify the payment dispute…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-fulfillment/get-activities":{"get":{"operationId":"ecommerce_ebay_sell_fulfillment_get_activities","summary":"Get Payment Dispute Activity","description":"GET /payment_dispute/{payment_dispute_id}/activity","tags":["ecommerce"],"parameters":[{"name":"payment_dispute_id","in":"query","required":true,"description":"This is the unique identifier of the payment dispute. This path parameter must be passed in at the end of the call URI to identify the…","schema":{"type":"string","description":"This is the unique identifier of the payment dispute. This path parameter must be passed in at the end of the call URI to identify the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-fulfillment/add-evidence":{"post":{"operationId":"ecommerce_ebay_sell_fulfillment_add_evidence","summary":"Add an Evidence File","description":"POST /payment_dispute/{payment_dispute_id}/add_evidence","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["payment_dispute_id"],"properties":{"payment_dispute_id":{"type":"string","description":"This is the unique identifier of the payment dispute. This path parameter must be passed into the call URI to identify the payment dispute…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-fulfillment/contest-payment-dispute":{"post":{"operationId":"ecommerce_ebay_sell_fulfillment_contest_payment_dispute","summary":"Contest Payment Dispute","description":"POST /payment_dispute/{payment_dispute_id}/contest","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["payment_dispute_id"],"properties":{"payment_dispute_id":{"type":"string","description":"This is the unique identifier of the payment dispute. This path parameter must be passed into the call URI to identify the payment dispute…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-fulfillment/fetch-evidence-content":{"get":{"operationId":"ecommerce_ebay_sell_fulfillment_fetch_evidence_content","summary":"Get Payment Dispute Evidence File","description":"GET /payment_dispute/{payment_dispute_id}/fetch_evidence_content","tags":["ecommerce"],"parameters":[{"name":"payment_dispute_id","in":"query","required":true,"description":"The identifier of the payment dispute. The identifier of each payment dispute is returned in the getPaymentDisputeSummaries response. This…","schema":{"type":"string","description":"The identifier of the payment dispute. The identifier of each payment dispute is returned in the getPaymentDisputeSummaries response. This…"}},{"name":"evidence_id","in":"query","required":true,"description":"The identifier of the evidential file set. The identifier of an evidential file set for a payment dispute is returned under the evidence…","schema":{"type":"string","description":"The identifier of the evidential file set. The identifier of an evidential file set for a payment dispute is returned under the evidence…"}},{"name":"file_id","in":"query","required":true,"description":"The identifier of an evidential file. This file must belong to the evidential file set identified through the evidence_id query parameter.…","schema":{"type":"string","description":"The identifier of an evidential file. This file must belong to the evidential file set identified through the evidence_id query parameter.…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-fulfillment/update-evidence":{"post":{"operationId":"ecommerce_ebay_sell_fulfillment_update_evidence","summary":"Update evidence","description":"POST /payment_dispute/{payment_dispute_id}/update_evidence","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["payment_dispute_id"],"properties":{"payment_dispute_id":{"type":"string","description":"This is the unique identifier of the payment dispute. This path parameter must be passed into the call URI to identify the payment dispute…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-fulfillment/upload-evidence-file":{"post":{"operationId":"ecommerce_ebay_sell_fulfillment_upload_evidence_file","summary":"Upload an Evidence File","description":"POST /payment_dispute/{payment_dispute_id}/upload_evidence_file","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["payment_dispute_id"],"properties":{"payment_dispute_id":{"type":"string","description":"This is the unique identifier of the payment dispute. This path parameter must be passed into the call URI to identify the payment dispute…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:ebay-sell-fulfillment/get-payment-dispute-summaries":{"get":{"operationId":"ecommerce_ebay_sell_fulfillment_get_payment_dispute_summaries","summary":"Search Payment Dispute by Filters","description":"GET /payment_dispute_summary","tags":["ecommerce"],"parameters":[{"name":"order_id","in":"query","required":false,"description":"This filter is used if the seller wishes to retrieve one or more payment disputes filed against a specific order. It is possible that…","schema":{"type":"string","description":"This filter is used if the seller wishes to retrieve one or more payment disputes filed against a specific order. It is possible that…"}},{"name":"buyer_username","in":"query","required":false,"description":"This filter is used if the seller wishes to retrieve one or more payment disputes opened by a specific seller. The string that is passed…","schema":{"type":"string","description":"This filter is used if the seller wishes to retrieve one or more payment disputes opened by a specific seller. The string that is passed…"}},{"name":"open_date_from","in":"query","required":false,"description":"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…","schema":{"type":"string","description":"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…"}},{"name":"open_date_to","in":"query","required":false,"description":"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…","schema":{"type":"string","description":"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…"}},{"name":"payment_dispute_status","in":"query","required":false,"description":"This filter is used if the seller wishes to only retrieve payment disputes in a specific state. More than one value can be specified. If…","schema":{"type":"string","description":"This filter is used if the seller wishes to only retrieve payment disputes in a specific state. More than one value can be specified. If…"}},{"name":"limit","in":"query","required":false,"description":"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…","schema":{"type":"string","description":"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…"}},{"name":"offset","in":"query","required":false,"description":"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…","schema":{"type":"string","description":"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…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}