POST v1/Photo/{id}

This method uploads a photo to be used for product listings.

Request Information

URI Parameters

Name Description Type Additional information
id

The id of the photo to update

integer

Optional

Body Parameters

Photo

Name Description Type
PhotoID

The unique internal identifier of each photo in Tradevine e.g. 345146054865858558

integer
OrganisationID

The internal identifier of this organisation in Tradevine e.g. 3451460443781171981

integer
FileName

The uploaded file name

string
ContentsBase64

The file content, Base64 encoded

string
TradevineUrl

The Tradevine URL of the photo e.g. https://nz.tradevine.com/MyOrgName/ProductPhotos/GetPhoto?photoID=345146054865858558

string
PublicUrl

The public non-authenticated URL of the full-size photo e.g. https://nz.tradevine.com/BlobStorage/GetFullPhoto?photoID=345146054865858558&organisationID=3451460443781171981

string
PublicThumbnailUrl

The public non-authenticated URL of the thumbnail photo e.g. https://nz.tradevine.com/BlobStorage/GetFullPhoto?photoID=345146054865858558&organisationID=3451460443781171981&size=100

string
CreatedDate

The date and time (in UTC) that the photo was created

date
CreatedBy

The internal Tradevine ID of the user that created the photo

integer
ModifiedDate

The date and time (in UTC) that the photo was last modified

date
ModifiedBy

The internal Tradevine ID of the user that last modified the photo

integer

Request Formats

application/json

Sample:

{
  "PhotoID": 3500531279205274929,
  "OrganisationID": 3500531373198221079,
  "FileName": "Image1.jpg",
  "ContentsBase64": "",
  "TradevineUrl": null,
  "PublicUrl": null,
  "PublicThumbnailUrl": null,
  "CreatedDate": "2013-04-02T07:30:06Z",
  "CreatedBy": 1,
  "ModifiedDate": "2013-04-02T07:30:06Z",
  "ModifiedBy": 1
}

Response Information

Resource Description

The photo data from the Tradevine database

Photo

Name Description Type
PhotoID

The unique internal identifier of each photo in Tradevine e.g. 345146054865858558

integer
OrganisationID

The internal identifier of this organisation in Tradevine e.g. 3451460443781171981

integer
FileName

The uploaded file name

string
ContentsBase64

The file content, Base64 encoded

string
TradevineUrl

The Tradevine URL of the photo e.g. https://nz.tradevine.com/MyOrgName/ProductPhotos/GetPhoto?photoID=345146054865858558

string
PublicUrl

The public non-authenticated URL of the full-size photo e.g. https://nz.tradevine.com/BlobStorage/GetFullPhoto?photoID=345146054865858558&organisationID=3451460443781171981

string
PublicThumbnailUrl

The public non-authenticated URL of the thumbnail photo e.g. https://nz.tradevine.com/BlobStorage/GetFullPhoto?photoID=345146054865858558&organisationID=3451460443781171981&size=100

string
CreatedDate

The date and time (in UTC) that the photo was created

date
CreatedBy

The internal Tradevine ID of the user that created the photo

integer
ModifiedDate

The date and time (in UTC) that the photo was last modified

date
ModifiedBy

The internal Tradevine ID of the user that last modified the photo

integer

Response Formats

application/json

Sample:

{
  "PhotoID": 3500531279205274929,
  "OrganisationID": 3500531373198221079,
  "FileName": "Image1.jpg",
  "ContentsBase64": "",
  "TradevineUrl": null,
  "PublicUrl": null,
  "PublicThumbnailUrl": null,
  "CreatedDate": "2013-04-02T07:30:06Z",
  "CreatedBy": 1,
  "ModifiedDate": "2013-04-02T07:30:06Z",
  "ModifiedBy": 1
}