How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Visma

Visma Shipment API

The Shipment API from Visma — 11 operation(s) for shipment.

Documentation Provider Profile APIs.io OpenAPI GitHub

Visma Shipment API is one of 193 APIs that Visma publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Shipment. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, rate-limit docs, and a support channel.

This API exposes 13 operations across 11 paths, and defines 92 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://api.finance.visma.net.

13 operations 11 paths 92 schemas 4 GET8 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://api.finance.visma.net
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Visma Shipment API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (interactiveapi) using the authorizationCode flow, exposing 5 scopes.

Paths & Operations 13

Across 11 paths, the API surfaces 13 operations — 4 GET, 8 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Shipment 13
GET
/v1/shipment/{shipmentNbr}
Get a specific Shipment
Shipment_GetByshipmentNbr 3 params → 200202
PUT
/v1/shipment/{shipmentNbr}
Update a specific Shipment
Shipment_PutByshipmentNbr 3 params body → 204412202
GET
/v1/shipment
Get a range of SO Shipments - ScreenId=SO302000 Request page size must be lower…
Shipment_GetAllShipments 16 params → 200202
POST
/v1/shipment
Create a Shipment
Shipment_Post 1 param body → 201202
GET
/v1/shipment/{shipmentNbr}/printShipmentConfirmation
Get the shipment confirmation report
Shipment_PrintShipmentConfirmationByshipmentNbr 2 params → 200202
GET
/v1/shipment/{shipmentNbr}/printPickList
Get the pick list report
Shipment_PrintPickListByshipmentNbr 2 params → 200202
POST
/v1/shipment/{shipmentNumber}/action/addSOLine
Adds a Sales Order Line to a specific Shipment
Shipment_AddSOLineByshipmentNumber 2 params body → 204202
POST
/v1/shipment/{shipmentNumber}/action/addSOOrder
Adds a Sales Order to a specific Shipment
Shipment_AddSOOrderByshipmentNumber 2 params body → 204202
POST
/v1/shipment/{shipmentNumber}/action/confirmShipment
Confirm shipment operation
Shipment_ConfirmShipmentByshipmentNumber 2 params → 200202
POST
/v1/shipment/{shipmentNumber}/action/correctShipment
Correct shipment operation
Shipment_CorrectShipmentByshipmentNumber 2 params → 200202
POST
/v1/shipment/{shipmentNumber}/action/addLine
Adds a new Shipment Line to a specific Shipment
Shipment_AddLineByshipmentNumber 2 params body → 204202
POST
/v1/shipment/{shipmentNumber}/action/deleteLine/{lineNumber}
Deletes a Shipment Line from a specific Shipment
Shipment_DeleteLineByshipmentNumberlineNumber 3 params body → 204202
POST
/v1/shipment/{shipmentNumber}/action/cancelShipment
Cancel shipment operation
Shipment_CancelShipmentByshipmentNumber 2 params → 200202

Schemas 92

The contract defines 92 schemas that model the data the API accepts and returns. The most detailed are ShipmentDto (52 properties), ShipmentUpdateDto (49 properties), ShipmentCreateDto (49 properties), ShipmentDetailLineDto (30 properties). Each schema is shown below with its type and property counts.

