{"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/cloud:aliyun-agency/customer-note-create":{"post":{"operationId":"cloud_aliyun_agency_customer_note_create","summary":"Creates a customer note","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://agency.aliyuncs.com","https://agency.ap-southeast-1.aliyuncs.com"],"default":"https://agency.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://agency.ap-southeast-1.aliyuncs.com"},"CustomerUid":{"type":"string","description":"The UID of the customer"},"CustomerName":{"type":"string","description":"The name of the customer"},"ContactName":{"type":"string","description":"The name of the contact"},"ContactInformation":{"type":"string","description":"The contact information"},"TouchDate":{"type":"integer","description":"The touch time. This value is a UNIX timestamp in milliseconds"},"NoteContent":{"type":"string","description":"The content of the note"}}}}}},"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/cloud:aliyun-agency/customer-note-edit":{"post":{"operationId":"cloud_aliyun_agency_customer_note_edit","summary":"Edits a customer note","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://agency.aliyuncs.com","https://agency.ap-southeast-1.aliyuncs.com"],"default":"https://agency.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://agency.ap-southeast-1.aliyuncs.com"},"NoteId":{"type":"integer","description":"The note ID. This parameter is required"},"ContactName":{"type":"string","description":"The name of the contact"},"ContactInformation":{"type":"string","description":"The contact information"},"TouchDate":{"type":"integer","description":"The touch date. The value is a UNIX timestamp in milliseconds"},"NoteContent":{"type":"string","description":"The content of the note"}}}}}},"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/cloud:aliyun-agency/customer-note-list":{"post":{"operationId":"cloud_aliyun_agency_customer_note_list","summary":"Queries a paged query list of customer notes with paging support","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://agency.aliyuncs.com","https://agency.ap-southeast-1.aliyuncs.com"],"default":"https://agency.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://agency.ap-southeast-1.aliyuncs.com"},"CustomerUid":{"type":"string","description":"The UID of the customer"},"PageNum":{"type":"integer","description":"The page number. Pages start from 1"},"PageSize":{"type":"integer","description":"The number of entries per page. Default value: 20"}}}}}},"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/cloud:aliyun-agency/customer-note-list-detail":{"post":{"operationId":"cloud_aliyun_agency_customer_note_list_detail","summary":"Queries the details of a customer note","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://agency.aliyuncs.com","https://agency.ap-southeast-1.aliyuncs.com"],"default":"https://agency.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://agency.ap-southeast-1.aliyuncs.com"},"NoteId":{"type":"integer","description":"The ID of the note"}}}}}},"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/cloud:aliyun-agency/get-bill-detail-file-list":{"post":{"operationId":"cloud_aliyun_agency_get_bill_detail_file_list","summary":"Queries the bill export file of a China partner for a specific billing cycle. The system pushes the file to…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["BillMonth"],"properties":{"endpoint":{"type":"string","enum":["https://agency.aliyuncs.com","https://agency.ap-southeast-1.aliyuncs.com"],"default":"https://agency.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://agency.ap-southeast-1.aliyuncs.com"},"BillMonth":{"type":"string","description":"The billing month"},"OssAccessKeyId":{"type":"string","description":"The AccessKey ID used to upload files to OSS"},"OssAccessKeySecret":{"type":"string","description":"The AccessKey secret used to upload files to OSS"},"OssSecurityToken":{"type":"string","description":"The STS token used to upload files to OSS"},"OssBucketName":{"type":"string","description":"The OSS bucket"},"OssEndpoint":{"type":"string","description":"The endpoint of the region where the OSS bucket for file sharing is located"},"OssRegion":{"type":"string","description":"The region where the OSS bucket is located"}}}}}},"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/cloud:aliyun-agency/get-commission-detail-file-list":{"post":{"operationId":"cloud_aliyun_agency_get_commission_detail_file_list","summary":"Queries the commission details of a partner","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://agency.aliyuncs.com","https://agency.ap-southeast-1.aliyuncs.com"],"default":"https://agency.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://agency.ap-southeast-1.aliyuncs.com"},"BillMonth":{"type":"string","description":"The billing month"},"OssAccessKeyId":{"type":"string","description":"The AccessKey ID used to upload files to OSS"},"OssAccessKeySecret":{"type":"string","description":"The AccessKey secret used to upload files to OSS"},"OssSecurityToken":{"type":"string","description":"The STS token used to upload files to OSS"},"OssBucketName":{"type":"string","description":"The OSS bucket name"},"OssEndpoint":{"type":"string","description":"The endpoint of the region where the Object Storage Service (OSS) bucket corresponding to the file sharing resides"},"OssRegion":{"type":"string","description":"The region where the OSS bucket resides"}}}}}},"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/cloud:aliyun-agency/get-customer-order-list":{"post":{"operationId":"cloud_aliyun_agency_get_customer_order_list","summary":"Queries partner customer acquisition orders","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PageNo","PageSize"],"properties":{"endpoint":{"type":"string","enum":["https://agency.aliyuncs.com","https://agency.ap-southeast-1.aliyuncs.com"],"default":"https://agency.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://agency.ap-southeast-1.aliyuncs.com"},"PageNo":{"type":"integer","description":"The page number"},"PageSize":{"type":"integer","description":"The number of entries per page"},"CustomerUid":{"type":"integer","description":"The customer UID"},"CustomerAccount":{"type":"string","description":"The customer account"},"RamAccountForCustomerManager":{"type":"string","description":"The employee who follows up with the customer"},"ProjectId":{"type":"integer","description":"The opportunity ID"},"OrderId":{"type":"integer","description":"The order ID"},"OrderTypeList":{"type":"string","description":"The list of order types (JSON-encoded)"},"OrderStatus":{"type":"integer","enum":["1","2","3"],"description":"The order status. Valid values: 1: unpaid 2: canceled 3: paid"},"PayType":{"type":"integer","enum":["1","2"],"description":"The payment type. Valid values: 1: non-delegated payment 2: delegated payment"},"ProductCode":{"type":"string","description":"The product code"},"ProductName":{"type":"string","description":"The product name"},"OrderCreateAfter":{"type":"integer","description":"The start timestamp for order creation. The time range cannot exceed 6 months. The order creation time range and the order payment time…"},"OrderCreateBefore":{"type":"integer","description":"The end timestamp for order creation. The time range cannot exceed 6 months. The order creation time range and the order payment time…"},"OrderPayAfter":{"type":"integer","description":"The start timestamp for order payment. The time range cannot exceed 6 months. The order creation time range and the order payment time…"},"OrderPayBefore":{"type":"integer","description":"The end timestamp for order payment. The time range cannot exceed 6 months. The order creation time range and the order payment time range…"},"PayAmountAfter":{"type":"number","description":"The minimum actual payment amount"},"PayAmountBefore":{"type":"number","description":"The maximum actual payment amount"}}}}}},"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/cloud:aliyun-agency/get-intl-commission-detail-file-list":{"post":{"operationId":"cloud_aliyun_agency_get_intl_commission_detail_file_list","summary":"Downloads the commission details of an international partner","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["BillMonth","OssAccessKeyId","OssAccessKeySecret","OssSecurityToken","OssBucketName","OssEndpoint","OssRegion"],"properties":{"endpoint":{"type":"string","enum":["https://agency.aliyuncs.com","https://agency.ap-southeast-1.aliyuncs.com"],"default":"https://agency.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://agency.ap-southeast-1.aliyuncs.com"},"BillMonth":{"type":"string","description":"The bill month"},"OssAccessKeyId":{"type":"string","description":"The AccessKey ID used to upload files to OSS"},"OssAccessKeySecret":{"type":"string","description":"The AccessKey secret used to upload files to OSS"},"OssSecurityToken":{"type":"string","description":"The STS token used to upload files to OSS"},"OssBucketName":{"type":"string","description":"The OSS bucket"},"OssEndpoint":{"type":"string","description":"The endpoint of the region where the Object Storage Service (OSS) bucket for file sharing resides"},"OssRegion":{"type":"string","description":"The region where the current OSS bucket resides"}}}}}},"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/cloud:aliyun-agency/get-renewal-rate-list":{"post":{"operationId":"cloud_aliyun_agency_get_renewal_rate_list","summary":"Queries the partner renewal rate","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["FiscalYearAndQuarter"],"properties":{"endpoint":{"type":"string","enum":["https://agency.aliyuncs.com","https://agency.ap-southeast-1.aliyuncs.com"],"default":"https://agency.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://agency.ap-southeast-1.aliyuncs.com"},"FiscalYearAndQuarter":{"type":"string","description":"The fiscal year and quarter"}}}}}},"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/cloud:aliyun-agency/get-sub-partner-list":{"post":{"operationId":"cloud_aliyun_agency_get_sub_partner_list","summary":"Queries the list of secondary distributors","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PageNo","PageSize"],"properties":{"endpoint":{"type":"string","enum":["https://agency.aliyuncs.com","https://agency.ap-southeast-1.aliyuncs.com"],"default":"https://agency.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://agency.ap-southeast-1.aliyuncs.com"},"SubPartnerPid":{"type":"string","description":"The PID of the secondary partner"},"SubPartnerCompanyName":{"type":"string","description":"The company name of the secondary partner"},"PageNo":{"type":"integer","description":"The page number, starting from 1"},"PageSize":{"type":"integer","description":"The number of entries per page. Maximum value: 100"}}}}}},"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/cloud:aliyun-agency/get-sub-partner-order-list":{"post":{"operationId":"cloud_aliyun_agency_get_sub_partner_order_list","summary":"Queries channel expansion orders","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PageNo","PageSize"],"properties":{"endpoint":{"type":"string","enum":["https://agency.aliyuncs.com","https://agency.ap-southeast-1.aliyuncs.com"],"default":"https://agency.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://agency.ap-southeast-1.aliyuncs.com"},"SubPartnerUid":{"type":"integer","description":"The UID of the secondary partner"},"SubPartnerName":{"type":"string","description":"The name of the secondary partner"},"ProjectId":{"type":"integer","description":"The opportunity ID"},"OrderId":{"type":"integer","description":"The order ID"},"OrderTypeList":{"type":"string","description":"The list of order types. Valid values: BUY, UPGRADE, DOWNGRADE, RENEW, REFUND, and OTHERS (JSON-encoded)"},"OrderStatus":{"type":"integer","description":"The order status. Valid values: 1: unpaid 2: paid 3: voided"},"PayType":{"type":"integer","description":"The payment type. Valid values: 1: non-delegated payment 2: delegated payment"},"ProductCode":{"type":"string","description":"The product code"},"ProductName":{"type":"string","description":"The product name"},"OrderCreateAfter":{"type":"integer","description":"The start timestamp of the order creation time range. The time range cannot exceed 6 months. The order creation time range and the order…"},"OrderCreateBefore":{"type":"integer","description":"The end timestamp of the order creation time range. The time range cannot exceed 6 months. The order creation time range and the order…"},"OrderPayAfter":{"type":"integer","description":"The start timestamp of the order payment time range. The time range cannot exceed 6 months. The order creation time range and the order…"},"OrderPayBefore":{"type":"integer","description":"The end timestamp of the order payment time range. The time range cannot exceed 6 months. The order creation time range and the order…"},"PayAmountAfter":{"type":"integer","description":"The minimum actual payment amount"},"PayAmountBefore":{"type":"integer","description":"The maximum actual payment amount"},"PageNo":{"type":"integer","description":"The page number"},"PageSize":{"type":"integer","description":"The number of entries per page"}}}}}},"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/cloud:aliyun-agency/version":{"post":{"operationId":"cloud_aliyun_agency_version","summary":"version","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://agency.aliyuncs.com","https://agency.ap-southeast-1.aliyuncs.com"],"default":"https://agency.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://agency.ap-southeast-1.aliyuncs.com"}}}}}},"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"}}},"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"}}}}}}}