Skip to content

Update a DESADV

Request

Replaces the header fields; replaces party and address when supplied; upserts items by Id (Id 0 adds a new item). Items are never deleted.

Security
Bearer
Path
desadvNumberstringrequired
Body
senderIdstring or null

Gets the sender identifier.

senderNamestring or null

Gets the sender name.

recipientIdstring or null

Gets the recipient identifier.

recipientNamestring or null

Gets the recipient name.

documentStatusstring or null

Gets the document status.

poNumberRefstring or null

Gets the referenced purchase-order number.

shipmentDatestring, (date-time)

Gets the shipment date.

latestDeliveryDatestring, (date-time)

Gets the latest delivery date.

partyobject(DesadvPartyRequest)

Represents the parties of a DESADV.

addressobject(DesadvAddressRequest)

Represents the party addresses of a DESADV.

desadvItemsArray of objects or null(DesadvItemRequest)

Gets the DESADV line items. On update, items are matched by Id (Id 0 adds a new item) and never deleted.

curl -i -X PUT \
  'https://developer.sustainabilitymaster.ai/_mock/openapi/api/DueDiligence/Desadv/{desadvNumber}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "senderId": "string",
    "senderName": "string",
    "recipientId": "string",
    "recipientName": "string",
    "documentStatus": "string",
    "poNumberRef": "string",
    "shipmentDate": "2019-08-24T14:15:22Z",
    "latestDeliveryDate": "2019-08-24T14:15:22Z",
    "party": {
      "buyerId": "string",
      "supplierGlnid": "string",
      "consigneeId": "string",
      "carrierId": "string",
      "buyerName": "string",
      "supplierName": "string",
      "consigneeName": "string",
      "carrierName": "string"
    },
    "address": {
      "buyerStAddrs": "string",
      "supplierStAddrs": "string",
      "consigneeStAddrs": "string",
      "carrierStAddrs": "string",
      "buyerCity": "string",
      "supplierCity": "string",
      "consigneeCity": "string",
      "carrierCity": "string",
      "buyerZipCode": "string",
      "supplierZipCode": "string",
      "consigneeZipCode": "string",
      "carrierStZipCode": "string",
      "buyerCountry": "string",
      "supplierCountry": "string",
      "consigneeCountry": "string",
      "carrierStCountry": "string"
    },
    "desadvItems": [
      {
        "id": 0,
        "desadvItemId": "string",
        "poNumberRef": "string",
        "itemHsnCode": "string",
        "itemGtinCode": "string",
        "unit": "string",
        "dispatchQuantity": 0.1,
        "eutracesReferenceId": "string",
        "eutracesVerificationNumber": "string",
        "carrierCode": "string",
        "ssccode": "string",
        "containerId": "string",
        "packageId": "string"
      }
    ]
  }'

Responses

OK

Response
No content