{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://www.apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/ecommerce:ebay-sell-account/get-advertising-eligibility":{"get":{"operationId":"ecommerce_ebay_sell_account_get_advertising_eligibility","summary":"This method allows developers to check the seller eligibility status for eBay advertising programs.","description":"GET /advertising_eligibility","tags":["ecommerce"],"parameters":[{"name":"program_types","in":"query","required":false,"description":"A comma-separated list of eBay advertising programs. Tip: See the AdvertisingProgramEnum type for possible values. If no programs are…","schema":{"type":"string","description":"A comma-separated list of eBay advertising programs. Tip: See the AdvertisingProgramEnum type for possible values. If no programs are…"}},{"name":"X-EBAY-C-MARKETPLACE-ID","in":"query","required":true,"description":"The unique identifier of the eBay marketplace for which the seller eligibility status shall be checked. Note: This value is case-sensitive.","schema":{"type":"string","description":"The unique identifier of the eBay marketplace for which the seller eligibility status shall be checked. Note: This value is case-sensitive."}}],"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-account/get-custom-policies":{"get":{"operationId":"ecommerce_ebay_sell_account_get_custom_policies","summary":"This method retrieves the list of custom policies specified by the policy_types query parameter for the…","description":"GET /custom_policy/","tags":["ecommerce"],"parameters":[{"name":"policy_types","in":"query","required":false,"description":"This query parameter specifies the type of custom policies to be returned. Multiple policy types may be requested in a single call by…","schema":{"type":"string","description":"This query parameter specifies the type of custom policies to be returned. Multiple policy types may be requested in a single call by…"}},{"name":"X-EBAY-C-MARKETPLACE-ID","in":"query","required":true,"description":"This header parameter specifies the eBay marketplace for the custom policy that is being created. Supported values for this header can be…","schema":{"type":"string","description":"This header parameter specifies the eBay marketplace for the custom policy that is being created. Supported values for this header can be…"}}],"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-account/create-custom-policy":{"post":{"operationId":"ecommerce_ebay_sell_account_create_custom_policy","summary":"This method creates a new custom policy in which a seller specifies their terms for complying with local…","description":"POST /custom_policy/","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-EBAY-C-MARKETPLACE-ID","body"],"properties":{"X-EBAY-C-MARKETPLACE-ID":{"type":"string","description":"This header parameter specifies the eBay marketplace for the custom policy that is being created. Supported values for this header can be…"},"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-account/get-custom-policy":{"get":{"operationId":"ecommerce_ebay_sell_account_get_custom_policy","summary":"This method retrieves the custom policy specified by the custom_policy_id path parameter for the selected…","description":"GET /custom_policy/{custom_policy_id}","tags":["ecommerce"],"parameters":[{"name":"custom_policy_id","in":"query","required":true,"description":"This path parameter is the unique custom policy identifier for the policy to be returned. Note: This value is automatically assigned by…","schema":{"type":"string","description":"This path parameter is the unique custom policy identifier for the policy to be returned. Note: This value is automatically assigned by…"}},{"name":"X-EBAY-C-MARKETPLACE-ID","in":"query","required":true,"description":"This header parameter specifies the eBay marketplace for the custom policy that is being created. Supported values for this header can be…","schema":{"type":"string","description":"This header parameter specifies the eBay marketplace for the custom policy that is being created. Supported values for this header can be…"}}],"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-account/update-custom-policy":{"post":{"operationId":"ecommerce_ebay_sell_account_update_custom_policy","summary":"This method updates an existing custom policy specified by the custom_policy_id path parameter for the…","description":"PUT /custom_policy/{custom_policy_id}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["custom_policy_id","X-EBAY-C-MARKETPLACE-ID","body"],"properties":{"custom_policy_id":{"type":"string","description":"This path parameter is the unique custom policy identifier for the policy to be returned. Note: This value is automatically assigned by…"},"X-EBAY-C-MARKETPLACE-ID":{"type":"string","description":"This header parameter specifies the eBay marketplace for the custom policy that is being created. Supported values for this header can be…"},"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-account/get-fulfillment-policies":{"get":{"operationId":"ecommerce_ebay_sell_account_get_fulfillment_policies","summary":"This method retrieves all the fulfillment policies configured for the marketplace you specify using the…","description":"GET /fulfillment_policy","tags":["ecommerce"],"parameters":[{"name":"marketplace_id","in":"query","required":true,"description":"This query parameter specifies the eBay marketplace of the policies you want to retrieve. For implementation help, refer to eBay API…","schema":{"type":"string","description":"This query parameter specifies the eBay marketplace of the policies you want to retrieve. For implementation help, refer to eBay API…"}}],"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-account/create-fulfillment-policy":{"post":{"operationId":"ecommerce_ebay_sell_account_create_fulfillment_policy","summary":"This method creates a new fulfillment policy where the policy encapsulates seller's terms for fulfilling…","description":"POST /fulfillment_policy/","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"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-account/get-fulfillment-policy-by-name":{"get":{"operationId":"ecommerce_ebay_sell_account_get_fulfillment_policy_by_name","summary":"This method retrieves the details for a specific fulfillment policy. In the request, supply both the policy…","description":"GET /fulfillment_policy/get_by_policy_name","tags":["ecommerce"],"parameters":[{"name":"marketplace_id","in":"query","required":true,"description":"This query parameter specifies the eBay marketplace of the policy you want to retrieve. For implementation help, refer to eBay API…","schema":{"type":"string","description":"This query parameter specifies the eBay marketplace of the policy you want to retrieve. For implementation help, refer to eBay API…"}},{"name":"name","in":"query","required":true,"description":"This query parameter specifies the seller-defined name of the fulfillment policy you want to retrieve.","schema":{"type":"string","description":"This query parameter specifies the seller-defined name of the fulfillment policy you want to retrieve."}}],"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-account/get-fulfillment-policy":{"get":{"operationId":"ecommerce_ebay_sell_account_get_fulfillment_policy","summary":"This method retrieves the complete details of a fulfillment policy. Supply the ID of the policy you want to…","description":"GET /fulfillment_policy/{fulfillmentPolicyId}","tags":["ecommerce"],"parameters":[{"name":"fulfillmentPolicyId","in":"query","required":true,"description":"This path parameter specifies the ID of the fulfillment policy you want to retrieve.","schema":{"type":"string","description":"This path parameter specifies the ID of the fulfillment policy you want to retrieve."}}],"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-account/update-fulfillment-policy":{"post":{"operationId":"ecommerce_ebay_sell_account_update_fulfillment_policy","summary":"This method updates an existing fulfillment policy. Specify the policy you want to update using the…","description":"PUT /fulfillment_policy/{fulfillmentPolicyId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["fulfillmentPolicyId","body"],"properties":{"fulfillmentPolicyId":{"type":"string","description":"This path parameter specifies the ID of the fulfillment policy you want to update."},"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-account/delete-fulfillment-policy":{"post":{"operationId":"ecommerce_ebay_sell_account_delete_fulfillment_policy","summary":"This method deletes a fulfillment policy. Supply the ID of the policy you want to delete in the…","description":"DELETE /fulfillment_policy/{fulfillmentPolicyId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["fulfillmentPolicyId"],"properties":{"fulfillmentPolicyId":{"type":"string","description":"This path parameter specifies the ID of the fulfillment policy to delete."}}}}}},"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-account/get-kyc":{"get":{"operationId":"ecommerce_ebay_sell_account_get_kyc","summary":"Note: This method was originally created to see which onboarding requirements were still pending for sellers…","description":"GET /kyc","tags":["ecommerce"],"parameters":[],"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-account/get-payment-policies":{"get":{"operationId":"ecommerce_ebay_sell_account_get_payment_policies","summary":"This method retrieves all the payment policies configured for the marketplace you specify using the…","description":"GET /payment_policy","tags":["ecommerce"],"parameters":[{"name":"marketplace_id","in":"query","required":true,"description":"This query parameter specifies the eBay marketplace of the policies you want to retrieve. For implementation help, refer to eBay API…","schema":{"type":"string","description":"This query parameter specifies the eBay marketplace of the policies you want to retrieve. For implementation help, refer to eBay API…"}}],"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-account/create-payment-policy":{"post":{"operationId":"ecommerce_ebay_sell_account_create_payment_policy","summary":"This method creates a new payment policy where the policy encapsulates seller's terms for order payments.…","description":"POST /payment_policy","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"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-account/get-payment-policy-by-name":{"get":{"operationId":"ecommerce_ebay_sell_account_get_payment_policy_by_name","summary":"This method retrieves the details of a specific payment policy. Supply both the policy name and its…","description":"GET /payment_policy/get_by_policy_name","tags":["ecommerce"],"parameters":[{"name":"marketplace_id","in":"query","required":true,"description":"This query parameter specifies the eBay marketplace of the policy you want to retrieve. For implementation help, refer to eBay API…","schema":{"type":"string","description":"This query parameter specifies the eBay marketplace of the policy you want to retrieve. For implementation help, refer to eBay API…"}},{"name":"name","in":"query","required":true,"description":"This query parameter specifies the seller-defined name of the payment policy you want to retrieve.","schema":{"type":"string","description":"This query parameter specifies the seller-defined name of the payment policy you want to retrieve."}}],"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-account/get-payment-policy":{"get":{"operationId":"ecommerce_ebay_sell_account_get_payment_policy","summary":"This method retrieves the complete details of a payment policy. Supply the ID of the policy you want to…","description":"GET /payment_policy/{payment_policy_id}","tags":["ecommerce"],"parameters":[{"name":"payment_policy_id","in":"query","required":true,"description":"This path parameter specifies the ID of the payment policy you want to retrieve.","schema":{"type":"string","description":"This path parameter specifies the ID of the payment policy you want to retrieve."}}],"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-account/update-payment-policy":{"post":{"operationId":"ecommerce_ebay_sell_account_update_payment_policy","summary":"This method updates an existing payment policy. Specify the policy you want to update using the…","description":"PUT /payment_policy/{payment_policy_id}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["payment_policy_id","body"],"properties":{"payment_policy_id":{"type":"string","description":"This path parameter specifies the ID of the payment policy you want to update."},"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-account/delete-payment-policy":{"post":{"operationId":"ecommerce_ebay_sell_account_delete_payment_policy","summary":"This method deletes a payment policy. Supply the ID of the policy you want to delete in the paymentPolicyId…","description":"DELETE /payment_policy/{payment_policy_id}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["payment_policy_id"],"properties":{"payment_policy_id":{"type":"string","description":"This path parameter specifies the ID of the payment policy you want to delete."}}}}}},"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-account/get-payments-program":{"get":{"operationId":"ecommerce_ebay_sell_account_get_payments_program","summary":"Note: This method is no longer applicable, as all seller accounts globally have been enabled for the new…","description":"GET /payments_program/{marketplace_id}/{payments_program_type}","tags":["ecommerce"],"parameters":[{"name":"marketplace_id","in":"query","required":true,"description":"This path parameter specifies the eBay marketplace of the payments program for which you want to retrieve the seller's status.","schema":{"type":"string","description":"This path parameter specifies the eBay marketplace of the payments program for which you want to retrieve the seller's status."}},{"name":"payments_program_type","in":"query","required":true,"description":"This path parameter specifies the payments program whose status is returned by the call.","schema":{"type":"string","description":"This path parameter specifies the payments program whose status is returned by the call."}}],"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-account/get-payments-program-onboarding":{"get":{"operationId":"ecommerce_ebay_sell_account_get_payments_program_onboarding","summary":"Note: This method is no longer applicable, as all seller accounts globally have been enabled for the new…","description":"GET /payments_program/{marketplace_id}/{payments_program_type}/onboarding","tags":["ecommerce"],"parameters":[{"name":"marketplace_id","in":"query","required":true,"description":"The eBay marketplace ID associated with the onboarding status to retrieve.","schema":{"type":"string","description":"The eBay marketplace ID associated with the onboarding status to retrieve."}},{"name":"payments_program_type","in":"query","required":true,"description":"The type of payments program whose status is returned by the method.","schema":{"type":"string","description":"The type of payments program whose status is returned by the method."}}],"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-account/get-privileges":{"get":{"operationId":"ecommerce_ebay_sell_account_get_privileges","summary":"This method retrieves the seller's current set of privileges, including whether or not the seller's eBay…","description":"GET /privilege","tags":["ecommerce"],"parameters":[],"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-account/get-opted-in-programs":{"get":{"operationId":"ecommerce_ebay_sell_account_get_opted_in_programs","summary":"This method gets a list of the seller programs that the seller has opted-in to.","description":"GET /program/get_opted_in_programs","tags":["ecommerce"],"parameters":[],"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-account/opt-in-to-program":{"post":{"operationId":"ecommerce_ebay_sell_account_opt_in_to_program","summary":"This method opts the seller in to an eBay seller program. Refer to the Account API overview for information…","description":"POST /program/opt_in","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"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-account/opt-out-of-program":{"post":{"operationId":"ecommerce_ebay_sell_account_opt_out_of_program","summary":"This method opts the seller out of a seller program to which you have previously opted-in to. Get a list of…","description":"POST /program/opt_out","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"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-account/get-rate-tables":{"get":{"operationId":"ecommerce_ebay_sell_account_get_rate_tables","summary":"This method retrieves a seller's shipping rate tables for the country specified in the country_code query…","description":"GET /rate_table","tags":["ecommerce"],"parameters":[{"name":"country_code","in":"query","required":false,"description":"This query parameter specifies the two-letter ISO 3166 code of country for which you want shipping rate table information. If you do not…","schema":{"type":"string","description":"This query parameter specifies the two-letter ISO 3166 code of country for which you want shipping rate table information. If you do not…"}}],"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-account/get-return-policies":{"get":{"operationId":"ecommerce_ebay_sell_account_get_return_policies","summary":"This method retrieves all the return policies configured for the marketplace you specify using the…","description":"GET /return_policy","tags":["ecommerce"],"parameters":[{"name":"marketplace_id","in":"query","required":true,"description":"This query parameter specifies the ID of the eBay marketplace of the policy you want to retrieve. For implementation help, refer to eBay…","schema":{"type":"string","description":"This query parameter specifies the ID of the eBay marketplace of the policy you want to retrieve. For implementation help, refer to eBay…"}}],"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-account/create-return-policy":{"post":{"operationId":"ecommerce_ebay_sell_account_create_return_policy","summary":"This method creates a new return policy where the policy encapsulates seller's terms for returning items.…","description":"POST /return_policy","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"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-account/get-return-policy-by-name":{"get":{"operationId":"ecommerce_ebay_sell_account_get_return_policy_by_name","summary":"This method retrieves the details of a specific return policy. Supply both the policy name and its…","description":"GET /return_policy/get_by_policy_name","tags":["ecommerce"],"parameters":[{"name":"marketplace_id","in":"query","required":true,"description":"This query parameter specifies the ID of the eBay marketplace of the policy you want to retrieve. For implementation help, refer to eBay…","schema":{"type":"string","description":"This query parameter specifies the ID of the eBay marketplace of the policy you want to retrieve. For implementation help, refer to eBay…"}},{"name":"name","in":"query","required":true,"description":"This query parameter specifies the seller-defined name of the return policy you want to retrieve.","schema":{"type":"string","description":"This query parameter specifies the seller-defined name of the return policy you want to retrieve."}}],"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-account/get-return-policy":{"get":{"operationId":"ecommerce_ebay_sell_account_get_return_policy","summary":"This method retrieves the complete details of the return policy specified by the returnPolicyId path…","description":"GET /return_policy/{return_policy_id}","tags":["ecommerce"],"parameters":[{"name":"return_policy_id","in":"query","required":true,"description":"This path parameter specifies the of the return policy you want to retrieve.","schema":{"type":"string","description":"This path parameter specifies the of the return policy you want to retrieve."}}],"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-account/update-return-policy":{"post":{"operationId":"ecommerce_ebay_sell_account_update_return_policy","summary":"This method updates an existing return policy. Specify the policy you want to update using the…","description":"PUT /return_policy/{return_policy_id}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["return_policy_id","body"],"properties":{"return_policy_id":{"type":"string","description":"This path parameter specifies the ID of the return policy you want to update."},"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-account/delete-return-policy":{"post":{"operationId":"ecommerce_ebay_sell_account_delete_return_policy","summary":"This method deletes a return policy. Supply the ID of the policy you want to delete in the returnPolicyId…","description":"DELETE /return_policy/{return_policy_id}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["return_policy_id"],"properties":{"return_policy_id":{"type":"string","description":"This path parameter specifies the ID of the return policy you want to delete."}}}}}},"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-account/get-sales-taxes":{"get":{"operationId":"ecommerce_ebay_sell_account_get_sales_taxes","summary":"Use this call to retrieve all sales tax table entries that the seller has defined for a specific country.…","description":"GET /sales_tax","tags":["ecommerce"],"parameters":[{"name":"country_code","in":"query","required":true,"description":"This path parameter specifies the two-letter ISO 3166 code for the country whose tax table you want to retrieve. For implementation help,…","schema":{"type":"string","description":"This path parameter specifies the two-letter ISO 3166 code for the country whose tax table you want to retrieve. For implementation help,…"}}],"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-account/get-sales-tax":{"get":{"operationId":"ecommerce_ebay_sell_account_get_sales_tax","summary":"This call gets the current sales tax table entry for a specific tax jurisdiction. Specify the jurisdiction…","description":"GET /sales_tax/{countryCode}/{jurisdictionId}","tags":["ecommerce"],"parameters":[{"name":"countryCode","in":"query","required":true,"description":"This path parameter specifies the two-letter ISO 3166 code for the country whose sales tax table you want to retrieve.","schema":{"type":"string","description":"This path parameter specifies the two-letter ISO 3166 code for the country whose sales tax table you want to retrieve."}},{"name":"jurisdictionId","in":"query","required":true,"description":"This path parameter specifies the ID of the sales tax jurisdiction for the tax table entry you want to retrieve. Retrieve valid…","schema":{"type":"string","description":"This path parameter specifies the ID of the sales tax jurisdiction for the tax table entry you want to retrieve. Retrieve valid…"}}],"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-account/create-or-replace-sales-tax":{"post":{"operationId":"ecommerce_ebay_sell_account_create_or_replace_sales_tax","summary":"This method creates or updates a sales tax table entry for a jurisdiction. Specify the tax table entry you…","description":"PUT /sales_tax/{countryCode}/{jurisdictionId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["countryCode","jurisdictionId","body"],"properties":{"countryCode":{"type":"string","description":"This path parameter specifies the two-letter ISO 3166 code for the country for which you want to create a sales tax table entry."},"jurisdictionId":{"type":"string","description":"This path parameter specifies the ID of the tax jurisdiction for the table entry you want to create. Retrieve valid jurisdiction IDs using…"},"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-account/delete-sales-tax":{"post":{"operationId":"ecommerce_ebay_sell_account_delete_sales_tax","summary":"This call deletes a sales tax table entry for a jurisdiction. Specify the jurisdiction to delete using the…","description":"DELETE /sales_tax/{countryCode}/{jurisdictionId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["countryCode","jurisdictionId"],"properties":{"countryCode":{"type":"string","description":"This path parameter specifies the two-letter ISO 3166 code for the country whose sales tax table entry you want to delete."},"jurisdictionId":{"type":"string","description":"This path parameter specifies the ID of the sales tax jurisdiction whose table entry you want to delete. Retrieve valid jurisdiction IDs…"}}}}}},"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-account/get-subscription":{"get":{"operationId":"ecommerce_ebay_sell_account_get_subscription","summary":"This method retrieves a list of subscriptions associated with the seller account.","description":"GET /subscription","tags":["ecommerce"],"parameters":[{"name":"limit","in":"query","required":false,"description":"This field is for future use.","schema":{"type":"string","description":"This field is for future use."}},{"name":"continuation_token","in":"query","required":false,"description":"This field is for future use.","schema":{"type":"string","description":"This field is for future use."}}],"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"}}}}}}}