Order is ready to pick up

POST {{url}}/moovinApiWebServices{{country}}/rest/api/ecommerceExternal/completeOrder

This method indicates that the order is ready to be picked up by Moover.

State

  • SUCCESS: the process was successful.
  • ERRORPARAMETERSCHANGE: when trying to make a parameter change, but it is not allowed (see Parameter changes).
  • PROFILEISBLOCKED: if this status is presented, it means that your account is blocked by pending invoices and you will not be able to request package deliveries until they are canceled
  • ERRORINTERNAL: if this error occurs please contact Moovin as they are uncontrolled causes.
  • ERRORNOTPERMISSION: You do not have the permissions to execute the action on the package. It is presented in case of executing the request on a package that does not belong to the profile.

Parameter changes

The method allows you to indicate if any parameter has changed at the time of packaging the products, the changes allowed for each of the services are indicated below:

Express service (Ondemand)

In the case of the express service, it is allowed to modify the vehicle, this when preparing the order it is identified that the quoted vehicle is not the correct one, so it can be changed from car to motorcycle or vice versa. Note: to be able to indicate this change, you only have to attach the vehicle parameter in the body with the option of motorcycle or car as appropriate.

Service en route (route)

It is allowed to change the size of the box quoted or to be able to create a different number of packages in the case of having to send more than one package to the client, for which the listSize parameter must be added with the following structure : json [ { "quantity":1, "size":"S", "weight":0.1 }, { "quantity":1, "size":"M", "weight":1 } ] In case of using dimensions, the following structure is sent

 [
    {
        "quantity":1
        "length":15,
        "width":25,
        "high":36,
        "weight":0.1
    },
    {
        "quantity":1
        "length":12,
        "width":45,
        "high":20,
        "weight":1
    }
]

Note: It is important to keep in mind that the products considered will be those indicated when creating the order.

When we proceed to notify that the order is ready for collection, a change was indicated in the conditions (size or number of packages), the response contains the parameter listPackage to indicate the cost of each of the packages that is going to be delivered. With the following structure:

"listPackage": [
        {
            "cost": {
                "amount": 3700.0,
                "type": "route"
            },
            "size": "M",
            "idPackage": 144984,
            "orderQR": "idPackage<MN>144984||fullName<MN>Daniel Abarca||phone<MN>87654321||identification<MN>124450570"
        },
]

Important

If the number of packages increases, a list is sent with the guide number corresponding to each package, it is mandatory to create them and paste them on each package, otherwise the company will not be able to collect. In the same way, the dimensions of the boxes must correspond to the generated label.

Request Body

{"idPackage"=>136}

HEADERS

KeyDatatypeRequiredDescription
tokenstring
Content-Typestring

RESPONSES

status: OK

{&quot;status&quot;:&quot;SUCCESS&quot;,&quot;message&quot;:&quot;Complete&quot;}