Resources Models Unions Annotations Clients

shopify-merchant-config 0.19.7

History | Watch
  • Contact: N/A
  • License: N/A

Resources

country_of_origin

Operations

Method and Path Description
PUT /:organization/shopify/merchant/config/country/of/origin
GET /:organization/shopify/merchant/config/country/of/origin

io.flow.billing.v0.unions.bank_account_form

Operations

Method and Path Description
PUT /:organization/shopify/merchant/config/bank/account

io.flow.merchant.onboarding.v0.models.ultimate_beneficiary_owner

Operations

Method and Path Description
PUT /:organization/shopify/merchant/config/ultimate/beneficiary/owner

know_your_business

Operations

Method and Path Description
PUT /:organization/shopify/merchant/config/know/your/business

Update your business details. Common errors:

  • EIN [{ein}] must be 9 digits: The EIN provided should contains only 9 digits, no other character is accepted
  • {field} cannot be blank: the field has to at least contains some text There might be other messages check them for details

package_dimensions

Operations

Method and Path Description
PUT /:organization/shopify/merchant/config/package/dimensions/default

Headers

No headers

Imports

https://app.apibuilder.io/flow/billing-bank-account/latest/service.json
https://app.apibuilder.io/flow/billing/latest/service.json
https://app.apibuilder.io/flow/common/latest/service.json
https://app.apibuilder.io/flow/error/latest/service.json
https://app.apibuilder.io/flow/merchant-onboarding/latest/service.json
https://app.apibuilder.io/flow/reference/latest/service.json

Enums

No enums

Interfaces

No interfaces

Models

company

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
legal_name string Yes -

incorporation_country string Yes -

incorporation_jurisdiction string Yes -

tax_registration_number string Yes -

country_of_origin

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
country io.flow.reference.v0.models.country:0.19.7 Yes -

country_of_origin_form

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
country string Yes -

individual

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
legal_name string Yes -

tax_registration_number string No -

date_of_birth date-iso8601 Yes -

know_your_business_usa

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
id string Yes -

organization_id string Yes -

shop io.flow.merchant.onboarding.v0.models.shop:0.19.7 No -

primary_entity entity Yes -

parent_company company No -

ultimate_parent_company company No -

ultimate_beneficiary_owner individual Yes -

business_url string Yes -

business_address io.flow.common.v0.models.address:0.19.7 Yes -

know_your_business_usa_form

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
primary_entity entity Yes -

parent_company company No -

ultimate_parent_company company No -

ultimate_beneficiary_owner individual Yes -

business_url string Yes -

business_address io.flow.common.v0.models.address:0.19.7 Yes -

package_dimensions

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
dimensions [io.flow.common.v0.models.dimension:0.19.7] Yes -

package_dimensions_form

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
dimensions [io.flow.common.v0.models.dimension:0.19.7] Yes -

Unions

entity

Interfaces: None

  • Type discriminator: discriminator
Type Discriminator Value Example Json Description
company company Minimal | Full

individual individual Minimal | Full

know_your_business

Interfaces: None

  • Type discriminator: discriminator
Type Discriminator Value Example Json Description
know_your_business_usa know_your_business_usa Minimal | Full

know_your_business_form

Interfaces: None

  • Type discriminator: discriminator
Type Discriminator Value Example Json Description
know_your_business_usa_form know_your_business_usa_form Minimal | Full

Annotations

personal_data

Identifies a field that contains Personal Data, as defined by GDPR. By default, any field marked with this annotation will be kept for 1 year and will be purgeable upon request provided there are no incomplete business activities associated with it.

consumer

Identifies a field that contains data about a consumer [as opposed to an employee of Flow, an organization or a partner].