{"method":"POST","path":"https://api.revcent.com/v2/user_shops","summary":"Create A User Shop","description":"Create a user shop in RevCent which will link and integrate existing stores such as WooCommerce to RevCent. View markdown documentation at https://revcent.com/documentation/markdown/mcp/operation/CreateUserShop.md for an in-depth overview of this operation.  A site shop is required, along with the correct required fields when creating a user shop. You must have previously installed the appropriate RevCent plugin before creating a user shop as well as acquired the necessary credentials. For example, if the site shop is WooCommerce, they must have already installed the RevCent Payment plugin in WordPress and have created an API key/secret.<br>After creating the user shop, run the ValidateUserShop operation to ensure all remote settings are configured correctly, and if not configured correctly you can run the FixUserShop operation to have Revcent automatically configure settings correctly.<br>Once you have validated the user shop using the ValidateUserShop operation and potentially fixed the user shop using the FixUserShop operation, it is important to use the GetUserShop operation with remote_data query string parameters of 'shipping_methods' and 'offline_payment_methods', then edit the user shop with appropriately mapped values for the items in both methods.<br>Once you have set the shipping_methods and offline_payment_methods, use the GetUserShop operation to retrieve the remote_data products, which can then be used to create each product in RevCent associated with the user shop with the RevCent third_party_shop ID and the shops' product ID.","operationId":"CreateUserShop","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"name":{"description":"The user shop name. Must be unique from other user shop names.","type":"string"},"description":{"description":"The user shop description.","type":"string"},"url":{"type":"string","description":"The shop URL. Confirm the exact URL with the user before creating the user shop."},"payment_profile_id":{"type":"string","description":"A 20 character payment profile ID to associate with the user shop. This determines the payment profile that will process credit card transactions. If you do not have a payment profile ID, or a payment profile ID is invalid, automatically get a list of available payment profiles using the GetPaymentProfiles operation and find the appropriate payment profile and its ID. Confirm with the user the specific payment profile they want.","minLength":20,"maxLength":20},"campaign_id":{"type":"string","description":"A 20 character campaign ID to associate with the user shop. If you do not have a campaign ID, or a campaign ID is invalid, automatically get a list of available campaigns using the GetCampaigns operation and find the appropriate campaign and its ID. Confirm with the user the specific campaign they want.","minLength":20,"maxLength":20},"site_shop_id":{"type":"string","description":"A 20 character site shop ID which is associated with the user shop. If you do not have a site shop ID, or a site shop ID is invalid, automatically get a list of available site shops using the GetSiteShops operation and find the appropriate site shop and its ID. Confirm with the user the specific site shop they want.","minLength":20,"maxLength":20},"site_shop_version":{"type":"string","description":"The version of the shop software. For WooCommerce stores, the default value should be '3'. Confirm the exact version with the user before creating the user shop. A WooCommerce store should have a default version of '3'."},"fields":{"description":"An array of objects, each containing the id and value of the fields corresponding to the site shop. Get the site shop fields by using the GetSiteShop operation when the site_shop_id is confirmed.","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"id":{"description":"The id for the individual field according to the site shop fields required.","type":"string"},"value":{"description":"The value for the individual field according to the site shop fields required.","type":"string"}},"required":["id","value"]}}},"type":"object","required":["name","campaign_id","payment_profile_id","site_shop_id","site_shop_version"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"description":"","properties":{"api_call_id":{"type":"string","description":"A 20 character API call ID.","minLength":20,"maxLength":20},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time"},"code":{"description":"API call response code.","type":"integer","format":"int32","enum":[1]},"id":{"type":"string","description":"A 20 character user shop ID.","minLength":20,"maxLength":20},"result":{"type":"string"}},"type":"object","additionalProperties":false}}},"description":"Successful response."},"default":{"content":{"application/json":{"schema":{"description":"","properties":{"api_call_id":{"type":"string","description":"A 20 character API call ID.","minLength":20,"maxLength":20},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time"},"code":{"description":"This value indicates that there is an error. Will always be 0.","type":"integer","enum":[0]},"error_code":{"description":"The specific error code.","type":"string"},"message":{"description":"A human readable description of the error.","type":"string"},"result":{"description":"A description of the API call result.","type":"string"}},"title":"APIStandardErrors","type":"object","additionalProperties":false}}},"description":"Error response."}}}