Shipment methods

We reserve the right to change this documentation

Verison: 1.0 (read more)

Read more about shipment methods

Overview

Order of the methods

The order of the Array of the available property is the correct order of the methods. At this moment this is the following:

  1. EHF
  2. eFaktura + AvtaleGiro
  3. AvtaleGiro
  4. Vipps Faktura
  5. eFaktura
  6. E-mail
  7. Paper
  8. Print it youself

Get available and default shipment methods for recipient

1
GET /shipment-methods/recipient/{recipientNumber}/{documentType}

example: /shipment-methods/recipient/42/invoice

Available document types:

  • invoice
  • offer
  • order-confirmation

Response

HTTP/1.1 200 OK

HTTP/1.1 404 NOT FOUND if the recipient doesn’t exist (read more)

HTTP/1.1 204 NO CONTENT if there isn’t any information about the document (read more)

It is important to notice that the values in the arrays are identical with the properties on the document shipment object.

1
2
3
4
{
    "available": ["email", "paper", "eFaktura"],
    "default": ["eFaktura"]
}

Get available and default shipment methods for recipient when sending again

1
GET /shipment-methods/{documentType}/{documentNumber}

example: /shipment-methods/invoice/2

Available document types:

  • invoice
  • credit-note
  • dunning
  • offer
  • order-confirmation

Response

HTTP/1.1 200 OK

HTTP/1.1 404 NOT FOUND if the recipient doesn’t exist (read more)

HTTP/1.1 204 NO CONTENT if there isn’t any information about the document (read more)

It is important to notice that the values in the arrays are identical with the properties on the document shipment object.

1
2
3
4
{
    "available": ["email", "paper", "eFaktura"],
    "default": ["eFaktura"]
}

Get available and default shipment methods when sending document based on invoice

1
GET /shipment-methods/invoice/{baseDocumentNumber}/{documentType}

example: Get methods for sending credit note for invoice with number 2 /shipment-methods/invoice/2/credit-note

Available document types:

  • credit-note
  • dunning

Response

HTTP/1.1 200 OK

HTTP/1.1 404 NOT FOUND if the recipient doesn’t exist (read more)

HTTP/1.1 204 NO CONTENT if there isn’t any information about the document (read more)

1
2
3
4
{
    "available": ["email", "paper", "eFaktura"],
    "default": ["eFaktura"]
}

International documents

In case the document is international an additional parameter is required. The response will be the same.

Request

1
GET /shipment-methods/recipient/{recipientNumber}/{documentType}?international=true

example: /shipment-methods/recipient/42/invoice?international=true

Special cases

It is possible that both eFaktura and AvtaleGiro are enabled in this case the default property contains more options.

It is important to notice that the values in the arrays are identical with the properties on the document shipment object.

1
2
3
4
{
    "available": ["email", "paper", "eFaktura", "avtaleGiro"],
    "default": ["eFaktura", "avtaleGiro"]
}

In case when only email and paper are available for sending invoice, offer or order confirmation, originator and recipient preference will decide which of them gets to be the default value.

Paper is always the default value for sending dunning.