Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This API enables activating a return parcel.

...

  • The user is a ws-user

  • The user has access to the web service FlowBooking

  • The user has access to the shop registered on the parcel

  • A parcel can only be activated once

Anchor
Setup
Setup
Setup

Make sure you have the following information at hand before proceeding.


Example

Description

Username (see Authentication section)

wsfoobar

A valid username.

Password (see Authentication section)

a-very-very-long-password

A password matching given username.

Info

Clients using this API should not fail if new optional fields are added to the API. If a new field is added to the request or response on a later stage, existing clients should handle this in a way such as they just ignore the field.

Anchor
Environments
Environments
Environments / Endpoints

...

Name

Type

Example

Description

returnCode

string

R-1337

This can be placed on some shipping labels.

pickupDate

string

12.06.2019

Defines which date the customer should return the parcel.

placementCode

string

mailbox

Defines where the customer should place the parcel when ready for pickup.

Error response

Code

Action

409 - order.waiting.for.register.arrival

Activation done too soon after registration. Wait a couple of minutes and try again