customerInShipmentDto
object
The top part Customer The customer to whom the goods specified in the document should be shipped. (This field does not appear for transfers.)
3 properties
shipViaInShipmentDto
object
Delivery settings tab Shipping information section Ship via The carrier used for shipping the goods.
2 properties
locationInShipmentDetailLineDto
object
Document details tab Location The location in the warehouse from which the item is shipped.
3 properties
customStr5InShipmentDetailLineAddDto
object
A free custom colum of type string with max length 100.
1 property
DtoValueOfString
object
1 property
uomInAllocationsUpdateDto
object
UoM The unit of measure for the specified quantity of the inventory item.
1 property
ShipmentDetailLineUpdateDto
object
22 properties
DtoValueOfNullableOfShipmentOperations
object
1 property
expirationDateInShipmentDetailLineUpdateDto
object
Property will become obsolete after version 5.31
1 property
customStr5InShipmentCreateDto
object
A free custom colum of type string with max length 100.
1 property
modeOfTrasportInShipmentDto
object
Delivery settings tab Intrastat section Mode of transportation The method of transportation.
2 properties
countyInShipmentAddressDto
object
County The county or province.
2 properties
shippingTermsInShipmentDto
object
Delivery settings tab Shipping information section Shipping terms The shipping terms used in relations with the customer.
2 properties
ShipmentCreateDto
object
49 properties
customStr3InShipmentDetailLineAddDto
object
A free custom colum of type string with max length 100.
1 property
customInt1InShipmentUpdateDto
object
A free custom colum of type int
1 property
customDateTimeUTC1InShipmentUpdateDto
object
A free custom colum of type DateTime - in UTC timezone
1 property
customInt1InShipmentDetailLineUpdateDto
object
A free custom colum of type int
1 property
AllocationsUpdateDto
object
This class represents a Allocations for Purchase Receipt Line in PurchaseReceiptEndpoint. Used to add/update data.
7 properties
ShipmentDetailLineDto
object
30 properties
customInt1InShipmentCreateDto
object
A free custom colum of type int
1 property
AllocationsDto
object
This class represents a Allocations for Purchase Receipt Line in PurchaseReceiptController. Used for getting data.
8 properties
customStr1InShipmentUpdateDto
object
A free custom colum of type string with max length 100.
1 property
customStr3InShipmentDetailLineUpdateDto
object
A free custom colum of type string with max length 100.
1 property
DtoValueOfNullableOfInt32
object
1 property
ShipmentSOLine
object
4 properties
customStr2InShipmentDetailLineUpdateDto
object
A free custom colum of type string with max length 100.
1 property
customDec1InShipmentCreateDto
object
A free custom colum of type decimal with max 4 decimals.
1 property
customDec1InShipmentUpdateDto
object
A free custom colum of type decimal with max 4 decimals.
1 property
ShipmentOrderLineDto
object
10 properties
DtoValueOfNullableOfTransportationModes
object
1 property
locationInShipmentDto
object
Mandatory field: The top part Location The customer location to receive the shipment.
3 properties
ownerInShipmentDto
object
The top part Owner The user assigned to approve the document.
2 properties
customInt2InShipmentDetailLineAddDto
object
A free custom colum of type int
1 property
ConfirmShipmentActionResultDto
object
3 properties
customStr4InShipmentDetailLineUpdateDto
object
A free custom colum of type string with max length 100.
1 property
shippingZoneInShipmentDto
object
Delivery settings tab Shipping information section Shipping zone ID The shipping zone of the customer.
2 properties
customDateTimeUTC1InShipmentDetailLineAddDto
object
A free custom colum of type DateTime - in UTC timezone
1 property
customStr1InShipmentCreateDto
object
A free custom colum of type string with max length 100.
1 property
customDec2InShipmentDetailLineUpdateDto
object
A free custom colum of type decimal with max 4 decimals.
1 property
ShipmentPackageLineUpdateDto
object
12 properties
DtoValueOfNullableOfDateTime
object
1 property
ShipmentUpdateDeleteLineDto
object
1 property 1 required
expirationDateInAllocationsUpdateDto
object
Expiration date The expiration date of the specified quantity of the stock item.
1 property
customDec1InShipmentDetailLineAddDto
object
A free custom colum of type decimal with max 4 decimals.
1 property
customStr2InShipmentUpdateDto
object
A free custom colum of type string with max length 100.
1 property
countryInShipmentAddressDto
object
Country The country.
4 properties
customDateTimeUTC1InShipmentCreateDto
object
A free custom colum of type DateTime - in UTC timezone
1 property
ShipmentUpdateDto
object
49 properties
customStr4InShipmentUpdateDto
object
A free custom colum of type string with max length 100.
1 property
deliveryContactInShipmentDto
object
Delivery settings tab Delivery address contact section
9 properties
ShipmentDetailLineAddDto
object
17 properties 1 required
lotSerialNumberInAllocationsUpdateDto
object
Lot/Serial no. The lot or serial number of the item.
1 property
DtoValueOfNullableOfDecimal
object
1 property
locationInAllocationsUpdateDto
object
Location The location in the warehouse.
1 property
warehouseInShipmentDetailLineDto
object
Mandatory field: Document details tab Warehouse The warehouse from which the items is shipped.
2 properties
customInt2InShipmentUpdateDto
object
A free custom colum of type int
1 property
DtoValueOfNullableOfBoolean
object
1 property
toWarehouseInShipmentDto
object
The top part To warehouse The warehouse to which the goods should be shipped in case of a transfer.
2 properties
customDec2InShipmentDetailLineAddDto
object
A free custom colum of type decimal with max 4 decimals.
1 property
MetadataDto
object
2 properties
customInt1InShipmentDetailLineAddDto
object
A free custom colum of type int
1 property
customStr1InShipmentDetailLineUpdateDto
object
A free custom colum of type string with max length 100.
1 property
customDec1InShipmentDetailLineUpdateDto
object
A free custom colum of type decimal with max 4 decimals.
1 property
customInt2InShipmentCreateDto
object
A free custom colum of type int
1 property
customStr1InShipmentDetailLineAddDto
object
A free custom colum of type string with max length 100.
1 property
customStr2InShipmentDetailLineAddDto
object
A free custom colum of type string with max length 100.
1 property
DtoValueOfBoolean
object
1 property
customStr3InShipmentCreateDto
object
A free custom colum of type string with max length 100.
1 property
DtoValueOfNullableOfShipmentTypes
object
1 property
customDec2InShipmentCreateDto
object
A free custom colum of type decimal with max 4 decimals.
1 property
fobPointInShipmentDto
object
Delivery settings tab Shipping information section FOB point The point where obligation of goods passes to the customer.
2 properties
customStr3InShipmentUpdateDto
object
A free custom colum of type string with max length 100.
1 property
customDec2InShipmentUpdateDto
object
A free custom colum of type decimal with max 4 decimals.
1 property
customDateTimeUTC1InShipmentDetailLineUpdateDto
object
A free custom colum of type DateTime - in UTC timezone
1 property
customStr5InShipmentUpdateDto
object
A free custom colum of type string with max length 100.
1 property
lineNbrInAllocationsUpdateDto
object
Line no. The line of the purchase order that contains the selected item.
1 property
customStr4InShipmentDetailLineAddDto
object
A free custom colum of type string with max length 100.
1 property
ShipmentDto
object
This class represents a Shipment in ShipmentController. Used by getting data.
52 properties
PackageDetailLineDto
object
14 properties
BackgroundApiAcceptedDto
object
2 properties
transactionTypeInShipmentDto
object
Delivery settings tab Intrastat section Transaction type The 1-digit code that describes the nature of the transaction (according to EU regulations for Intrast…
2 properties
customStr2InShipmentCreateDto
object
A free custom colum of type string with max length 100.
1 property
quantityInAllocationsUpdateDto
object
Quantity The quantity of the stock item with the same lot number. It is 1 for items with serial numbers.
1 property
DtoValueOfInt32
object
1 property
customInt2InShipmentDetailLineUpdateDto
object
A free custom colum of type int
1 property
customStr5InShipmentDetailLineUpdateDto
object
A free custom colum of type string with max length 100.
1 property
fromWarehouseInShipmentDto
object
Mandatory field: The top part Warehouse ID The warehouse from which the goods should be shipped.
2 properties
locationInAllocationsDto
object
Location The location in the warehouse.
3 properties
customStr4InShipmentCreateDto
object
A free custom colum of type string with max length 100.
1 property
deliveryAddressInShipmentDto
object
Delivery settings tab Delivery address section
9 properties
ShipmentSOOrder
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

visma-shipment-api-openapi.yml Raw ↑

Other APIs Visma publishes across the network.

Visma Business NXT GraphQL API
AE Profile APIs.io
Visma Account API
AE Profile APIs.io
Visma Accounts API
AE Profile APIs.io
Visma Agreements API
AE Profile APIs.io
Visma Allocation Periods API
AE Profile APIs.io
Visma Approval API
AE Profile APIs.io
Visma App Store Activation Status API
AE Profile APIs.io
Visma Article Account Codings API
AE Profile APIs.io
Visma Article Labels API
AE Profile APIs.io
Visma Articles API
AE Profile APIs.io
Visma Attachment API
AE Profile APIs.io
Visma Attachment Links API
AE Profile APIs.io
#Shipment
← Back to V APIs
API Details
ID
visma:visma-shipment-api
Base URL
https://api.finance.visma.net
Docs
https://docs.vismasoftware.no/vismanetapi/
Provider
Visma
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=visma-shipment-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/visma-shipment-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Visma Shipment API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.