{ "name": "shopify-merchant-config", "attributes": [ { "name": "api-build", "value": { "host": "merchant-onboarding" } } ], "imports": [ { "uri": "https://app.apibuilder.io/flow/error/latest/service.json" }, { "uri": "https://app.apibuilder.io/flow/billing/latest/service.json" }, { "uri": "https://app.apibuilder.io/flow/common/latest/service.json" }, { "uri": "https://app.apibuilder.io/flow/billing-bank-account/latest/service.json" }, { "uri": "https://app.apibuilder.io/flow/merchant-onboarding/latest/service.json" }, { "uri": "https://app.apibuilder.io/flow/reference/latest/service.json" } ], "unions": { "know_your_business_form": { "discriminator": "discriminator", "types": [ { "type": "know_your_business_usa_form" } ] }, "know_your_business": { "discriminator": "discriminator", "types": [ { "type": "know_your_business_usa" } ] }, "entity": { "discriminator": "discriminator", "types": [ { "type": "company" }, { "type": "individual" } ] } }, "models": { "country_of_origin_form": { "fields": [ { "name": "country", "type": "string" } ] }, "country_of_origin": { "fields": [ { "name": "country", "type": "io.flow.reference.v0.models.country" } ] }, "company": { "fields": [ { "name": "legal_name", "type": "string" }, { "name": "incorporation_country", "type": "string" }, { "name": "incorporation_jurisdiction", "type": "string" }, { "name": "tax_registration_number", "type": "string" } ] }, "individual": { "fields": [ { "name": "legal_name", "type": "string" }, { "name": "tax_registration_number", "type": "string", "required": false }, { "name": "date_of_birth", "type": "date-iso8601" } ] }, "know_your_business_usa_form": { "fields": [ { "name": "primary_entity", "type": "entity" }, { "name": "parent_company", "type": "company", "required": false }, { "name": "ultimate_parent_company", "type": "company", "required": false }, { "name": "ultimate_beneficiary_owner", "type": "individual" }, { "name": "business_url", "type": "string" }, { "name": "business_address", "type": "io.flow.common.v0.models.address" } ] }, "know_your_business_usa": { "fields": [ { "name": "id", "type": "string" }, { "name": "organization_id", "type": "string" }, { "name": "shop", "type": "io.flow.merchant.onboarding.v0.models.shop", "required": false }, { "name": "primary_entity", "type": "entity" }, { "name": "parent_company", "type": "company", "required": false }, { "name": "ultimate_parent_company", "type": "company", "required": false }, { "name": "ultimate_beneficiary_owner", "type": "individual" }, { "name": "business_url", "type": "string" }, { "name": "business_address", "type": "io.flow.common.v0.models.address" } ] }, "package_dimensions": { "fields": [ { "name": "dimensions", "type": "[io.flow.common.v0.models.dimension]" } ] }, "package_dimensions_form": { "fields": [ { "name": "dimensions", "type": "[io.flow.common.v0.models.dimension]" } ] } }, "resources": { "know_your_business": { "path": "/:organization/shopify/merchant/config/know/your/business", "operations": [ { "method": "PUT", "body": { "type": "know_your_business_form" }, "description": "Update your business details.\n Common errors:\n- **EIN [{ein}] must be 9 digits**: The EIN provided should contains only 9 digits, no other character is accepted\n- **{field} cannot be blank**: the field has to at least contains some text\n*There might be other messages check them for details*", "responses": { "200": { "type": "know_your_business" }, "201": { "type": "know_your_business" }, "401": { "type": "unit" }, "404": { "type": "unit" }, "422": { "type": "io.flow.error.v0.models.generic_error"} } } ] }, "country_of_origin": { "path": "/:organization/shopify/merchant/config/country/of/origin", "operations": [ { "method": "PUT", "body": { "type": "country_of_origin_form" }, "responses": { "200": { "type": "country_of_origin" }, "401": { "type": "unit" }, "404": { "type": "unit" }, "422": { "type": "io.flow.error.v0.models.generic_error" } } }, { "method": "GET", "parameters": [ { "name": "organization", "type": "string" } ], "responses": { "200": { "type": "country_of_origin" }, "401": { "type": "unit" }, "404": { "type": "unit" }, "422": { "type": "io.flow.error.v0.models.generic_error" } } } ] }, "io.flow.billing.v0.unions.bank_account_form": { "path": "/:organization/shopify/merchant/config/bank/account", "operations": [ { "method": "PUT", "body": { "type": "io.flow.billing.v0.unions.bank_account_form" }, "responses": { "200": { "type": "io.flow.billing.v0.models.organization_bank_account" }, "401": { "type": "unit" }, "404": { "type": "unit" }, "422": { "type": "io.flow.error.v0.models.generic_error" } } } ] }, "io.flow.merchant.onboarding.v0.models.ultimate_beneficiary_owner": { "path": "/:organization/shopify/merchant/config/ultimate/beneficiary/owner", "operations": [ { "method": "PUT", "body": { "type": "io.flow.merchant.onboarding.v0.models.ultimate_beneficiary_owner" }, "responses": { "200": { "type": "io.flow.merchant.onboarding.v0.models.ultimate_beneficiary_owner" }, "401": { "type": "unit" }, "404": { "type": "unit" }, "422": { "type": "io.flow.error.v0.models.generic_error" } } } ] }, "package_dimensions": { "path": "/:organization/shopify/merchant/config/package/dimensions/default", "operations": [ { "method": "PUT", "body": { "type": "package_dimensions_form" }, "responses": { "200": { "type": "package_dimensions" }, "401": { "type": "unit" }, "404": { "type": "unit" }, "422": { "type": "io.flow.error.v0.models.generic_error" } } } ] } } }