Skip to content

PropmanProphecy/papiNet-API

 
 

Repository files navigation

papiNet Logo

papiNet API

papiNet is a global paper, forest products and bioproducts industry e-Business initiative, started in year 2000. papiNet consists of an XML set of standard electronic documents that facilitates the flow of information among parties engaged in buying, selling, and distribution of paper, forest and bio related products.

papiNet API is a new initiative that aim to deliver a similar industry level standardization of a REST API that facilitates the flow of information among parties engaged in buying, selling, and distribution of paper, forest and bio related products.

Use Case Driven

For this new flavour of the papiNet standard, we have decided to adopt an agile way of working, delivering the papiNet API definition iteratively based on specific use cases.

Master Data Use Case

The following API endpoints allows a customer to get master data information such as customer-articles, locations and parties from a seller:

  • GET /customer-articles
  • GET /customer-articles/{customerArticleId}
  • GET /locations
  • GET /locations/{locationId}
  • GET /parties
  • GET /parties/{partyId}

Purchase Order Use Case

The following API endpoints allows a customer to send, list, retrieve and modify purchase-orders for the seller:

  • POST /purchase-orders
  • GET /purchase-orders
  • GET /purchase-orders/{purchaseOrderId}
  • PATCH /purchase-orders/{purchaseOrderId}

Warehouse Logistics Use Case

The following API endpoints allows a supplier to communicate to a logistics supplier:

  • GET /supplier-orders
  • GET /supplier-orders/{supplierOrderId}
  • GET /logistics-delivery-notes
  • GET /logistics-delivery-notes/{logisticsDeliveryNoteId}
  • POST /logistics-delivery-notes
  • PUT /logistics-delivery-notes/{logisticsDeliveryNoteId}
  • POST /logistics-goods-receipts
  • PUT /logistics-goods-receipts/{logisticsGoodsReceiptId}
  • GET /delivery-instructions
  • GET /delivery-instructions/{deliveryInstructionId}

The papiNet API Standard

The following normative document is available:

  • papiNet-API.yaml the OpenAPI document describing the papiNet API. This is the main normative document.

In addition to these normative documents, we also have a papiNet mock service that provides live responses in line with the scenarios described within the use case documents.

About

papiNet is a global paper, forest products and bioproducts industry e-Business initiative.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 72.5%
  • Batchfile 12.7%
  • Python 10.6%
  • Shell 4.2%