In order to integrate your VTEX site with the Picker Platform, you must first create your app keys in order to synchronize and authorize any request that will be made with VTEX. To do this, you must go to Account Settings > Application Keys.

Then, you should click on “Manage Keys”.
‍

Here you should click on the “Generate New” option. In the next window, you can add a name to your new key.
‍

For the credentials to be created to have the necessary access, you must add a role to it. Since Picker will consult the orders created and the pickup points, you must add roles to it that have access to these instances (in the case of the demonstration, it will be given administrative access).

Once the key data has been saved, a screen will appear where you will be presented with the credentials. It is very important that at this time you copy both the Application Key and your Application Token, since, after this screen, you will not be able to consult them again.
‍

Keep in mind that these sets of keys will be useful for any API request you want to make with VTEX (some of the steps you'll see below will require them).

Picker at VTEX is considered a Carrier, who must be assigned a Shipping Policy. Before creating Picker as a Shipping Policy, you must first meet the following requirements:

1) Activate Geolocation Shipping https://help.vtex.com/en/tutorial/registering-geolocation--tutorials_138

2) Create Pickup Points:
‍
https://help.vtex.com/en/tutorial/o-que-e-uma-transportadora-7u9duMD5UQa2QQwukAWMcE

a) When creating a pickup point (which for Picker represents a place in your workspace), you must create it with the same data with which you created it on your Picker platform.

b) To be able to identify your Picker locations in VTEX, you must enter the API Key of your location as the Pickup Point ID

To create a shipping policy, you can do it in 2 different ways:


1) Via Web Portal https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140


‍IMPORTANT: When manually creating a shipping policy that you want to integrate with Picker, you must enter the word “PICK” as an ID.

2) Via API with Postman https://developers.vtex.com/vtex-rest-api/reference/post_logistics-pvt-shipping-policies

In the same way as in its version on the Web Portal, it is necessary that for this shipping policy, the word “PICK” must be entered as an ID




In addition to this, it should be noted that once this policy has been created, they must enter the pricing rules for this delivery method (These prices are those that will be charged to the customer and are totally independent of the prices charged by Picker for each delivery)

Once you have all the previous steps, we will execute the command hook record via Postman. This step is the most important, since once this step is entered, all orders that have the Picker shipping method will be entered on the platform.

To create the hook needed to create the order in Picker, you'll need to run the following endpoint with your credentials https://developers.vtex.com/vtex-rest-api/reference/hookconfiguration


For this particular case, we'll execute the endpoint with the following body:

Before running this endpoint, you should consider the following:

1) We want the order to be created in Picker once it's accepted, that's why in the status field, we use “order-accepted”.

2) It is mandatory that in the status field (even if it's an array), you only enter a single type of status, to avoid duplicating orders in Picker.

3) In url, you must enter the endpoint of the environment you want to use:

a) For test environment: https://dev-api.pickerexpress.com/api/pushVtexOrder

b) For production environment: https://api.pickerexpress.com/api/pushVtexOrder


‍If you need more information
about hooks, you can see it here https://developers.vtex.com/vtex-rest-api/docs/orders-feed#hook-notifications

To start integrating Picker with Shopify, you should start by creating an app for your store. You can do this using the option Apps > Develop apps for your store.

It then allows the development of customized applications (Remember to read the terms and conditions).

Once you have approved the development of custom applications, this screen will appear. Click on create an application.
‍

We create the application (in this case we are going to put it Picker), and we proceed to click on Configure control panel API scopes.
‍

On this screen, it is very important to have selected the following permissions that the Picker API will have. The following must be selected:

• read_payment_terms

• read_shipping

• read_orders

• read_locals

• read_fulfillments

• read_locations

• read_assigned_fulfillment_orders

• read_third_party_fulfillment_orders

• read_merchant_managed_fulfillment_orders

Also, make sure that the version of API and Webhooks is 2022 04

Once this is done, we proceed to click on Install application to be able to request the access token for Shopify API services.

Keep in mind that this token It can only be revealed once. Copy it and keep it in a safe place.

Before you can set up Shopify credentials in Picker, you'll first need to create a Workspace. Once the workspace is created, go to the Configuration -> Integrations section.

Click on Change, to be able to enter your credentials. In this section, you'll need to add both the Access Token you obtained from Shopify and the URL of your site. Once added, an attempt will be made to verify the credentials in order to proceed to the next step (to verify that you entered the credentials correctly, the failed label will disappear).

When creating an order on Shopify, it's important to know which Picker location the order is shipped from. For this consideration, a relationship is made between the Shopify branches of your site and the Picker location in your Workspace.
To be able to list Shopify branches in Picker, on the same Shopify Settings screen, click Change. If you have already configured your credentials correctly, you will see Shopify branches and Picker locations when you enter the Manage Premises option.

Next, you'll see a list of all the branches you have active on Shopify. If any of these branches are related to a Picker location, the name of the location to which it relates will appear at the bottom of the branch name.

To proceed to relate a Shopify branch to a Picker location, you must click on the Edit button next to the Shopify branch. When you click here, a new window will appear where you can select the Picker location that you want to link to your selected Shopify branch.

When you select the location and click OK, this configuration will be saved.

This way, if a Shopify order is born from a branch, the Picker platform will know which location it is mentioned and will save it when the order is created.