https://di.no/doc

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

This API enables activating a return parcel.

Contents

Prerequisites/Info (INTERNAL USE)

  • 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


Setup

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


ExampleDescription
Username (see Authentication section)wsfoobarA valid username.
Password (see Authentication section)a-very-very-long-passwordA password matching given username.


Environments / Endpoints

Consider using the TEST-endpoint wile developing your system. By doing this you ensure that your test-data will not pollute any potential external systems.

TESTPOST
https://staging-ws.di.no/ws/json/parcel/booking/v-1/activateOrder
PRODUCTIONPOST
https://ws.di.no/ws/json/parcel/booking/v-1/activateOrder


Authentication

This endpoint requires the user to be authenticated. Refer to the documentation here for more information on how to obtain a valid token to use in your request. 

Making a Request

Notes

  • A parcel can only be activated once

  • 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.

Request-Headers

keyvalue examplecomment

Authorization

Bearer "SECRET_WS_TOKEN"

See authentication on how to obtain a token
Content-Typeapplication/json

Request Body

NameTypeExampleMandatoryDescription
identifierstring(401)70712190172720651 / (00)370123460120012952(tick)

The identifier determines the parcel which should be activated. 

Identifier can be either a trackingReference or a shipmentId.

desiredDeliveryDate

string20190612

Date format yyyyMMdd. Optional field.
If specified for return solutions this date represents the day when the carrier
should pickup the package and should be earliest tomorrow. Normally the
consignor / sender will be instructed to lay out the package the day before pickup.
The date will default to the first possible date if not specified, and can not
exceed three months.

Response

NameTypeExampleDescription
partieslist of party objects

Note that the API could make minor changes to the returned consignee address.

propertiesmap of root properties
Map with additional properties. See root properties below.

Root properties

Name
Type
Example
Description

returnCode

stringR-1337This can be placed on some shipping labels.

pickupDate

string12.06.2019Defines which date the customer should return the parcel.
placementCodestringmailboxDefines where the customer should place the parcel when ready for pickup.
  • No labels